Package com.oracle.bmc.oda

Class OdaAsyncClient

java.lang.Object

com.oracle.bmc.http.internal.BaseAsyncClient

com.oracle.bmc.oda.OdaAsyncClient

All Implemented Interfaces:

OdaAsync, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190506")
public class OdaAsyncClient
extends BaseAsyncClient
implements OdaAsync

Async client implementation for Oda service.
There are two ways to use async client: 1. Use AsyncHandler: using AsyncHandler, if the response to the call is an InputStream, like getObject Api in object storage service, developers need to process the stream in AsyncHandler, and not anywhere else, because the stream will be closed right after the AsyncHandler is invoked.
2. Use Java Future: using Java Future, developers need to close the stream after they are done with the Java Future.
Accessing the result should be done in a mutually exclusive manner, either through the Future or the AsyncHandler, but not both. If the Future is used, the caller should pass in null as the AsyncHandler. If the AsyncHandler is used, it is still safe to use the Future to determine whether or not the request was completed via Future.isDone/isCancelled.
Please refer to https://github.com/oracle/oci-java-sdk/blob/master/bmc-examples/src/main/java/ResteasyClientWithObjectStorageExample.java

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	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	Description
OdaAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)	Deprecated. Use the builder instead.
OdaAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)	Deprecated. Use the builder instead.
OdaAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)	Deprecated. Use the builder instead.
OdaAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)	Deprecated. Use the builder instead.
OdaAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)	Deprecated. Use the builder instead.
OdaAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)	Deprecated. Use the builder instead.
OdaAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)	Deprecated. Use the builder instead.

Method Summary

Modifier and Type	Method	Description
static OdaAsyncClient.Builder	builder()	Create a builder for this client.
Future<ChangeOdaInstanceCompartmentResponse>	changeOdaInstanceCompartment(ChangeOdaInstanceCompartmentRequest request, AsyncHandler<ChangeOdaInstanceCompartmentRequest,ChangeOdaInstanceCompartmentResponse> handler)	Moves an Digital Assistant instance into a different compartment.
protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER>	clientCall(REQ request, Supplier<RESP_BUILDER> responseBuilder)
void	close()
Future<CreateOdaInstanceResponse>	createOdaInstance(CreateOdaInstanceRequest request, AsyncHandler<CreateOdaInstanceRequest,CreateOdaInstanceResponse> handler)	Starts an asynchronous job to create a Digital Assistant instance.
Future<CreateOdaInstanceAttachmentResponse>	createOdaInstanceAttachment(CreateOdaInstanceAttachmentRequest request, AsyncHandler<CreateOdaInstanceAttachmentRequest,CreateOdaInstanceAttachmentResponse> handler)	Starts an asynchronous job to create a Digital Assistant instance attachment.
Future<DeleteOdaInstanceResponse>	deleteOdaInstance(DeleteOdaInstanceRequest request, AsyncHandler<DeleteOdaInstanceRequest,DeleteOdaInstanceResponse> handler)	Starts an asynchronous job to delete the specified Digital Assistant instance.
Future<DeleteOdaInstanceAttachmentResponse>	deleteOdaInstanceAttachment(DeleteOdaInstanceAttachmentRequest request, AsyncHandler<DeleteOdaInstanceAttachmentRequest,DeleteOdaInstanceAttachmentResponse> handler)	Starts an asynchronous job to delete the specified Digital Assistant instance attachment.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
Future<GetOdaInstanceResponse>	getOdaInstance(GetOdaInstanceRequest request, AsyncHandler<GetOdaInstanceRequest,GetOdaInstanceResponse> handler)	Gets the specified Digital Assistant instance.
Future<GetOdaInstanceAttachmentResponse>	getOdaInstanceAttachment(GetOdaInstanceAttachmentRequest request, AsyncHandler<GetOdaInstanceAttachmentRequest,GetOdaInstanceAttachmentResponse> handler)	Gets an ODA instance attachment by identifier
Future<GetWorkRequestResponse>	getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)	Gets information about the work request with the specified ID, including its status.
Future<ListOdaInstanceAttachmentsResponse>	listOdaInstanceAttachments(ListOdaInstanceAttachmentsRequest request, AsyncHandler<ListOdaInstanceAttachmentsRequest,ListOdaInstanceAttachmentsResponse> handler)	Returns a list of ODA instance attachments
Future<ListOdaInstancesResponse>	listOdaInstances(ListOdaInstancesRequest request, AsyncHandler<ListOdaInstancesRequest,ListOdaInstancesResponse> handler)	Returns a page of Digital Assistant instances that belong to the specified compartment.
Future<ListWorkRequestErrorsResponse>	listWorkRequestErrors(ListWorkRequestErrorsRequest request, AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)	Returns a page of errors for the specified work request.
Future<ListWorkRequestLogsResponse>	listWorkRequestLogs(ListWorkRequestLogsRequest request, AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)	Returns a page of of log messages for a given work request.
Future<ListWorkRequestsResponse>	listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)	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’).
Future<StartOdaInstanceResponse>	startOdaInstance(StartOdaInstanceRequest request, AsyncHandler<StartOdaInstanceRequest,StartOdaInstanceResponse> handler)	Starts an inactive Digital Assistant instance.
Future<StopOdaInstanceResponse>	stopOdaInstance(StopOdaInstanceRequest request, AsyncHandler<StopOdaInstanceRequest,StopOdaInstanceResponse> handler)	Stops an active Digital Assistant instance.
void	updateBaseEndpoint(String endpoint)	This method should be used for parameterized endpoint templates only.
Future<UpdateOdaInstanceResponse>	updateOdaInstance(UpdateOdaInstanceRequest request, AsyncHandler<UpdateOdaInstanceRequest,UpdateOdaInstanceResponse> handler)	Updates the specified Digital Assistant instance with the information in the request body.
Future<UpdateOdaInstanceAttachmentResponse>	updateOdaInstanceAttachment(UpdateOdaInstanceAttachmentRequest request, AsyncHandler<UpdateOdaInstanceAttachmentRequest,UpdateOdaInstanceAttachmentResponse> handler)	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 java.lang.Object

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

Methods inherited from interface java.lang.AutoCloseable

close

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

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

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

OdaAsyncClient

@Deprecated
public OdaAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

OdaAsyncClient

@Deprecated
public OdaAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                      ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

OdaAsyncClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

OdaAsyncClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

OdaAsyncClient

@Deprecated
public OdaAsyncClient(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 OdaAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

OdaAsyncClient

@Deprecated
public OdaAsyncClient(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 OdaAsyncClient.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)

OdaAsyncClient

@Deprecated
public OdaAsyncClient(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 OdaAsyncClient.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

Method Detail

builder

public static OdaAsyncClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: OdaAsync

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 OdaAsync

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: OdaAsync

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 OdaAsync

Parameters:

regionId - The public region ID.

changeOdaInstanceCompartment

public Future<ChangeOdaInstanceCompartmentResponse> changeOdaInstanceCompartment(ChangeOdaInstanceCompartmentRequest request,
                                                                                 AsyncHandler<ChangeOdaInstanceCompartmentRequest,ChangeOdaInstanceCompartmentResponse> handler)

Description copied from interface: OdaAsync

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 OdaAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

createOdaInstance

public Future<CreateOdaInstanceResponse> createOdaInstance(CreateOdaInstanceRequest request,
                                                           AsyncHandler<CreateOdaInstanceRequest,CreateOdaInstanceResponse> handler)

Description copied from interface: OdaAsync

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 OdaAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

createOdaInstanceAttachment

public Future<CreateOdaInstanceAttachmentResponse> createOdaInstanceAttachment(CreateOdaInstanceAttachmentRequest request,
                                                                               AsyncHandler<CreateOdaInstanceAttachmentRequest,CreateOdaInstanceAttachmentResponse> handler)

Description copied from interface: OdaAsync

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 OdaAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

deleteOdaInstance

public Future<DeleteOdaInstanceResponse> deleteOdaInstance(DeleteOdaInstanceRequest request,
                                                           AsyncHandler<DeleteOdaInstanceRequest,DeleteOdaInstanceResponse> handler)

Description copied from interface: OdaAsync

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 OdaAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

deleteOdaInstanceAttachment

public Future<DeleteOdaInstanceAttachmentResponse> deleteOdaInstanceAttachment(DeleteOdaInstanceAttachmentRequest request,
                                                                               AsyncHandler<DeleteOdaInstanceAttachmentRequest,DeleteOdaInstanceAttachmentResponse> handler)

Description copied from interface: OdaAsync

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

Specified by:

deleteOdaInstanceAttachment in interface OdaAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getOdaInstance

public Future<GetOdaInstanceResponse> getOdaInstance(GetOdaInstanceRequest request,
                                                     AsyncHandler<GetOdaInstanceRequest,GetOdaInstanceResponse> handler)

Description copied from interface: OdaAsync

Gets the specified Digital Assistant instance.

Specified by:

getOdaInstance in interface OdaAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getOdaInstanceAttachment

public Future<GetOdaInstanceAttachmentResponse> getOdaInstanceAttachment(GetOdaInstanceAttachmentRequest request,
                                                                         AsyncHandler<GetOdaInstanceAttachmentRequest,GetOdaInstanceAttachmentResponse> handler)

Description copied from interface: OdaAsync

Gets an ODA instance attachment by identifier

Specified by:

getOdaInstanceAttachment in interface OdaAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getWorkRequest

public Future<GetWorkRequestResponse> getWorkRequest(GetWorkRequestRequest request,
                                                     AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)

Description copied from interface: OdaAsync

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 OdaAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listOdaInstanceAttachments

public Future<ListOdaInstanceAttachmentsResponse> listOdaInstanceAttachments(ListOdaInstanceAttachmentsRequest request,
                                                                             AsyncHandler<ListOdaInstanceAttachmentsRequest,ListOdaInstanceAttachmentsResponse> handler)

Description copied from interface: OdaAsync

Returns a list of ODA instance attachments

Specified by:

listOdaInstanceAttachments in interface OdaAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listOdaInstances

public Future<ListOdaInstancesResponse> listOdaInstances(ListOdaInstancesRequest request,
                                                         AsyncHandler<ListOdaInstancesRequest,ListOdaInstancesResponse> handler)

Description copied from interface: OdaAsync

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 OdaAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listWorkRequestErrors

public Future<ListWorkRequestErrorsResponse> listWorkRequestErrors(ListWorkRequestErrorsRequest request,
                                                                   AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)

Description copied from interface: OdaAsync

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 OdaAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listWorkRequestLogs

public Future<ListWorkRequestLogsResponse> listWorkRequestLogs(ListWorkRequestLogsRequest request,
                                                               AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)

Description copied from interface: OdaAsync

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 OdaAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listWorkRequests

public Future<ListWorkRequestsResponse> listWorkRequests(ListWorkRequestsRequest request,
                                                         AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)

Description copied from interface: OdaAsync

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 OdaAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

startOdaInstance

public Future<StartOdaInstanceResponse> startOdaInstance(StartOdaInstanceRequest request,
                                                         AsyncHandler<StartOdaInstanceRequest,StartOdaInstanceResponse> handler)

Description copied from interface: OdaAsync

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 OdaAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

stopOdaInstance

public Future<StopOdaInstanceResponse> stopOdaInstance(StopOdaInstanceRequest request,
                                                       AsyncHandler<StopOdaInstanceRequest,StopOdaInstanceResponse> handler)

Description copied from interface: OdaAsync

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 OdaAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

updateOdaInstance

public Future<UpdateOdaInstanceResponse> updateOdaInstance(UpdateOdaInstanceRequest request,
                                                           AsyncHandler<UpdateOdaInstanceRequest,UpdateOdaInstanceResponse> handler)

Description copied from interface: OdaAsync

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

Specified by:

updateOdaInstance in interface OdaAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

updateOdaInstanceAttachment

public Future<UpdateOdaInstanceAttachmentResponse> updateOdaInstanceAttachment(UpdateOdaInstanceAttachmentRequest request,
                                                                               AsyncHandler<UpdateOdaInstanceAttachmentRequest,UpdateOdaInstanceAttachmentResponse> handler)

Description copied from interface: OdaAsync

Updates the ODA instance attachment

Specified by:

updateOdaInstanceAttachment in interface OdaAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

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()

clientCall

protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER> clientCall(REQ request,
                                                                                                                                                                                   Supplier<RESP_BUILDER> responseBuilder)