ContainerEngineAsync (Oracle Cloud Infrastructure Java SDK

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

ContainerEngineAsyncClient
```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20180222")
public interface ContainerEngineAsync
extends AutoCloseable
```
API for the Container Engine for Kubernetes service. Use this API to build, deploy, and manage cloud-native applications. For more information, see Overview of Container Engine for Kubernetes.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Future<ClusterMigrateToNativeVcnResponse>`	`clusterMigrateToNativeVcn(ClusterMigrateToNativeVcnRequest request, AsyncHandler<ClusterMigrateToNativeVcnRequest,ClusterMigrateToNativeVcnResponse> handler)` Initiates cluster migration to use native VCN.
`Future<CreateClusterResponse>`	`createCluster(CreateClusterRequest request, AsyncHandler<CreateClusterRequest,CreateClusterResponse> handler)` Create a new cluster.
`Future<CreateKubeconfigResponse>`	`createKubeconfig(CreateKubeconfigRequest request, AsyncHandler<CreateKubeconfigRequest,CreateKubeconfigResponse> handler)` Create the Kubeconfig YAML for a cluster.
`Future<CreateNodePoolResponse>`	`createNodePool(CreateNodePoolRequest request, AsyncHandler<CreateNodePoolRequest,CreateNodePoolResponse> handler)` Create a new node pool.
`Future<DeleteClusterResponse>`	`deleteCluster(DeleteClusterRequest request, AsyncHandler<DeleteClusterRequest,DeleteClusterResponse> handler)` Delete a cluster.
`Future<DeleteNodePoolResponse>`	`deleteNodePool(DeleteNodePoolRequest request, AsyncHandler<DeleteNodePoolRequest,DeleteNodePoolResponse> handler)` Delete a node pool.
`Future<DeleteWorkRequestResponse>`	`deleteWorkRequest(DeleteWorkRequestRequest request, AsyncHandler<DeleteWorkRequestRequest,DeleteWorkRequestResponse> handler)` Cancel a work request that has not started.
`Future<GetClusterResponse>`	`getCluster(GetClusterRequest request, AsyncHandler<GetClusterRequest,GetClusterResponse> handler)` Get the details of a cluster.
`Future<GetClusterMigrateToNativeVcnStatusResponse>`	`getClusterMigrateToNativeVcnStatus(GetClusterMigrateToNativeVcnStatusRequest request, AsyncHandler<GetClusterMigrateToNativeVcnStatusRequest,GetClusterMigrateToNativeVcnStatusResponse> handler)` Get details on a cluster’s migration to native VCN.
`Future<GetClusterOptionsResponse>`	`getClusterOptions(GetClusterOptionsRequest request, AsyncHandler<GetClusterOptionsRequest,GetClusterOptionsResponse> handler)` Get options available for clusters.
`String`	`getEndpoint()` Gets the set endpoint for REST call (ex, https://www.example.com)
`Future<GetNodePoolResponse>`	`getNodePool(GetNodePoolRequest request, AsyncHandler<GetNodePoolRequest,GetNodePoolResponse> handler)` Get the details of a node pool.
`Future<GetNodePoolOptionsResponse>`	`getNodePoolOptions(GetNodePoolOptionsRequest request, AsyncHandler<GetNodePoolOptionsRequest,GetNodePoolOptionsResponse> handler)` Get options available for node pools.
`Future<GetWorkRequestResponse>`	`getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)` Get the details of a work request.
`Future<ListClustersResponse>`	`listClusters(ListClustersRequest request, AsyncHandler<ListClustersRequest,ListClustersResponse> handler)` List all the cluster objects in a compartment.
`Future<ListNodePoolsResponse>`	`listNodePools(ListNodePoolsRequest request, AsyncHandler<ListNodePoolsRequest,ListNodePoolsResponse> handler)` List all the node pools in a compartment, and optionally filter by cluster.
`Future<ListWorkRequestErrorsResponse>`	`listWorkRequestErrors(ListWorkRequestErrorsRequest request, AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)` Get the errors of a work request.
`Future<ListWorkRequestLogsResponse>`	`listWorkRequestLogs(ListWorkRequestLogsRequest request, AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)` Get the logs of a work request.
`Future<ListWorkRequestsResponse>`	`listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)` List all work requests in a compartment.
`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<UpdateClusterResponse>`	`updateCluster(UpdateClusterRequest request, AsyncHandler<UpdateClusterRequest,UpdateClusterResponse> handler)` Update the details of a cluster.
`Future<UpdateClusterEndpointConfigResponse>`	`updateClusterEndpointConfig(UpdateClusterEndpointConfigRequest request, AsyncHandler<UpdateClusterEndpointConfigRequest,UpdateClusterEndpointConfigResponse> handler)` Update the details of the cluster endpoint configuration.
`Future<UpdateNodePoolResponse>`	`updateNodePool(UpdateNodePoolRequest request, AsyncHandler<UpdateNodePoolRequest,UpdateNodePoolResponse> handler)` Update the details of a node pool.

Methods inherited from interface java.lang.AutoCloseable
close

- Method Detail
  - 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.
  - clusterMigrateToNativeVcn
```
Future<ClusterMigrateToNativeVcnResponse> clusterMigrateToNativeVcn(ClusterMigrateToNativeVcnRequest request,
                                                                    AsyncHandler<ClusterMigrateToNativeVcnRequest,ClusterMigrateToNativeVcnResponse> handler)
```
    Initiates cluster migration to use native VCN.
    
    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.
  - createCluster
```
Future<CreateClusterResponse> createCluster(CreateClusterRequest request,
                                            AsyncHandler<CreateClusterRequest,CreateClusterResponse> handler)
```
    Create a new cluster.
    
    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.
  - createKubeconfig
```
Future<CreateKubeconfigResponse> createKubeconfig(CreateKubeconfigRequest request,
                                                  AsyncHandler<CreateKubeconfigRequest,CreateKubeconfigResponse> handler)
```
    Create the Kubeconfig YAML for a cluster.
    
    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.
  - createNodePool
```
Future<CreateNodePoolResponse> createNodePool(CreateNodePoolRequest request,
                                              AsyncHandler<CreateNodePoolRequest,CreateNodePoolResponse> handler)
```
    Create a new node pool.
    
    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.
  - deleteCluster
```
Future<DeleteClusterResponse> deleteCluster(DeleteClusterRequest request,
                                            AsyncHandler<DeleteClusterRequest,DeleteClusterResponse> handler)
```
    Delete a cluster.
    
    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.
  - deleteNodePool
```
Future<DeleteNodePoolResponse> deleteNodePool(DeleteNodePoolRequest request,
                                              AsyncHandler<DeleteNodePoolRequest,DeleteNodePoolResponse> handler)
```
    Delete a node pool.
    
    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.
  - deleteWorkRequest
```
Future<DeleteWorkRequestResponse> deleteWorkRequest(DeleteWorkRequestRequest request,
                                                    AsyncHandler<DeleteWorkRequestRequest,DeleteWorkRequestResponse> handler)
```
    Cancel a work request that has not started.
    
    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.
  - getCluster
```
Future<GetClusterResponse> getCluster(GetClusterRequest request,
                                      AsyncHandler<GetClusterRequest,GetClusterResponse> handler)
```
    Get the details of a cluster.
    
    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.
  - getClusterMigrateToNativeVcnStatus
```
Future<GetClusterMigrateToNativeVcnStatusResponse> getClusterMigrateToNativeVcnStatus(GetClusterMigrateToNativeVcnStatusRequest request,
                                                                                      AsyncHandler<GetClusterMigrateToNativeVcnStatusRequest,GetClusterMigrateToNativeVcnStatusResponse> handler)
```
    Get details on a cluster’s migration to native VCN.
    
    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.
  - getClusterOptions
```
Future<GetClusterOptionsResponse> getClusterOptions(GetClusterOptionsRequest request,
                                                    AsyncHandler<GetClusterOptionsRequest,GetClusterOptionsResponse> handler)
```
    Get options available for clusters.
    
    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.
  - getNodePool
```
Future<GetNodePoolResponse> getNodePool(GetNodePoolRequest request,
                                        AsyncHandler<GetNodePoolRequest,GetNodePoolResponse> handler)
```
    Get the details of a node pool.
    
    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.
  - getNodePoolOptions
```
Future<GetNodePoolOptionsResponse> getNodePoolOptions(GetNodePoolOptionsRequest request,
                                                      AsyncHandler<GetNodePoolOptionsRequest,GetNodePoolOptionsResponse> handler)
```
    Get options available for node pools.
    
    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)
```
    Get the details of a 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.
  - listClusters
```
Future<ListClustersResponse> listClusters(ListClustersRequest request,
                                          AsyncHandler<ListClustersRequest,ListClustersResponse> handler)
```
    List all the cluster objects 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.
  - listNodePools
```
Future<ListNodePoolsResponse> listNodePools(ListNodePoolsRequest request,
                                            AsyncHandler<ListNodePoolsRequest,ListNodePoolsResponse> handler)
```
    List all the node pools in a compartment, and optionally filter by cluster.
    
    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)
```
    Get the errors of a 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)
```
    Get the logs of a 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)
```
    List all 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.
  - updateCluster
```
Future<UpdateClusterResponse> updateCluster(UpdateClusterRequest request,
                                            AsyncHandler<UpdateClusterRequest,UpdateClusterResponse> handler)
```
    Update the details of a cluster.
    
    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.
  - updateClusterEndpointConfig
```
Future<UpdateClusterEndpointConfigResponse> updateClusterEndpointConfig(UpdateClusterEndpointConfigRequest request,
                                                                        AsyncHandler<UpdateClusterEndpointConfigRequest,UpdateClusterEndpointConfigResponse> handler)
```
    Update the details of the cluster endpoint configuration.
    
    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.
  - updateNodePool
```
Future<UpdateNodePoolResponse> updateNodePool(UpdateNodePoolRequest request,
                                              AsyncHandler<UpdateNodePoolRequest,UpdateNodePoolResponse> handler)
```
    Update the details of a node pool.
    
    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 ContainerEngineAsync

Method Summary

Methods inherited from interface java.lang.AutoCloseable

Method Detail

setEndpoint

getEndpoint

setRegion

setRegion

clusterMigrateToNativeVcn

createCluster

createKubeconfig

createNodePool

deleteCluster

deleteNodePool

deleteWorkRequest

getCluster

getClusterMigrateToNativeVcnStatus

getClusterOptions

getNodePool

getNodePoolOptions

getWorkRequest

listClusters

listNodePools

listWorkRequestErrors

listWorkRequestLogs

listWorkRequests

updateCluster

updateClusterEndpointConfig

updateNodePool