com.oracle.bmc.containerinstances

Class ContainerInstanceAsyncClient

java.lang.Object

com.oracle.bmc.http.internal.BaseAsyncClient

com.oracle.bmc.containerinstances.ContainerInstanceAsyncClient

All Implemented Interfaces:

ContainerInstanceAsync, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20210415")
public class ContainerInstanceAsyncClient
extends BaseAsyncClient
implements ContainerInstanceAsync

Async client implementation for ContainerInstance 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 and Description
static class	ContainerInstanceAsyncClient.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 ContainerInstance.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static ContainerInstanceAsyncClient.Builder	builder() Create a builder for this client.
Future<ChangeContainerInstanceCompartmentResponse>	changeContainerInstanceCompartment(ChangeContainerInstanceCompartmentRequest request, AsyncHandler<ChangeContainerInstanceCompartmentRequest,ChangeContainerInstanceCompartmentResponse> handler) Moves a container instance resource from one compartment identifier to another.
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<CreateContainerInstanceResponse>	createContainerInstance(CreateContainerInstanceRequest request, AsyncHandler<CreateContainerInstanceRequest,CreateContainerInstanceResponse> handler) Creates a container instance and deploys the containers on it.
Future<DeleteContainerInstanceResponse>	deleteContainerInstance(DeleteContainerInstanceRequest request, AsyncHandler<DeleteContainerInstanceRequest,DeleteContainerInstanceResponse> handler) Deletes a container instance and its containers.
String	getClientCommonLibraryVersion()
Future<GetContainerResponse>	getContainer(GetContainerRequest request, AsyncHandler<GetContainerRequest,GetContainerResponse> handler) Get details about a single container by the container ID.
Future<GetContainerInstanceResponse>	getContainerInstance(GetContainerInstanceRequest request, AsyncHandler<GetContainerInstanceRequest,GetContainerInstanceResponse> handler) Gets information about the specified container instance.
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
Future<GetWorkRequestResponse>	getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler) Gets the status of the work request with the given ID.
Future<ListContainerInstancesResponse>	listContainerInstances(ListContainerInstancesRequest request, AsyncHandler<ListContainerInstancesRequest,ListContainerInstancesResponse> handler) Returns a list of container instances.
Future<ListContainerInstanceShapesResponse>	listContainerInstanceShapes(ListContainerInstanceShapesRequest request, AsyncHandler<ListContainerInstanceShapesRequest,ListContainerInstanceShapesResponse> handler) Lists the shapes that can be used to create container instances.
Future<ListContainersResponse>	listContainers(ListContainersRequest request, AsyncHandler<ListContainersRequest,ListContainersResponse> handler) Returns a list of containers in a compartment.
Future<ListWorkRequestErrorsResponse>	listWorkRequestErrors(ListWorkRequestErrorsRequest request, AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler) Returns a paginated list of errors for a work request.
Future<ListWorkRequestLogsResponse>	listWorkRequestLogs(ListWorkRequestLogsRequest request, AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler) Returns a paginated list of logs for a work request.
Future<ListWorkRequestsResponse>	listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler) Lists the work requests in a 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.
Future<RestartContainerInstanceResponse>	restartContainerInstance(RestartContainerInstanceRequest request, AsyncHandler<RestartContainerInstanceRequest,RestartContainerInstanceResponse> handler) Restarts a container instance.
Future<RetrieveLogsResponse>	retrieveLogs(RetrieveLogsRequest request, AsyncHandler<RetrieveLogsRequest,RetrieveLogsResponse> handler) Returns the most recent 256 KB of logs from the specified container.
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<StartContainerInstanceResponse>	startContainerInstance(StartContainerInstanceRequest request, AsyncHandler<StartContainerInstanceRequest,StartContainerInstanceResponse> handler) Starts a container instance if it is "inactive".
Future<StopContainerInstanceResponse>	stopContainerInstance(StopContainerInstanceRequest request, AsyncHandler<StopContainerInstanceRequest,StopContainerInstanceResponse> handler) Stops a container instance if it is "active".
void	updateBaseEndpoint(String endpoint) This method should be used for parameterized endpoint templates only.
Future<UpdateContainerResponse>	updateContainer(UpdateContainerRequest request, AsyncHandler<UpdateContainerRequest,UpdateContainerResponse> handler) Updates a container.
Future<UpdateContainerInstanceResponse>	updateContainerInstance(UpdateContainerInstanceRequest request, AsyncHandler<UpdateContainerInstanceRequest,UpdateContainerInstanceResponse> handler) Updates a container instance.
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 com.oracle.bmc.containerinstances.ContainerInstanceAsync

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for ContainerInstance.

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

ContainerInstanceAsyncClient

@Deprecated
public ContainerInstanceAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

ContainerInstanceAsyncClient

@Deprecated
public ContainerInstanceAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                                ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

ContainerInstanceAsyncClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

ContainerInstanceAsyncClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

ContainerInstanceAsyncClient

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

ContainerInstanceAsyncClient

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

ContainerInstanceAsyncClient

@Deprecated
public ContainerInstanceAsyncClient(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 ContainerInstanceAsyncClient.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 ContainerInstanceAsyncClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: ContainerInstanceAsync

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 ContainerInstanceAsync

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: ContainerInstanceAsync

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 ContainerInstanceAsync

Parameters:

regionId - The public region ID.

changeContainerInstanceCompartment

public Future<ChangeContainerInstanceCompartmentResponse> changeContainerInstanceCompartment(ChangeContainerInstanceCompartmentRequest request,
                                                                                             AsyncHandler<ChangeContainerInstanceCompartmentRequest,ChangeContainerInstanceCompartmentResponse> handler)

Description copied from interface: ContainerInstanceAsync

Moves a container instance resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.

Specified by:

changeContainerInstanceCompartment in interface ContainerInstanceAsync

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.

createContainerInstance

public Future<CreateContainerInstanceResponse> createContainerInstance(CreateContainerInstanceRequest request,
                                                                       AsyncHandler<CreateContainerInstanceRequest,CreateContainerInstanceResponse> handler)

Description copied from interface: ContainerInstanceAsync

Creates a container instance and deploys the containers on it.

Specified by:

createContainerInstance in interface ContainerInstanceAsync

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.

deleteContainerInstance

public Future<DeleteContainerInstanceResponse> deleteContainerInstance(DeleteContainerInstanceRequest request,
                                                                       AsyncHandler<DeleteContainerInstanceRequest,DeleteContainerInstanceResponse> handler)

Description copied from interface: ContainerInstanceAsync

Deletes a container instance and its containers.

Specified by:

deleteContainerInstance in interface ContainerInstanceAsync

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.

getContainer

public Future<GetContainerResponse> getContainer(GetContainerRequest request,
                                                 AsyncHandler<GetContainerRequest,GetContainerResponse> handler)

Description copied from interface: ContainerInstanceAsync

Get details about a single container by the container ID.

Specified by:

getContainer in interface ContainerInstanceAsync

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.

getContainerInstance

public Future<GetContainerInstanceResponse> getContainerInstance(GetContainerInstanceRequest request,
                                                                 AsyncHandler<GetContainerInstanceRequest,GetContainerInstanceResponse> handler)

Description copied from interface: ContainerInstanceAsync

Gets information about the specified container instance.

Specified by:

getContainerInstance in interface ContainerInstanceAsync

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: ContainerInstanceAsync

Gets the status of the work request with the given ID.

Specified by:

getWorkRequest in interface ContainerInstanceAsync

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.

listContainerInstanceShapes

public Future<ListContainerInstanceShapesResponse> listContainerInstanceShapes(ListContainerInstanceShapesRequest request,
                                                                               AsyncHandler<ListContainerInstanceShapesRequest,ListContainerInstanceShapesResponse> handler)

Description copied from interface: ContainerInstanceAsync

Lists the shapes that can be used to create container instances.

Specified by:

listContainerInstanceShapes in interface ContainerInstanceAsync

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.

listContainerInstances

public Future<ListContainerInstancesResponse> listContainerInstances(ListContainerInstancesRequest request,
                                                                     AsyncHandler<ListContainerInstancesRequest,ListContainerInstancesResponse> handler)

Description copied from interface: ContainerInstanceAsync

Returns a list of container instances.

Specified by:

listContainerInstances in interface ContainerInstanceAsync

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.

listContainers

public Future<ListContainersResponse> listContainers(ListContainersRequest request,
                                                     AsyncHandler<ListContainersRequest,ListContainersResponse> handler)

Description copied from interface: ContainerInstanceAsync

Returns a list of containers in a compartment.

Specified by:

listContainers in interface ContainerInstanceAsync

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: ContainerInstanceAsync

Returns a paginated list of errors for a work request.

Specified by:

listWorkRequestErrors in interface ContainerInstanceAsync

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: ContainerInstanceAsync

Returns a paginated list of logs for a work request.

Specified by:

listWorkRequestLogs in interface ContainerInstanceAsync

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: ContainerInstanceAsync

Lists the work requests in a compartment.

Specified by:

listWorkRequests in interface ContainerInstanceAsync

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.

restartContainerInstance

public Future<RestartContainerInstanceResponse> restartContainerInstance(RestartContainerInstanceRequest request,
                                                                         AsyncHandler<RestartContainerInstanceRequest,RestartContainerInstanceResponse> handler)

Description copied from interface: ContainerInstanceAsync

Restarts a container instance. When provided, If-Match is checked against ETag values of the container instance.

Specified by:

restartContainerInstance in interface ContainerInstanceAsync

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.

retrieveLogs

public Future<RetrieveLogsResponse> retrieveLogs(RetrieveLogsRequest request,
                                                 AsyncHandler<RetrieveLogsRequest,RetrieveLogsResponse> handler)

Description copied from interface: ContainerInstanceAsync

Returns the most recent 256 KB of logs from the specified container.

Specified by:

retrieveLogs in interface ContainerInstanceAsync

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.

startContainerInstance

public Future<StartContainerInstanceResponse> startContainerInstance(StartContainerInstanceRequest request,
                                                                     AsyncHandler<StartContainerInstanceRequest,StartContainerInstanceResponse> handler)

Description copied from interface: ContainerInstanceAsync

Starts a container instance if it is "inactive". No effect otherwise. When provided, If-Match is checked against ETag values of the container instance.

Specified by:

startContainerInstance in interface ContainerInstanceAsync

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.

stopContainerInstance

public Future<StopContainerInstanceResponse> stopContainerInstance(StopContainerInstanceRequest request,
                                                                   AsyncHandler<StopContainerInstanceRequest,StopContainerInstanceResponse> handler)

Description copied from interface: ContainerInstanceAsync

Stops a container instance if it is "active". No effect otherwise. When provided, If-Match is checked against ETag values of the container instance.

Specified by:

stopContainerInstance in interface ContainerInstanceAsync

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.

updateContainer

public Future<UpdateContainerResponse> updateContainer(UpdateContainerRequest request,
                                                       AsyncHandler<UpdateContainerRequest,UpdateContainerResponse> handler)

Description copied from interface: ContainerInstanceAsync

Updates a container.

Specified by:

updateContainer in interface ContainerInstanceAsync

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.

updateContainerInstance

public Future<UpdateContainerInstanceResponse> updateContainerInstance(UpdateContainerInstanceRequest request,
                                                                       AsyncHandler<UpdateContainerInstanceRequest,UpdateContainerInstanceResponse> handler)

Description copied from interface: ContainerInstanceAsync

Updates a container instance.

Specified by:

updateContainerInstance in interface ContainerInstanceAsync

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)