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 Kubernetes Engine service (also known as the Container Engine for Kubernetes service). Use this API to build, deploy, and manage cloud-native applications. For more information, see Overview of Kubernetes Engine.

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.
`CompleteCredentialRotationResponse`	`completeCredentialRotation(CompleteCredentialRotationRequest request)` Complete cluster credential rotation.
`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.
`CreateVirtualNodePoolResponse`	`createVirtualNodePool(CreateVirtualNodePoolRequest request)` Create a new virtual node pool.
`CreateWorkloadMappingResponse`	`createWorkloadMapping(CreateWorkloadMappingRequest request)` Create the specified workloadMapping for a cluster.
`DeleteClusterResponse`	`deleteCluster(DeleteClusterRequest request)` Delete a cluster.
`DeleteNodeResponse`	`deleteNode(DeleteNodeRequest request)` Delete node.
`DeleteNodePoolResponse`	`deleteNodePool(DeleteNodePoolRequest request)` Delete a node pool.
`DeleteVirtualNodePoolResponse`	`deleteVirtualNodePool(DeleteVirtualNodePoolRequest request)` Delete a virtual node pool.
`DeleteWorkloadMappingResponse`	`deleteWorkloadMapping(DeleteWorkloadMappingRequest request)` Delete workloadMapping for a provisioned cluster.
`DeleteWorkRequestResponse`	`deleteWorkRequest(DeleteWorkRequestRequest request)` Cancel a work request that has not started.
`DisableAddonResponse`	`disableAddon(DisableAddonRequest request)` Disable addon for a provisioned cluster.
`GetAddonResponse`	`getAddon(GetAddonRequest request)` Get the specified addon for a cluster.
`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.
`GetCredentialRotationStatusResponse`	`getCredentialRotationStatus(GetCredentialRotationStatusRequest request)` Get cluster credential rotation status.
`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.
`GetVirtualNodeResponse`	`getVirtualNode(GetVirtualNodeRequest request)` Get the details of a virtual node.
`GetVirtualNodePoolResponse`	`getVirtualNodePool(GetVirtualNodePoolRequest request)` Get the details of a virtual node pool.
`ContainerEngineWaiters`	`getWaiters()` Gets the pre-configured waiters available for resources for this service.
`GetWorkloadMappingResponse`	`getWorkloadMapping(GetWorkloadMappingRequest request)` Get the specified workloadMapping for a cluster.
`GetWorkRequestResponse`	`getWorkRequest(GetWorkRequestRequest request)` Get the details of a work request.
`InstallAddonResponse`	`installAddon(InstallAddonRequest request)` Install the specified addon for a cluster.
`ListAddonOptionsResponse`	`listAddonOptions(ListAddonOptionsRequest request)` Get list of supported addons for a specific kubernetes version.
`ListAddonsResponse`	`listAddons(ListAddonsRequest request)` List addon for a provisioned cluster.
`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.
`ListPodShapesResponse`	`listPodShapes(ListPodShapesRequest request)` List all the Pod Shapes in a compartment.
`ListVirtualNodePoolsResponse`	`listVirtualNodePools(ListVirtualNodePoolsRequest request)` List all the virtual node pools in a compartment, and optionally filter by cluster.
`ListVirtualNodesResponse`	`listVirtualNodes(ListVirtualNodesRequest request)` List virtual nodes in a virtual node pool.
`ListWorkloadMappingsResponse`	`listWorkloadMappings(ListWorkloadMappingsRequest request)` List workloadMappings for a provisioned 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’).
`StartCredentialRotationResponse`	`startCredentialRotation(StartCredentialRotationRequest request)` Start cluster credential rotation by adding new credentials, old credentials will still work after this operation.
`UpdateAddonResponse`	`updateAddon(UpdateAddonRequest request)` Update addon details for a cluster.
`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.
`UpdateVirtualNodePoolResponse`	`updateVirtualNodePool(UpdateVirtualNodePoolRequest request)` Update the details of a virtual node pool.
`UpdateWorkloadMappingResponse`	`updateWorkloadMapping(UpdateWorkloadMappingRequest request)` Update workloadMapping details for a cluster.
`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 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.
  - 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
  - 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.
  - completeCredentialRotation
```
CompleteCredentialRotationResponse completeCredentialRotation(CompleteCredentialRotationRequest request)
```
    Complete cluster credential rotation. Retire old credentials from kubernetes components.
    
    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 CompleteCredentialRotation 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.
  - createVirtualNodePool
```
CreateVirtualNodePoolResponse createVirtualNodePool(CreateVirtualNodePoolRequest request)
```
    Create a new virtual 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 CreateVirtualNodePool API.
  - createWorkloadMapping
```
CreateWorkloadMappingResponse createWorkloadMapping(CreateWorkloadMappingRequest request)
```
    Create the specified workloadMapping 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 CreateWorkloadMapping 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.
  - deleteVirtualNodePool
```
DeleteVirtualNodePoolResponse deleteVirtualNodePool(DeleteVirtualNodePoolRequest request)
```
    Delete a virtual 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 DeleteVirtualNodePool 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.
  - deleteWorkloadMapping
```
DeleteWorkloadMappingResponse deleteWorkloadMapping(DeleteWorkloadMappingRequest request)
```
    Delete workloadMapping for a provisioned 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 DeleteWorkloadMapping API.
  - disableAddon
```
DisableAddonResponse disableAddon(DisableAddonRequest request)
```
    Disable addon for a provisioned 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 DisableAddon API.
  - getAddon
```
GetAddonResponse getAddon(GetAddonRequest request)
```
    Get the specified addon 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 GetAddon 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.
  - getCredentialRotationStatus
```
GetCredentialRotationStatusResponse getCredentialRotationStatus(GetCredentialRotationStatusRequest request)
```
    Get cluster credential rotation status.
    
    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 GetCredentialRotationStatus 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.
  - getVirtualNode
```
GetVirtualNodeResponse getVirtualNode(GetVirtualNodeRequest request)
```
    Get the details of a virtual 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 GetVirtualNode API.
  - getVirtualNodePool
```
GetVirtualNodePoolResponse getVirtualNodePool(GetVirtualNodePoolRequest request)
```
    Get the details of a virtual 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 GetVirtualNodePool 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.
  - getWorkloadMapping
```
GetWorkloadMappingResponse getWorkloadMapping(GetWorkloadMappingRequest request)
```
    Get the specified workloadMapping 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 GetWorkloadMapping API.
  - installAddon
```
InstallAddonResponse installAddon(InstallAddonRequest request)
```
    Install the specified addon 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 InstallAddon API.
  - listAddonOptions
```
ListAddonOptionsResponse listAddonOptions(ListAddonOptionsRequest request)
```
    Get list of supported addons for a specific kubernetes version.
    
    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 ListAddonOptions API.
  - listAddons
```
ListAddonsResponse listAddons(ListAddonsRequest request)
```
    List addon for a provisioned 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 ListAddons 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.
  - listPodShapes
```
ListPodShapesResponse listPodShapes(ListPodShapesRequest request)
```
    List all the Pod Shapes 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 ListPodShapes API.
  - listVirtualNodePools
```
ListVirtualNodePoolsResponse listVirtualNodePools(ListVirtualNodePoolsRequest request)
```
    List all the virtual 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 ListVirtualNodePools API.
  - listVirtualNodes
```
ListVirtualNodesResponse listVirtualNodes(ListVirtualNodesRequest request)
```
    List virtual nodes in a virtual 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 ListVirtualNodes 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.
  - listWorkloadMappings
```
ListWorkloadMappingsResponse listWorkloadMappings(ListWorkloadMappingsRequest request)
```
    List workloadMappings for a provisioned 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 ListWorkloadMappings API.
  - startCredentialRotation
```
StartCredentialRotationResponse startCredentialRotation(StartCredentialRotationRequest request)
```
    Start cluster credential rotation by adding new credentials, old credentials will still work after this operation.
    
    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 StartCredentialRotation API.
  - updateAddon
```
UpdateAddonResponse updateAddon(UpdateAddonRequest request)
```
    Update addon details 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 UpdateAddon 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.
  - updateVirtualNodePool
```
UpdateVirtualNodePoolResponse updateVirtualNodePool(UpdateVirtualNodePoolRequest request)
```
    Update the details of a virtual 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 UpdateVirtualNodePool API.
  - updateWorkloadMapping
```
UpdateWorkloadMappingResponse updateWorkloadMapping(UpdateWorkloadMappingRequest request)
```
    Update workloadMapping details 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 UpdateWorkloadMapping 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

useRealmSpecificEndpointTemplate

clusterMigrateToNativeVcn

completeCredentialRotation

createCluster

createKubeconfig

createNodePool

createVirtualNodePool

createWorkloadMapping

deleteCluster

deleteNode

deleteNodePool

deleteVirtualNodePool

deleteWorkRequest

deleteWorkloadMapping

disableAddon

getAddon

getCluster

getClusterMigrateToNativeVcnStatus

getClusterOptions

getCredentialRotationStatus

getNodePool

getNodePoolOptions

getVirtualNode

getVirtualNodePool

getWorkRequest

getWorkloadMapping

installAddon

listAddonOptions

listAddons

listClusters

listNodePools

listPodShapes

listVirtualNodePools

listVirtualNodes

listWorkRequestErrors

listWorkRequestLogs

listWorkRequests

listWorkloadMappings

startCredentialRotation

updateAddon

updateCluster

updateClusterEndpointConfig

updateNodePool

updateVirtualNodePool

updateWorkloadMapping

getWaiters

getPaginators