@Generated(value="OracleSDKGenerator",
comments="API Version: 20190506")
public interface OdaAsync
extends AutoCloseable
API to create and maintain Oracle Digital Assistant service instances.
closevoid refreshClient()
Rebuilds the client from scratch. Useful to refresh certificates.
void setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
endpoint - The endpoint of the serice.String getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
void setRegion(Region region)
Sets the region to call (ex, Region.US_PHOENIX_1).
Note, this will call setEndpoint after resolving the
endpoint. If the service is not available in this region, however, an
IllegalArgumentException will be raised.
region - The region of the service.void setRegion(String regionId)
Sets the region to call (ex, ‘us-phoenix-1’).
Note, this will first try to map the region ID to a known Region and call setRegion.
If no known Region could be determined, it will create an endpoint based on the default
endpoint format (Region.formatDefaultRegionEndpoint(Service, String)
and then call setEndpoint.
regionId - The public region ID.void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)
Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”
realmSpecificEndpointTemplateEnabled - flag to enable the use of realm specific endpoint
templateFuture<ChangeOdaInstanceCompartmentResponse> changeOdaInstanceCompartment(ChangeOdaInstanceCompartmentRequest request, AsyncHandler<ChangeOdaInstanceCompartmentRequest,ChangeOdaInstanceCompartmentResponse> handler)
Moves an Digital Assistant instance into a different compartment. When provided, If-Match is checked against ETag values of the resource.
request - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.Future<CreateOdaInstanceResponse> createOdaInstance(CreateOdaInstanceRequest request, AsyncHandler<CreateOdaInstanceRequest,CreateOdaInstanceResponse> handler)
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}`.
request - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.Future<CreateOdaInstanceAttachmentResponse> createOdaInstanceAttachment(CreateOdaInstanceAttachmentRequest request, AsyncHandler<CreateOdaInstanceAttachmentRequest,CreateOdaInstanceAttachmentResponse> handler)
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}`.
request - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.Future<DeleteOdaInstanceResponse> deleteOdaInstance(DeleteOdaInstanceRequest request, AsyncHandler<DeleteOdaInstanceRequest,DeleteOdaInstanceResponse> handler)
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}.
request - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.Future<DeleteOdaInstanceAttachmentResponse> deleteOdaInstanceAttachment(DeleteOdaInstanceAttachmentRequest request, AsyncHandler<DeleteOdaInstanceAttachmentRequest,DeleteOdaInstanceAttachmentResponse> handler)
Starts an asynchronous job to delete the specified Digital Assistant instance attachment.
request - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.Future<GetOdaInstanceResponse> getOdaInstance(GetOdaInstanceRequest request, AsyncHandler<GetOdaInstanceRequest,GetOdaInstanceResponse> handler)
Gets the specified Digital Assistant instance.
request - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.Future<GetOdaInstanceAttachmentResponse> getOdaInstanceAttachment(GetOdaInstanceAttachmentRequest request, AsyncHandler<GetOdaInstanceAttachmentRequest,GetOdaInstanceAttachmentResponse> handler)
Gets an ODA instance attachment by identifier
request - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.Future<GetWorkRequestResponse> getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)
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.
request - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.Future<ListOdaInstanceAttachmentsResponse> listOdaInstanceAttachments(ListOdaInstanceAttachmentsRequest request, AsyncHandler<ListOdaInstanceAttachmentsRequest,ListOdaInstanceAttachmentsResponse> handler)
Returns a list of ODA instance attachments
request - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.Future<ListOdaInstancesResponse> listOdaInstances(ListOdaInstancesRequest request, AsyncHandler<ListOdaInstancesRequest,ListOdaInstancesResponse> handler)
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.
request - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.Future<ListWorkRequestErrorsResponse> listWorkRequestErrors(ListWorkRequestErrorsRequest request, AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)
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.
request - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.Future<ListWorkRequestLogsResponse> listWorkRequestLogs(ListWorkRequestLogsRequest request, AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)
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.
request - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.Future<ListWorkRequestsResponse> listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)
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.
request - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.Future<StartOdaInstanceResponse> startOdaInstance(StartOdaInstanceRequest request, AsyncHandler<StartOdaInstanceRequest,StartOdaInstanceResponse> handler)
Starts an inactive Digital Assistant instance. Once active, the instance will be accessible and metering of requests will be started again.
request - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.Future<StopOdaInstanceResponse> stopOdaInstance(StopOdaInstanceRequest request, AsyncHandler<StopOdaInstanceRequest,StopOdaInstanceResponse> handler)
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.
request - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.Future<UpdateOdaInstanceResponse> updateOdaInstance(UpdateOdaInstanceRequest request, AsyncHandler<UpdateOdaInstanceRequest,UpdateOdaInstanceResponse> handler)
Updates the specified Digital Assistant instance with the information in the request body.
request - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.Future<UpdateOdaInstanceAttachmentResponse> updateOdaInstanceAttachment(UpdateOdaInstanceAttachmentRequest request, AsyncHandler<UpdateOdaInstanceAttachmentRequest,UpdateOdaInstanceAttachmentResponse> handler)
Updates the ODA instance attachment
request - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.Copyright © 2016–2024. All rights reserved.