com.oracle.bmc.containerinstances

Class ContainerInstanceClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.containerinstances.ContainerInstanceClient

All Implemented Interfaces:

ContainerInstance, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20210415")
public class ContainerInstanceClient
extends BaseSyncClient
implements ContainerInstance

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static Service	SERVICE Service instance for ContainerInstance.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static ContainerInstanceClient.Builder	builder() Create a builder for this client.
ChangeContainerInstanceCompartmentResponse	changeContainerInstanceCompartment(ChangeContainerInstanceCompartmentRequest request) Moves a container instance resource from one compartment identifier to another.
void	close()
CreateContainerInstanceResponse	createContainerInstance(CreateContainerInstanceRequest request) Creates a container instance and deploys the containers on it.
DeleteContainerInstanceResponse	deleteContainerInstance(DeleteContainerInstanceRequest request) Deletes a container instance and its containers.
GetContainerResponse	getContainer(GetContainerRequest request) Get details about a single container by the container ID.
GetContainerInstanceResponse	getContainerInstance(GetContainerInstanceRequest request) Gets information about the specified container instance.
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
ContainerInstancePaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
ContainerInstanceWaiters	getWaiters() Gets the pre-configured waiters available for resources for this service.
GetWorkRequestResponse	getWorkRequest(GetWorkRequestRequest request) Gets the status of the work request with the given ID.
ListContainerInstancesResponse	listContainerInstances(ListContainerInstancesRequest request) Returns a list of container instances.
ListContainerInstanceShapesResponse	listContainerInstanceShapes(ListContainerInstanceShapesRequest request) Lists the shapes that can be used to create container instances.
ListContainersResponse	listContainers(ListContainersRequest request) Returns a list of containers in a compartment.
ListWorkRequestErrorsResponse	listWorkRequestErrors(ListWorkRequestErrorsRequest request) Return a paginated list of errors for a given work request.
ListWorkRequestLogsResponse	listWorkRequestLogs(ListWorkRequestLogsRequest request) Return a paginated list of logs for a given work request.
ListWorkRequestsResponse	listWorkRequests(ListWorkRequestsRequest request) 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.
RestartContainerInstanceResponse	restartContainerInstance(RestartContainerInstanceRequest request) Restarts a container instance.
RetrieveLogsResponse	retrieveLogs(RetrieveLogsRequest request) Retrieves recent 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’).
StartContainerInstanceResponse	startContainerInstance(StartContainerInstanceRequest request) Starts a container instance if it is "inactive".
StopContainerInstanceResponse	stopContainerInstance(StopContainerInstanceRequest request) Stops a container instance if it is "active".
void	updateBaseEndpoint(String endpoint) This method should be used for parameterized endpoint templates only.
UpdateContainerResponse	updateContainer(UpdateContainerRequest request) Updates a container.
UpdateContainerInstanceResponse	updateContainerInstance(UpdateContainerInstanceRequest request) 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 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.containerinstances.ContainerInstance

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for ContainerInstance.

Constructor Detail

ContainerInstanceClient

@Deprecated
public ContainerInstanceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

ContainerInstanceClient

@Deprecated
public ContainerInstanceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                           ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

ContainerInstanceClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

ContainerInstanceClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

ContainerInstanceClient

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

ContainerInstanceClient

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

ContainerInstanceClient

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

ContainerInstanceClient

@Deprecated
public ContainerInstanceClient(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 ContainerInstanceClient.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 - ContainerInstanceClient.Builder.executorService

Method Detail

builder

public static ContainerInstanceClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: ContainerInstance

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 ContainerInstance

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: ContainerInstance

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 ContainerInstance

Parameters:

regionId - The public region ID.

changeContainerInstanceCompartment

public ChangeContainerInstanceCompartmentResponse changeContainerInstanceCompartment(ChangeContainerInstanceCompartmentRequest request)

Description copied from interface: ContainerInstance

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 ContainerInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createContainerInstance

public CreateContainerInstanceResponse createContainerInstance(CreateContainerInstanceRequest request)

Description copied from interface: ContainerInstance

Creates a container instance and deploys the containers on it.

Specified by:

createContainerInstance in interface ContainerInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteContainerInstance

public DeleteContainerInstanceResponse deleteContainerInstance(DeleteContainerInstanceRequest request)

Description copied from interface: ContainerInstance

Deletes a container instance and its containers.

Specified by:

deleteContainerInstance in interface ContainerInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getContainer

public GetContainerResponse getContainer(GetContainerRequest request)

Description copied from interface: ContainerInstance

Get details about a single container by the container ID.

Specified by:

getContainer in interface ContainerInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getContainerInstance

public GetContainerInstanceResponse getContainerInstance(GetContainerInstanceRequest request)

Description copied from interface: ContainerInstance

Gets information about the specified container instance.

Specified by:

getContainerInstance in interface ContainerInstance

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

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

Specified by:

getWorkRequest in interface ContainerInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listContainerInstanceShapes

public ListContainerInstanceShapesResponse listContainerInstanceShapes(ListContainerInstanceShapesRequest request)

Description copied from interface: ContainerInstance

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

Specified by:

listContainerInstanceShapes in interface ContainerInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listContainerInstances

public ListContainerInstancesResponse listContainerInstances(ListContainerInstancesRequest request)

Description copied from interface: ContainerInstance

Returns a list of container instances.

Specified by:

listContainerInstances in interface ContainerInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listContainers

public ListContainersResponse listContainers(ListContainersRequest request)

Description copied from interface: ContainerInstance

Returns a list of containers in a compartment.

Specified by:

listContainers in interface ContainerInstance

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

Return a paginated list of errors for a given work request.

Specified by:

listWorkRequestErrors in interface ContainerInstance

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

Return a paginated list of logs for a given work request.

Specified by:

listWorkRequestLogs in interface ContainerInstance

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

Lists the work requests in a compartment.

Specified by:

listWorkRequests in interface ContainerInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

restartContainerInstance

public RestartContainerInstanceResponse restartContainerInstance(RestartContainerInstanceRequest request)

Description copied from interface: ContainerInstance

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

Specified by:

restartContainerInstance in interface ContainerInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

retrieveLogs

public RetrieveLogsResponse retrieveLogs(RetrieveLogsRequest request)

Description copied from interface: ContainerInstance

Retrieves recent logs from the specified container. The most recent 256 KB of logs are returned.

Specified by:

retrieveLogs in interface ContainerInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

startContainerInstance

public StartContainerInstanceResponse startContainerInstance(StartContainerInstanceRequest request)

Description copied from interface: ContainerInstance

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 ContainerInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

stopContainerInstance

public StopContainerInstanceResponse stopContainerInstance(StopContainerInstanceRequest request)

Description copied from interface: ContainerInstance

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 ContainerInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateContainer

public UpdateContainerResponse updateContainer(UpdateContainerRequest request)

Description copied from interface: ContainerInstance

Updates a container.

Specified by:

updateContainer in interface ContainerInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateContainerInstance

public UpdateContainerInstanceResponse updateContainerInstance(UpdateContainerInstanceRequest request)

Description copied from interface: ContainerInstance

Updates a container instance.

Specified by:

updateContainerInstance in interface ContainerInstance

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public ContainerInstanceWaiters getWaiters()

Description copied from interface: ContainerInstance

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

Specified by:

getWaiters in interface ContainerInstance

Returns:

The service waiters.

getPaginators

public ContainerInstancePaginators getPaginators()

Description copied from interface: ContainerInstance

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 ContainerInstance

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