ContainerInstanceAsync (Oracle Cloud Infrastructure Java SDK

All Superinterfaces:: AutoCloseable

All Known Implementing Classes:: ContainerInstanceAsyncClient

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20210415")
public interface ContainerInstanceAsync
extends AutoCloseable

A description of the Container Instance API

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Future<ChangeContainerInstanceCompartmentResponse>`	`changeContainerInstanceCompartment(ChangeContainerInstanceCompartmentRequest request, AsyncHandler<ChangeContainerInstanceCompartmentRequest,ChangeContainerInstanceCompartmentResponse> handler)` Moves a ContainerInstance resource from one compartment identifier to another.
`Future<CreateContainerInstanceResponse>`	`createContainerInstance(CreateContainerInstanceRequest request, AsyncHandler<CreateContainerInstanceRequest,CreateContainerInstanceResponse> handler)` Creates a new ContainerInstance.
`Future<DeleteContainerInstanceResponse>`	`deleteContainerInstance(DeleteContainerInstanceRequest request, AsyncHandler<DeleteContainerInstanceRequest,DeleteContainerInstanceResponse> handler)` Deletes a ContainerInstance resource by identifier
`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 a ContainerInstance by identifier
`String`	`getEndpoint()` Gets the set endpoint for REST call (ex, https://www.example.com)
`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 ContainerInstances.
`Future<ListContainerInstanceShapesResponse>`	`listContainerInstanceShapes(ListContainerInstanceShapesRequest request, AsyncHandler<ListContainerInstanceShapesRequest,ListContainerInstanceShapesResponse> handler)` Get a list of shapes for creating Container Instances and their details.
`Future<ListContainersResponse>`	`listContainers(ListContainersRequest request, AsyncHandler<ListContainersRequest,ListContainersResponse> handler)` Return a list of Containers.
`Future<ListWorkRequestErrorsResponse>`	`listWorkRequestErrors(ListWorkRequestErrorsRequest request, AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)` Return a (paginated) list of errors for a given work request.
`Future<ListWorkRequestLogsResponse>`	`listWorkRequestLogs(ListWorkRequestLogsRequest request, AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)` Return a (paginated) list of logs for a given work request.
`Future<ListWorkRequestsResponse>`	`listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)` Lists the work requests in a compartment.
`void`	`refreshClient()` Rebuilds the client from scratch.
`Future<RestartContainerInstanceResponse>`	`restartContainerInstance(RestartContainerInstanceRequest request, AsyncHandler<RestartContainerInstanceRequest,RestartContainerInstanceResponse> handler)` Restarts a container instance.
`Future<RetrieveLogsResponse>`	`retrieveLogs(RetrieveLogsRequest request, AsyncHandler<RetrieveLogsRequest,RetrieveLogsResponse> handler)` Retrieve recent log from a single container by the container ID up to 256KB.
`void`	`setEndpoint(String endpoint)` Sets the endpoint to call (ex, https://www.example.com).
`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".
`Future<UpdateContainerResponse>`	`updateContainer(UpdateContainerRequest request, AsyncHandler<UpdateContainerRequest,UpdateContainerResponse> handler)` Update a Container.
`Future<UpdateContainerInstanceResponse>`	`updateContainerInstance(UpdateContainerInstanceRequest request, AsyncHandler<UpdateContainerInstanceRequest,UpdateContainerInstanceResponse> handler)` Updates the ContainerInstance
`void`	`useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)` Determines whether realm specific endpoint should be used or not.

Methods inherited from interface java.lang.AutoCloseable
close

- Method Detail
  - refreshClient
```
void refreshClient()
```
    Rebuilds the client from scratch. Useful to refresh certificates.
  - setEndpoint
```
void setEndpoint(String endpoint)
```
    Sets the endpoint to call (ex, https://www.example.com).
    
    Parameters:
    
    endpoint - The endpoint of the serice.
  - getEndpoint
```
String getEndpoint()
```
    Gets the set endpoint for REST call (ex, https://www.example.com)
  - setRegion
```
void setRegion(Region region)
```
    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.
    
    Parameters:
    
    region - The region of the service.
  - setRegion
```
void setRegion(String regionId)
```
    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.
    
    Parameters:
    
    regionId - The public region ID.
  - useRealmSpecificEndpointTemplate
```
void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)
```
    Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”
    
    Parameters:
    
    realmSpecificEndpointTemplateEnabled - flag to enable the use of realm specific endpoint template
  - changeContainerInstanceCompartment
```
Future<ChangeContainerInstanceCompartmentResponse> changeContainerInstanceCompartment(ChangeContainerInstanceCompartmentRequest request,
                                                                                      AsyncHandler<ChangeContainerInstanceCompartmentRequest,ChangeContainerInstanceCompartmentResponse> handler)
```
    Moves a ContainerInstance resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.
    
    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
```
Future<CreateContainerInstanceResponse> createContainerInstance(CreateContainerInstanceRequest request,
                                                                AsyncHandler<CreateContainerInstanceRequest,CreateContainerInstanceResponse> handler)
```
    Creates a new ContainerInstance.
    
    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
```
Future<DeleteContainerInstanceResponse> deleteContainerInstance(DeleteContainerInstanceRequest request,
                                                                AsyncHandler<DeleteContainerInstanceRequest,DeleteContainerInstanceResponse> handler)
```
    Deletes a ContainerInstance resource by identifier
    
    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
```
Future<GetContainerResponse> getContainer(GetContainerRequest request,
                                          AsyncHandler<GetContainerRequest,GetContainerResponse> handler)
```
    Get details about a single container by the container ID.
    
    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
```
Future<GetContainerInstanceResponse> getContainerInstance(GetContainerInstanceRequest request,
                                                          AsyncHandler<GetContainerInstanceRequest,GetContainerInstanceResponse> handler)
```
    Gets a ContainerInstance by identifier
    
    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
```
Future<GetWorkRequestResponse> getWorkRequest(GetWorkRequestRequest request,
                                              AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)
```
    Gets the status of the work request with the given ID.
    
    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
```
Future<ListContainerInstanceShapesResponse> listContainerInstanceShapes(ListContainerInstanceShapesRequest request,
                                                                        AsyncHandler<ListContainerInstanceShapesRequest,ListContainerInstanceShapesResponse> handler)
```
    Get a list of shapes for creating Container Instances and their details.
    
    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
```
Future<ListContainerInstancesResponse> listContainerInstances(ListContainerInstancesRequest request,
                                                              AsyncHandler<ListContainerInstancesRequest,ListContainerInstancesResponse> handler)
```
    Returns a list of ContainerInstances.
    
    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
```
Future<ListContainersResponse> listContainers(ListContainersRequest request,
                                              AsyncHandler<ListContainersRequest,ListContainersResponse> handler)
```
    Return a list of Containers.
    
    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
```
Future<ListWorkRequestErrorsResponse> listWorkRequestErrors(ListWorkRequestErrorsRequest request,
                                                            AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)
```
    Return a (paginated) list of errors for a given work request.
    
    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
```
Future<ListWorkRequestLogsResponse> listWorkRequestLogs(ListWorkRequestLogsRequest request,
                                                        AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)
```
    Return a (paginated) list of logs for a given work request.
    
    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
```
Future<ListWorkRequestsResponse> listWorkRequests(ListWorkRequestsRequest request,
                                                  AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)
```
    Lists the work requests in a compartment.
    
    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
```
Future<RestartContainerInstanceResponse> restartContainerInstance(RestartContainerInstanceRequest request,
                                                                  AsyncHandler<RestartContainerInstanceRequest,RestartContainerInstanceResponse> handler)
```
    Restarts a container instance. When provided, If-Match is checked against ETag values of the container instance.
    
    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
```
Future<RetrieveLogsResponse> retrieveLogs(RetrieveLogsRequest request,
                                          AsyncHandler<RetrieveLogsRequest,RetrieveLogsResponse> handler)
```
    Retrieve recent log from a single container by the container ID up to 256KB.
    
    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
```
Future<StartContainerInstanceResponse> startContainerInstance(StartContainerInstanceRequest request,
                                                              AsyncHandler<StartContainerInstanceRequest,StartContainerInstanceResponse> handler)
```
    Starts a container instance if it is "inactive". No effect otherwise. When provided, If-Match is checked against ETag values of the container instance.
    
    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
```
Future<StopContainerInstanceResponse> stopContainerInstance(StopContainerInstanceRequest request,
                                                            AsyncHandler<StopContainerInstanceRequest,StopContainerInstanceResponse> handler)
```
    Stops a container instance if it is "active". No effect otherwise. When provided, If-Match is checked against ETag values of the container instance.
    
    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
```
Future<UpdateContainerResponse> updateContainer(UpdateContainerRequest request,
                                                AsyncHandler<UpdateContainerRequest,UpdateContainerResponse> handler)
```
    Update a Container.
    
    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
```
Future<UpdateContainerInstanceResponse> updateContainerInstance(UpdateContainerInstanceRequest request,
                                                                AsyncHandler<UpdateContainerInstanceRequest,UpdateContainerInstanceResponse> handler)
```
    Updates the ContainerInstance
    
    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.

Interface ContainerInstanceAsync

Method Summary

Methods inherited from interface java.lang.AutoCloseable

Method Detail

refreshClient

setEndpoint

getEndpoint

setRegion

setRegion

useRealmSpecificEndpointTemplate

changeContainerInstanceCompartment

createContainerInstance

deleteContainerInstance

getContainer

getContainerInstance

getWorkRequest

listContainerInstanceShapes

listContainerInstances

listContainers

listWorkRequestErrors

listWorkRequestLogs

listWorkRequests

restartContainerInstance

retrieveLogs

startContainerInstance

stopContainerInstance

updateContainer

updateContainerInstance