ContainerEngine (Oracle Cloud Infrastructure Java SDK

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

ContainerEngineClient
```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20180222")
public interface ContainerEngine
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.

This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.

Method Summary

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

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 service.
  - 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
```
ClusterMigrateToNativeVcnResponse clusterMigrateToNativeVcn(ClusterMigrateToNativeVcnRequest request)
```
    Initiates cluster migration to use native VCN.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ClusterMigrateToNativeVcn API.
  - createCluster
```
CreateClusterResponse createCluster(CreateClusterRequest request)
```
    Create a new cluster.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use CreateCluster API.
  - createKubeconfig
```
CreateKubeconfigResponse createKubeconfig(CreateKubeconfigRequest request)
```
    Create the Kubeconfig YAML for a cluster.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use CreateKubeconfig API.
  - createNodePool
```
CreateNodePoolResponse createNodePool(CreateNodePoolRequest request)
```
    Create a new node pool.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use CreateNodePool API.
  - deleteCluster
```
DeleteClusterResponse deleteCluster(DeleteClusterRequest request)
```
    Delete a cluster.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use DeleteCluster API.
  - deleteNode
```
DeleteNodeResponse deleteNode(DeleteNodeRequest request)
```
    Delete node.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use DeleteNode API.
  - deleteNodePool
```
DeleteNodePoolResponse deleteNodePool(DeleteNodePoolRequest request)
```
    Delete a node pool.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use DeleteNodePool API.
  - deleteWorkRequest
```
DeleteWorkRequestResponse deleteWorkRequest(DeleteWorkRequestRequest request)
```
    Cancel a work request that has not started.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use DeleteWorkRequest API.
  - getCluster
```
GetClusterResponse getCluster(GetClusterRequest request)
```
    Get the details of a cluster.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use GetCluster API.
  - getClusterMigrateToNativeVcnStatus
```
GetClusterMigrateToNativeVcnStatusResponse getClusterMigrateToNativeVcnStatus(GetClusterMigrateToNativeVcnStatusRequest request)
```
    Get details on a cluster’s migration to native VCN.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use GetClusterMigrateToNativeVcnStatus API.
  - getClusterOptions
```
GetClusterOptionsResponse getClusterOptions(GetClusterOptionsRequest request)
```
    Get options available for clusters.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use GetClusterOptions API.
  - getNodePool
```
GetNodePoolResponse getNodePool(GetNodePoolRequest request)
```
    Get the details of a node pool.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use GetNodePool API.
  - getNodePoolOptions
```
GetNodePoolOptionsResponse getNodePoolOptions(GetNodePoolOptionsRequest request)
```
    Get options available for node pools.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use GetNodePoolOptions API.
  - getWorkRequest
```
GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
```
    Get the details of a work request.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use GetWorkRequest API.
  - listClusters
```
ListClustersResponse listClusters(ListClustersRequest request)
```
    List all the cluster objects in a compartment.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListClusters API.
  - listNodePools
```
ListNodePoolsResponse listNodePools(ListNodePoolsRequest request)
```
    List all the node pools in a compartment, and optionally filter by cluster.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListNodePools API.
  - listWorkRequestErrors
```
ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
```
    Get the errors of a work request.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListWorkRequestErrors API.
  - listWorkRequestLogs
```
ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
```
    Get the logs of a work request.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListWorkRequestLogs API.
  - listWorkRequests
```
ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
```
    List all work requests in a compartment.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListWorkRequests API.
  - updateCluster
```
UpdateClusterResponse updateCluster(UpdateClusterRequest request)
```
    Update the details of a cluster.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use UpdateCluster API.
  - updateClusterEndpointConfig
```
UpdateClusterEndpointConfigResponse updateClusterEndpointConfig(UpdateClusterEndpointConfigRequest request)
```
    Update the details of the cluster endpoint configuration.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use UpdateClusterEndpointConfig API.
  - updateNodePool
```
UpdateNodePoolResponse updateNodePool(UpdateNodePoolRequest request)
```
    Update the details of a node pool.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use UpdateNodePool API.
  - getWaiters
```
ContainerEngineWaiters getWaiters()
```
    Gets the pre-configured waiters available for resources for this service.
    
    Returns:
    
    The service waiters.
  - getPaginators
```
ContainerEnginePaginators getPaginators()
```
    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.
    
    Returns:
    
    The service paginators.

Interface ContainerEngine

Method Summary

Methods inherited from interface java.lang.AutoCloseable

Method Detail

refreshClient

setEndpoint

getEndpoint

setRegion

setRegion

clusterMigrateToNativeVcn

createCluster

createKubeconfig

createNodePool

deleteCluster

deleteNode

deleteNodePool

deleteWorkRequest

getCluster

getClusterMigrateToNativeVcnStatus

getClusterOptions

getNodePool

getNodePoolOptions

getWorkRequest

listClusters

listNodePools

listWorkRequestErrors

listWorkRequestLogs

listWorkRequests

updateCluster

updateClusterEndpointConfig

updateNodePool

getWaiters

getPaginators