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 SummaryNested Classes Modifier and Type Class Description static classContainerInstanceClient.BuilderBuilder class for this client.
 - 
Field SummaryFields Modifier and Type Field Description StringclientCommonLibraryVersionCompatible SDK version, provided by the codegen.Optional<String>minimumClientCommonLibraryVersionFromClientMinimum compatible SDK version, maybe provided by the codegen.static ServiceSERVICEService instance for ContainerInstance.
 - 
Constructor SummaryConstructors Constructor Description ContainerInstanceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)Deprecated.Use thebuilderinstead.ContainerInstanceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)Deprecated.Use thebuilderinstead.ContainerInstanceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.ContainerInstanceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.ContainerInstanceClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)Deprecated.Use thebuilderinstead.ContainerInstanceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)Deprecated.Use thebuilderinstead.ContainerInstanceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)Deprecated.Use thebuilderinstead.ContainerInstanceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)Deprecated.Use thebuilderinstead.
 - 
Method SummaryAll Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ContainerInstanceClient.Builderbuilder()Create a builder for this client.ChangeContainerInstanceCompartmentResponsechangeContainerInstanceCompartment(ChangeContainerInstanceCompartmentRequest request)Moves a container instance resource from one compartment identifier to another.voidclose()CreateContainerInstanceResponsecreateContainerInstance(CreateContainerInstanceRequest request)Creates a container instance and deploys the containers on it.DeleteContainerInstanceResponsedeleteContainerInstance(DeleteContainerInstanceRequest request)Deletes a container instance and its containers.StringgetClientCommonLibraryVersion()GetContainerResponsegetContainer(GetContainerRequest request)Get details about a single container by the container ID.GetContainerInstanceResponsegetContainerInstance(GetContainerInstanceRequest request)Gets information about the specified container instance.protected ClientConfiguratorgetDefaultConfigurator()StringgetEndpoint()Optional<String>getMinimumClientCommonLibraryVersionFromClient()ContainerInstancePaginatorsgetPaginators()Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.ContainerInstanceWaitersgetWaiters()Gets the pre-configured waiters available for resources for this service.GetWorkRequestResponsegetWorkRequest(GetWorkRequestRequest request)Gets the status of the work request with the given ID.ListContainerInstancesResponselistContainerInstances(ListContainerInstancesRequest request)Returns a list of container instances.ListContainerInstanceShapesResponselistContainerInstanceShapes(ListContainerInstanceShapesRequest request)Lists the shapes that can be used to create container instances.ListContainersResponselistContainers(ListContainersRequest request)Returns a list of containers in a compartment.ListWorkRequestErrorsResponselistWorkRequestErrors(ListWorkRequestErrorsRequest request)Returns a paginated list of errors for a work request.ListWorkRequestLogsResponselistWorkRequestLogs(ListWorkRequestLogsRequest request)Returns a paginated list of logs for a work request.ListWorkRequestsResponselistWorkRequests(ListWorkRequestsRequest request)Lists the work requests in a compartment.voidpopulateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)Populate the parameters in the endpoint with its corresponding value and update the base endpoint.voidrefreshClient()Rebuild the backingHttpClient.RestartContainerInstanceResponserestartContainerInstance(RestartContainerInstanceRequest request)Restarts a container instance.RetrieveLogsResponseretrieveLogs(RetrieveLogsRequest request)Returns the most recent 256 KB of logs from the specified container.voidsetEndpoint(String endpoint)voidsetRegion(Region region)Sets the region to call (ex, Region.US_PHOENIX_1).voidsetRegion(String regionId)Sets the region to call (ex, ‘us-phoenix-1’).StartContainerInstanceResponsestartContainerInstance(StartContainerInstanceRequest request)Starts a container instance if it is "inactive".StopContainerInstanceResponsestopContainerInstance(StopContainerInstanceRequest request)Stops a container instance if it is "active".voidupdateBaseEndpoint(String endpoint)This method should be used for parameterized endpoint templates only.UpdateContainerResponseupdateContainer(UpdateContainerRequest request)Updates a container.UpdateContainerInstanceResponseupdateContainerInstance(UpdateContainerInstanceRequest request)Updates a container instance.voiduseRealmSpecificEndpointTemplate(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.BaseSyncClientclientCall
 - 
Methods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 - 
Methods inherited from interface java.lang.AutoCloseableclose
 - 
Methods inherited from interface com.oracle.bmc.containerinstances.ContainerInstancegetEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
 
- 
 
- 
- 
- 
Constructor Detail- 
ContainerInstanceClient@Deprecated public ContainerInstanceClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Deprecated.Use thebuilderinstead.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 thebuilderinstead.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 thebuilderinstead.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 thebuilderinstead.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 thebuilderinstead.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 thebuilderinstead.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 thebuilderinstead.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 thebuilderinstead.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- 
builderpublic static ContainerInstanceClient.Builder builder() Create a builder for this client.- Returns:
- builder
 
 - 
setRegionpublic void setRegion(Region region) Description copied from interface:ContainerInstanceSets the region to call (ex, Region.US_PHOENIX_1).Note, this will call setEndpointafter resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.- Specified by:
- setRegionin interface- ContainerInstance
- Parameters:
- region- The region of the service.
 
 - 
setRegionpublic void setRegion(String regionId) Description copied from interface:ContainerInstanceSets 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 callsetEndpoint.- Specified by:
- setRegionin interface- ContainerInstance
- Parameters:
- regionId- The public region ID.
 
 - 
changeContainerInstanceCompartmentpublic ChangeContainerInstanceCompartmentResponse changeContainerInstanceCompartment(ChangeContainerInstanceCompartmentRequest request) Description copied from interface:ContainerInstanceMoves a container instance resource from one compartment identifier to another.When provided, If-Match is checked against ETag values of the resource. - Specified by:
- changeContainerInstanceCompartmentin interface- ContainerInstance
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
createContainerInstancepublic CreateContainerInstanceResponse createContainerInstance(CreateContainerInstanceRequest request) Description copied from interface:ContainerInstanceCreates a container instance and deploys the containers on it.- Specified by:
- createContainerInstancein interface- ContainerInstance
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
deleteContainerInstancepublic DeleteContainerInstanceResponse deleteContainerInstance(DeleteContainerInstanceRequest request) Description copied from interface:ContainerInstanceDeletes a container instance and its containers.- Specified by:
- deleteContainerInstancein interface- ContainerInstance
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
getContainerpublic GetContainerResponse getContainer(GetContainerRequest request) Description copied from interface:ContainerInstanceGet details about a single container by the container ID.- Specified by:
- getContainerin interface- ContainerInstance
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
getContainerInstancepublic GetContainerInstanceResponse getContainerInstance(GetContainerInstanceRequest request) Description copied from interface:ContainerInstanceGets information about the specified container instance.- Specified by:
- getContainerInstancein interface- ContainerInstance
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
getWorkRequestpublic GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request) Description copied from interface:ContainerInstanceGets the status of the work request with the given ID.- Specified by:
- getWorkRequestin interface- ContainerInstance
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
listContainerInstanceShapespublic ListContainerInstanceShapesResponse listContainerInstanceShapes(ListContainerInstanceShapesRequest request) Description copied from interface:ContainerInstanceLists the shapes that can be used to create container instances.- Specified by:
- listContainerInstanceShapesin interface- ContainerInstance
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
listContainerInstancespublic ListContainerInstancesResponse listContainerInstances(ListContainerInstancesRequest request) Description copied from interface:ContainerInstanceReturns a list of container instances.- Specified by:
- listContainerInstancesin interface- ContainerInstance
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
listContainerspublic ListContainersResponse listContainers(ListContainersRequest request) Description copied from interface:ContainerInstanceReturns a list of containers in a compartment.- Specified by:
- listContainersin interface- ContainerInstance
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
listWorkRequestErrorspublic ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request) Description copied from interface:ContainerInstanceReturns a paginated list of errors for a work request.- Specified by:
- listWorkRequestErrorsin interface- ContainerInstance
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
listWorkRequestLogspublic ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request) Description copied from interface:ContainerInstanceReturns a paginated list of logs for a work request.- Specified by:
- listWorkRequestLogsin interface- ContainerInstance
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
listWorkRequestspublic ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request) Description copied from interface:ContainerInstanceLists the work requests in a compartment.- Specified by:
- listWorkRequestsin interface- ContainerInstance
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
restartContainerInstancepublic RestartContainerInstanceResponse restartContainerInstance(RestartContainerInstanceRequest request) Description copied from interface:ContainerInstanceRestarts a container instance.When provided, If-Match is checked against ETag values of the container instance. - Specified by:
- restartContainerInstancein interface- ContainerInstance
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
retrieveLogspublic RetrieveLogsResponse retrieveLogs(RetrieveLogsRequest request) Description copied from interface:ContainerInstanceReturns the most recent 256 KB of logs from the specified container.- Specified by:
- retrieveLogsin interface- ContainerInstance
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
startContainerInstancepublic StartContainerInstanceResponse startContainerInstance(StartContainerInstanceRequest request) Description copied from interface:ContainerInstanceStarts 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:
- startContainerInstancein interface- ContainerInstance
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
stopContainerInstancepublic StopContainerInstanceResponse stopContainerInstance(StopContainerInstanceRequest request) Description copied from interface:ContainerInstanceStops 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:
- stopContainerInstancein interface- ContainerInstance
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
updateContainerpublic UpdateContainerResponse updateContainer(UpdateContainerRequest request) Description copied from interface:ContainerInstanceUpdates a container.- Specified by:
- updateContainerin interface- ContainerInstance
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
updateContainerInstancepublic UpdateContainerInstanceResponse updateContainerInstance(UpdateContainerInstanceRequest request) Description copied from interface:ContainerInstanceUpdates a container instance.- Specified by:
- updateContainerInstancein interface- ContainerInstance
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
getWaiterspublic ContainerInstanceWaiters getWaiters() Description copied from interface:ContainerInstanceGets the pre-configured waiters available for resources for this service.- Specified by:
- getWaitersin interface- ContainerInstance
- Returns:
- The service waiters.
 
 - 
getPaginatorspublic ContainerInstancePaginators getPaginators() Description copied from interface:ContainerInstanceGets the pre-configured paginators available for list operations in this service which may return multiple pages of data.These paginators provide an Iterableinterface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.- Specified by:
- getPaginatorsin interface- ContainerInstance
- Returns:
- The service paginators.
 
 - 
getDefaultConfiguratorprotected ClientConfigurator getDefaultConfigurator() 
 - 
useRealmSpecificEndpointTemplatepublic 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
 
 - 
populateServiceParametersInEndpointpublic 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
 
 - 
updateBaseEndpointpublic 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
 
 - 
setEndpointpublic final void setEndpoint(String endpoint) 
 - 
getEndpointpublic final String getEndpoint() 
 - 
refreshClientpublic final void refreshClient() Rebuild the backingHttpClient.This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.
 - 
closepublic final void close() - Specified by:
- closein interface- AutoCloseable
 
 - 
getClientCommonLibraryVersionpublic String getClientCommonLibraryVersion() 
 
- 
 
-