com.oracle.bmc.oda

Interface Oda

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

OdaClient

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190506")
public interface Oda
extends AutoCloseable

API to create and maintain Oracle Digital Assistant service instances.

Method Summary

Modifier and Type	Method and Description
ChangeOdaInstanceCompartmentResponse	changeOdaInstanceCompartment(ChangeOdaInstanceCompartmentRequest request) Moves an Digital Assistant instance into a different compartment.
CreateOdaInstanceResponse	createOdaInstance(CreateOdaInstanceRequest request) Starts an asynchronous job to create a Digital Assistant instance.
DeleteOdaInstanceResponse	deleteOdaInstance(DeleteOdaInstanceRequest request) Starts an asynchronous job to delete the specified Digital Assistant instance.
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
GetOdaInstanceResponse	getOdaInstance(GetOdaInstanceRequest request) Gets the specified Digital Assistant instance.
OdaPaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
OdaWaiters	getWaiters() Gets the pre-configured waiters available for resources for this service.
GetWorkRequestResponse	getWorkRequest(GetWorkRequestRequest request) Gets information about the work request with the specified ID, including its status.
ListOdaInstancesResponse	listOdaInstances(ListOdaInstancesRequest request) Returns a page of Digital Assistant instances that belong to the specified compartment.
ListWorkRequestErrorsResponse	listWorkRequestErrors(ListWorkRequestErrorsRequest request) Returns a page of errors for the specified work request.
ListWorkRequestLogsResponse	listWorkRequestLogs(ListWorkRequestLogsRequest request) Returns a page of of log messages for a given work request.
ListWorkRequestsResponse	listWorkRequests(ListWorkRequestsRequest request) Returns a page of work requests for the specified compartment.
void	setEndpoint(String endpoint) Sets the endpoint to call (ex, https://www.example.com).
void	setRegion(Region region) Sets the region to call (ex, Region.US_PHOENIX_1).
void	setRegion(String regionId) Sets the region to call (ex, ‘us-phoenix-1’).
StartOdaInstanceResponse	startOdaInstance(StartOdaInstanceRequest request) Starts an inactive Digital Assistant instance.
StopOdaInstanceResponse	stopOdaInstance(StopOdaInstanceRequest request) Stops an active Digital Assistant instance.
UpdateOdaInstanceResponse	updateOdaInstance(UpdateOdaInstanceRequest request) Updates the specified Digital Assistant instance with the information in the request body.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

setEndpoint

void setEndpoint(String endpoint)

Sets the endpoint to call (ex, https://www.example.com).

Parameters:

endpoint - The endpoint of the service.

getEndpoint

String getEndpoint()

Gets the set endpoint for REST call (ex, https://www.example.com)

setRegion

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.

Parameters:

region - The region of the service.

setRegion

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.

Parameters:

regionId - The public region ID.

changeOdaInstanceCompartment

ChangeOdaInstanceCompartmentResponse changeOdaInstanceCompartment(ChangeOdaInstanceCompartmentRequest request)

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use ChangeOdaInstanceCompartment API.

createOdaInstance

CreateOdaInstanceResponse createOdaInstance(CreateOdaInstanceRequest request)

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}`.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use CreateOdaInstance API.

deleteOdaInstance

DeleteOdaInstanceResponse deleteOdaInstance(DeleteOdaInstanceRequest request)

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}.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use DeleteOdaInstance API.

getOdaInstance

GetOdaInstanceResponse getOdaInstance(GetOdaInstanceRequest request)

Gets the specified Digital Assistant instance.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use GetOdaInstance API.

getWorkRequest

GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)

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.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use GetWorkRequest API.

listOdaInstances

ListOdaInstancesResponse listOdaInstances(ListOdaInstancesRequest request)

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.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use ListOdaInstances API.

listWorkRequestErrors

ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)

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.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use ListWorkRequestErrors API.

listWorkRequestLogs

ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)

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.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use ListWorkRequestLogs API.

listWorkRequests

ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)

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.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use ListWorkRequests API.

startOdaInstance

StartOdaInstanceResponse startOdaInstance(StartOdaInstanceRequest request)

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use StartOdaInstance API.

stopOdaInstance

StopOdaInstanceResponse stopOdaInstance(StopOdaInstanceRequest request)

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.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use StopOdaInstance API.

updateOdaInstance

UpdateOdaInstanceResponse updateOdaInstance(UpdateOdaInstanceRequest request)

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use UpdateOdaInstance API.

getWaiters

OdaWaiters getWaiters()

Gets the pre-configured waiters available for resources for this service.

Returns:

The service waiters.

getPaginators

OdaPaginators getPaginators()

Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data. These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.

Returns:

The service paginators.