@Generated(value="OracleSDKGenerator", comments="API Version: 20190506") public class OdaClient extends Object implements Oda
Modifier and Type | Class and Description |
---|---|
static class |
OdaClient.Builder
Builder class for this client.
|
Modifier and Type | Field and Description |
---|---|
static Service |
SERVICE
Service instance for Oda.
|
Modifier | Constructor and Description |
---|---|
|
OdaClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration.
|
|
OdaClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration.
|
|
OdaClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Creates a new service instance using the given authentication provider and client configuration.
|
|
OdaClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Creates a new service instance using the given authentication provider and client configuration.
|
|
OdaClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint,
ExecutorService executorService)
Creates a new service instance using the given authentication provider and client configuration.
|
protected |
OdaClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint,
ExecutorService executorService,
RestClientFactoryBuilder restClientFactoryBuilder)
Creates a new service instance using the given authentication provider and client configuration.
|
|
OdaClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
|
|
OdaClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
|
|
OdaClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator)
Creates a new service instance using the given authentication provider and client configuration.
|
Modifier and Type | Method and Description |
---|---|
static OdaClient.Builder |
builder()
Create a builder for this client.
|
ChangeOdaInstanceCompartmentResponse |
changeOdaInstanceCompartment(ChangeOdaInstanceCompartmentRequest request)
Moves an Digital Assistant instance into a different compartment.
|
void |
close() |
CreateOdaInstanceResponse |
createOdaInstance(CreateOdaInstanceRequest request)
Starts an asynchronous job to create a Digital Assistant instance.
|
CreateOdaInstanceAttachmentResponse |
createOdaInstanceAttachment(CreateOdaInstanceAttachmentRequest request)
Starts an asynchronous job to create a Digital Assistant instance attachment.
|
DeleteOdaInstanceResponse |
deleteOdaInstance(DeleteOdaInstanceRequest request)
Starts an asynchronous job to delete the specified Digital Assistant instance.
|
DeleteOdaInstanceAttachmentResponse |
deleteOdaInstanceAttachment(DeleteOdaInstanceAttachmentRequest request)
Starts an asynchronous job to delete the specified Digital Assistant instance attachment.
|
String |
getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
|
GetOdaInstanceResponse |
getOdaInstance(GetOdaInstanceRequest request)
Gets the specified Digital Assistant instance.
|
GetOdaInstanceAttachmentResponse |
getOdaInstanceAttachment(GetOdaInstanceAttachmentRequest request)
Gets an ODA instance attachment by identifier
|
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.
|
ListOdaInstanceAttachmentsResponse |
listOdaInstanceAttachments(ListOdaInstanceAttachmentsRequest request)
Returns a list of ODA instance attachments
|
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 |
refreshClient()
Rebuilds the client from scratch.
|
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.
|
UpdateOdaInstanceAttachmentResponse |
updateOdaInstanceAttachment(UpdateOdaInstanceAttachmentRequest request)
Updates the ODA instance attachment
|
public static final Service SERVICE
Service instance for Oda.
public OdaClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
authenticationDetailsProvider
- The authentication details provider, required.public OdaClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.public OdaClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.public OdaClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.public OdaClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.additionalClientConfigurators
- Additional client configurators to be run after the primary configurator.public OdaClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.additionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)public OdaClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.signingStrategyRequestSignerFactories
- The request signer factories for each signing strategy used to create the request signeradditionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)public OdaClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.signingStrategyRequestSignerFactories
- The request signer factories for each signing strategy used to create the request signeradditionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)executorService
- ExecutorService used by the client, or null to use the default configured ThreadPoolExecutorprotected OdaClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService, RestClientFactoryBuilder restClientFactoryBuilder)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
Use the OdaClient.Builder
to get access to all these parameters.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.signingStrategyRequestSignerFactories
- The request signer factories for each signing strategy used to create the request signeradditionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)executorService
- ExecutorService used by the client, or null to use the default configured ThreadPoolExecutorrestClientFactoryBuilder
- the builder for the RestClientFactory
public static OdaClient.Builder builder()
Create a builder for this client.
public void refreshClient()
Oda
Rebuilds the client from scratch. Useful to refresh certificates.
refreshClient
in interface Oda
public void setEndpoint(String endpoint)
Oda
Sets the endpoint to call (ex, https://www.example.com).
setEndpoint
in interface Oda
endpoint
- The endpoint of the service.public String getEndpoint()
Oda
Gets the set endpoint for REST call (ex, https://www.example.com)
getEndpoint
in interface Oda
public void setRegion(Region region)
Oda
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.
public void setRegion(String regionId)
Oda
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
.
public void close()
close
in interface AutoCloseable
public ChangeOdaInstanceCompartmentResponse changeOdaInstanceCompartment(ChangeOdaInstanceCompartmentRequest request)
Oda
Moves an Digital Assistant instance into a different compartment. When provided, If-Match is checked against ETag values of the resource.
changeOdaInstanceCompartment
in interface Oda
request
- The request object containing the details to sendpublic CreateOdaInstanceResponse createOdaInstance(CreateOdaInstanceRequest request)
Oda
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}`.
createOdaInstance
in interface Oda
request
- The request object containing the details to sendpublic CreateOdaInstanceAttachmentResponse createOdaInstanceAttachment(CreateOdaInstanceAttachmentRequest request)
Oda
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}`.
createOdaInstanceAttachment
in interface Oda
request
- The request object containing the details to sendpublic DeleteOdaInstanceResponse deleteOdaInstance(DeleteOdaInstanceRequest request)
Oda
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}
.
deleteOdaInstance
in interface Oda
request
- The request object containing the details to sendpublic DeleteOdaInstanceAttachmentResponse deleteOdaInstanceAttachment(DeleteOdaInstanceAttachmentRequest request)
Oda
Starts an asynchronous job to delete the specified Digital Assistant instance attachment.
deleteOdaInstanceAttachment
in interface Oda
request
- The request object containing the details to sendpublic GetOdaInstanceResponse getOdaInstance(GetOdaInstanceRequest request)
Oda
Gets the specified Digital Assistant instance.
getOdaInstance
in interface Oda
request
- The request object containing the details to sendpublic GetOdaInstanceAttachmentResponse getOdaInstanceAttachment(GetOdaInstanceAttachmentRequest request)
Oda
Gets an ODA instance attachment by identifier
getOdaInstanceAttachment
in interface Oda
request
- The request object containing the details to sendpublic GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
Oda
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.
getWorkRequest
in interface Oda
request
- The request object containing the details to sendpublic ListOdaInstanceAttachmentsResponse listOdaInstanceAttachments(ListOdaInstanceAttachmentsRequest request)
Oda
Returns a list of ODA instance attachments
listOdaInstanceAttachments
in interface Oda
request
- The request object containing the details to sendpublic ListOdaInstancesResponse listOdaInstances(ListOdaInstancesRequest request)
Oda
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.
listOdaInstances
in interface Oda
request
- The request object containing the details to sendpublic ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
Oda
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.
listWorkRequestErrors
in interface Oda
request
- The request object containing the details to sendpublic ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
Oda
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.
listWorkRequestLogs
in interface Oda
request
- The request object containing the details to sendpublic ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
Oda
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.
listWorkRequests
in interface Oda
request
- The request object containing the details to sendpublic StartOdaInstanceResponse startOdaInstance(StartOdaInstanceRequest request)
Oda
Starts an inactive Digital Assistant instance. Once active, the instance will be accessible and metering of requests will be started again.
startOdaInstance
in interface Oda
request
- The request object containing the details to sendpublic StopOdaInstanceResponse stopOdaInstance(StopOdaInstanceRequest request)
Oda
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.
stopOdaInstance
in interface Oda
request
- The request object containing the details to sendpublic UpdateOdaInstanceResponse updateOdaInstance(UpdateOdaInstanceRequest request)
Oda
Updates the specified Digital Assistant instance with the information in the request body.
updateOdaInstance
in interface Oda
request
- The request object containing the details to sendpublic UpdateOdaInstanceAttachmentResponse updateOdaInstanceAttachment(UpdateOdaInstanceAttachmentRequest request)
Oda
Updates the ODA instance attachment
updateOdaInstanceAttachment
in interface Oda
request
- The request object containing the details to sendpublic OdaWaiters getWaiters()
Oda
Gets the pre-configured waiters available for resources for this service.
getWaiters
in interface Oda
public OdaPaginators getPaginators()
Oda
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.
getPaginators
in interface Oda
Copyright © 2016–2022. All rights reserved.