@Generated(value="OracleSDKGenerator", comments="API Version: 20210415") public class ContainerInstanceClient extends BaseSyncClient implements ContainerInstance
Modifier and Type | Class and Description |
---|---|
static class |
ContainerInstanceClient.Builder
Builder class for this client.
|
Modifier and Type | Field and Description |
---|---|
static Service |
SERVICE
Service instance for ContainerInstance.
|
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. |
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.
|
clientCall
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
close
public static final Service SERVICE
Service instance for ContainerInstance.
@Deprecated public ContainerInstanceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see ContainerInstanceClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)@Deprecated public ContainerInstanceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see ContainerInstanceClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
@Deprecated public ContainerInstanceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see ContainerInstanceClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
@Deprecated public ContainerInstanceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
builder
instead.Create a new client instance.
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
@Deprecated public ContainerInstanceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
builder
instead.Create a new client instance.
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
@Deprecated public ContainerInstanceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
builder
instead.Create a new client instance.
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)
@Deprecated public ContainerInstanceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
builder
instead.Create a new client instance.
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
@Deprecated public ContainerInstanceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
builder
instead.Create a new client instance.
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
public static ContainerInstanceClient.Builder builder()
Create a builder for this client.
public void setRegion(Region region)
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.
setRegion
in interface ContainerInstance
region
- The region of the service.public void setRegion(String regionId)
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
.
setRegion
in interface ContainerInstance
regionId
- The public region ID.public ChangeContainerInstanceCompartmentResponse changeContainerInstanceCompartment(ChangeContainerInstanceCompartmentRequest request)
ContainerInstance
Moves a container instance resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.
changeContainerInstanceCompartment
in interface ContainerInstance
request
- The request object containing the details to sendpublic CreateContainerInstanceResponse createContainerInstance(CreateContainerInstanceRequest request)
ContainerInstance
Creates a container instance and deploys the containers on it.
createContainerInstance
in interface ContainerInstance
request
- The request object containing the details to sendpublic DeleteContainerInstanceResponse deleteContainerInstance(DeleteContainerInstanceRequest request)
ContainerInstance
Deletes a container instance and its containers.
deleteContainerInstance
in interface ContainerInstance
request
- The request object containing the details to sendpublic GetContainerResponse getContainer(GetContainerRequest request)
ContainerInstance
Get details about a single container by the container ID.
getContainer
in interface ContainerInstance
request
- The request object containing the details to sendpublic GetContainerInstanceResponse getContainerInstance(GetContainerInstanceRequest request)
ContainerInstance
Gets information about the specified container instance.
getContainerInstance
in interface ContainerInstance
request
- The request object containing the details to sendpublic GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
ContainerInstance
Gets the status of the work request with the given ID.
getWorkRequest
in interface ContainerInstance
request
- The request object containing the details to sendpublic ListContainerInstanceShapesResponse listContainerInstanceShapes(ListContainerInstanceShapesRequest request)
ContainerInstance
Lists the shapes that can be used to create container instances.
listContainerInstanceShapes
in interface ContainerInstance
request
- The request object containing the details to sendpublic ListContainerInstancesResponse listContainerInstances(ListContainerInstancesRequest request)
ContainerInstance
Returns a list of container instances.
listContainerInstances
in interface ContainerInstance
request
- The request object containing the details to sendpublic ListContainersResponse listContainers(ListContainersRequest request)
ContainerInstance
Returns a list of containers in a compartment.
listContainers
in interface ContainerInstance
request
- The request object containing the details to sendpublic ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
ContainerInstance
Return a paginated list of errors for a given work request.
listWorkRequestErrors
in interface ContainerInstance
request
- The request object containing the details to sendpublic ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
ContainerInstance
Return a paginated list of logs for a given work request.
listWorkRequestLogs
in interface ContainerInstance
request
- The request object containing the details to sendpublic ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
ContainerInstance
Lists the work requests in a compartment.
listWorkRequests
in interface ContainerInstance
request
- The request object containing the details to sendpublic RestartContainerInstanceResponse restartContainerInstance(RestartContainerInstanceRequest request)
ContainerInstance
Restarts a container instance. When provided, If-Match is checked against ETag values of the container instance.
restartContainerInstance
in interface ContainerInstance
request
- The request object containing the details to sendpublic RetrieveLogsResponse retrieveLogs(RetrieveLogsRequest request)
ContainerInstance
Retrieves recent logs from the specified container. The most recent 256 KB of logs are returned.
retrieveLogs
in interface ContainerInstance
request
- The request object containing the details to sendpublic StartContainerInstanceResponse startContainerInstance(StartContainerInstanceRequest request)
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.
startContainerInstance
in interface ContainerInstance
request
- The request object containing the details to sendpublic StopContainerInstanceResponse stopContainerInstance(StopContainerInstanceRequest request)
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.
stopContainerInstance
in interface ContainerInstance
request
- The request object containing the details to sendpublic UpdateContainerResponse updateContainer(UpdateContainerRequest request)
ContainerInstance
Updates a container.
updateContainer
in interface ContainerInstance
request
- The request object containing the details to sendpublic UpdateContainerInstanceResponse updateContainerInstance(UpdateContainerInstanceRequest request)
ContainerInstance
Updates a container instance.
updateContainerInstance
in interface ContainerInstance
request
- The request object containing the details to sendpublic ContainerInstanceWaiters getWaiters()
ContainerInstance
Gets the pre-configured waiters available for resources for this service.
getWaiters
in interface ContainerInstance
public ContainerInstancePaginators getPaginators()
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.
getPaginators
in interface ContainerInstance
protected ClientConfigurator getDefaultConfigurator()
public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
useOfRealmSpecificEndpointTemplateEnabled
- This flag can be set to true or false to
enable or disable the use of realm-specific endpoint template respectivelypublic final void populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)
endpoint
- The endpoint template in userequiredParametersMap
- Map of parameter name as key and value set in request path or
query parameter as valuepublic final void updateBaseEndpoint(String endpoint)
endpoint
- The updated endpoint to usepublic final void setEndpoint(String endpoint)
public final String getEndpoint()
public final void refreshClient()
HttpClient
. This will call ClientConfigurator
s again, and
can be used to e.g. refresh the SSL certificate.public final void close()
close
in interface AutoCloseable
Copyright © 2016–2023. All rights reserved.