com.oracle.bmc.oda

Class OdaClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.oda.OdaClient

All Implemented Interfaces:

Oda, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190506")
public class OdaClient
extends BaseSyncClient
implements Oda

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OdaClient.Builder Builder class for this client.

Field Summary

Fields

Modifier and Type	Field and Description
String	clientCommonLibraryVersion Compatible SDK version, provided by the codegen.
Optional<String>	minimumClientCommonLibraryVersionFromClient Minimum compatible SDK version, maybe provided by the codegen.
static Service	SERVICE Service instance for Oda.

Constructor Summary

Constructors

Constructor and Description
OdaClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory) Deprecated. Use the builder instead.
OdaClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Deprecated. Use the builder instead.
OdaClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
OdaClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
OdaClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService) Deprecated. Use the builder instead.
OdaClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Deprecated. Use the builder instead.
OdaClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Deprecated. Use the builder instead.
OdaClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator) Deprecated. Use the builder instead.

Method Summary

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	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
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	populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap) Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
void	refreshClient() Rebuild the backing HttpClient.
void	setEndpoint(String endpoint)
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.
void	updateBaseEndpoint(String endpoint) This method should be used for parameterized endpoint templates only.
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
void	useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled) This method should be used to enable or disable the use of realm-specific endpoint template.

Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient

clientCall

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.oracle.bmc.oda.Oda

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for Oda.

clientCommonLibraryVersion

public final String clientCommonLibraryVersion

Compatible SDK version, provided by the codegen.

minimumClientCommonLibraryVersionFromClient

public final Optional<String> minimumClientCommonLibraryVersionFromClient

Minimum compatible SDK version, maybe provided by the codegen.

Constructor Detail

OdaClient

@Deprecated
public OdaClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see OdaClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

OdaClient

@Deprecated
public OdaClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                             ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see OdaClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

OdaClient

@Deprecated
public OdaClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                             ClientConfiguration configuration,
                             ClientConfigurator clientConfigurator)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see OdaClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

OdaClient

@Deprecated
public OdaClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                             ClientConfiguration configuration,
                             ClientConfigurator clientConfigurator,
                             RequestSignerFactory defaultRequestSignerFactory)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see OdaClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

OdaClient

@Deprecated
public OdaClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                             ClientConfiguration configuration,
                             ClientConfigurator clientConfigurator,
                             RequestSignerFactory defaultRequestSignerFactory,
                             List<ClientConfigurator> additionalClientConfigurators)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see OdaClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

OdaClient

@Deprecated
public OdaClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                             ClientConfiguration configuration,
                             ClientConfigurator clientConfigurator,
                             RequestSignerFactory defaultRequestSignerFactory,
                             List<ClientConfigurator> additionalClientConfigurators,
                             String endpoint)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see OdaClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

OdaClient

@Deprecated
public OdaClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                             ClientConfiguration configuration,
                             ClientConfigurator clientConfigurator,
                             RequestSignerFactory defaultRequestSignerFactory,
                             Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                             List<ClientConfigurator> additionalClientConfigurators,
                             String endpoint)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see OdaClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

OdaClient

@Deprecated
public OdaClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                             ClientConfiguration configuration,
                             ClientConfigurator clientConfigurator,
                             RequestSignerFactory defaultRequestSignerFactory,
                             Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                             List<ClientConfigurator> additionalClientConfigurators,
                             String endpoint,
                             ExecutorService executorService)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see OdaClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

executorService - OdaClient.Builder.executorService

Method Detail

builder

public static OdaClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: 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.

Specified by:

setRegion in interface Oda

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: 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.

Specified by:

setRegion in interface Oda

Parameters:

regionId - The public region ID.

changeOdaInstanceCompartment

public ChangeOdaInstanceCompartmentResponse changeOdaInstanceCompartment(ChangeOdaInstanceCompartmentRequest request)

Description copied from interface: Oda

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

Specified by:

changeOdaInstanceCompartment in interface Oda

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createOdaInstance

public CreateOdaInstanceResponse createOdaInstance(CreateOdaInstanceRequest request)

Description copied from interface: 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}`.

Specified by:

createOdaInstance in interface Oda

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createOdaInstanceAttachment

public CreateOdaInstanceAttachmentResponse createOdaInstanceAttachment(CreateOdaInstanceAttachmentRequest request)

Description copied from interface: 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}`.

Specified by:

createOdaInstanceAttachment in interface Oda

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteOdaInstance

public DeleteOdaInstanceResponse deleteOdaInstance(DeleteOdaInstanceRequest request)

Description copied from interface: 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}.

Specified by:

deleteOdaInstance in interface Oda

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteOdaInstanceAttachment

public DeleteOdaInstanceAttachmentResponse deleteOdaInstanceAttachment(DeleteOdaInstanceAttachmentRequest request)

Description copied from interface: Oda

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

Specified by:

deleteOdaInstanceAttachment in interface Oda

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getOdaInstance

public GetOdaInstanceResponse getOdaInstance(GetOdaInstanceRequest request)

Description copied from interface: Oda

Gets the specified Digital Assistant instance.

Specified by:

getOdaInstance in interface Oda

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getOdaInstanceAttachment

public GetOdaInstanceAttachmentResponse getOdaInstanceAttachment(GetOdaInstanceAttachmentRequest request)

Description copied from interface: Oda

Gets an ODA instance attachment by identifier

Specified by:

getOdaInstanceAttachment in interface Oda

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWorkRequest

public GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)

Description copied from interface: 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.

Specified by:

getWorkRequest in interface Oda

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listOdaInstanceAttachments

public ListOdaInstanceAttachmentsResponse listOdaInstanceAttachments(ListOdaInstanceAttachmentsRequest request)

Description copied from interface: Oda

Returns a list of ODA instance attachments

Specified by:

listOdaInstanceAttachments in interface Oda

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listOdaInstances

public ListOdaInstancesResponse listOdaInstances(ListOdaInstancesRequest request)

Description copied from interface: 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.

Specified by:

listOdaInstances in interface Oda

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequestErrors

public ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)

Description copied from interface: 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.

Specified by:

listWorkRequestErrors in interface Oda

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequestLogs

public ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)

Description copied from interface: 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.

Specified by:

listWorkRequestLogs in interface Oda

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequests

public ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)

Description copied from interface: 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.

Specified by:

listWorkRequests in interface Oda

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

startOdaInstance

public StartOdaInstanceResponse startOdaInstance(StartOdaInstanceRequest request)

Description copied from interface: Oda

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

Specified by:

startOdaInstance in interface Oda

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

stopOdaInstance

public StopOdaInstanceResponse stopOdaInstance(StopOdaInstanceRequest request)

Description copied from interface: 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.

Specified by:

stopOdaInstance in interface Oda

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateOdaInstance

public UpdateOdaInstanceResponse updateOdaInstance(UpdateOdaInstanceRequest request)

Description copied from interface: Oda

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

Specified by:

updateOdaInstance in interface Oda

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateOdaInstanceAttachment

public UpdateOdaInstanceAttachmentResponse updateOdaInstanceAttachment(UpdateOdaInstanceAttachmentRequest request)

Description copied from interface: Oda

Updates the ODA instance attachment

Specified by:

updateOdaInstanceAttachment in interface Oda

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public OdaWaiters getWaiters()

Description copied from interface: Oda

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

Specified by:

getWaiters in interface Oda

Returns:

The service waiters.

getPaginators

public OdaPaginators getPaginators()

Description copied from interface: 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.

Specified by:

getPaginators in interface Oda

Returns:

The service paginators.

getDefaultConfigurator

protected ClientConfigurator getDefaultConfigurator()

useRealmSpecificEndpointTemplate

public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)

This method should be used to enable or disable the use of realm-specific endpoint template. The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false

Parameters:

useOfRealmSpecificEndpointTemplateEnabled - This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively

populateServiceParametersInEndpoint

public final void populateServiceParametersInEndpoint(String endpoint,
                                                      Map<String,Object> requiredParametersMap)

Populate the parameters in the endpoint with its corresponding value and update the base endpoint. The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.

Parameters:

endpoint - The endpoint template in use

requiredParametersMap - Map of parameter name as key and value set in request path or query parameter as value

updateBaseEndpoint

public final void updateBaseEndpoint(String endpoint)

This method should be used for parameterized endpoint templates only. This does not include {region} and {secondLevelDomain} parameters.

Parameters:

endpoint - The updated endpoint to use

setEndpoint

public final void setEndpoint(String endpoint)

getEndpoint

public final String getEndpoint()

refreshClient

public final void refreshClient()

Rebuild the backing HttpClient. This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.

close

public final void close()

Specified by:

close in interface AutoCloseable

getClientCommonLibraryVersion

public String getClientCommonLibraryVersion()

getMinimumClientCommonLibraryVersionFromClient

public Optional<String> getMinimumClientCommonLibraryVersionFromClient()