Class ManagementClient
Service client instance for Management.
Implements
Inherited Members
Namespace: Oci.OdaService
Assembly: OCI.DotNetSDK.Oda.dll
Syntax
public class ManagementClient : RegionalClientBase, IDisposable
Constructors
ManagementClient(IBasicAuthenticationDetailsProvider, ClientConfiguration, string)
Creates a new service instance using the given authentication provider and/or client configuration and/or endpoint. A client configuration can also be provided optionally to adjust REST client behaviors.
Declaration
public ManagementClient(IBasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration clientConfiguration = null, string endpoint = null)
Parameters
Type | Name | Description |
---|---|---|
IBasicAuthenticationDetailsProvider | authenticationDetailsProvider | The authentication details provider. Required. |
ClientConfiguration | clientConfiguration | The client configuration that contains settings to adjust REST client behaviors. Optional. |
string | endpoint | The endpoint of the service. If not provided and the client is a regional client, the endpoint will be constructed based on region information. Optional. |
Properties
Paginators
Declaration
public ManagementPaginators Paginators { get; }
Property Value
Type | Description |
---|---|
ManagementPaginators |
Waiters
Declaration
public ManagementWaiters Waiters { get; }
Property Value
Type | Description |
---|---|
ManagementWaiters |
Methods
BulkCreateSkillEntities(BulkCreateSkillEntitiesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Bulk create composite and value list entities into a skill.
Declaration
public Task<BulkCreateSkillEntitiesResponse> BulkCreateSkillEntities(BulkCreateSkillEntitiesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
BulkCreateSkillEntitiesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<BulkCreateSkillEntitiesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use BulkCreateSkillEntities API.
CascadingDeleteSkillCustomEntities(CascadingDeleteSkillCustomEntitiesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Cascading delete of the custom entities in a skill.
Declaration
public Task<CascadingDeleteSkillCustomEntitiesResponse> CascadingDeleteSkillCustomEntities(CascadingDeleteSkillCustomEntitiesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CascadingDeleteSkillCustomEntitiesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CascadingDeleteSkillCustomEntitiesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CascadingDeleteSkillCustomEntities API.
ChangeOdaPrivateEndpointCompartment(ChangeOdaPrivateEndpointCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Starts an asynchronous job to move the specified ODA Private Endpoint into a different compartment.
<br/>
To monitor the status of the job, take the opc-work-request-id
response header
value and use it to call GET /workRequests/{workRequestID}
.
When provided, If-Match is checked against ETag values of the resource.
Declaration
public Task<ChangeOdaPrivateEndpointCompartmentResponse> ChangeOdaPrivateEndpointCompartment(ChangeOdaPrivateEndpointCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeOdaPrivateEndpointCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ChangeOdaPrivateEndpointCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeOdaPrivateEndpointCompartment API.
ConfigureDigitalAssistantParameters(ConfigureDigitalAssistantParametersRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
This will store the provided parameters in the Digital Assistant instance and update any Digital Assistants with matching parameters.
Declaration
public Task<ConfigureDigitalAssistantParametersResponse> ConfigureDigitalAssistantParameters(ConfigureDigitalAssistantParametersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ConfigureDigitalAssistantParametersRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ConfigureDigitalAssistantParametersResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ConfigureDigitalAssistantParameters API.
CreateAuthenticationProvider(CreateAuthenticationProviderRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new Authentication Provider
Declaration
public Task<CreateAuthenticationProviderResponse> CreateAuthenticationProvider(CreateAuthenticationProviderRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateAuthenticationProviderRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateAuthenticationProviderResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateAuthenticationProvider API.
CreateChannel(CreateChannelRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new Channel.
Declaration
public Task<CreateChannelResponse> CreateChannel(CreateChannelRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateChannelRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateChannelResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateChannel API.
CreateDigitalAssistant(CreateDigitalAssistantRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new Digital Assistant.
Declaration
public Task<CreateDigitalAssistantResponse> CreateDigitalAssistant(CreateDigitalAssistantRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateDigitalAssistantRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateDigitalAssistantResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateDigitalAssistant API.
CreateOdaPrivateEndpoint(CreateOdaPrivateEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Starts an asynchronous job to create an ODA Private Endpoint.
<br/>
To monitor the status of the job, take the opc-work-request-id
response
header value and use it to call GET /workRequests/{workRequestID}
.
Declaration
public Task<CreateOdaPrivateEndpointResponse> CreateOdaPrivateEndpoint(CreateOdaPrivateEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateOdaPrivateEndpointRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateOdaPrivateEndpointResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateOdaPrivateEndpoint API.
CreateOdaPrivateEndpointAttachment(CreateOdaPrivateEndpointAttachmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Starts an asynchronous job to create an ODA Private Endpoint Attachment.
<br/>
To monitor the status of the job, take the opc-work-request-id
response
header value and use it to call GET /workRequests/{workRequestID}
.
Declaration
public Task<CreateOdaPrivateEndpointAttachmentResponse> CreateOdaPrivateEndpointAttachment(CreateOdaPrivateEndpointAttachmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateOdaPrivateEndpointAttachmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateOdaPrivateEndpointAttachmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateOdaPrivateEndpointAttachment API.
CreateOdaPrivateEndpointScanProxy(CreateOdaPrivateEndpointScanProxyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Starts an asynchronous job to create an ODA Private Endpoint Scan Proxy.
<br/>
To monitor the status of the job, take the opc-work-request-id
response
header value and use it to call GET /workRequests/{workRequestID}
.
Declaration
public Task<CreateOdaPrivateEndpointScanProxyResponse> CreateOdaPrivateEndpointScanProxy(CreateOdaPrivateEndpointScanProxyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateOdaPrivateEndpointScanProxyRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateOdaPrivateEndpointScanProxyResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateOdaPrivateEndpointScanProxy API.
CreateSkill(CreateSkillRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new Skill from scratch.
Declaration
public Task<CreateSkillResponse> CreateSkill(CreateSkillRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateSkillRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateSkillResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateSkill API.
CreateSkillParameter(CreateSkillParameterRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new Skill Parameter.
Declaration
public Task<CreateSkillParameterResponse> CreateSkillParameter(CreateSkillParameterRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateSkillParameterRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateSkillParameterResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateSkillParameter API.
CreateTranslator(CreateTranslatorRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new Translator
Declaration
public Task<CreateTranslatorResponse> CreateTranslator(CreateTranslatorRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateTranslatorRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateTranslatorResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateTranslator API.
DeleteAuthenticationProvider(DeleteAuthenticationProviderRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Delete the specified Authentication Provider.
Declaration
public Task<DeleteAuthenticationProviderResponse> DeleteAuthenticationProvider(DeleteAuthenticationProviderRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteAuthenticationProviderRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteAuthenticationProviderResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteAuthenticationProvider API.
DeleteChannel(DeleteChannelRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Delete the specified Channel.
Declaration
public Task<DeleteChannelResponse> DeleteChannel(DeleteChannelRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteChannelRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteChannelResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteChannel API.
DeleteDigitalAssistant(DeleteDigitalAssistantRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Delete the specified Digital Assistant.
Declaration
public Task<DeleteDigitalAssistantResponse> DeleteDigitalAssistant(DeleteDigitalAssistantRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteDigitalAssistantRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteDigitalAssistantResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteDigitalAssistant API.
DeleteOdaPrivateEndpoint(DeleteOdaPrivateEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Starts an asynchronous job to delete the specified ODA Private Endpoint.
To monitor the status of the job, take the opc-work-request-id
response header value and use it to call GET /workRequests/{workRequestID}
.
Declaration
public Task<DeleteOdaPrivateEndpointResponse> DeleteOdaPrivateEndpoint(DeleteOdaPrivateEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteOdaPrivateEndpointRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteOdaPrivateEndpointResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteOdaPrivateEndpoint API.
DeleteOdaPrivateEndpointAttachment(DeleteOdaPrivateEndpointAttachmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Starts an asynchronous job to delete the specified ODA Private Endpoint Attachment.
To monitor the status of the job, take the opc-work-request-id
response header value and use it to call GET /workRequests/{workRequestID}
.
Declaration
public Task<DeleteOdaPrivateEndpointAttachmentResponse> DeleteOdaPrivateEndpointAttachment(DeleteOdaPrivateEndpointAttachmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteOdaPrivateEndpointAttachmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteOdaPrivateEndpointAttachmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteOdaPrivateEndpointAttachment API.
DeleteOdaPrivateEndpointScanProxy(DeleteOdaPrivateEndpointScanProxyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Starts an asynchronous job to delete the specified ODA Private Endpoint Scan Proxy.
To monitor the status of the job, take the opc-work-request-id
response header value and use it to call GET /workRequests/{workRequestID}
.
Declaration
public Task<DeleteOdaPrivateEndpointScanProxyResponse> DeleteOdaPrivateEndpointScanProxy(DeleteOdaPrivateEndpointScanProxyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteOdaPrivateEndpointScanProxyRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteOdaPrivateEndpointScanProxyResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteOdaPrivateEndpointScanProxy API.
DeleteSkill(DeleteSkillRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Delete the specified Skill.
Declaration
public Task<DeleteSkillResponse> DeleteSkill(DeleteSkillRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteSkillRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteSkillResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteSkill API.
DeleteSkillParameter(DeleteSkillParameterRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Delete the specified Skill Parameter.
Declaration
public Task<DeleteSkillParameterResponse> DeleteSkillParameter(DeleteSkillParameterRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteSkillParameterRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteSkillParameterResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteSkillParameter API.
DeleteTranslator(DeleteTranslatorRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Delete the specified Translator.
Declaration
public Task<DeleteTranslatorResponse> DeleteTranslator(DeleteTranslatorRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteTranslatorRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteTranslatorResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteTranslator API.
ExportDigitalAssistant(ExportDigitalAssistantRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Exports the specified Digital Assistant as an archive to Object Storage.
Declaration
public Task<ExportDigitalAssistantResponse> ExportDigitalAssistant(ExportDigitalAssistantRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ExportDigitalAssistantRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ExportDigitalAssistantResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ExportDigitalAssistant API.
ExportSkill(ExportSkillRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Exports the specified Skill as an archive to Object Storage.
Declaration
public Task<ExportSkillResponse> ExportSkill(ExportSkillRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ExportSkillRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ExportSkillResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ExportSkill API.
GetAuthenticationProvider(GetAuthenticationProviderRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the specified Authentication Provider.
Declaration
public Task<GetAuthenticationProviderResponse> GetAuthenticationProvider(GetAuthenticationProviderRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetAuthenticationProviderRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetAuthenticationProviderResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetAuthenticationProvider API.
GetChannel(GetChannelRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the specified Channel.
Declaration
public Task<GetChannelResponse> GetChannel(GetChannelRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetChannelRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetChannelResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetChannel API.
GetDigitalAssistant(GetDigitalAssistantRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the specified Digital Assistant.
Declaration
public Task<GetDigitalAssistantResponse> GetDigitalAssistant(GetDigitalAssistantRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetDigitalAssistantRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetDigitalAssistantResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetDigitalAssistant API.
GetDigitalAssistantParameter(GetDigitalAssistantParameterRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the specified Digital Assistant Parameter.
Declaration
public Task<GetDigitalAssistantParameterResponse> GetDigitalAssistantParameter(GetDigitalAssistantParameterRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetDigitalAssistantParameterRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetDigitalAssistantParameterResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetDigitalAssistantParameter API.
GetOdaPrivateEndpoint(GetOdaPrivateEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the specified ODA Private Endpoint.
Declaration
public Task<GetOdaPrivateEndpointResponse> GetOdaPrivateEndpoint(GetOdaPrivateEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetOdaPrivateEndpointRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetOdaPrivateEndpointResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetOdaPrivateEndpoint API.
GetOdaPrivateEndpointAttachment(GetOdaPrivateEndpointAttachmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the specified ODA Private Endpoint Attachment.
Declaration
public Task<GetOdaPrivateEndpointAttachmentResponse> GetOdaPrivateEndpointAttachment(GetOdaPrivateEndpointAttachmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetOdaPrivateEndpointAttachmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetOdaPrivateEndpointAttachmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetOdaPrivateEndpointAttachment API.
GetOdaPrivateEndpointScanProxy(GetOdaPrivateEndpointScanProxyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the specified ODA Private Endpoint Scan Proxy.
Declaration
public Task<GetOdaPrivateEndpointScanProxyResponse> GetOdaPrivateEndpointScanProxy(GetOdaPrivateEndpointScanProxyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetOdaPrivateEndpointScanProxyRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetOdaPrivateEndpointScanProxyResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetOdaPrivateEndpointScanProxy API.
GetSkill(GetSkillRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the specified Skill.
Declaration
public Task<GetSkillResponse> GetSkill(GetSkillRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetSkillRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetSkillResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetSkill API.
GetSkillParameter(GetSkillParameterRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the specified Skill Parameter.
Declaration
public Task<GetSkillParameterResponse> GetSkillParameter(GetSkillParameterRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetSkillParameterRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetSkillParameterResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetSkillParameter API.
GetTranslator(GetTranslatorRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the specified Translator.
Declaration
public Task<GetTranslatorResponse> GetTranslator(GetTranslatorRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetTranslatorRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetTranslatorResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetTranslator API.
ImportBot(ImportBotRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Import a Bot archive from Object Storage.
Declaration
public Task<ImportBotResponse> ImportBot(ImportBotRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ImportBotRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ImportBotResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ImportBot API.
ListAuthenticationProviders(ListAuthenticationProvidersRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a page of Authentication Providers that belong to the specified Digital Assistant instance.
<br/>
If the opc-next-page
header appears in the response, then
there are more items to retrieve. To get the next page in the subsequent
GET request, include the header's value as the page
query parameter.
Declaration
public Task<ListAuthenticationProvidersResponse> ListAuthenticationProviders(ListAuthenticationProvidersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListAuthenticationProvidersRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListAuthenticationProvidersResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListAuthenticationProviders API.
ListChannels(ListChannelsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a page of Channels that belong to the specified Digital Assistant instance.
<br/>
If the opc-next-page
header appears in the response, then
there are more items to retrieve. To get the next page in the subsequent
GET request, include the header's value as the page
query parameter.
Declaration
public Task<ListChannelsResponse> ListChannels(ListChannelsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListChannelsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListChannelsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListChannels API.
ListDigitalAssistantParameters(ListDigitalAssistantParametersRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a page of Parameters that belong to the specified Digital Assistant.
<br/>
If the opc-next-page
header appears in the response, then
there are more items to retrieve. To get the next page in the subsequent
GET request, include the header's value as the page
query parameter.
Declaration
public Task<ListDigitalAssistantParametersResponse> ListDigitalAssistantParameters(ListDigitalAssistantParametersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListDigitalAssistantParametersRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListDigitalAssistantParametersResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListDigitalAssistantParameters API.
ListDigitalAssistants(ListDigitalAssistantsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a page of Digital Assistants that belong to the specified Digital Assistant instance.
<br/>
If the opc-next-page
header appears in the response, then
there are more items to retrieve. To get the next page in the subsequent
GET request, include the header's value as the page
query parameter.
Declaration
public Task<ListDigitalAssistantsResponse> ListDigitalAssistants(ListDigitalAssistantsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListDigitalAssistantsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListDigitalAssistantsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListDigitalAssistants API.
ListOdaPrivateEndpointAttachments(ListOdaPrivateEndpointAttachmentsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a page of ODA Instances attached to this ODA Private Endpoint.
<br/>
If the opc-next-page
header appears in the response, then
there are more items to retrieve. To get the next page in the subsequent
GET request, include the header's value as the page
query parameter.
Declaration
public Task<ListOdaPrivateEndpointAttachmentsResponse> ListOdaPrivateEndpointAttachments(ListOdaPrivateEndpointAttachmentsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListOdaPrivateEndpointAttachmentsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListOdaPrivateEndpointAttachmentsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListOdaPrivateEndpointAttachments API.
ListOdaPrivateEndpointScanProxies(ListOdaPrivateEndpointScanProxiesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a page of ODA Private Endpoint Scan Proxies that belong to the specified
ODA Private Endpoint.
<br/>
If the opc-next-page
header appears in the response, then
there are more items to retrieve. To get the next page in the subsequent
GET request, include the header's value as the page
query parameter.
Declaration
public Task<ListOdaPrivateEndpointScanProxiesResponse> ListOdaPrivateEndpointScanProxies(ListOdaPrivateEndpointScanProxiesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListOdaPrivateEndpointScanProxiesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListOdaPrivateEndpointScanProxiesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListOdaPrivateEndpointScanProxies API.
ListOdaPrivateEndpoints(ListOdaPrivateEndpointsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a page of ODA Private Endpoints that belong to the specified
compartment.
<br/>
If the opc-next-page
header appears in the response, then
there are more items to retrieve. To get the next page in the subsequent
GET request, include the header's value as the page
query parameter.
Declaration
public Task<ListOdaPrivateEndpointsResponse> ListOdaPrivateEndpoints(ListOdaPrivateEndpointsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListOdaPrivateEndpointsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListOdaPrivateEndpointsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListOdaPrivateEndpoints API.
ListSkillParameters(ListSkillParametersRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a page of Skill Parameters that belong to the specified Skill.
<br/>
If the opc-next-page
header appears in the response, then
there are more items to retrieve. To get the next page in the subsequent
GET request, include the header's value as the page
query parameter.
Declaration
public Task<ListSkillParametersResponse> ListSkillParameters(ListSkillParametersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListSkillParametersRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListSkillParametersResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListSkillParameters API.
ListSkills(ListSkillsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a page of Skills that belong to the specified Digital Assistant instance.
<br/>
If the opc-next-page
header appears in the response, then
there are more items to retrieve. To get the next page in the subsequent
GET request, include the header's value as the page
query parameter.
Declaration
public Task<ListSkillsResponse> ListSkills(ListSkillsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListSkillsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListSkillsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListSkills API.
ListTranslators(ListTranslatorsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a page of Translators that belong to the specified Digital Assistant instance.
<br/>
If the opc-next-page
header appears in the response, then
there are more items to retrieve. To get the next page in the subsequent
GET request, include the header's value as the page
query parameter.
Declaration
public Task<ListTranslatorsResponse> ListTranslators(ListTranslatorsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListTranslatorsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListTranslatorsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListTranslators API.
PublishDigitalAssistant(PublishDigitalAssistantRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Publish a draft Digital Assistant. Once published the Digital Assistant cannot be modified.
Declaration
public Task<PublishDigitalAssistantResponse> PublishDigitalAssistant(PublishDigitalAssistantRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
PublishDigitalAssistantRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<PublishDigitalAssistantResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use PublishDigitalAssistant API.
PublishSkill(PublishSkillRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Publish a draft Skill. Once published it cannot be modified.
Declaration
public Task<PublishSkillResponse> PublishSkill(PublishSkillRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
PublishSkillRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<PublishSkillResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use PublishSkill API.
RotateChannelKeys(RotateChannelKeysRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
This will generate new keys for any generated keys in the Channel (eg. secretKey, verifyToken). If a Channel has no generated keys then no changes will be made. Ensure that you take note of the newly generated keys in the response as they will not be returned again.
Declaration
public Task<RotateChannelKeysResponse> RotateChannelKeys(RotateChannelKeysRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
RotateChannelKeysRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<RotateChannelKeysResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use RotateChannelKeys API.
StartChannel(StartChannelRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Starts a Channel so that it will begin accepting messages.
Declaration
public Task<StartChannelResponse> StartChannel(StartChannelRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
StartChannelRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<StartChannelResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use StartChannel API.
StopChannel(StopChannelRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Stops a Channel so that it will no longer accept messages.
Declaration
public Task<StopChannelResponse> StopChannel(StopChannelRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
StopChannelRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<StopChannelResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use StopChannel API.
TrainSkill(TrainSkillRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Train a skill.
Declaration
public Task<TrainSkillResponse> TrainSkill(TrainSkillRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
TrainSkillRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<TrainSkillResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use TrainSkill API.
UpdateAuthenticationProvider(UpdateAuthenticationProviderRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the specified Authentication Provider with the information in the request body.
Declaration
public Task<UpdateAuthenticationProviderResponse> UpdateAuthenticationProvider(UpdateAuthenticationProviderRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateAuthenticationProviderRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateAuthenticationProviderResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateAuthenticationProvider API.
UpdateChannel(UpdateChannelRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the specified Channel with the information in the request body.
Declaration
public Task<UpdateChannelResponse> UpdateChannel(UpdateChannelRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateChannelRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateChannelResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateChannel API.
UpdateDigitalAssistant(UpdateDigitalAssistantRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the specified Digital Assistant with the information in the request body.
Declaration
public Task<UpdateDigitalAssistantResponse> UpdateDigitalAssistant(UpdateDigitalAssistantRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateDigitalAssistantRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateDigitalAssistantResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateDigitalAssistant API.
UpdateDigitalAssistantParameter(UpdateDigitalAssistantParameterRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the specified Digital Assistant Parameter with the information in the request body.
Declaration
public Task<UpdateDigitalAssistantParameterResponse> UpdateDigitalAssistantParameter(UpdateDigitalAssistantParameterRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateDigitalAssistantParameterRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateDigitalAssistantParameterResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateDigitalAssistantParameter API.
UpdateOdaPrivateEndpoint(UpdateOdaPrivateEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Starts an asynchronous job to update the specified ODA Private Endpoint with the information in the request body.
Declaration
public Task<UpdateOdaPrivateEndpointResponse> UpdateOdaPrivateEndpoint(UpdateOdaPrivateEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateOdaPrivateEndpointRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateOdaPrivateEndpointResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateOdaPrivateEndpoint API.
UpdateSkill(UpdateSkillRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the specified Skill with the information in the request body.
Declaration
public Task<UpdateSkillResponse> UpdateSkill(UpdateSkillRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateSkillRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateSkillResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateSkill API.
UpdateSkillParameter(UpdateSkillParameterRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the specified Skill Parameter with the information in the request body.
Declaration
public Task<UpdateSkillParameterResponse> UpdateSkillParameter(UpdateSkillParameterRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateSkillParameterRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateSkillParameterResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateSkillParameter API.
UpdateTranslator(UpdateTranslatorRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the specified Translator with the information in the request body.
Declaration
public Task<UpdateTranslatorResponse> UpdateTranslator(UpdateTranslatorRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateTranslatorRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateTranslatorResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateTranslator API.