diff --git a/.vscode/cspell.json b/.vscode/cspell.json
index acd03fb12e20..4d5dbc2789d6 100644
--- a/.vscode/cspell.json
+++ b/.vscode/cspell.json
@@ -1031,6 +1031,13 @@
"AUHOURS"
]
},
+ {
+ "filename": "**/sdk/discovery/**",
+ "words": [
+ "milli",
+ "invst"
+ ]
+ },
{
"filename": "**/sdk/communication/azure-communication-identity/CHANGELOG.md",
"words": [
diff --git a/eng/versioning/version_client.txt b/eng/versioning/version_client.txt
index b219a26528da..9b6c2fdc0afa 100644
--- a/eng/versioning/version_client.txt
+++ b/eng/versioning/version_client.txt
@@ -41,6 +41,7 @@ com.azure:azure-ai-agents;2.2.0;2.3.0-beta.1
com.azure:azure-ai-anomalydetector;3.0.0-beta.5;3.0.0-beta.6
com.azure:azure-ai-contentsafety;1.0.19;1.1.0-beta.1
com.azure:azure-ai-contentunderstanding;1.0.0;1.1.0-beta.3
+com.azure:azure-ai-discovery;1.0.0;1.0.0
com.azure:azure-ai-documentintelligence;1.0.9;1.1.0-beta.1
com.azure:azure-ai-documenttranslator;1.0.0-beta.1;1.0.0-beta.2
com.azure:azure-ai-formrecognizer;4.1.13;4.2.0-beta.1
diff --git a/pom.xml b/pom.xml
index 19f9517ddf8d..38ab701a83cf 100644
--- a/pom.xml
+++ b/pom.xml
@@ -106,6 +106,7 @@
Request Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * id: String (Optional)
+ * bookshelfName: String (Required)
+ * storageAssetReferences (Optional): [
+ * (Optional){
+ * id: String (Optional, Required on create)
+ * userAssignedIdentity: String (Optional)
+ * }
+ * ]
+ * knowledgeBaseUrl: String (Optional)
+ * provisioningState: String(Succeeded/Failed/Canceled/Accepted/Provisioning/Updating/Deleting) (Optional)
+ * error (Optional): {
+ * error (Required): (recursive schema, see error above)
+ * }
+ * status: String(NotStarted/Running/Succeeded/Canceled/Failed) (Optional)
+ * createdByApiVersion: String (Optional)
+ * lastIndexingRun (Optional): {
+ * runId: String (Optional)
+ * status: String(NotStarted/Running/Succeeded/Canceled/Failed) (Optional)
+ * error (Optional): (recursive schema, see error above)
+ * indexingMetrics (Optional): {
+ * documentsProcessed: int (Required)
+ * documentsFailed: int (Required)
+ * documentsTotal: int (Required)
+ * indexingPercentageComplete: int (Required)
+ * enrichmentStartTimeUtc: OffsetDateTime (Optional)
+ * enrichmentEndTimeUtc: OffsetDateTime (Optional)
+ * indexingStartTimeUtc: OffsetDateTime (Optional)
+ * indexingEndTimeUtc: OffsetDateTime (Optional)
+ * }
+ * }
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * tags (Optional): [
+ * (Optional){
+ * key: String (Optional)
+ * value: String (Optional)
+ * }
+ * ]
+ * description: String (Optional, Required on create)
+ * copilotInstruction: String (Optional, Required on create)
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * id: String (Optional)
+ * bookshelfName: String (Required)
+ * storageAssetReferences (Optional): [
+ * (Optional){
+ * id: String (Optional, Required on create)
+ * userAssignedIdentity: String (Optional)
+ * }
+ * ]
+ * knowledgeBaseUrl: String (Optional)
+ * provisioningState: String(Succeeded/Failed/Canceled/Accepted/Provisioning/Updating/Deleting) (Optional)
+ * error (Optional): {
+ * error (Required): (recursive schema, see error above)
+ * }
+ * status: String(NotStarted/Running/Succeeded/Canceled/Failed) (Optional)
+ * createdByApiVersion: String (Optional)
+ * lastIndexingRun (Optional): {
+ * runId: String (Optional)
+ * status: String(NotStarted/Running/Succeeded/Canceled/Failed) (Optional)
+ * error (Optional): (recursive schema, see error above)
+ * indexingMetrics (Optional): {
+ * documentsProcessed: int (Required)
+ * documentsFailed: int (Required)
+ * documentsTotal: int (Required)
+ * indexingPercentageComplete: int (Required)
+ * enrichmentStartTimeUtc: OffsetDateTime (Optional)
+ * enrichmentEndTimeUtc: OffsetDateTime (Optional)
+ * indexingStartTimeUtc: OffsetDateTime (Optional)
+ * indexingEndTimeUtc: OffsetDateTime (Optional)
+ * }
+ * }
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * tags (Optional): [
+ * (Optional){
+ * key: String (Optional)
+ * value: String (Optional)
+ * }
+ * ]
+ * description: String (Optional, Required on create)
+ * copilotInstruction: String (Optional, Required on create)
+ * }
+ * }
+ *
+ *
+ * @param knowledgeBaseName The knowledgeBase name.
+ * @param resource The resource instance.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link PollerFlux} for polling of a knowledgeBase.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public PollerFluxResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * id: String (Optional)
+ * bookshelfName: String (Required)
+ * storageAssetReferences (Optional): [
+ * (Optional){
+ * id: String (Optional, Required on create)
+ * userAssignedIdentity: String (Optional)
+ * }
+ * ]
+ * knowledgeBaseUrl: String (Optional)
+ * provisioningState: String(Succeeded/Failed/Canceled/Accepted/Provisioning/Updating/Deleting) (Optional)
+ * error (Optional): {
+ * error (Required): (recursive schema, see error above)
+ * }
+ * status: String(NotStarted/Running/Succeeded/Canceled/Failed) (Optional)
+ * createdByApiVersion: String (Optional)
+ * lastIndexingRun (Optional): {
+ * runId: String (Optional)
+ * status: String(NotStarted/Running/Succeeded/Canceled/Failed) (Optional)
+ * error (Optional): (recursive schema, see error above)
+ * indexingMetrics (Optional): {
+ * documentsProcessed: int (Required)
+ * documentsFailed: int (Required)
+ * documentsTotal: int (Required)
+ * indexingPercentageComplete: int (Required)
+ * enrichmentStartTimeUtc: OffsetDateTime (Optional)
+ * enrichmentEndTimeUtc: OffsetDateTime (Optional)
+ * indexingStartTimeUtc: OffsetDateTime (Optional)
+ * indexingEndTimeUtc: OffsetDateTime (Optional)
+ * }
+ * }
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * tags (Optional): [
+ * (Optional){
+ * key: String (Optional)
+ * value: String (Optional)
+ * }
+ * ]
+ * description: String (Optional, Required on create)
+ * copilotInstruction: String (Optional, Required on create)
+ * }
+ * }
+ *
+ *
+ * @param knowledgeBaseName The knowledgeBase name.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a knowledgeBase along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * id: String (Optional)
+ * bookshelfName: String (Required)
+ * storageAssetReferences (Optional): [
+ * (Optional){
+ * id: String (Optional, Required on create)
+ * userAssignedIdentity: String (Optional)
+ * }
+ * ]
+ * knowledgeBaseUrl: String (Optional)
+ * provisioningState: String(Succeeded/Failed/Canceled/Accepted/Provisioning/Updating/Deleting) (Optional)
+ * error (Optional): {
+ * error (Required): (recursive schema, see error above)
+ * }
+ * status: String(NotStarted/Running/Succeeded/Canceled/Failed) (Optional)
+ * createdByApiVersion: String (Optional)
+ * lastIndexingRun (Optional): {
+ * runId: String (Optional)
+ * status: String(NotStarted/Running/Succeeded/Canceled/Failed) (Optional)
+ * error (Optional): (recursive schema, see error above)
+ * indexingMetrics (Optional): {
+ * documentsProcessed: int (Required)
+ * documentsFailed: int (Required)
+ * documentsTotal: int (Required)
+ * indexingPercentageComplete: int (Required)
+ * enrichmentStartTimeUtc: OffsetDateTime (Optional)
+ * enrichmentEndTimeUtc: OffsetDateTime (Optional)
+ * indexingStartTimeUtc: OffsetDateTime (Optional)
+ * indexingEndTimeUtc: OffsetDateTime (Optional)
+ * }
+ * }
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * tags (Optional): [
+ * (Optional){
+ * key: String (Optional)
+ * value: String (Optional)
+ * }
+ * ]
+ * description: String (Optional, Required on create)
+ * copilotInstruction: String (Optional, Required on create)
+ * }
+ * }
+ *
+ *
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return paged collection of KnowledgeBase items as paginated response with {@link PagedFlux}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.COLLECTION)
+ public PagedFluxResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * operationType: String(Indexing/CancelIndexing/Search/Delete) (Required)
+ * id: String (Required)
+ * status: String(NotStarted/Running/Succeeded/Failed/Canceled) (Required)
+ * error (Optional): {
+ * error (Required): (recursive schema, see error above)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param knowledgeBaseName The knowledgeBase name.
+ * @param operationId The unique ID of the operation.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the status of a long-running operation along with {@link Response} on successful completion of
+ * {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoHeader Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| repeatability-request-id | String | No | Repeatability request ID header |
| repeatability-first-sent | String | No | Repeatability first sent header as + * HTTP-date |
Request Body Schema
+ * + *
+ * {@code
+ * {
+ * nodePoolId: String (Optional)
+ * projectId: String (Optional)
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * status: String(NotStarted/Running/Succeeded/Failed/Canceled) (Required)
+ * error (Optional): {
+ * error (Required): (recursive schema, see error above)
+ * }
+ * result (Optional): {
+ * runId: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param knowledgeBaseName The knowledgeBase name.
+ * @param startIndexingRequest The startIndexingRequest parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link PollerFlux} for polling of provides status details for long running operations.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public PollerFluxHeader Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| repeatability-request-id | String | No | Repeatability request ID header |
| repeatability-first-sent | String | No | Repeatability first sent header as + * HTTP-date |
Response Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * status: String(NotStarted/Running/Succeeded/Failed/Canceled) (Required)
+ * error (Optional): {
+ * error (Required): (recursive schema, see error above)
+ * }
+ * result (Optional): {
+ * runId: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param knowledgeBaseName The knowledgeBase name.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link PollerFlux} for polling of provides status details for long running operations.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public PollerFluxHeader Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| repeatability-request-id | String | No | Repeatability request ID header |
| repeatability-first-sent | String | No | Repeatability first sent header as + * HTTP-date |
Request Body Schema
+ * + *
+ * {@code
+ * {
+ * query: String (Required)
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * status: String(NotStarted/Running/Succeeded/Failed/Canceled) (Required)
+ * error (Optional): {
+ * error (Required): (recursive schema, see error above)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param knowledgeBaseName The knowledgeBase name.
+ * @param body The search request body.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link PollerFlux} for polling of long-running operation.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public PollerFluxResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * status: String(NotStarted/Running/Succeeded/Failed/Canceled) (Required)
+ * error (Optional): {
+ * error (Required): (recursive schema, see error above)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param knowledgeBaseName The knowledgeBase name.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link PollerFlux} for polling of provides status details for long running operations.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public PollerFluxRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * id: String (Optional)
+ * bookshelfName: String (Required)
+ * storageAssetReferences (Optional): [
+ * (Optional){
+ * id: String (Optional, Required on create)
+ * userAssignedIdentity: String (Optional)
+ * }
+ * ]
+ * knowledgeBaseUrl: String (Optional)
+ * provisioningState: String(Succeeded/Failed/Canceled/Accepted/Provisioning/Updating/Deleting) (Optional)
+ * error (Optional): {
+ * error (Required): (recursive schema, see error above)
+ * }
+ * status: String(NotStarted/Running/Succeeded/Canceled/Failed) (Optional)
+ * createdByApiVersion: String (Optional)
+ * lastIndexingRun (Optional): {
+ * runId: String (Optional)
+ * status: String(NotStarted/Running/Succeeded/Canceled/Failed) (Optional)
+ * error (Optional): (recursive schema, see error above)
+ * indexingMetrics (Optional): {
+ * documentsProcessed: int (Required)
+ * documentsFailed: int (Required)
+ * documentsTotal: int (Required)
+ * indexingPercentageComplete: int (Required)
+ * enrichmentStartTimeUtc: OffsetDateTime (Optional)
+ * enrichmentEndTimeUtc: OffsetDateTime (Optional)
+ * indexingStartTimeUtc: OffsetDateTime (Optional)
+ * indexingEndTimeUtc: OffsetDateTime (Optional)
+ * }
+ * }
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * tags (Optional): [
+ * (Optional){
+ * key: String (Optional)
+ * value: String (Optional)
+ * }
+ * ]
+ * description: String (Optional, Required on create)
+ * copilotInstruction: String (Optional, Required on create)
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * id: String (Optional)
+ * bookshelfName: String (Required)
+ * storageAssetReferences (Optional): [
+ * (Optional){
+ * id: String (Optional, Required on create)
+ * userAssignedIdentity: String (Optional)
+ * }
+ * ]
+ * knowledgeBaseUrl: String (Optional)
+ * provisioningState: String(Succeeded/Failed/Canceled/Accepted/Provisioning/Updating/Deleting) (Optional)
+ * error (Optional): {
+ * error (Required): (recursive schema, see error above)
+ * }
+ * status: String(NotStarted/Running/Succeeded/Canceled/Failed) (Optional)
+ * createdByApiVersion: String (Optional)
+ * lastIndexingRun (Optional): {
+ * runId: String (Optional)
+ * status: String(NotStarted/Running/Succeeded/Canceled/Failed) (Optional)
+ * error (Optional): (recursive schema, see error above)
+ * indexingMetrics (Optional): {
+ * documentsProcessed: int (Required)
+ * documentsFailed: int (Required)
+ * documentsTotal: int (Required)
+ * indexingPercentageComplete: int (Required)
+ * enrichmentStartTimeUtc: OffsetDateTime (Optional)
+ * enrichmentEndTimeUtc: OffsetDateTime (Optional)
+ * indexingStartTimeUtc: OffsetDateTime (Optional)
+ * indexingEndTimeUtc: OffsetDateTime (Optional)
+ * }
+ * }
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * tags (Optional): [
+ * (Optional){
+ * key: String (Optional)
+ * value: String (Optional)
+ * }
+ * ]
+ * description: String (Optional, Required on create)
+ * copilotInstruction: String (Optional, Required on create)
+ * }
+ * }
+ *
+ *
+ * @param knowledgeBaseName The knowledgeBase name.
+ * @param resource The resource instance.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link SyncPoller} for polling of a knowledgeBase.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public SyncPollerResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * id: String (Optional)
+ * bookshelfName: String (Required)
+ * storageAssetReferences (Optional): [
+ * (Optional){
+ * id: String (Optional, Required on create)
+ * userAssignedIdentity: String (Optional)
+ * }
+ * ]
+ * knowledgeBaseUrl: String (Optional)
+ * provisioningState: String(Succeeded/Failed/Canceled/Accepted/Provisioning/Updating/Deleting) (Optional)
+ * error (Optional): {
+ * error (Required): (recursive schema, see error above)
+ * }
+ * status: String(NotStarted/Running/Succeeded/Canceled/Failed) (Optional)
+ * createdByApiVersion: String (Optional)
+ * lastIndexingRun (Optional): {
+ * runId: String (Optional)
+ * status: String(NotStarted/Running/Succeeded/Canceled/Failed) (Optional)
+ * error (Optional): (recursive schema, see error above)
+ * indexingMetrics (Optional): {
+ * documentsProcessed: int (Required)
+ * documentsFailed: int (Required)
+ * documentsTotal: int (Required)
+ * indexingPercentageComplete: int (Required)
+ * enrichmentStartTimeUtc: OffsetDateTime (Optional)
+ * enrichmentEndTimeUtc: OffsetDateTime (Optional)
+ * indexingStartTimeUtc: OffsetDateTime (Optional)
+ * indexingEndTimeUtc: OffsetDateTime (Optional)
+ * }
+ * }
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * tags (Optional): [
+ * (Optional){
+ * key: String (Optional)
+ * value: String (Optional)
+ * }
+ * ]
+ * description: String (Optional, Required on create)
+ * copilotInstruction: String (Optional, Required on create)
+ * }
+ * }
+ *
+ *
+ * @param knowledgeBaseName The knowledgeBase name.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a knowledgeBase along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * id: String (Optional)
+ * bookshelfName: String (Required)
+ * storageAssetReferences (Optional): [
+ * (Optional){
+ * id: String (Optional, Required on create)
+ * userAssignedIdentity: String (Optional)
+ * }
+ * ]
+ * knowledgeBaseUrl: String (Optional)
+ * provisioningState: String(Succeeded/Failed/Canceled/Accepted/Provisioning/Updating/Deleting) (Optional)
+ * error (Optional): {
+ * error (Required): (recursive schema, see error above)
+ * }
+ * status: String(NotStarted/Running/Succeeded/Canceled/Failed) (Optional)
+ * createdByApiVersion: String (Optional)
+ * lastIndexingRun (Optional): {
+ * runId: String (Optional)
+ * status: String(NotStarted/Running/Succeeded/Canceled/Failed) (Optional)
+ * error (Optional): (recursive schema, see error above)
+ * indexingMetrics (Optional): {
+ * documentsProcessed: int (Required)
+ * documentsFailed: int (Required)
+ * documentsTotal: int (Required)
+ * indexingPercentageComplete: int (Required)
+ * enrichmentStartTimeUtc: OffsetDateTime (Optional)
+ * enrichmentEndTimeUtc: OffsetDateTime (Optional)
+ * indexingStartTimeUtc: OffsetDateTime (Optional)
+ * indexingEndTimeUtc: OffsetDateTime (Optional)
+ * }
+ * }
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * tags (Optional): [
+ * (Optional){
+ * key: String (Optional)
+ * value: String (Optional)
+ * }
+ * ]
+ * description: String (Optional, Required on create)
+ * copilotInstruction: String (Optional, Required on create)
+ * }
+ * }
+ *
+ *
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return paged collection of KnowledgeBase items as paginated response with {@link PagedIterable}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.COLLECTION)
+ public PagedIterableResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * operationType: String(Indexing/CancelIndexing/Search/Delete) (Required)
+ * id: String (Required)
+ * status: String(NotStarted/Running/Succeeded/Failed/Canceled) (Required)
+ * error (Optional): {
+ * error (Required): (recursive schema, see error above)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param knowledgeBaseName The knowledgeBase name.
+ * @param operationId The unique ID of the operation.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the status of a long-running operation along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseHeader Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| repeatability-request-id | String | No | Repeatability request ID header |
| repeatability-first-sent | String | No | Repeatability first sent header as + * HTTP-date |
Request Body Schema
+ * + *
+ * {@code
+ * {
+ * nodePoolId: String (Optional)
+ * projectId: String (Optional)
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * status: String(NotStarted/Running/Succeeded/Failed/Canceled) (Required)
+ * error (Optional): {
+ * error (Required): (recursive schema, see error above)
+ * }
+ * result (Optional): {
+ * runId: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param knowledgeBaseName The knowledgeBase name.
+ * @param startIndexingRequest The startIndexingRequest parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link SyncPoller} for polling of provides status details for long running operations.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public SyncPollerHeader Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| repeatability-request-id | String | No | Repeatability request ID header |
| repeatability-first-sent | String | No | Repeatability first sent header as + * HTTP-date |
Response Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * status: String(NotStarted/Running/Succeeded/Failed/Canceled) (Required)
+ * error (Optional): {
+ * error (Required): (recursive schema, see error above)
+ * }
+ * result (Optional): {
+ * runId: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param knowledgeBaseName The knowledgeBase name.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link SyncPoller} for polling of provides status details for long running operations.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public SyncPollerHeader Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| repeatability-request-id | String | No | Repeatability request ID header |
| repeatability-first-sent | String | No | Repeatability first sent header as + * HTTP-date |
Request Body Schema
+ * + *
+ * {@code
+ * {
+ * query: String (Required)
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * status: String(NotStarted/Running/Succeeded/Failed/Canceled) (Required)
+ * error (Optional): {
+ * error (Required): (recursive schema, see error above)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param knowledgeBaseName The knowledgeBase name.
+ * @param body The search request body.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link SyncPoller} for polling of long-running operation.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public SyncPollerResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * status: String(NotStarted/Running/Succeeded/Failed/Canceled) (Required)
+ * error (Optional): {
+ * error (Required): (recursive schema, see error above)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param knowledgeBaseName The knowledgeBase name.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link SyncPoller} for polling of provides status details for long running operations.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public SyncPollerResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * displayName: String (Optional)
+ * investigationName: String (Optional)
+ * projectName: String (Optional)
+ * }
+ * }
+ *
+ *
+ * @param conversationName The conversation name.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a conversation along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * projectName: String (Required)
+ * investigationName: String (Optional)
+ * displayName: String (Optional)
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * displayName: String (Optional)
+ * investigationName: String (Optional)
+ * projectName: String (Optional)
+ * }
+ * }
+ *
+ *
+ * @param createRequest The createRequest parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a conversation along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * displayName: String (Optional)
+ * investigationName: String (Optional)
+ * projectName: String (Optional)
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * displayName: String (Optional)
+ * investigationName: String (Optional)
+ * projectName: String (Optional)
+ * }
+ * }
+ *
+ *
+ * @param conversationName The conversation name.
+ * @param resource The resource instance.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a conversation along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| investigationName | String | No | The name of the associated Investigation |
| projectName | String | No | The name of the associated Project |
| createdSince | OffsetDateTime | No | The oldest creation timestamp to keep |
| top | Integer | No | The number of result items to return. |
| skip | Integer | No | The number of result items to skip. |
| maxpagesize | Integer | No | The maximum number of result items per page. |
Response Body Schema
+ * + *
+ * {@code
+ * {
+ * value (Required): [
+ * (Required){
+ * name: String (Required)
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * displayName: String (Optional)
+ * investigationName: String (Optional)
+ * projectName: String (Optional)
+ * }
+ * ]
+ * nextLink: String (Optional)
+ * }
+ * }
+ *
+ *
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return paged collection of Conversation items along with {@link Response} on successful completion of
+ * {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * displayName: String (Optional)
+ * investigationName: String (Optional)
+ * projectName: String (Optional)
+ * }
+ * }
+ *
+ *
+ * @param conversationName The conversation name.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a conversation along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * projectName: String (Required)
+ * investigationName: String (Optional)
+ * displayName: String (Optional)
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * displayName: String (Optional)
+ * investigationName: String (Optional)
+ * projectName: String (Optional)
+ * }
+ * }
+ *
+ *
+ * @param createRequest The createRequest parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a conversation along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * displayName: String (Optional)
+ * investigationName: String (Optional)
+ * projectName: String (Optional)
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * displayName: String (Optional)
+ * investigationName: String (Optional)
+ * projectName: String (Optional)
+ * }
+ * }
+ *
+ *
+ * @param conversationName The conversation name.
+ * @param resource The resource instance.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a conversation along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| investigationName | String | No | The name of the associated Investigation |
| projectName | String | No | The name of the associated Project |
| createdSince | OffsetDateTime | No | The oldest creation timestamp to keep |
| top | Integer | No | The number of result items to return. |
| skip | Integer | No | The number of result items to skip. |
| maxpagesize | Integer | No | The maximum number of result items per page. |
Response Body Schema
+ * + *
+ * {@code
+ * {
+ * value (Required): [
+ * (Required){
+ * name: String (Required)
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * displayName: String (Optional)
+ * investigationName: String (Optional)
+ * projectName: String (Optional)
+ * }
+ * ]
+ * nextLink: String (Optional)
+ * }
+ * }
+ *
+ *
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return paged collection of Conversation items along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * projectName: String (Required)
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * status: String(Created/Validated/Failed) (Optional)
+ * description: String (Optional)
+ * tags (Optional): [
+ * (Optional){
+ * key: String (Optional)
+ * value: String (Optional)
+ * }
+ * ]
+ * displayName: String (Optional)
+ * }
+ * }
+ *
+ *
+ * @param projectName The project name.
+ * @param investigationName The investigation name.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a investigation list item along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * status: String(NotStarted/Running/Succeeded/Failed/Canceled) (Required)
+ * error (Optional): {
+ * error (Required): (recursive schema, see error above)
+ * }
+ * result (Optional): {
+ * name: String (Required)
+ * projectName: String (Required)
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * status: String(Created/Validated/Failed) (Optional)
+ * description: String (Optional)
+ * tags (Optional): [
+ * (Optional){
+ * key: String (Optional)
+ * value: String (Optional)
+ * }
+ * ]
+ * displayName: String (Optional)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param projectName The project name.
+ * @param investigationName The investigation name.
+ * @param operationId The unique ID of the operation.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the status of a long-running operation along with {@link Response} on successful completion of
+ * {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * projectName: String (Required)
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * status: String(Created/Validated/Failed) (Optional)
+ * description: String (Optional)
+ * tags (Optional): [
+ * (Optional){
+ * key: String (Optional)
+ * value: String (Optional)
+ * }
+ * ]
+ * displayName: String (Optional)
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * projectName: String (Required)
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * status: String(Created/Validated/Failed) (Optional)
+ * description: String (Optional)
+ * tags (Optional): [
+ * (Optional){
+ * key: String (Optional)
+ * value: String (Optional)
+ * }
+ * ]
+ * displayName: String (Optional)
+ * }
+ * }
+ *
+ *
+ * @param projectName The project name.
+ * @param investigationName The investigation name.
+ * @param resource The resource instance.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a investigation list item along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * projectName: String (Required)
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * status: String(Created/Validated/Failed) (Optional)
+ * description: String (Optional)
+ * tags (Optional): [
+ * (Optional){
+ * key: String (Optional)
+ * value: String (Optional)
+ * }
+ * ]
+ * displayName: String (Optional)
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * projectName: String (Required)
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * status: String(Created/Validated/Failed) (Optional)
+ * description: String (Optional)
+ * tags (Optional): [
+ * (Optional){
+ * key: String (Optional)
+ * value: String (Optional)
+ * }
+ * ]
+ * displayName: String (Optional)
+ * }
+ * }
+ *
+ *
+ * @param projectName The project name.
+ * @param investigationName The investigation name.
+ * @param resource The resource instance.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a investigation list item along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * status: String(NotStarted/Running/Succeeded/Failed/Canceled) (Required)
+ * error (Optional): {
+ * error (Required): (recursive schema, see error above)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param projectName The project name.
+ * @param investigationName The investigation name.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link PollerFlux} for polling of provides status details for long running operations.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public PollerFluxQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| createdSince | OffsetDateTime | No | The oldest creation timestamp to keep |
| top | Integer | No | The number of result items to return. |
| skip | Integer | No | The number of result items to skip. |
| maxpagesize | Integer | No | The maximum number of result items per page. |
Response Body Schema
+ * + *
+ * {@code
+ * {
+ * value (Required): [
+ * (Required){
+ * name: String (Required)
+ * projectName: String (Required)
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * status: String(Created/Validated/Failed) (Optional)
+ * description: String (Optional)
+ * tags (Optional): [
+ * (Optional){
+ * key: String (Optional)
+ * value: String (Optional)
+ * }
+ * ]
+ * displayName: String (Optional)
+ * }
+ * ]
+ * nextLink: String (Optional)
+ * }
+ * }
+ *
+ *
+ * @param projectName The project name.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return paged collection of Investigation items along with {@link Response} on successful completion of
+ * {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * discoveryEngineStatus: String(Inactive/Active) (Required)
+ * systemPrompt: String (Optional)
+ * configuration (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * }
+ * }
+ *
+ *
+ * @param projectName The project name.
+ * @param investigationName The investigation name.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the discovery engine for an investigation along with {@link Response} on successful completion of
+ * {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| top | Integer | No | The number of result items to return. |
| skip | Integer | No | The number of result items to skip. |
| maxpagesize | Integer | No | The maximum number of result items per page. |
Response Body Schema
+ * + *
+ * {@code
+ * {
+ * value (Required): [
+ * (Required){
+ * content: String (Required)
+ * type: String(Thought) (Required)
+ * createdAt: OffsetDateTime (Optional)
+ * }
+ * ]
+ * nextLink: String (Optional)
+ * }
+ * }
+ *
+ *
+ * @param projectName The project name.
+ * @param investigationName The investigation name.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return paged collection of WorkingMemoryEntry items along with {@link Response} on successful completion of
+ * {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * discoveryEngineStatus: String(Inactive/Active) (Required)
+ * systemPrompt: String (Optional)
+ * configuration (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * }
+ * }
+ *
+ *
+ * @param projectName The project name.
+ * @param investigationName The investigation name.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return discovery engine instance along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * discoveryEngineStatus: String(Inactive/Active) (Required)
+ * systemPrompt: String (Optional)
+ * configuration (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * }
+ * }
+ *
+ *
+ * @param projectName The project name.
+ * @param investigationName The investigation name.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return discovery engine instance along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * systemPrompt: String (Optional)
+ * configuration (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * discoveryEngineStatus: String(Inactive/Active) (Required)
+ * systemPrompt: String (Optional)
+ * configuration (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * }
+ * }
+ *
+ *
+ * @param projectName The project name.
+ * @param investigationName The investigation name.
+ * @param body The discovery engine update request. This will create the discovery engine if it does not already
+ * exist.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return discovery engine instance along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * projectName: String (Required)
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * status: String(Created/Validated/Failed) (Optional)
+ * description: String (Optional)
+ * tags (Optional): [
+ * (Optional){
+ * key: String (Optional)
+ * value: String (Optional)
+ * }
+ * ]
+ * displayName: String (Optional)
+ * }
+ * }
+ *
+ *
+ * @param projectName The project name.
+ * @param investigationName The investigation name.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a investigation list item along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * status: String(NotStarted/Running/Succeeded/Failed/Canceled) (Required)
+ * error (Optional): {
+ * error (Required): (recursive schema, see error above)
+ * }
+ * result (Optional): {
+ * name: String (Required)
+ * projectName: String (Required)
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * status: String(Created/Validated/Failed) (Optional)
+ * description: String (Optional)
+ * tags (Optional): [
+ * (Optional){
+ * key: String (Optional)
+ * value: String (Optional)
+ * }
+ * ]
+ * displayName: String (Optional)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param projectName The project name.
+ * @param investigationName The investigation name.
+ * @param operationId The unique ID of the operation.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the status of a long-running operation along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * projectName: String (Required)
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * status: String(Created/Validated/Failed) (Optional)
+ * description: String (Optional)
+ * tags (Optional): [
+ * (Optional){
+ * key: String (Optional)
+ * value: String (Optional)
+ * }
+ * ]
+ * displayName: String (Optional)
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * projectName: String (Required)
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * status: String(Created/Validated/Failed) (Optional)
+ * description: String (Optional)
+ * tags (Optional): [
+ * (Optional){
+ * key: String (Optional)
+ * value: String (Optional)
+ * }
+ * ]
+ * displayName: String (Optional)
+ * }
+ * }
+ *
+ *
+ * @param projectName The project name.
+ * @param investigationName The investigation name.
+ * @param resource The resource instance.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a investigation list item along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * projectName: String (Required)
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * status: String(Created/Validated/Failed) (Optional)
+ * description: String (Optional)
+ * tags (Optional): [
+ * (Optional){
+ * key: String (Optional)
+ * value: String (Optional)
+ * }
+ * ]
+ * displayName: String (Optional)
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * projectName: String (Required)
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * status: String(Created/Validated/Failed) (Optional)
+ * description: String (Optional)
+ * tags (Optional): [
+ * (Optional){
+ * key: String (Optional)
+ * value: String (Optional)
+ * }
+ * ]
+ * displayName: String (Optional)
+ * }
+ * }
+ *
+ *
+ * @param projectName The project name.
+ * @param investigationName The investigation name.
+ * @param resource The resource instance.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a investigation list item along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * status: String(NotStarted/Running/Succeeded/Failed/Canceled) (Required)
+ * error (Optional): {
+ * error (Required): (recursive schema, see error above)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param projectName The project name.
+ * @param investigationName The investigation name.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link SyncPoller} for polling of provides status details for long running operations.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public SyncPollerQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| createdSince | OffsetDateTime | No | The oldest creation timestamp to keep |
| top | Integer | No | The number of result items to return. |
| skip | Integer | No | The number of result items to skip. |
| maxpagesize | Integer | No | The maximum number of result items per page. |
Response Body Schema
+ * + *
+ * {@code
+ * {
+ * value (Required): [
+ * (Required){
+ * name: String (Required)
+ * projectName: String (Required)
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * status: String(Created/Validated/Failed) (Optional)
+ * description: String (Optional)
+ * tags (Optional): [
+ * (Optional){
+ * key: String (Optional)
+ * value: String (Optional)
+ * }
+ * ]
+ * displayName: String (Optional)
+ * }
+ * ]
+ * nextLink: String (Optional)
+ * }
+ * }
+ *
+ *
+ * @param projectName The project name.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return paged collection of Investigation items along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * discoveryEngineStatus: String(Inactive/Active) (Required)
+ * systemPrompt: String (Optional)
+ * configuration (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * }
+ * }
+ *
+ *
+ * @param projectName The project name.
+ * @param investigationName The investigation name.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the discovery engine for an investigation along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| top | Integer | No | The number of result items to return. |
| skip | Integer | No | The number of result items to skip. |
| maxpagesize | Integer | No | The maximum number of result items per page. |
Response Body Schema
+ * + *
+ * {@code
+ * {
+ * value (Required): [
+ * (Required){
+ * content: String (Required)
+ * type: String(Thought) (Required)
+ * createdAt: OffsetDateTime (Optional)
+ * }
+ * ]
+ * nextLink: String (Optional)
+ * }
+ * }
+ *
+ *
+ * @param projectName The project name.
+ * @param investigationName The investigation name.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return paged collection of WorkingMemoryEntry items along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * discoveryEngineStatus: String(Inactive/Active) (Required)
+ * systemPrompt: String (Optional)
+ * configuration (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * }
+ * }
+ *
+ *
+ * @param projectName The project name.
+ * @param investigationName The investigation name.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return discovery engine instance along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * discoveryEngineStatus: String(Inactive/Active) (Required)
+ * systemPrompt: String (Optional)
+ * configuration (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * }
+ * }
+ *
+ *
+ * @param projectName The project name.
+ * @param investigationName The investigation name.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return discovery engine instance along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * systemPrompt: String (Optional)
+ * configuration (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * discoveryEngineStatus: String(Inactive/Active) (Required)
+ * systemPrompt: String (Optional)
+ * configuration (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * }
+ * }
+ *
+ *
+ * @param projectName The project name.
+ * @param investigationName The investigation name.
+ * @param body The discovery engine update request. This will create the discovery engine if it does not already
+ * exist.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return discovery engine instance along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * title: String (Optional)
+ * priority: String(Low/Medium/High) (Optional)
+ * description: String (Optional)
+ * validationRequirements (Optional): [
+ * String (Optional)
+ * ]
+ * parentId: String (Optional)
+ * dependsOn (Optional): [
+ * String (Optional)
+ * ]
+ * relatedTo (Optional): [
+ * String (Optional)
+ * ]
+ * assignedTo (Optional): {
+ * id: String (Optional, Required on create)
+ * type: String(User/Application/System) (Optional, Required on create)
+ * }
+ * comments (Optional): [
+ * (Optional){
+ * timestamp: OffsetDateTime (Optional)
+ * createdBy: String (Optional, Required on create)
+ * createdByType: String(User/Application/System) (Optional, Required on create)
+ * text: String (Optional, Required on create)
+ * }
+ * ]
+ * status: String(New/OnHold/Complete/Removed/FlaggedHuman/FlaggedAi/Executing/ExecutionDone/Stale/Failed/Incomplete) (Optional)
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * executionHistory (Optional): [
+ * (Optional){
+ * createdAt: OffsetDateTime (Optional, Required on create)
+ * action: String (Optional, Required on create)
+ * createdBy: String (Optional, Required on create)
+ * createdByType: String(User/Application/System) (Optional, Required on create)
+ * summary: String (Optional)
+ * responseMessageText: String (Optional)
+ * responseMessageId: String (Optional)
+ * additionalDetails (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * ]
+ * investigationId: String (Optional)
+ * taskResult (Optional): {
+ * text: String (Optional)
+ * storageAssetIds (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * storageAssetIds (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * }
+ *
+ *
+ * @param projectName The project name.
+ * @param investigationName The investigation name.
+ * @param taskName The unique identifier of the task.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a task by ID along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| filter | String | No | OData filter expression. Supported fields: investigationId, + * status, createdByType, priority, createdAt, lastModifiedAt. Example: status eq 'new' or status eq + * 'executing' |
Response Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * title: String (Optional)
+ * priority: String(Low/Medium/High) (Optional)
+ * description: String (Optional)
+ * validationRequirements (Optional): [
+ * String (Optional)
+ * ]
+ * parentId: String (Optional)
+ * dependsOn (Optional): [
+ * String (Optional)
+ * ]
+ * relatedTo (Optional): [
+ * String (Optional)
+ * ]
+ * assignedTo (Optional): {
+ * id: String (Optional, Required on create)
+ * type: String(User/Application/System) (Optional, Required on create)
+ * }
+ * comments (Optional): [
+ * (Optional){
+ * timestamp: OffsetDateTime (Optional)
+ * createdBy: String (Optional, Required on create)
+ * createdByType: String(User/Application/System) (Optional, Required on create)
+ * text: String (Optional, Required on create)
+ * }
+ * ]
+ * status: String(New/OnHold/Complete/Removed/FlaggedHuman/FlaggedAi/Executing/ExecutionDone/Stale/Failed/Incomplete) (Optional)
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * executionHistory (Optional): [
+ * (Optional){
+ * createdAt: OffsetDateTime (Optional, Required on create)
+ * action: String (Optional, Required on create)
+ * createdBy: String (Optional, Required on create)
+ * createdByType: String(User/Application/System) (Optional, Required on create)
+ * summary: String (Optional)
+ * responseMessageText: String (Optional)
+ * responseMessageId: String (Optional)
+ * additionalDetails (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * ]
+ * investigationId: String (Optional)
+ * taskResult (Optional): {
+ * text: String (Optional)
+ * storageAssetIds (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * storageAssetIds (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * }
+ *
+ *
+ * @param projectName The project name.
+ * @param investigationName The investigation name.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return paged collection of Task items as paginated response with {@link PagedFlux}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.COLLECTION)
+ public PagedFluxRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * title: String (Optional)
+ * priority: String(Low/Medium/High) (Optional)
+ * description: String (Optional)
+ * validationRequirements (Optional): [
+ * String (Optional)
+ * ]
+ * parentId: String (Optional)
+ * dependsOn (Optional): [
+ * String (Optional)
+ * ]
+ * relatedTo (Optional): [
+ * String (Optional)
+ * ]
+ * assignedTo (Optional): {
+ * id: String (Optional, Required on create)
+ * type: String(User/Application/System) (Optional, Required on create)
+ * }
+ * comments (Optional): [
+ * (Optional){
+ * timestamp: OffsetDateTime (Optional)
+ * createdBy: String (Optional, Required on create)
+ * createdByType: String(User/Application/System) (Optional, Required on create)
+ * text: String (Optional, Required on create)
+ * }
+ * ]
+ * status: String(New/OnHold/Complete/Removed/FlaggedHuman/FlaggedAi/Executing/ExecutionDone/Stale/Failed/Incomplete) (Optional)
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * executionHistory (Optional): [
+ * (Optional){
+ * createdAt: OffsetDateTime (Optional, Required on create)
+ * action: String (Optional, Required on create)
+ * createdBy: String (Optional, Required on create)
+ * createdByType: String(User/Application/System) (Optional, Required on create)
+ * summary: String (Optional)
+ * responseMessageText: String (Optional)
+ * responseMessageId: String (Optional)
+ * additionalDetails (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * ]
+ * investigationId: String (Optional)
+ * taskResult (Optional): {
+ * text: String (Optional)
+ * storageAssetIds (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * storageAssetIds (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * title: String (Optional)
+ * priority: String(Low/Medium/High) (Optional)
+ * description: String (Optional)
+ * validationRequirements (Optional): [
+ * String (Optional)
+ * ]
+ * parentId: String (Optional)
+ * dependsOn (Optional): [
+ * String (Optional)
+ * ]
+ * relatedTo (Optional): [
+ * String (Optional)
+ * ]
+ * assignedTo (Optional): {
+ * id: String (Optional, Required on create)
+ * type: String(User/Application/System) (Optional, Required on create)
+ * }
+ * comments (Optional): [
+ * (Optional){
+ * timestamp: OffsetDateTime (Optional)
+ * createdBy: String (Optional, Required on create)
+ * createdByType: String(User/Application/System) (Optional, Required on create)
+ * text: String (Optional, Required on create)
+ * }
+ * ]
+ * status: String(New/OnHold/Complete/Removed/FlaggedHuman/FlaggedAi/Executing/ExecutionDone/Stale/Failed/Incomplete) (Optional)
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * executionHistory (Optional): [
+ * (Optional){
+ * createdAt: OffsetDateTime (Optional, Required on create)
+ * action: String (Optional, Required on create)
+ * createdBy: String (Optional, Required on create)
+ * createdByType: String(User/Application/System) (Optional, Required on create)
+ * summary: String (Optional)
+ * responseMessageText: String (Optional)
+ * responseMessageId: String (Optional)
+ * additionalDetails (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * ]
+ * investigationId: String (Optional)
+ * taskResult (Optional): {
+ * text: String (Optional)
+ * storageAssetIds (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * storageAssetIds (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * }
+ *
+ *
+ * @param projectName The project name.
+ * @param investigationName The investigation name.
+ * @param body Task creation request.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return task resource along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * title: String (Optional)
+ * priority: String(Low/Medium/High) (Optional)
+ * description: String (Optional)
+ * validationRequirements (Optional): [
+ * String (Optional)
+ * ]
+ * parentId: String (Optional)
+ * dependsOn (Optional): [
+ * String (Optional)
+ * ]
+ * relatedTo (Optional): [
+ * String (Optional)
+ * ]
+ * assignedTo (Optional): {
+ * id: String (Optional, Required on create)
+ * type: String(User/Application/System) (Optional, Required on create)
+ * }
+ * comments (Optional): [
+ * (Optional){
+ * timestamp: OffsetDateTime (Optional)
+ * createdBy: String (Optional, Required on create)
+ * createdByType: String(User/Application/System) (Optional, Required on create)
+ * text: String (Optional, Required on create)
+ * }
+ * ]
+ * status: String(New/OnHold/Complete/Removed/FlaggedHuman/FlaggedAi/Executing/ExecutionDone/Stale/Failed/Incomplete) (Optional)
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * executionHistory (Optional): [
+ * (Optional){
+ * createdAt: OffsetDateTime (Optional, Required on create)
+ * action: String (Optional, Required on create)
+ * createdBy: String (Optional, Required on create)
+ * createdByType: String(User/Application/System) (Optional, Required on create)
+ * summary: String (Optional)
+ * responseMessageText: String (Optional)
+ * responseMessageId: String (Optional)
+ * additionalDetails (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * ]
+ * investigationId: String (Optional)
+ * taskResult (Optional): {
+ * text: String (Optional)
+ * storageAssetIds (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * storageAssetIds (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * title: String (Optional)
+ * priority: String(Low/Medium/High) (Optional)
+ * description: String (Optional)
+ * validationRequirements (Optional): [
+ * String (Optional)
+ * ]
+ * parentId: String (Optional)
+ * dependsOn (Optional): [
+ * String (Optional)
+ * ]
+ * relatedTo (Optional): [
+ * String (Optional)
+ * ]
+ * assignedTo (Optional): {
+ * id: String (Optional, Required on create)
+ * type: String(User/Application/System) (Optional, Required on create)
+ * }
+ * comments (Optional): [
+ * (Optional){
+ * timestamp: OffsetDateTime (Optional)
+ * createdBy: String (Optional, Required on create)
+ * createdByType: String(User/Application/System) (Optional, Required on create)
+ * text: String (Optional, Required on create)
+ * }
+ * ]
+ * status: String(New/OnHold/Complete/Removed/FlaggedHuman/FlaggedAi/Executing/ExecutionDone/Stale/Failed/Incomplete) (Optional)
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * executionHistory (Optional): [
+ * (Optional){
+ * createdAt: OffsetDateTime (Optional, Required on create)
+ * action: String (Optional, Required on create)
+ * createdBy: String (Optional, Required on create)
+ * createdByType: String(User/Application/System) (Optional, Required on create)
+ * summary: String (Optional)
+ * responseMessageText: String (Optional)
+ * responseMessageId: String (Optional)
+ * additionalDetails (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * ]
+ * investigationId: String (Optional)
+ * taskResult (Optional): {
+ * text: String (Optional)
+ * storageAssetIds (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * storageAssetIds (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * }
+ *
+ *
+ * @param projectName The project name.
+ * @param investigationName The investigation name.
+ * @param taskName The unique identifier of the task.
+ * @param resource The resource instance.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return task resource along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoHeader Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| Content-Type | String | No | The content type. Allowed values: + * "application/json". |
Request Body Schema
+ * + *
+ * {@code
+ * {
+ * assignee (Optional): {
+ * id: String (Optional, Required on create)
+ * type: String(User/Application/System) (Optional, Required on create)
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * title: String (Optional)
+ * priority: String(Low/Medium/High) (Optional)
+ * description: String (Optional)
+ * validationRequirements (Optional): [
+ * String (Optional)
+ * ]
+ * parentId: String (Optional)
+ * dependsOn (Optional): [
+ * String (Optional)
+ * ]
+ * relatedTo (Optional): [
+ * String (Optional)
+ * ]
+ * assignedTo (Optional): {
+ * id: String (Optional, Required on create)
+ * type: String(User/Application/System) (Optional, Required on create)
+ * }
+ * comments (Optional): [
+ * (Optional){
+ * timestamp: OffsetDateTime (Optional)
+ * createdBy: String (Optional, Required on create)
+ * createdByType: String(User/Application/System) (Optional, Required on create)
+ * text: String (Optional, Required on create)
+ * }
+ * ]
+ * status: String(New/OnHold/Complete/Removed/FlaggedHuman/FlaggedAi/Executing/ExecutionDone/Stale/Failed/Incomplete) (Optional)
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * executionHistory (Optional): [
+ * (Optional){
+ * createdAt: OffsetDateTime (Optional, Required on create)
+ * action: String (Optional, Required on create)
+ * createdBy: String (Optional, Required on create)
+ * createdByType: String(User/Application/System) (Optional, Required on create)
+ * summary: String (Optional)
+ * responseMessageText: String (Optional)
+ * responseMessageId: String (Optional)
+ * additionalDetails (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * ]
+ * investigationId: String (Optional)
+ * taskResult (Optional): {
+ * text: String (Optional)
+ * storageAssetIds (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * storageAssetIds (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * }
+ *
+ *
+ * @param projectName The project name.
+ * @param investigationName The investigation name.
+ * @param taskName The task name.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return task resource along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * timestamp: OffsetDateTime (Optional)
+ * createdBy: String (Optional, Required on create)
+ * createdByType: String(User/Application/System) (Optional, Required on create)
+ * text: String (Optional, Required on create)
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * title: String (Optional)
+ * priority: String(Low/Medium/High) (Optional)
+ * description: String (Optional)
+ * validationRequirements (Optional): [
+ * String (Optional)
+ * ]
+ * parentId: String (Optional)
+ * dependsOn (Optional): [
+ * String (Optional)
+ * ]
+ * relatedTo (Optional): [
+ * String (Optional)
+ * ]
+ * assignedTo (Optional): {
+ * id: String (Optional, Required on create)
+ * type: String(User/Application/System) (Optional, Required on create)
+ * }
+ * comments (Optional): [
+ * (Optional){
+ * timestamp: OffsetDateTime (Optional)
+ * createdBy: String (Optional, Required on create)
+ * createdByType: String(User/Application/System) (Optional, Required on create)
+ * text: String (Optional, Required on create)
+ * }
+ * ]
+ * status: String(New/OnHold/Complete/Removed/FlaggedHuman/FlaggedAi/Executing/ExecutionDone/Stale/Failed/Incomplete) (Optional)
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * executionHistory (Optional): [
+ * (Optional){
+ * createdAt: OffsetDateTime (Optional, Required on create)
+ * action: String (Optional, Required on create)
+ * createdBy: String (Optional, Required on create)
+ * createdByType: String(User/Application/System) (Optional, Required on create)
+ * summary: String (Optional)
+ * responseMessageText: String (Optional)
+ * responseMessageId: String (Optional)
+ * additionalDetails (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * ]
+ * investigationId: String (Optional)
+ * taskResult (Optional): {
+ * text: String (Optional)
+ * storageAssetIds (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * storageAssetIds (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * }
+ *
+ *
+ * @param projectName The project name.
+ * @param investigationName The investigation name.
+ * @param taskName The task name.
+ * @param body Comment to add.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return task resource along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * createdAt: OffsetDateTime (Optional, Required on create)
+ * action: String (Optional, Required on create)
+ * createdBy: String (Optional, Required on create)
+ * createdByType: String(User/Application/System) (Optional, Required on create)
+ * summary: String (Optional)
+ * responseMessageText: String (Optional)
+ * responseMessageId: String (Optional)
+ * additionalDetails (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * title: String (Optional)
+ * priority: String(Low/Medium/High) (Optional)
+ * description: String (Optional)
+ * validationRequirements (Optional): [
+ * String (Optional)
+ * ]
+ * parentId: String (Optional)
+ * dependsOn (Optional): [
+ * String (Optional)
+ * ]
+ * relatedTo (Optional): [
+ * String (Optional)
+ * ]
+ * assignedTo (Optional): {
+ * id: String (Optional, Required on create)
+ * type: String(User/Application/System) (Optional, Required on create)
+ * }
+ * comments (Optional): [
+ * (Optional){
+ * timestamp: OffsetDateTime (Optional)
+ * createdBy: String (Optional, Required on create)
+ * createdByType: String(User/Application/System) (Optional, Required on create)
+ * text: String (Optional, Required on create)
+ * }
+ * ]
+ * status: String(New/OnHold/Complete/Removed/FlaggedHuman/FlaggedAi/Executing/ExecutionDone/Stale/Failed/Incomplete) (Optional)
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * executionHistory (Optional): [
+ * (Optional){
+ * createdAt: OffsetDateTime (Optional, Required on create)
+ * action: String (Optional, Required on create)
+ * createdBy: String (Optional, Required on create)
+ * createdByType: String(User/Application/System) (Optional, Required on create)
+ * summary: String (Optional)
+ * responseMessageText: String (Optional)
+ * responseMessageId: String (Optional)
+ * additionalDetails (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * ]
+ * investigationId: String (Optional)
+ * taskResult (Optional): {
+ * text: String (Optional)
+ * storageAssetIds (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * storageAssetIds (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * }
+ *
+ *
+ * @param projectName The project name.
+ * @param investigationName The investigation name.
+ * @param taskName The task name.
+ * @param body Execution history entry to add.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return task resource along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * title: String (Optional)
+ * priority: String(Low/Medium/High) (Optional)
+ * description: String (Optional)
+ * validationRequirements (Optional): [
+ * String (Optional)
+ * ]
+ * parentId: String (Optional)
+ * dependsOn (Optional): [
+ * String (Optional)
+ * ]
+ * relatedTo (Optional): [
+ * String (Optional)
+ * ]
+ * assignedTo (Optional): {
+ * id: String (Optional, Required on create)
+ * type: String(User/Application/System) (Optional, Required on create)
+ * }
+ * comments (Optional): [
+ * (Optional){
+ * timestamp: OffsetDateTime (Optional)
+ * createdBy: String (Optional, Required on create)
+ * createdByType: String(User/Application/System) (Optional, Required on create)
+ * text: String (Optional, Required on create)
+ * }
+ * ]
+ * status: String(New/OnHold/Complete/Removed/FlaggedHuman/FlaggedAi/Executing/ExecutionDone/Stale/Failed/Incomplete) (Optional)
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * executionHistory (Optional): [
+ * (Optional){
+ * createdAt: OffsetDateTime (Optional, Required on create)
+ * action: String (Optional, Required on create)
+ * createdBy: String (Optional, Required on create)
+ * createdByType: String(User/Application/System) (Optional, Required on create)
+ * summary: String (Optional)
+ * responseMessageText: String (Optional)
+ * responseMessageId: String (Optional)
+ * additionalDetails (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * ]
+ * investigationId: String (Optional)
+ * taskResult (Optional): {
+ * text: String (Optional)
+ * storageAssetIds (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * storageAssetIds (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * }
+ *
+ *
+ * @param projectName The project name.
+ * @param investigationName The investigation name.
+ * @param taskName The unique identifier of the task.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a task by ID along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| filter | String | No | OData filter expression. Supported fields: investigationId, + * status, createdByType, priority, createdAt, lastModifiedAt. Example: status eq 'new' or status eq + * 'executing' |
Response Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * title: String (Optional)
+ * priority: String(Low/Medium/High) (Optional)
+ * description: String (Optional)
+ * validationRequirements (Optional): [
+ * String (Optional)
+ * ]
+ * parentId: String (Optional)
+ * dependsOn (Optional): [
+ * String (Optional)
+ * ]
+ * relatedTo (Optional): [
+ * String (Optional)
+ * ]
+ * assignedTo (Optional): {
+ * id: String (Optional, Required on create)
+ * type: String(User/Application/System) (Optional, Required on create)
+ * }
+ * comments (Optional): [
+ * (Optional){
+ * timestamp: OffsetDateTime (Optional)
+ * createdBy: String (Optional, Required on create)
+ * createdByType: String(User/Application/System) (Optional, Required on create)
+ * text: String (Optional, Required on create)
+ * }
+ * ]
+ * status: String(New/OnHold/Complete/Removed/FlaggedHuman/FlaggedAi/Executing/ExecutionDone/Stale/Failed/Incomplete) (Optional)
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * executionHistory (Optional): [
+ * (Optional){
+ * createdAt: OffsetDateTime (Optional, Required on create)
+ * action: String (Optional, Required on create)
+ * createdBy: String (Optional, Required on create)
+ * createdByType: String(User/Application/System) (Optional, Required on create)
+ * summary: String (Optional)
+ * responseMessageText: String (Optional)
+ * responseMessageId: String (Optional)
+ * additionalDetails (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * ]
+ * investigationId: String (Optional)
+ * taskResult (Optional): {
+ * text: String (Optional)
+ * storageAssetIds (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * storageAssetIds (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * }
+ *
+ *
+ * @param projectName The project name.
+ * @param investigationName The investigation name.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return paged collection of Task items as paginated response with {@link PagedIterable}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.COLLECTION)
+ public PagedIterableRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * title: String (Optional)
+ * priority: String(Low/Medium/High) (Optional)
+ * description: String (Optional)
+ * validationRequirements (Optional): [
+ * String (Optional)
+ * ]
+ * parentId: String (Optional)
+ * dependsOn (Optional): [
+ * String (Optional)
+ * ]
+ * relatedTo (Optional): [
+ * String (Optional)
+ * ]
+ * assignedTo (Optional): {
+ * id: String (Optional, Required on create)
+ * type: String(User/Application/System) (Optional, Required on create)
+ * }
+ * comments (Optional): [
+ * (Optional){
+ * timestamp: OffsetDateTime (Optional)
+ * createdBy: String (Optional, Required on create)
+ * createdByType: String(User/Application/System) (Optional, Required on create)
+ * text: String (Optional, Required on create)
+ * }
+ * ]
+ * status: String(New/OnHold/Complete/Removed/FlaggedHuman/FlaggedAi/Executing/ExecutionDone/Stale/Failed/Incomplete) (Optional)
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * executionHistory (Optional): [
+ * (Optional){
+ * createdAt: OffsetDateTime (Optional, Required on create)
+ * action: String (Optional, Required on create)
+ * createdBy: String (Optional, Required on create)
+ * createdByType: String(User/Application/System) (Optional, Required on create)
+ * summary: String (Optional)
+ * responseMessageText: String (Optional)
+ * responseMessageId: String (Optional)
+ * additionalDetails (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * ]
+ * investigationId: String (Optional)
+ * taskResult (Optional): {
+ * text: String (Optional)
+ * storageAssetIds (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * storageAssetIds (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * title: String (Optional)
+ * priority: String(Low/Medium/High) (Optional)
+ * description: String (Optional)
+ * validationRequirements (Optional): [
+ * String (Optional)
+ * ]
+ * parentId: String (Optional)
+ * dependsOn (Optional): [
+ * String (Optional)
+ * ]
+ * relatedTo (Optional): [
+ * String (Optional)
+ * ]
+ * assignedTo (Optional): {
+ * id: String (Optional, Required on create)
+ * type: String(User/Application/System) (Optional, Required on create)
+ * }
+ * comments (Optional): [
+ * (Optional){
+ * timestamp: OffsetDateTime (Optional)
+ * createdBy: String (Optional, Required on create)
+ * createdByType: String(User/Application/System) (Optional, Required on create)
+ * text: String (Optional, Required on create)
+ * }
+ * ]
+ * status: String(New/OnHold/Complete/Removed/FlaggedHuman/FlaggedAi/Executing/ExecutionDone/Stale/Failed/Incomplete) (Optional)
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * executionHistory (Optional): [
+ * (Optional){
+ * createdAt: OffsetDateTime (Optional, Required on create)
+ * action: String (Optional, Required on create)
+ * createdBy: String (Optional, Required on create)
+ * createdByType: String(User/Application/System) (Optional, Required on create)
+ * summary: String (Optional)
+ * responseMessageText: String (Optional)
+ * responseMessageId: String (Optional)
+ * additionalDetails (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * ]
+ * investigationId: String (Optional)
+ * taskResult (Optional): {
+ * text: String (Optional)
+ * storageAssetIds (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * storageAssetIds (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * }
+ *
+ *
+ * @param projectName The project name.
+ * @param investigationName The investigation name.
+ * @param body Task creation request.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return task resource along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * title: String (Optional)
+ * priority: String(Low/Medium/High) (Optional)
+ * description: String (Optional)
+ * validationRequirements (Optional): [
+ * String (Optional)
+ * ]
+ * parentId: String (Optional)
+ * dependsOn (Optional): [
+ * String (Optional)
+ * ]
+ * relatedTo (Optional): [
+ * String (Optional)
+ * ]
+ * assignedTo (Optional): {
+ * id: String (Optional, Required on create)
+ * type: String(User/Application/System) (Optional, Required on create)
+ * }
+ * comments (Optional): [
+ * (Optional){
+ * timestamp: OffsetDateTime (Optional)
+ * createdBy: String (Optional, Required on create)
+ * createdByType: String(User/Application/System) (Optional, Required on create)
+ * text: String (Optional, Required on create)
+ * }
+ * ]
+ * status: String(New/OnHold/Complete/Removed/FlaggedHuman/FlaggedAi/Executing/ExecutionDone/Stale/Failed/Incomplete) (Optional)
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * executionHistory (Optional): [
+ * (Optional){
+ * createdAt: OffsetDateTime (Optional, Required on create)
+ * action: String (Optional, Required on create)
+ * createdBy: String (Optional, Required on create)
+ * createdByType: String(User/Application/System) (Optional, Required on create)
+ * summary: String (Optional)
+ * responseMessageText: String (Optional)
+ * responseMessageId: String (Optional)
+ * additionalDetails (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * ]
+ * investigationId: String (Optional)
+ * taskResult (Optional): {
+ * text: String (Optional)
+ * storageAssetIds (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * storageAssetIds (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * title: String (Optional)
+ * priority: String(Low/Medium/High) (Optional)
+ * description: String (Optional)
+ * validationRequirements (Optional): [
+ * String (Optional)
+ * ]
+ * parentId: String (Optional)
+ * dependsOn (Optional): [
+ * String (Optional)
+ * ]
+ * relatedTo (Optional): [
+ * String (Optional)
+ * ]
+ * assignedTo (Optional): {
+ * id: String (Optional, Required on create)
+ * type: String(User/Application/System) (Optional, Required on create)
+ * }
+ * comments (Optional): [
+ * (Optional){
+ * timestamp: OffsetDateTime (Optional)
+ * createdBy: String (Optional, Required on create)
+ * createdByType: String(User/Application/System) (Optional, Required on create)
+ * text: String (Optional, Required on create)
+ * }
+ * ]
+ * status: String(New/OnHold/Complete/Removed/FlaggedHuman/FlaggedAi/Executing/ExecutionDone/Stale/Failed/Incomplete) (Optional)
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * executionHistory (Optional): [
+ * (Optional){
+ * createdAt: OffsetDateTime (Optional, Required on create)
+ * action: String (Optional, Required on create)
+ * createdBy: String (Optional, Required on create)
+ * createdByType: String(User/Application/System) (Optional, Required on create)
+ * summary: String (Optional)
+ * responseMessageText: String (Optional)
+ * responseMessageId: String (Optional)
+ * additionalDetails (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * ]
+ * investigationId: String (Optional)
+ * taskResult (Optional): {
+ * text: String (Optional)
+ * storageAssetIds (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * storageAssetIds (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * }
+ *
+ *
+ * @param projectName The project name.
+ * @param investigationName The investigation name.
+ * @param taskName The unique identifier of the task.
+ * @param resource The resource instance.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return task resource along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseHeader Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| Content-Type | String | No | The content type. Allowed values: + * "application/json". |
Request Body Schema
+ * + *
+ * {@code
+ * {
+ * assignee (Optional): {
+ * id: String (Optional, Required on create)
+ * type: String(User/Application/System) (Optional, Required on create)
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * title: String (Optional)
+ * priority: String(Low/Medium/High) (Optional)
+ * description: String (Optional)
+ * validationRequirements (Optional): [
+ * String (Optional)
+ * ]
+ * parentId: String (Optional)
+ * dependsOn (Optional): [
+ * String (Optional)
+ * ]
+ * relatedTo (Optional): [
+ * String (Optional)
+ * ]
+ * assignedTo (Optional): {
+ * id: String (Optional, Required on create)
+ * type: String(User/Application/System) (Optional, Required on create)
+ * }
+ * comments (Optional): [
+ * (Optional){
+ * timestamp: OffsetDateTime (Optional)
+ * createdBy: String (Optional, Required on create)
+ * createdByType: String(User/Application/System) (Optional, Required on create)
+ * text: String (Optional, Required on create)
+ * }
+ * ]
+ * status: String(New/OnHold/Complete/Removed/FlaggedHuman/FlaggedAi/Executing/ExecutionDone/Stale/Failed/Incomplete) (Optional)
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * executionHistory (Optional): [
+ * (Optional){
+ * createdAt: OffsetDateTime (Optional, Required on create)
+ * action: String (Optional, Required on create)
+ * createdBy: String (Optional, Required on create)
+ * createdByType: String(User/Application/System) (Optional, Required on create)
+ * summary: String (Optional)
+ * responseMessageText: String (Optional)
+ * responseMessageId: String (Optional)
+ * additionalDetails (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * ]
+ * investigationId: String (Optional)
+ * taskResult (Optional): {
+ * text: String (Optional)
+ * storageAssetIds (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * storageAssetIds (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * }
+ *
+ *
+ * @param projectName The project name.
+ * @param investigationName The investigation name.
+ * @param taskName The task name.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return task resource along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * timestamp: OffsetDateTime (Optional)
+ * createdBy: String (Optional, Required on create)
+ * createdByType: String(User/Application/System) (Optional, Required on create)
+ * text: String (Optional, Required on create)
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * title: String (Optional)
+ * priority: String(Low/Medium/High) (Optional)
+ * description: String (Optional)
+ * validationRequirements (Optional): [
+ * String (Optional)
+ * ]
+ * parentId: String (Optional)
+ * dependsOn (Optional): [
+ * String (Optional)
+ * ]
+ * relatedTo (Optional): [
+ * String (Optional)
+ * ]
+ * assignedTo (Optional): {
+ * id: String (Optional, Required on create)
+ * type: String(User/Application/System) (Optional, Required on create)
+ * }
+ * comments (Optional): [
+ * (Optional){
+ * timestamp: OffsetDateTime (Optional)
+ * createdBy: String (Optional, Required on create)
+ * createdByType: String(User/Application/System) (Optional, Required on create)
+ * text: String (Optional, Required on create)
+ * }
+ * ]
+ * status: String(New/OnHold/Complete/Removed/FlaggedHuman/FlaggedAi/Executing/ExecutionDone/Stale/Failed/Incomplete) (Optional)
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * executionHistory (Optional): [
+ * (Optional){
+ * createdAt: OffsetDateTime (Optional, Required on create)
+ * action: String (Optional, Required on create)
+ * createdBy: String (Optional, Required on create)
+ * createdByType: String(User/Application/System) (Optional, Required on create)
+ * summary: String (Optional)
+ * responseMessageText: String (Optional)
+ * responseMessageId: String (Optional)
+ * additionalDetails (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * ]
+ * investigationId: String (Optional)
+ * taskResult (Optional): {
+ * text: String (Optional)
+ * storageAssetIds (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * storageAssetIds (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * }
+ *
+ *
+ * @param projectName The project name.
+ * @param investigationName The investigation name.
+ * @param taskName The task name.
+ * @param body Comment to add.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return task resource along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * createdAt: OffsetDateTime (Optional, Required on create)
+ * action: String (Optional, Required on create)
+ * createdBy: String (Optional, Required on create)
+ * createdByType: String(User/Application/System) (Optional, Required on create)
+ * summary: String (Optional)
+ * responseMessageText: String (Optional)
+ * responseMessageId: String (Optional)
+ * additionalDetails (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * title: String (Optional)
+ * priority: String(Low/Medium/High) (Optional)
+ * description: String (Optional)
+ * validationRequirements (Optional): [
+ * String (Optional)
+ * ]
+ * parentId: String (Optional)
+ * dependsOn (Optional): [
+ * String (Optional)
+ * ]
+ * relatedTo (Optional): [
+ * String (Optional)
+ * ]
+ * assignedTo (Optional): {
+ * id: String (Optional, Required on create)
+ * type: String(User/Application/System) (Optional, Required on create)
+ * }
+ * comments (Optional): [
+ * (Optional){
+ * timestamp: OffsetDateTime (Optional)
+ * createdBy: String (Optional, Required on create)
+ * createdByType: String(User/Application/System) (Optional, Required on create)
+ * text: String (Optional, Required on create)
+ * }
+ * ]
+ * status: String(New/OnHold/Complete/Removed/FlaggedHuman/FlaggedAi/Executing/ExecutionDone/Stale/Failed/Incomplete) (Optional)
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * executionHistory (Optional): [
+ * (Optional){
+ * createdAt: OffsetDateTime (Optional, Required on create)
+ * action: String (Optional, Required on create)
+ * createdBy: String (Optional, Required on create)
+ * createdByType: String(User/Application/System) (Optional, Required on create)
+ * summary: String (Optional)
+ * responseMessageText: String (Optional)
+ * responseMessageId: String (Optional)
+ * additionalDetails (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * ]
+ * investigationId: String (Optional)
+ * taskResult (Optional): {
+ * text: String (Optional)
+ * storageAssetIds (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * storageAssetIds (Optional): [
+ * String (Optional)
+ * ]
+ * }
+ * }
+ *
+ *
+ * @param projectName The project name.
+ * @param investigationName The investigation name.
+ * @param taskName The task name.
+ * @param body Execution history entry to add.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return task resource along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| logCount | Integer | No | Number of log lines to return (0-2500). |
Response Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * status: String(NotStarted/Running/Succeeded/Failed/Canceled) (Required)
+ * error (Optional): {
+ * error (Required): (recursive schema, see error above)
+ * }
+ * result (Optional): {
+ * status: String (Optional)
+ * runtimeDetails: String (Required)
+ * createdAt: OffsetDateTime (Optional)
+ * completedAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * toolReport (Optional): {
+ * percentageComplete: int (Required)
+ * statusInformation (Optional): {
+ * }
+ * logs: String (Optional)
+ * }
+ * outputData (Required): [
+ * (Required){
+ * storageUri: String (Required)
+ * mountPath: String (Required)
+ * }
+ * ]
+ * debugInfo: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param projectName Name of the associated Project.
+ * @param operationId The unique ID of the operation.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return provides status details for long running operations along with {@link Response} on successful completion
+ * of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * toolId: String (Required)
+ * command: String (Optional)
+ * inlineFiles (Optional): [
+ * (Optional){
+ * mountPath: String (Required)
+ * encodedFile: String (Required)
+ * }
+ * ]
+ * inputData (Optional): [
+ * (Optional){
+ * storageUri: String (Required)
+ * mountPath: String (Required)
+ * mountProtocol: String(NFS/BlobfuseCaching) (Optional)
+ * }
+ * ]
+ * outputData (Optional): [
+ * (Optional){
+ * storageUri: String (Required)
+ * mountPath: String (Required)
+ * mountProtocol: String(NFS/BlobfuseCaching) (Optional)
+ * }
+ * ]
+ * nodePoolIds (Required): [
+ * String (Required)
+ * ]
+ * infraOverrides (Optional): {
+ * cpu: String (Optional)
+ * ram: String (Optional)
+ * gpu: String (Optional)
+ * replicaCount: Integer (Optional)
+ * imageUri: String (Optional)
+ * maxCpu: String (Optional)
+ * maxRam: String (Optional)
+ * maxGpu: String (Optional)
+ * }
+ * environmentVariables (Optional): [
+ * (Optional){
+ * name: String (Required)
+ * value: String (Optional)
+ * }
+ * ]
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * status: String(NotStarted/Running/Succeeded/Failed/Canceled) (Required)
+ * error (Optional): {
+ * error (Required): (recursive schema, see error above)
+ * }
+ * result (Optional): {
+ * status: String (Optional)
+ * runtimeDetails: String (Required)
+ * createdAt: OffsetDateTime (Optional)
+ * completedAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * toolReport (Optional): {
+ * percentageComplete: int (Required)
+ * statusInformation (Optional): {
+ * }
+ * logs: String (Optional)
+ * }
+ * outputData (Required): [
+ * (Required){
+ * storageUri: String (Required)
+ * mountPath: String (Required)
+ * }
+ * ]
+ * debugInfo: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param projectName Name of the associated Project.
+ * @param runRequest The runRequest parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link PollerFlux} for polling of provides status details for long running operations.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public PollerFluxResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * status: String(NotStarted/Running/Succeeded/Failed/Canceled) (Required)
+ * error (Optional): {
+ * error (Required): (recursive schema, see error above)
+ * }
+ * result (Optional): {
+ * status: String (Optional)
+ * runtimeDetails: String (Required)
+ * createdAt: OffsetDateTime (Optional)
+ * completedAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * toolReport (Optional): {
+ * percentageComplete: int (Required)
+ * statusInformation (Optional): {
+ * }
+ * logs: String (Optional)
+ * }
+ * outputData (Required): [
+ * (Required){
+ * storageUri: String (Required)
+ * mountPath: String (Required)
+ * }
+ * ]
+ * debugInfo: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param projectName Name of the associated Project.
+ * @param operationId ID of the operation to cancel.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link PollerFlux} for polling of response model for the cancel run operation status.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public PollerFluxQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| top | Integer | No | The number of result items to return. |
| skip | Integer | No | The number of result items to skip. |
| maxpagesize | Integer | No | The maximum number of result items per page. |
Response Body Schema
+ * + *
+ * {@code
+ * {
+ * value (Required): [
+ * (Required){
+ * id: String (Required)
+ * nodepoolId: String (Required)
+ * status: String(NotStarted/Running/Succeeded/Canceled/Failed) (Required)
+ * runtimeDetails: String (Required)
+ * createdAt: OffsetDateTime (Required)
+ * completedAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * }
+ * ]
+ * nextLink: String (Optional)
+ * }
+ * }
+ *
+ *
+ * @param projectName Name of the associated Project.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return paged collection of Operation items along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * supercomputers (Required): {
+ * String (Required): {
+ * activeJobs: long (Required)
+ * pendingJobs: long (Required)
+ * nodepools (Required): {
+ * String (Required): {
+ * reservedCPUs: String (Required)
+ * allocatableCPUs: String (Required)
+ * reservedMemory: String (Required)
+ * allocatableMemory: String (Required)
+ * reservedGPUs: String (Required)
+ * allocatableGPUs: String (Required)
+ * }
+ * }
+ * }
+ * }
+ * }
+ * }
+ *
+ *
+ * @param projectName Name of the associated Project.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return overview of compute usage for a project along with {@link Response} on successful completion of
+ * {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| logCount | Integer | No | Number of log lines to return (0-2500). |
Response Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * status: String(NotStarted/Running/Succeeded/Failed/Canceled) (Required)
+ * error (Optional): {
+ * error (Required): (recursive schema, see error above)
+ * }
+ * result (Optional): {
+ * status: String (Optional)
+ * runtimeDetails: String (Required)
+ * createdAt: OffsetDateTime (Optional)
+ * completedAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * toolReport (Optional): {
+ * percentageComplete: int (Required)
+ * statusInformation (Optional): {
+ * }
+ * logs: String (Optional)
+ * }
+ * outputData (Required): [
+ * (Required){
+ * storageUri: String (Required)
+ * mountPath: String (Required)
+ * }
+ * ]
+ * debugInfo: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param projectName Name of the associated Project.
+ * @param operationId The unique ID of the operation.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return provides status details for long running operations along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * toolId: String (Required)
+ * command: String (Optional)
+ * inlineFiles (Optional): [
+ * (Optional){
+ * mountPath: String (Required)
+ * encodedFile: String (Required)
+ * }
+ * ]
+ * inputData (Optional): [
+ * (Optional){
+ * storageUri: String (Required)
+ * mountPath: String (Required)
+ * mountProtocol: String(NFS/BlobfuseCaching) (Optional)
+ * }
+ * ]
+ * outputData (Optional): [
+ * (Optional){
+ * storageUri: String (Required)
+ * mountPath: String (Required)
+ * mountProtocol: String(NFS/BlobfuseCaching) (Optional)
+ * }
+ * ]
+ * nodePoolIds (Required): [
+ * String (Required)
+ * ]
+ * infraOverrides (Optional): {
+ * cpu: String (Optional)
+ * ram: String (Optional)
+ * gpu: String (Optional)
+ * replicaCount: Integer (Optional)
+ * imageUri: String (Optional)
+ * maxCpu: String (Optional)
+ * maxRam: String (Optional)
+ * maxGpu: String (Optional)
+ * }
+ * environmentVariables (Optional): [
+ * (Optional){
+ * name: String (Required)
+ * value: String (Optional)
+ * }
+ * ]
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * status: String(NotStarted/Running/Succeeded/Failed/Canceled) (Required)
+ * error (Optional): {
+ * error (Required): (recursive schema, see error above)
+ * }
+ * result (Optional): {
+ * status: String (Optional)
+ * runtimeDetails: String (Required)
+ * createdAt: OffsetDateTime (Optional)
+ * completedAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * toolReport (Optional): {
+ * percentageComplete: int (Required)
+ * statusInformation (Optional): {
+ * }
+ * logs: String (Optional)
+ * }
+ * outputData (Required): [
+ * (Required){
+ * storageUri: String (Required)
+ * mountPath: String (Required)
+ * }
+ * ]
+ * debugInfo: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param projectName Name of the associated Project.
+ * @param runRequest The runRequest parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link SyncPoller} for polling of provides status details for long running operations.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public SyncPollerResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * status: String(NotStarted/Running/Succeeded/Failed/Canceled) (Required)
+ * error (Optional): {
+ * error (Required): (recursive schema, see error above)
+ * }
+ * result (Optional): {
+ * status: String (Optional)
+ * runtimeDetails: String (Required)
+ * createdAt: OffsetDateTime (Optional)
+ * completedAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * toolReport (Optional): {
+ * percentageComplete: int (Required)
+ * statusInformation (Optional): {
+ * }
+ * logs: String (Optional)
+ * }
+ * outputData (Required): [
+ * (Required){
+ * storageUri: String (Required)
+ * mountPath: String (Required)
+ * }
+ * ]
+ * debugInfo: String (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param projectName Name of the associated Project.
+ * @param operationId ID of the operation to cancel.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link SyncPoller} for polling of response model for the cancel run operation status.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public SyncPollerQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| top | Integer | No | The number of result items to return. |
| skip | Integer | No | The number of result items to skip. |
| maxpagesize | Integer | No | The maximum number of result items per page. |
Response Body Schema
+ * + *
+ * {@code
+ * {
+ * value (Required): [
+ * (Required){
+ * id: String (Required)
+ * nodepoolId: String (Required)
+ * status: String(NotStarted/Running/Succeeded/Canceled/Failed) (Required)
+ * runtimeDetails: String (Required)
+ * createdAt: OffsetDateTime (Required)
+ * completedAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * }
+ * ]
+ * nextLink: String (Optional)
+ * }
+ * }
+ *
+ *
+ * @param projectName Name of the associated Project.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return paged collection of Operation items along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * supercomputers (Required): {
+ * String (Required): {
+ * activeJobs: long (Required)
+ * pendingJobs: long (Required)
+ * nodepools (Required): {
+ * String (Required): {
+ * reservedCPUs: String (Required)
+ * allocatableCPUs: String (Required)
+ * reservedMemory: String (Required)
+ * allocatableMemory: String (Required)
+ * reservedGPUs: String (Required)
+ * allocatableGPUs: String (Required)
+ * }
+ * }
+ * }
+ * }
+ * }
+ * }
+ *
+ *
+ * @param projectName Name of the associated Project.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return overview of compute usage for a project along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * displayName: String (Optional)
+ * investigationName: String (Optional)
+ * projectName: String (Optional)
+ * }
+ * }
+ *
+ *
+ * @param conversationName The conversation name.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a conversation along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * displayName: String (Optional)
+ * investigationName: String (Optional)
+ * projectName: String (Optional)
+ * }
+ * }
+ *
+ *
+ * @param conversationName The conversation name.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a conversation along with {@link Response}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * projectName: String (Required)
+ * investigationName: String (Optional)
+ * displayName: String (Optional)
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * displayName: String (Optional)
+ * investigationName: String (Optional)
+ * projectName: String (Optional)
+ * }
+ * }
+ *
+ *
+ * @param createRequest The createRequest parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a conversation along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * projectName: String (Required)
+ * investigationName: String (Optional)
+ * displayName: String (Optional)
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * displayName: String (Optional)
+ * investigationName: String (Optional)
+ * projectName: String (Optional)
+ * }
+ * }
+ *
+ *
+ * @param createRequest The createRequest parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a conversation along with {@link Response}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * displayName: String (Optional)
+ * investigationName: String (Optional)
+ * projectName: String (Optional)
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * displayName: String (Optional)
+ * investigationName: String (Optional)
+ * projectName: String (Optional)
+ * }
+ * }
+ *
+ *
+ * @param conversationName The conversation name.
+ * @param resource The resource instance.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a conversation along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * displayName: String (Optional)
+ * investigationName: String (Optional)
+ * projectName: String (Optional)
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * displayName: String (Optional)
+ * investigationName: String (Optional)
+ * projectName: String (Optional)
+ * }
+ * }
+ *
+ *
+ * @param conversationName The conversation name.
+ * @param resource The resource instance.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a conversation along with {@link Response}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| investigationName | String | No | The name of the associated Investigation |
| projectName | String | No | The name of the associated Project |
| createdSince | OffsetDateTime | No | The oldest creation timestamp to keep |
| top | Integer | No | The number of result items to return. |
| skip | Integer | No | The number of result items to skip. |
| maxpagesize | Integer | No | The maximum number of result items per page. |
Response Body Schema
+ * + *
+ * {@code
+ * {
+ * value (Required): [
+ * (Required){
+ * name: String (Required)
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * displayName: String (Optional)
+ * investigationName: String (Optional)
+ * projectName: String (Optional)
+ * }
+ * ]
+ * nextLink: String (Optional)
+ * }
+ * }
+ *
+ *
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return paged collection of Conversation items along with {@link Response} on successful completion of
+ * {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| investigationName | String | No | The name of the associated Investigation |
| projectName | String | No | The name of the associated Project |
| createdSince | OffsetDateTime | No | The oldest creation timestamp to keep |
| top | Integer | No | The number of result items to return. |
| skip | Integer | No | The number of result items to skip. |
| maxpagesize | Integer | No | The maximum number of result items per page. |
Response Body Schema
+ * + *
+ * {@code
+ * {
+ * value (Required): [
+ * (Required){
+ * name: String (Required)
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * displayName: String (Optional)
+ * investigationName: String (Optional)
+ * projectName: String (Optional)
+ * }
+ * ]
+ * nextLink: String (Optional)
+ * }
+ * }
+ *
+ *
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return paged collection of Conversation items along with {@link Response}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * projectName: String (Required)
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * status: String(Created/Validated/Failed) (Optional)
+ * description: String (Optional)
+ * tags (Optional): [
+ * (Optional){
+ * key: String (Optional)
+ * value: String (Optional)
+ * }
+ * ]
+ * displayName: String (Optional)
+ * }
+ * }
+ *
+ *
+ * @param projectName The project name.
+ * @param investigationName The investigation name.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a investigation list item along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * projectName: String (Required)
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * status: String(Created/Validated/Failed) (Optional)
+ * description: String (Optional)
+ * tags (Optional): [
+ * (Optional){
+ * key: String (Optional)
+ * value: String (Optional)
+ * }
+ * ]
+ * displayName: String (Optional)
+ * }
+ * }
+ *
+ *
+ * @param projectName The project name.
+ * @param investigationName The investigation name.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a investigation list item along with {@link Response}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * status: String(NotStarted/Running/Succeeded/Failed/Canceled) (Required)
+ * error (Optional): {
+ * error (Required): (recursive schema, see error above)
+ * }
+ * result (Optional): {
+ * name: String (Required)
+ * projectName: String (Required)
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * status: String(Created/Validated/Failed) (Optional)
+ * description: String (Optional)
+ * tags (Optional): [
+ * (Optional){
+ * key: String (Optional)
+ * value: String (Optional)
+ * }
+ * ]
+ * displayName: String (Optional)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param projectName The project name.
+ * @param investigationName The investigation name.
+ * @param operationId The unique ID of the operation.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the status of a long-running operation along with {@link Response} on successful completion of
+ * {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * status: String(NotStarted/Running/Succeeded/Failed/Canceled) (Required)
+ * error (Optional): {
+ * error (Required): (recursive schema, see error above)
+ * }
+ * result (Optional): {
+ * name: String (Required)
+ * projectName: String (Required)
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * status: String(Created/Validated/Failed) (Optional)
+ * description: String (Optional)
+ * tags (Optional): [
+ * (Optional){
+ * key: String (Optional)
+ * value: String (Optional)
+ * }
+ * ]
+ * displayName: String (Optional)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param projectName The project name.
+ * @param investigationName The investigation name.
+ * @param operationId The unique ID of the operation.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the status of a long-running operation along with {@link Response}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * projectName: String (Required)
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * status: String(Created/Validated/Failed) (Optional)
+ * description: String (Optional)
+ * tags (Optional): [
+ * (Optional){
+ * key: String (Optional)
+ * value: String (Optional)
+ * }
+ * ]
+ * displayName: String (Optional)
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * projectName: String (Required)
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * status: String(Created/Validated/Failed) (Optional)
+ * description: String (Optional)
+ * tags (Optional): [
+ * (Optional){
+ * key: String (Optional)
+ * value: String (Optional)
+ * }
+ * ]
+ * displayName: String (Optional)
+ * }
+ * }
+ *
+ *
+ * @param projectName The project name.
+ * @param investigationName The investigation name.
+ * @param resource The resource instance.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a investigation list item along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * projectName: String (Required)
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * status: String(Created/Validated/Failed) (Optional)
+ * description: String (Optional)
+ * tags (Optional): [
+ * (Optional){
+ * key: String (Optional)
+ * value: String (Optional)
+ * }
+ * ]
+ * displayName: String (Optional)
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * projectName: String (Required)
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * status: String(Created/Validated/Failed) (Optional)
+ * description: String (Optional)
+ * tags (Optional): [
+ * (Optional){
+ * key: String (Optional)
+ * value: String (Optional)
+ * }
+ * ]
+ * displayName: String (Optional)
+ * }
+ * }
+ *
+ *
+ * @param projectName The project name.
+ * @param investigationName The investigation name.
+ * @param resource The resource instance.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a investigation list item along with {@link Response}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * projectName: String (Required)
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * status: String(Created/Validated/Failed) (Optional)
+ * description: String (Optional)
+ * tags (Optional): [
+ * (Optional){
+ * key: String (Optional)
+ * value: String (Optional)
+ * }
+ * ]
+ * displayName: String (Optional)
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * projectName: String (Required)
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * status: String(Created/Validated/Failed) (Optional)
+ * description: String (Optional)
+ * tags (Optional): [
+ * (Optional){
+ * key: String (Optional)
+ * value: String (Optional)
+ * }
+ * ]
+ * displayName: String (Optional)
+ * }
+ * }
+ *
+ *
+ * @param projectName The project name.
+ * @param investigationName The investigation name.
+ * @param resource The resource instance.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a investigation list item along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * projectName: String (Required)
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * status: String(Created/Validated/Failed) (Optional)
+ * description: String (Optional)
+ * tags (Optional): [
+ * (Optional){
+ * key: String (Optional)
+ * value: String (Optional)
+ * }
+ * ]
+ * displayName: String (Optional)
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * projectName: String (Required)
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * status: String(Created/Validated/Failed) (Optional)
+ * description: String (Optional)
+ * tags (Optional): [
+ * (Optional){
+ * key: String (Optional)
+ * value: String (Optional)
+ * }
+ * ]
+ * displayName: String (Optional)
+ * }
+ * }
+ *
+ *
+ * @param projectName The project name.
+ * @param investigationName The investigation name.
+ * @param resource The resource instance.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a investigation list item along with {@link Response}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * status: String(NotStarted/Running/Succeeded/Failed/Canceled) (Required)
+ * error (Optional): {
+ * error (Required): (recursive schema, see error above)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param projectName The project name.
+ * @param investigationName The investigation name.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return provides status details for long running operations along with {@link Response} on successful completion
+ * of {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ private MonoResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * status: String(NotStarted/Running/Succeeded/Failed/Canceled) (Required)
+ * error (Optional): {
+ * error (Required): (recursive schema, see error above)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param projectName The project name.
+ * @param investigationName The investigation name.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return provides status details for long running operations along with {@link Response}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ private ResponseResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * status: String(NotStarted/Running/Succeeded/Failed/Canceled) (Required)
+ * error (Optional): {
+ * error (Required): (recursive schema, see error above)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param projectName The project name.
+ * @param investigationName The investigation name.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link PollerFlux} for polling of provides status details for long running operations.
+ */
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public PollerFluxResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * status: String(NotStarted/Running/Succeeded/Failed/Canceled) (Required)
+ * error (Optional): {
+ * error (Required): (recursive schema, see error above)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param projectName The project name.
+ * @param investigationName The investigation name.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link SyncPoller} for polling of provides status details for long running operations.
+ */
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public SyncPollerResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * status: String(NotStarted/Running/Succeeded/Failed/Canceled) (Required)
+ * error (Optional): {
+ * error (Required): (recursive schema, see error above)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param projectName The project name.
+ * @param investigationName The investigation name.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link PollerFlux} for polling of provides status details for long running operations.
+ */
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public PollerFluxResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * id: String (Required)
+ * status: String(NotStarted/Running/Succeeded/Failed/Canceled) (Required)
+ * error (Optional): {
+ * error (Required): (recursive schema, see error above)
+ * }
+ * }
+ * }
+ *
+ *
+ * @param projectName The project name.
+ * @param investigationName The investigation name.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link SyncPoller} for polling of provides status details for long running operations.
+ */
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public SyncPollerQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| createdSince | OffsetDateTime | No | The oldest creation timestamp to keep |
| top | Integer | No | The number of result items to return. |
| skip | Integer | No | The number of result items to skip. |
| maxpagesize | Integer | No | The maximum number of result items per page. |
Response Body Schema
+ * + *
+ * {@code
+ * {
+ * value (Required): [
+ * (Required){
+ * name: String (Required)
+ * projectName: String (Required)
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * status: String(Created/Validated/Failed) (Optional)
+ * description: String (Optional)
+ * tags (Optional): [
+ * (Optional){
+ * key: String (Optional)
+ * value: String (Optional)
+ * }
+ * ]
+ * displayName: String (Optional)
+ * }
+ * ]
+ * nextLink: String (Optional)
+ * }
+ * }
+ *
+ *
+ * @param projectName The project name.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return paged collection of Investigation items along with {@link Response} on successful completion of
+ * {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| createdSince | OffsetDateTime | No | The oldest creation timestamp to keep |
| top | Integer | No | The number of result items to return. |
| skip | Integer | No | The number of result items to skip. |
| maxpagesize | Integer | No | The maximum number of result items per page. |
Response Body Schema
+ * + *
+ * {@code
+ * {
+ * value (Required): [
+ * (Required){
+ * name: String (Required)
+ * projectName: String (Required)
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * status: String(Created/Validated/Failed) (Optional)
+ * description: String (Optional)
+ * tags (Optional): [
+ * (Optional){
+ * key: String (Optional)
+ * value: String (Optional)
+ * }
+ * ]
+ * displayName: String (Optional)
+ * }
+ * ]
+ * nextLink: String (Optional)
+ * }
+ * }
+ *
+ *
+ * @param projectName The project name.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return paged collection of Investigation items along with {@link Response}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * discoveryEngineStatus: String(Inactive/Active) (Required)
+ * systemPrompt: String (Optional)
+ * configuration (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * }
+ * }
+ *
+ *
+ * @param projectName The project name.
+ * @param investigationName The investigation name.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the discovery engine for an investigation along with {@link Response} on successful completion of
+ * {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * discoveryEngineStatus: String(Inactive/Active) (Required)
+ * systemPrompt: String (Optional)
+ * configuration (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * }
+ * }
+ *
+ *
+ * @param projectName The project name.
+ * @param investigationName The investigation name.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the discovery engine for an investigation along with {@link Response}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| top | Integer | No | The number of result items to return. |
| skip | Integer | No | The number of result items to skip. |
| maxpagesize | Integer | No | The maximum number of result items per page. |
Response Body Schema
+ * + *
+ * {@code
+ * {
+ * value (Required): [
+ * (Required){
+ * content: String (Required)
+ * type: String(Thought) (Required)
+ * createdAt: OffsetDateTime (Optional)
+ * }
+ * ]
+ * nextLink: String (Optional)
+ * }
+ * }
+ *
+ *
+ * @param projectName The project name.
+ * @param investigationName The investigation name.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return paged collection of WorkingMemoryEntry items along with {@link Response} on successful completion of
+ * {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoQuery Parameters
+ *| Name | Type | Required | Description |
|---|---|---|---|
| top | Integer | No | The number of result items to return. |
| skip | Integer | No | The number of result items to skip. |
| maxpagesize | Integer | No | The maximum number of result items per page. |
Response Body Schema
+ * + *
+ * {@code
+ * {
+ * value (Required): [
+ * (Required){
+ * content: String (Required)
+ * type: String(Thought) (Required)
+ * createdAt: OffsetDateTime (Optional)
+ * }
+ * ]
+ * nextLink: String (Optional)
+ * }
+ * }
+ *
+ *
+ * @param projectName The project name.
+ * @param investigationName The investigation name.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return paged collection of WorkingMemoryEntry items along with {@link Response}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * discoveryEngineStatus: String(Inactive/Active) (Required)
+ * systemPrompt: String (Optional)
+ * configuration (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * }
+ * }
+ *
+ *
+ * @param projectName The project name.
+ * @param investigationName The investigation name.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return discovery engine instance along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * discoveryEngineStatus: String(Inactive/Active) (Required)
+ * systemPrompt: String (Optional)
+ * configuration (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * }
+ * }
+ *
+ *
+ * @param projectName The project name.
+ * @param investigationName The investigation name.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return discovery engine instance along with {@link Response}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * discoveryEngineStatus: String(Inactive/Active) (Required)
+ * systemPrompt: String (Optional)
+ * configuration (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * }
+ * }
+ *
+ *
+ * @param projectName The project name.
+ * @param investigationName The investigation name.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return discovery engine instance along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * discoveryEngineStatus: String(Inactive/Active) (Required)
+ * systemPrompt: String (Optional)
+ * configuration (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * }
+ * }
+ *
+ *
+ * @param projectName The project name.
+ * @param investigationName The investigation name.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return discovery engine instance along with {@link Response}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * systemPrompt: String (Optional)
+ * configuration (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * discoveryEngineStatus: String(Inactive/Active) (Required)
+ * systemPrompt: String (Optional)
+ * configuration (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * }
+ * }
+ *
+ *
+ * @param projectName The project name.
+ * @param investigationName The investigation name.
+ * @param body The discovery engine update request. This will create the discovery engine if it does not already
+ * exist.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return discovery engine instance along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * systemPrompt: String (Optional)
+ * configuration (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * discoveryEngineStatus: String(Inactive/Active) (Required)
+ * systemPrompt: String (Optional)
+ * configuration (Optional): {
+ * String: BinaryData (Required)
+ * }
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * }
+ * }
+ *
+ *
+ * @param projectName The project name.
+ * @param investigationName The investigation name.
+ * @param body The discovery engine update request. This will create the discovery engine if it does not already
+ * exist.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return discovery engine instance along with {@link Response}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * id: String (Optional)
+ * bookshelfName: String (Required)
+ * storageAssetReferences (Optional): [
+ * (Optional){
+ * id: String (Optional, Required on create)
+ * userAssignedIdentity: String (Optional)
+ * }
+ * ]
+ * knowledgeBaseUrl: String (Optional)
+ * provisioningState: String(Succeeded/Failed/Canceled/Accepted/Provisioning/Updating/Deleting) (Optional)
+ * error (Optional): {
+ * error (Required): (recursive schema, see error above)
+ * }
+ * status: String(NotStarted/Running/Succeeded/Canceled/Failed) (Optional)
+ * createdByApiVersion: String (Optional)
+ * lastIndexingRun (Optional): {
+ * runId: String (Optional)
+ * status: String(NotStarted/Running/Succeeded/Canceled/Failed) (Optional)
+ * error (Optional): (recursive schema, see error above)
+ * indexingMetrics (Optional): {
+ * documentsProcessed: int (Required)
+ * documentsFailed: int (Required)
+ * documentsTotal: int (Required)
+ * indexingPercentageComplete: int (Required)
+ * enrichmentStartTimeUtc: OffsetDateTime (Optional)
+ * enrichmentEndTimeUtc: OffsetDateTime (Optional)
+ * indexingStartTimeUtc: OffsetDateTime (Optional)
+ * indexingEndTimeUtc: OffsetDateTime (Optional)
+ * }
+ * }
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * tags (Optional): [
+ * (Optional){
+ * key: String (Optional)
+ * value: String (Optional)
+ * }
+ * ]
+ * description: String (Optional, Required on create)
+ * copilotInstruction: String (Optional, Required on create)
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * id: String (Optional)
+ * bookshelfName: String (Required)
+ * storageAssetReferences (Optional): [
+ * (Optional){
+ * id: String (Optional, Required on create)
+ * userAssignedIdentity: String (Optional)
+ * }
+ * ]
+ * knowledgeBaseUrl: String (Optional)
+ * provisioningState: String(Succeeded/Failed/Canceled/Accepted/Provisioning/Updating/Deleting) (Optional)
+ * error (Optional): {
+ * error (Required): (recursive schema, see error above)
+ * }
+ * status: String(NotStarted/Running/Succeeded/Canceled/Failed) (Optional)
+ * createdByApiVersion: String (Optional)
+ * lastIndexingRun (Optional): {
+ * runId: String (Optional)
+ * status: String(NotStarted/Running/Succeeded/Canceled/Failed) (Optional)
+ * error (Optional): (recursive schema, see error above)
+ * indexingMetrics (Optional): {
+ * documentsProcessed: int (Required)
+ * documentsFailed: int (Required)
+ * documentsTotal: int (Required)
+ * indexingPercentageComplete: int (Required)
+ * enrichmentStartTimeUtc: OffsetDateTime (Optional)
+ * enrichmentEndTimeUtc: OffsetDateTime (Optional)
+ * indexingStartTimeUtc: OffsetDateTime (Optional)
+ * indexingEndTimeUtc: OffsetDateTime (Optional)
+ * }
+ * }
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * tags (Optional): [
+ * (Optional){
+ * key: String (Optional)
+ * value: String (Optional)
+ * }
+ * ]
+ * description: String (Optional, Required on create)
+ * copilotInstruction: String (Optional, Required on create)
+ * }
+ * }
+ *
+ *
+ * @param knowledgeBaseName The knowledgeBase name.
+ * @param resource The resource instance.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a knowledgeBase along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ private MonoRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * id: String (Optional)
+ * bookshelfName: String (Required)
+ * storageAssetReferences (Optional): [
+ * (Optional){
+ * id: String (Optional, Required on create)
+ * userAssignedIdentity: String (Optional)
+ * }
+ * ]
+ * knowledgeBaseUrl: String (Optional)
+ * provisioningState: String(Succeeded/Failed/Canceled/Accepted/Provisioning/Updating/Deleting) (Optional)
+ * error (Optional): {
+ * error (Required): (recursive schema, see error above)
+ * }
+ * status: String(NotStarted/Running/Succeeded/Canceled/Failed) (Optional)
+ * createdByApiVersion: String (Optional)
+ * lastIndexingRun (Optional): {
+ * runId: String (Optional)
+ * status: String(NotStarted/Running/Succeeded/Canceled/Failed) (Optional)
+ * error (Optional): (recursive schema, see error above)
+ * indexingMetrics (Optional): {
+ * documentsProcessed: int (Required)
+ * documentsFailed: int (Required)
+ * documentsTotal: int (Required)
+ * indexingPercentageComplete: int (Required)
+ * enrichmentStartTimeUtc: OffsetDateTime (Optional)
+ * enrichmentEndTimeUtc: OffsetDateTime (Optional)
+ * indexingStartTimeUtc: OffsetDateTime (Optional)
+ * indexingEndTimeUtc: OffsetDateTime (Optional)
+ * }
+ * }
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * tags (Optional): [
+ * (Optional){
+ * key: String (Optional)
+ * value: String (Optional)
+ * }
+ * ]
+ * description: String (Optional, Required on create)
+ * copilotInstruction: String (Optional, Required on create)
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * id: String (Optional)
+ * bookshelfName: String (Required)
+ * storageAssetReferences (Optional): [
+ * (Optional){
+ * id: String (Optional, Required on create)
+ * userAssignedIdentity: String (Optional)
+ * }
+ * ]
+ * knowledgeBaseUrl: String (Optional)
+ * provisioningState: String(Succeeded/Failed/Canceled/Accepted/Provisioning/Updating/Deleting) (Optional)
+ * error (Optional): {
+ * error (Required): (recursive schema, see error above)
+ * }
+ * status: String(NotStarted/Running/Succeeded/Canceled/Failed) (Optional)
+ * createdByApiVersion: String (Optional)
+ * lastIndexingRun (Optional): {
+ * runId: String (Optional)
+ * status: String(NotStarted/Running/Succeeded/Canceled/Failed) (Optional)
+ * error (Optional): (recursive schema, see error above)
+ * indexingMetrics (Optional): {
+ * documentsProcessed: int (Required)
+ * documentsFailed: int (Required)
+ * documentsTotal: int (Required)
+ * indexingPercentageComplete: int (Required)
+ * enrichmentStartTimeUtc: OffsetDateTime (Optional)
+ * enrichmentEndTimeUtc: OffsetDateTime (Optional)
+ * indexingStartTimeUtc: OffsetDateTime (Optional)
+ * indexingEndTimeUtc: OffsetDateTime (Optional)
+ * }
+ * }
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * tags (Optional): [
+ * (Optional){
+ * key: String (Optional)
+ * value: String (Optional)
+ * }
+ * ]
+ * description: String (Optional, Required on create)
+ * copilotInstruction: String (Optional, Required on create)
+ * }
+ * }
+ *
+ *
+ * @param knowledgeBaseName The knowledgeBase name.
+ * @param resource The resource instance.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a knowledgeBase along with {@link Response}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ private ResponseRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * id: String (Optional)
+ * bookshelfName: String (Required)
+ * storageAssetReferences (Optional): [
+ * (Optional){
+ * id: String (Optional, Required on create)
+ * userAssignedIdentity: String (Optional)
+ * }
+ * ]
+ * knowledgeBaseUrl: String (Optional)
+ * provisioningState: String(Succeeded/Failed/Canceled/Accepted/Provisioning/Updating/Deleting) (Optional)
+ * error (Optional): {
+ * error (Required): (recursive schema, see error above)
+ * }
+ * status: String(NotStarted/Running/Succeeded/Canceled/Failed) (Optional)
+ * createdByApiVersion: String (Optional)
+ * lastIndexingRun (Optional): {
+ * runId: String (Optional)
+ * status: String(NotStarted/Running/Succeeded/Canceled/Failed) (Optional)
+ * error (Optional): (recursive schema, see error above)
+ * indexingMetrics (Optional): {
+ * documentsProcessed: int (Required)
+ * documentsFailed: int (Required)
+ * documentsTotal: int (Required)
+ * indexingPercentageComplete: int (Required)
+ * enrichmentStartTimeUtc: OffsetDateTime (Optional)
+ * enrichmentEndTimeUtc: OffsetDateTime (Optional)
+ * indexingStartTimeUtc: OffsetDateTime (Optional)
+ * indexingEndTimeUtc: OffsetDateTime (Optional)
+ * }
+ * }
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * tags (Optional): [
+ * (Optional){
+ * key: String (Optional)
+ * value: String (Optional)
+ * }
+ * ]
+ * description: String (Optional, Required on create)
+ * copilotInstruction: String (Optional, Required on create)
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * id: String (Optional)
+ * bookshelfName: String (Required)
+ * storageAssetReferences (Optional): [
+ * (Optional){
+ * id: String (Optional, Required on create)
+ * userAssignedIdentity: String (Optional)
+ * }
+ * ]
+ * knowledgeBaseUrl: String (Optional)
+ * provisioningState: String(Succeeded/Failed/Canceled/Accepted/Provisioning/Updating/Deleting) (Optional)
+ * error (Optional): {
+ * error (Required): (recursive schema, see error above)
+ * }
+ * status: String(NotStarted/Running/Succeeded/Canceled/Failed) (Optional)
+ * createdByApiVersion: String (Optional)
+ * lastIndexingRun (Optional): {
+ * runId: String (Optional)
+ * status: String(NotStarted/Running/Succeeded/Canceled/Failed) (Optional)
+ * error (Optional): (recursive schema, see error above)
+ * indexingMetrics (Optional): {
+ * documentsProcessed: int (Required)
+ * documentsFailed: int (Required)
+ * documentsTotal: int (Required)
+ * indexingPercentageComplete: int (Required)
+ * enrichmentStartTimeUtc: OffsetDateTime (Optional)
+ * enrichmentEndTimeUtc: OffsetDateTime (Optional)
+ * indexingStartTimeUtc: OffsetDateTime (Optional)
+ * indexingEndTimeUtc: OffsetDateTime (Optional)
+ * }
+ * }
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * tags (Optional): [
+ * (Optional){
+ * key: String (Optional)
+ * value: String (Optional)
+ * }
+ * ]
+ * description: String (Optional, Required on create)
+ * copilotInstruction: String (Optional, Required on create)
+ * }
+ * }
+ *
+ *
+ * @param knowledgeBaseName The knowledgeBase name.
+ * @param resource The resource instance.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link PollerFlux} for polling of a knowledgeBase.
+ */
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public PollerFluxRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * id: String (Optional)
+ * bookshelfName: String (Required)
+ * storageAssetReferences (Optional): [
+ * (Optional){
+ * id: String (Optional, Required on create)
+ * userAssignedIdentity: String (Optional)
+ * }
+ * ]
+ * knowledgeBaseUrl: String (Optional)
+ * provisioningState: String(Succeeded/Failed/Canceled/Accepted/Provisioning/Updating/Deleting) (Optional)
+ * error (Optional): {
+ * error (Required): (recursive schema, see error above)
+ * }
+ * status: String(NotStarted/Running/Succeeded/Canceled/Failed) (Optional)
+ * createdByApiVersion: String (Optional)
+ * lastIndexingRun (Optional): {
+ * runId: String (Optional)
+ * status: String(NotStarted/Running/Succeeded/Canceled/Failed) (Optional)
+ * error (Optional): (recursive schema, see error above)
+ * indexingMetrics (Optional): {
+ * documentsProcessed: int (Required)
+ * documentsFailed: int (Required)
+ * documentsTotal: int (Required)
+ * indexingPercentageComplete: int (Required)
+ * enrichmentStartTimeUtc: OffsetDateTime (Optional)
+ * enrichmentEndTimeUtc: OffsetDateTime (Optional)
+ * indexingStartTimeUtc: OffsetDateTime (Optional)
+ * indexingEndTimeUtc: OffsetDateTime (Optional)
+ * }
+ * }
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * tags (Optional): [
+ * (Optional){
+ * key: String (Optional)
+ * value: String (Optional)
+ * }
+ * ]
+ * description: String (Optional, Required on create)
+ * copilotInstruction: String (Optional, Required on create)
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * id: String (Optional)
+ * bookshelfName: String (Required)
+ * storageAssetReferences (Optional): [
+ * (Optional){
+ * id: String (Optional, Required on create)
+ * userAssignedIdentity: String (Optional)
+ * }
+ * ]
+ * knowledgeBaseUrl: String (Optional)
+ * provisioningState: String(Succeeded/Failed/Canceled/Accepted/Provisioning/Updating/Deleting) (Optional)
+ * error (Optional): {
+ * error (Required): (recursive schema, see error above)
+ * }
+ * status: String(NotStarted/Running/Succeeded/Canceled/Failed) (Optional)
+ * createdByApiVersion: String (Optional)
+ * lastIndexingRun (Optional): {
+ * runId: String (Optional)
+ * status: String(NotStarted/Running/Succeeded/Canceled/Failed) (Optional)
+ * error (Optional): (recursive schema, see error above)
+ * indexingMetrics (Optional): {
+ * documentsProcessed: int (Required)
+ * documentsFailed: int (Required)
+ * documentsTotal: int (Required)
+ * indexingPercentageComplete: int (Required)
+ * enrichmentStartTimeUtc: OffsetDateTime (Optional)
+ * enrichmentEndTimeUtc: OffsetDateTime (Optional)
+ * indexingStartTimeUtc: OffsetDateTime (Optional)
+ * indexingEndTimeUtc: OffsetDateTime (Optional)
+ * }
+ * }
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * tags (Optional): [
+ * (Optional){
+ * key: String (Optional)
+ * value: String (Optional)
+ * }
+ * ]
+ * description: String (Optional, Required on create)
+ * copilotInstruction: String (Optional, Required on create)
+ * }
+ * }
+ *
+ *
+ * @param knowledgeBaseName The knowledgeBase name.
+ * @param resource The resource instance.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link SyncPoller} for polling of a knowledgeBase.
+ */
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public SyncPollerRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * id: String (Optional)
+ * bookshelfName: String (Required)
+ * storageAssetReferences (Optional): [
+ * (Optional){
+ * id: String (Optional, Required on create)
+ * userAssignedIdentity: String (Optional)
+ * }
+ * ]
+ * knowledgeBaseUrl: String (Optional)
+ * provisioningState: String(Succeeded/Failed/Canceled/Accepted/Provisioning/Updating/Deleting) (Optional)
+ * error (Optional): {
+ * error (Required): (recursive schema, see error above)
+ * }
+ * status: String(NotStarted/Running/Succeeded/Canceled/Failed) (Optional)
+ * createdByApiVersion: String (Optional)
+ * lastIndexingRun (Optional): {
+ * runId: String (Optional)
+ * status: String(NotStarted/Running/Succeeded/Canceled/Failed) (Optional)
+ * error (Optional): (recursive schema, see error above)
+ * indexingMetrics (Optional): {
+ * documentsProcessed: int (Required)
+ * documentsFailed: int (Required)
+ * documentsTotal: int (Required)
+ * indexingPercentageComplete: int (Required)
+ * enrichmentStartTimeUtc: OffsetDateTime (Optional)
+ * enrichmentEndTimeUtc: OffsetDateTime (Optional)
+ * indexingStartTimeUtc: OffsetDateTime (Optional)
+ * indexingEndTimeUtc: OffsetDateTime (Optional)
+ * }
+ * }
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * tags (Optional): [
+ * (Optional){
+ * key: String (Optional)
+ * value: String (Optional)
+ * }
+ * ]
+ * description: String (Optional, Required on create)
+ * copilotInstruction: String (Optional, Required on create)
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * id: String (Optional)
+ * bookshelfName: String (Required)
+ * storageAssetReferences (Optional): [
+ * (Optional){
+ * id: String (Optional, Required on create)
+ * userAssignedIdentity: String (Optional)
+ * }
+ * ]
+ * knowledgeBaseUrl: String (Optional)
+ * provisioningState: String(Succeeded/Failed/Canceled/Accepted/Provisioning/Updating/Deleting) (Optional)
+ * error (Optional): {
+ * error (Required): (recursive schema, see error above)
+ * }
+ * status: String(NotStarted/Running/Succeeded/Canceled/Failed) (Optional)
+ * createdByApiVersion: String (Optional)
+ * lastIndexingRun (Optional): {
+ * runId: String (Optional)
+ * status: String(NotStarted/Running/Succeeded/Canceled/Failed) (Optional)
+ * error (Optional): (recursive schema, see error above)
+ * indexingMetrics (Optional): {
+ * documentsProcessed: int (Required)
+ * documentsFailed: int (Required)
+ * documentsTotal: int (Required)
+ * indexingPercentageComplete: int (Required)
+ * enrichmentStartTimeUtc: OffsetDateTime (Optional)
+ * enrichmentEndTimeUtc: OffsetDateTime (Optional)
+ * indexingStartTimeUtc: OffsetDateTime (Optional)
+ * indexingEndTimeUtc: OffsetDateTime (Optional)
+ * }
+ * }
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * tags (Optional): [
+ * (Optional){
+ * key: String (Optional)
+ * value: String (Optional)
+ * }
+ * ]
+ * description: String (Optional, Required on create)
+ * copilotInstruction: String (Optional, Required on create)
+ * }
+ * }
+ *
+ *
+ * @param knowledgeBaseName The knowledgeBase name.
+ * @param resource The resource instance.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link PollerFlux} for polling of a knowledgeBase.
+ */
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public PollerFluxRequest Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * id: String (Optional)
+ * bookshelfName: String (Required)
+ * storageAssetReferences (Optional): [
+ * (Optional){
+ * id: String (Optional, Required on create)
+ * userAssignedIdentity: String (Optional)
+ * }
+ * ]
+ * knowledgeBaseUrl: String (Optional)
+ * provisioningState: String(Succeeded/Failed/Canceled/Accepted/Provisioning/Updating/Deleting) (Optional)
+ * error (Optional): {
+ * error (Required): (recursive schema, see error above)
+ * }
+ * status: String(NotStarted/Running/Succeeded/Canceled/Failed) (Optional)
+ * createdByApiVersion: String (Optional)
+ * lastIndexingRun (Optional): {
+ * runId: String (Optional)
+ * status: String(NotStarted/Running/Succeeded/Canceled/Failed) (Optional)
+ * error (Optional): (recursive schema, see error above)
+ * indexingMetrics (Optional): {
+ * documentsProcessed: int (Required)
+ * documentsFailed: int (Required)
+ * documentsTotal: int (Required)
+ * indexingPercentageComplete: int (Required)
+ * enrichmentStartTimeUtc: OffsetDateTime (Optional)
+ * enrichmentEndTimeUtc: OffsetDateTime (Optional)
+ * indexingStartTimeUtc: OffsetDateTime (Optional)
+ * indexingEndTimeUtc: OffsetDateTime (Optional)
+ * }
+ * }
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * tags (Optional): [
+ * (Optional){
+ * key: String (Optional)
+ * value: String (Optional)
+ * }
+ * ]
+ * description: String (Optional, Required on create)
+ * copilotInstruction: String (Optional, Required on create)
+ * }
+ * }
+ *
+ *
+ * Response Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * id: String (Optional)
+ * bookshelfName: String (Required)
+ * storageAssetReferences (Optional): [
+ * (Optional){
+ * id: String (Optional, Required on create)
+ * userAssignedIdentity: String (Optional)
+ * }
+ * ]
+ * knowledgeBaseUrl: String (Optional)
+ * provisioningState: String(Succeeded/Failed/Canceled/Accepted/Provisioning/Updating/Deleting) (Optional)
+ * error (Optional): {
+ * error (Required): (recursive schema, see error above)
+ * }
+ * status: String(NotStarted/Running/Succeeded/Canceled/Failed) (Optional)
+ * createdByApiVersion: String (Optional)
+ * lastIndexingRun (Optional): {
+ * runId: String (Optional)
+ * status: String(NotStarted/Running/Succeeded/Canceled/Failed) (Optional)
+ * error (Optional): (recursive schema, see error above)
+ * indexingMetrics (Optional): {
+ * documentsProcessed: int (Required)
+ * documentsFailed: int (Required)
+ * documentsTotal: int (Required)
+ * indexingPercentageComplete: int (Required)
+ * enrichmentStartTimeUtc: OffsetDateTime (Optional)
+ * enrichmentEndTimeUtc: OffsetDateTime (Optional)
+ * indexingStartTimeUtc: OffsetDateTime (Optional)
+ * indexingEndTimeUtc: OffsetDateTime (Optional)
+ * }
+ * }
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * tags (Optional): [
+ * (Optional){
+ * key: String (Optional)
+ * value: String (Optional)
+ * }
+ * ]
+ * description: String (Optional, Required on create)
+ * copilotInstruction: String (Optional, Required on create)
+ * }
+ * }
+ *
+ *
+ * @param knowledgeBaseName The knowledgeBase name.
+ * @param resource The resource instance.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link SyncPoller} for polling of a knowledgeBase.
+ */
+ @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
+ public SyncPollerResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * id: String (Optional)
+ * bookshelfName: String (Required)
+ * storageAssetReferences (Optional): [
+ * (Optional){
+ * id: String (Optional, Required on create)
+ * userAssignedIdentity: String (Optional)
+ * }
+ * ]
+ * knowledgeBaseUrl: String (Optional)
+ * provisioningState: String(Succeeded/Failed/Canceled/Accepted/Provisioning/Updating/Deleting) (Optional)
+ * error (Optional): {
+ * error (Required): (recursive schema, see error above)
+ * }
+ * status: String(NotStarted/Running/Succeeded/Canceled/Failed) (Optional)
+ * createdByApiVersion: String (Optional)
+ * lastIndexingRun (Optional): {
+ * runId: String (Optional)
+ * status: String(NotStarted/Running/Succeeded/Canceled/Failed) (Optional)
+ * error (Optional): (recursive schema, see error above)
+ * indexingMetrics (Optional): {
+ * documentsProcessed: int (Required)
+ * documentsFailed: int (Required)
+ * documentsTotal: int (Required)
+ * indexingPercentageComplete: int (Required)
+ * enrichmentStartTimeUtc: OffsetDateTime (Optional)
+ * enrichmentEndTimeUtc: OffsetDateTime (Optional)
+ * indexingStartTimeUtc: OffsetDateTime (Optional)
+ * indexingEndTimeUtc: OffsetDateTime (Optional)
+ * }
+ * }
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * tags (Optional): [
+ * (Optional){
+ * key: String (Optional)
+ * value: String (Optional)
+ * }
+ * ]
+ * description: String (Optional, Required on create)
+ * copilotInstruction: String (Optional, Required on create)
+ * }
+ * }
+ *
+ *
+ * @param knowledgeBaseName The knowledgeBase name.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a knowledgeBase along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * id: String (Optional)
+ * bookshelfName: String (Required)
+ * storageAssetReferences (Optional): [
+ * (Optional){
+ * id: String (Optional, Required on create)
+ * userAssignedIdentity: String (Optional)
+ * }
+ * ]
+ * knowledgeBaseUrl: String (Optional)
+ * provisioningState: String(Succeeded/Failed/Canceled/Accepted/Provisioning/Updating/Deleting) (Optional)
+ * error (Optional): {
+ * error (Required): (recursive schema, see error above)
+ * }
+ * status: String(NotStarted/Running/Succeeded/Canceled/Failed) (Optional)
+ * createdByApiVersion: String (Optional)
+ * lastIndexingRun (Optional): {
+ * runId: String (Optional)
+ * status: String(NotStarted/Running/Succeeded/Canceled/Failed) (Optional)
+ * error (Optional): (recursive schema, see error above)
+ * indexingMetrics (Optional): {
+ * documentsProcessed: int (Required)
+ * documentsFailed: int (Required)
+ * documentsTotal: int (Required)
+ * indexingPercentageComplete: int (Required)
+ * enrichmentStartTimeUtc: OffsetDateTime (Optional)
+ * enrichmentEndTimeUtc: OffsetDateTime (Optional)
+ * indexingStartTimeUtc: OffsetDateTime (Optional)
+ * indexingEndTimeUtc: OffsetDateTime (Optional)
+ * }
+ * }
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * tags (Optional): [
+ * (Optional){
+ * key: String (Optional)
+ * value: String (Optional)
+ * }
+ * ]
+ * description: String (Optional, Required on create)
+ * copilotInstruction: String (Optional, Required on create)
+ * }
+ * }
+ *
+ *
+ * @param knowledgeBaseName The knowledgeBase name.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return a knowledgeBase along with {@link Response}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * id: String (Optional)
+ * bookshelfName: String (Required)
+ * storageAssetReferences (Optional): [
+ * (Optional){
+ * id: String (Optional, Required on create)
+ * userAssignedIdentity: String (Optional)
+ * }
+ * ]
+ * knowledgeBaseUrl: String (Optional)
+ * provisioningState: String(Succeeded/Failed/Canceled/Accepted/Provisioning/Updating/Deleting) (Optional)
+ * error (Optional): {
+ * error (Required): (recursive schema, see error above)
+ * }
+ * status: String(NotStarted/Running/Succeeded/Canceled/Failed) (Optional)
+ * createdByApiVersion: String (Optional)
+ * lastIndexingRun (Optional): {
+ * runId: String (Optional)
+ * status: String(NotStarted/Running/Succeeded/Canceled/Failed) (Optional)
+ * error (Optional): (recursive schema, see error above)
+ * indexingMetrics (Optional): {
+ * documentsProcessed: int (Required)
+ * documentsFailed: int (Required)
+ * documentsTotal: int (Required)
+ * indexingPercentageComplete: int (Required)
+ * enrichmentStartTimeUtc: OffsetDateTime (Optional)
+ * enrichmentEndTimeUtc: OffsetDateTime (Optional)
+ * indexingStartTimeUtc: OffsetDateTime (Optional)
+ * indexingEndTimeUtc: OffsetDateTime (Optional)
+ * }
+ * }
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * tags (Optional): [
+ * (Optional){
+ * key: String (Optional)
+ * value: String (Optional)
+ * }
+ * ]
+ * description: String (Optional, Required on create)
+ * copilotInstruction: String (Optional, Required on create)
+ * }
+ * }
+ *
+ *
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return paged collection of KnowledgeBase items along with {@link PagedResponse} on successful completion of
+ * {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ private MonoResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * id: String (Optional)
+ * bookshelfName: String (Required)
+ * storageAssetReferences (Optional): [
+ * (Optional){
+ * id: String (Optional, Required on create)
+ * userAssignedIdentity: String (Optional)
+ * }
+ * ]
+ * knowledgeBaseUrl: String (Optional)
+ * provisioningState: String(Succeeded/Failed/Canceled/Accepted/Provisioning/Updating/Deleting) (Optional)
+ * error (Optional): {
+ * error (Required): (recursive schema, see error above)
+ * }
+ * status: String(NotStarted/Running/Succeeded/Canceled/Failed) (Optional)
+ * createdByApiVersion: String (Optional)
+ * lastIndexingRun (Optional): {
+ * runId: String (Optional)
+ * status: String(NotStarted/Running/Succeeded/Canceled/Failed) (Optional)
+ * error (Optional): (recursive schema, see error above)
+ * indexingMetrics (Optional): {
+ * documentsProcessed: int (Required)
+ * documentsFailed: int (Required)
+ * documentsTotal: int (Required)
+ * indexingPercentageComplete: int (Required)
+ * enrichmentStartTimeUtc: OffsetDateTime (Optional)
+ * enrichmentEndTimeUtc: OffsetDateTime (Optional)
+ * indexingStartTimeUtc: OffsetDateTime (Optional)
+ * indexingEndTimeUtc: OffsetDateTime (Optional)
+ * }
+ * }
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * tags (Optional): [
+ * (Optional){
+ * key: String (Optional)
+ * value: String (Optional)
+ * }
+ * ]
+ * description: String (Optional, Required on create)
+ * copilotInstruction: String (Optional, Required on create)
+ * }
+ * }
+ *
+ *
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return paged collection of KnowledgeBase items as paginated response with {@link PagedFlux}.
+ */
+ @ServiceMethod(returns = ReturnType.COLLECTION)
+ public PagedFluxResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * id: String (Optional)
+ * bookshelfName: String (Required)
+ * storageAssetReferences (Optional): [
+ * (Optional){
+ * id: String (Optional, Required on create)
+ * userAssignedIdentity: String (Optional)
+ * }
+ * ]
+ * knowledgeBaseUrl: String (Optional)
+ * provisioningState: String(Succeeded/Failed/Canceled/Accepted/Provisioning/Updating/Deleting) (Optional)
+ * error (Optional): {
+ * error (Required): (recursive schema, see error above)
+ * }
+ * status: String(NotStarted/Running/Succeeded/Canceled/Failed) (Optional)
+ * createdByApiVersion: String (Optional)
+ * lastIndexingRun (Optional): {
+ * runId: String (Optional)
+ * status: String(NotStarted/Running/Succeeded/Canceled/Failed) (Optional)
+ * error (Optional): (recursive schema, see error above)
+ * indexingMetrics (Optional): {
+ * documentsProcessed: int (Required)
+ * documentsFailed: int (Required)
+ * documentsTotal: int (Required)
+ * indexingPercentageComplete: int (Required)
+ * enrichmentStartTimeUtc: OffsetDateTime (Optional)
+ * enrichmentEndTimeUtc: OffsetDateTime (Optional)
+ * indexingStartTimeUtc: OffsetDateTime (Optional)
+ * indexingEndTimeUtc: OffsetDateTime (Optional)
+ * }
+ * }
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * tags (Optional): [
+ * (Optional){
+ * key: String (Optional)
+ * value: String (Optional)
+ * }
+ * ]
+ * description: String (Optional, Required on create)
+ * copilotInstruction: String (Optional, Required on create)
+ * }
+ * }
+ *
+ *
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return paged collection of KnowledgeBase items along with {@link PagedResponse}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ private PagedResponseResponse Body Schema
+ * + *
+ * {@code
+ * {
+ * name: String (Required)
+ * id: String (Optional)
+ * bookshelfName: String (Required)
+ * storageAssetReferences (Optional): [
+ * (Optional){
+ * id: String (Optional, Required on create)
+ * userAssignedIdentity: String (Optional)
+ * }
+ * ]
+ * knowledgeBaseUrl: String (Optional)
+ * provisioningState: String(Succeeded/Failed/Canceled/Accepted/Provisioning/Updating/Deleting) (Optional)
+ * error (Optional): {
+ * error (Required): (recursive schema, see error above)
+ * }
+ * status: String(NotStarted/Running/Succeeded/Canceled/Failed) (Optional)
+ * createdByApiVersion: String (Optional)
+ * lastIndexingRun (Optional): {
+ * runId: String (Optional)
+ * status: String(NotStarted/Running/Succeeded/Canceled/Failed) (Optional)
+ * error (Optional): (recursive schema, see error above)
+ * indexingMetrics (Optional): {
+ * documentsProcessed: int (Required)
+ * documentsFailed: int (Required)
+ * documentsTotal: int (Required)
+ * indexingPercentageComplete: int (Required)
+ * enrichmentStartTimeUtc: OffsetDateTime (Optional)
+ * enrichmentEndTimeUtc: OffsetDateTime (Optional)
+ * indexingStartTimeUtc: OffsetDateTime (Optional)
+ * indexingEndTimeUtc: OffsetDateTime (Optional)
+ * }
+ * }
+ * createdAt: OffsetDateTime (Optional)
+ * createdBy: String (Optional)
+ * createdByType: String(User/Application/System) (Optional)
+ * lastModifiedAt: OffsetDateTime (Optional)
+ * lastModifiedBy: String (Optional)
+ * lastModifiedByType: String(User/Application/System) (Optional)
+ * tags (Optional): [
+ * (Optional){
+ * key: String (Optional)
+ * value: String (Optional)
+ * }
+ * ]
+ * description: String (Optional, Required on create)
+ * copilotInstruction: String (Optional, Required on create)
+ * }
+ * }
+ *
+ *
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return paged collection of KnowledgeBase items as paginated response with {@link PagedIterable}.
+ */
+ @ServiceMethod(returns = ReturnType.COLLECTION)
+ public PagedIterable