Class OdaClient

Service client instance for Oda.

Inheritance

object

ClientBase

RegionalClientBase

OdaClient

Implements

IDisposable

Inherited Members

RegionalClientBase.logger

RegionalClientBase.SetRegion(Region)

RegionalClientBase.SetRegion(string)

RegionalClientBase.UseRealmSpecificEndpointTemplate(bool)

RegionalClientBase.PopulateServiceParametersInEndpointTemplate(RestClient, Dictionary<string, object>)

RegionalClientBase.parseEndpointForParameters(string)

ClientBase.restClient

ClientBase.service

ClientBase.userAgent

ClientBase.Dispose()

ClientBase.Dispose(bool)

ClientBase.SetEndpoint(string)

ClientBase.GetEndpoint()

ClientBase.GetUserAgent()

ClientBase.SetRealmSpecificEndpointTemplate(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.OdaService

Assembly: OCI.DotNetSDK.Oda.dll

Syntax

public class OdaClient : RegionalClientBase, IDisposable

Constructors

OdaClient(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 OdaClient(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 OdaPaginators Paginators { get; }

Property Value

Type	Description
OdaPaginators

Waiters

Declaration

public OdaWaiters Waiters { get; }

Property Value

Type	Description
OdaWaiters

Methods

ChangeOdaInstanceCompartment(ChangeOdaInstanceCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves an Digital Assistant instance into a different compartment. When provided, If-Match is checked against ETag values of the resource.

Declaration

public Task<ChangeOdaInstanceCompartmentResponse> ChangeOdaInstanceCompartment(ChangeOdaInstanceCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeOdaInstanceCompartmentRequest	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<ChangeOdaInstanceCompartmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeOdaInstanceCompartment API.

CreateOdaInstance(CreateOdaInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Starts an asynchronous job to create a Digital Assistant instance. 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<CreateOdaInstanceResponse> CreateOdaInstance(CreateOdaInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateOdaInstanceRequest	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<CreateOdaInstanceResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateOdaInstance API.

CreateOdaInstanceAttachment(CreateOdaInstanceAttachmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Starts an asynchronous job to create a Digital Assistant instance 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<CreateOdaInstanceAttachmentResponse> CreateOdaInstanceAttachment(CreateOdaInstanceAttachmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateOdaInstanceAttachmentRequest	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<CreateOdaInstanceAttachmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateOdaInstanceAttachment API.

DeleteOdaInstance(DeleteOdaInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Starts an asynchronous job to delete the specified Digital Assistant instance. 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<DeleteOdaInstanceResponse> DeleteOdaInstance(DeleteOdaInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteOdaInstanceRequest	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<DeleteOdaInstanceResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteOdaInstance API.

DeleteOdaInstanceAttachment(DeleteOdaInstanceAttachmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Starts an asynchronous job to delete the specified Digital Assistant instance attachment.

Declaration

public Task<DeleteOdaInstanceAttachmentResponse> DeleteOdaInstanceAttachment(DeleteOdaInstanceAttachmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteOdaInstanceAttachmentRequest	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<DeleteOdaInstanceAttachmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteOdaInstanceAttachment API.

GetOdaInstance(GetOdaInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the specified Digital Assistant instance.

Declaration

public Task<GetOdaInstanceResponse> GetOdaInstance(GetOdaInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetOdaInstanceRequest	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<GetOdaInstanceResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetOdaInstance API.

GetOdaInstanceAttachment(GetOdaInstanceAttachmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets an ODA instance attachment by identifier

Declaration

public Task<GetOdaInstanceAttachmentResponse> GetOdaInstanceAttachment(GetOdaInstanceAttachmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetOdaInstanceAttachmentRequest	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<GetOdaInstanceAttachmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetOdaInstanceAttachment API.

GetWorkRequest(GetWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets information about the work request with the specified ID, including its status. You can use this operation to monitor the status of jobs that you requested to create, delete, and update instances.

Declaration

public Task<GetWorkRequestResponse> GetWorkRequest(GetWorkRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetWorkRequestRequest	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<GetWorkRequestResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetWorkRequest API.

ListOdaInstanceAttachments(ListOdaInstanceAttachmentsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a list of ODA instance attachments

Declaration

public Task<ListOdaInstanceAttachmentsResponse> ListOdaInstanceAttachments(ListOdaInstanceAttachmentsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListOdaInstanceAttachmentsRequest	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<ListOdaInstanceAttachmentsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListOdaInstanceAttachments API.

ListOdaInstances(ListOdaInstancesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a page of Digital Assistant instances that belong to the specified compartment. 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<ListOdaInstancesResponse> ListOdaInstances(ListOdaInstancesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListOdaInstancesRequest	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<ListOdaInstancesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListOdaInstances API.

ListWorkRequestErrors(ListWorkRequestErrorsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a page of errors for the specified work request. 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<ListWorkRequestErrorsResponse> ListWorkRequestErrors(ListWorkRequestErrorsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListWorkRequestErrorsRequest	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<ListWorkRequestErrorsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListWorkRequestErrors API.

ListWorkRequestLogs(ListWorkRequestLogsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a page of of log messages for a given work request. 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<ListWorkRequestLogsResponse> ListWorkRequestLogs(ListWorkRequestLogsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListWorkRequestLogsRequest	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<ListWorkRequestLogsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListWorkRequestLogs API.

ListWorkRequests(ListWorkRequestsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a page of work requests for the specified compartment. 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<ListWorkRequestsResponse> ListWorkRequests(ListWorkRequestsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListWorkRequestsRequest	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<ListWorkRequestsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListWorkRequests API.

StartOdaInstance(StartOdaInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Starts an inactive Digital Assistant instance. Once active, the instance will be accessible and metering of requests will be started again.

Declaration

public Task<StartOdaInstanceResponse> StartOdaInstance(StartOdaInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
StartOdaInstanceRequest	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<StartOdaInstanceResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use StartOdaInstance API.

StopOdaInstance(StopOdaInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Stops an active Digital Assistant instance. Once inactive, the instance will not be accessible and metering of requests will be stopped until the instance is started again. Data associated with the instance is not affected.

Declaration

public Task<StopOdaInstanceResponse> StopOdaInstance(StopOdaInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
StopOdaInstanceRequest	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<StopOdaInstanceResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use StopOdaInstance API.

UpdateOdaInstance(UpdateOdaInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the specified Digital Assistant instance with the information in the request body.

Declaration

public Task<UpdateOdaInstanceResponse> UpdateOdaInstance(UpdateOdaInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateOdaInstanceRequest	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<UpdateOdaInstanceResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateOdaInstance API.

UpdateOdaInstanceAttachment(UpdateOdaInstanceAttachmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the ODA instance attachment

Declaration

public Task<UpdateOdaInstanceAttachmentResponse> UpdateOdaInstanceAttachment(UpdateOdaInstanceAttachmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateOdaInstanceAttachmentRequest	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<UpdateOdaInstanceAttachmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateOdaInstanceAttachment API.

Implements

IDisposable