com.oracle.bmc.containerengine

Class ContainerEngineClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.containerengine.ContainerEngineClient

All Implemented Interfaces:

ContainerEngine, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20180222")
public class ContainerEngineClient
extends BaseSyncClient
implements ContainerEngine

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ContainerEngineClient.Builder Builder class for this client.

Field Summary

Fields

Modifier and Type	Field and Description
String	clientCommonLibraryVersion Compatible SDK version, provided by the codegen.
Optional<String>	minimumClientCommonLibraryVersionFromClient Minimum compatible SDK version, maybe provided by the codegen.
static Service	SERVICE Service instance for ContainerEngine.

Constructor Summary

Constructors

Constructor and Description
ContainerEngineClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory) Deprecated. Use the builder instead.
ContainerEngineClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Deprecated. Use the builder instead.
ContainerEngineClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
ContainerEngineClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
ContainerEngineClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService) Deprecated. Use the builder instead.
ContainerEngineClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Deprecated. Use the builder instead.
ContainerEngineClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Deprecated. Use the builder instead.
ContainerEngineClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator) Deprecated. Use the builder instead.

Method Summary

Modifier and Type	Method and Description
static ContainerEngineClient.Builder	builder() Create a builder for this client.
void	close()
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.
String	getClientCommonLibraryVersion()
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.
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
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	populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap) Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
void	refreshClient() Rebuild the backing HttpClient.
void	setEndpoint(String endpoint)
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.
void	updateBaseEndpoint(String endpoint) This method should be used for parameterized endpoint templates only.
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 useOfRealmSpecificEndpointTemplateEnabled) This method should be used to enable or disable the use of realm-specific endpoint template.

Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient

clientCall

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.oracle.bmc.containerengine.ContainerEngine

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for ContainerEngine.

clientCommonLibraryVersion

public final String clientCommonLibraryVersion

Compatible SDK version, provided by the codegen.

minimumClientCommonLibraryVersionFromClient

public final Optional<String> minimumClientCommonLibraryVersionFromClient

Minimum compatible SDK version, maybe provided by the codegen.

Constructor Detail

ContainerEngineClient

@Deprecated
public ContainerEngineClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see ContainerEngineClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

ContainerEngineClient

@Deprecated
public ContainerEngineClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                         ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see ContainerEngineClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

ContainerEngineClient

@Deprecated
public ContainerEngineClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                         ClientConfiguration configuration,
                                         ClientConfigurator clientConfigurator)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see ContainerEngineClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

ContainerEngineClient

@Deprecated
public ContainerEngineClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                         ClientConfiguration configuration,
                                         ClientConfigurator clientConfigurator,
                                         RequestSignerFactory defaultRequestSignerFactory)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see ContainerEngineClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

ContainerEngineClient

@Deprecated
public ContainerEngineClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                         ClientConfiguration configuration,
                                         ClientConfigurator clientConfigurator,
                                         RequestSignerFactory defaultRequestSignerFactory,
                                         List<ClientConfigurator> additionalClientConfigurators)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see ContainerEngineClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

ContainerEngineClient

@Deprecated
public ContainerEngineClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                         ClientConfiguration configuration,
                                         ClientConfigurator clientConfigurator,
                                         RequestSignerFactory defaultRequestSignerFactory,
                                         List<ClientConfigurator> additionalClientConfigurators,
                                         String endpoint)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see ContainerEngineClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

ContainerEngineClient

@Deprecated
public ContainerEngineClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                         ClientConfiguration configuration,
                                         ClientConfigurator clientConfigurator,
                                         RequestSignerFactory defaultRequestSignerFactory,
                                         Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                         List<ClientConfigurator> additionalClientConfigurators,
                                         String endpoint)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see ContainerEngineClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

ContainerEngineClient

@Deprecated
public ContainerEngineClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                         ClientConfiguration configuration,
                                         ClientConfigurator clientConfigurator,
                                         RequestSignerFactory defaultRequestSignerFactory,
                                         Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                         List<ClientConfigurator> additionalClientConfigurators,
                                         String endpoint,
                                         ExecutorService executorService)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see ContainerEngineClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

executorService - ContainerEngineClient.Builder.executorService

Method Detail

builder

public static ContainerEngineClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: ContainerEngine

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.

Specified by:

setRegion in interface ContainerEngine

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: ContainerEngine

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.

Specified by:

setRegion in interface ContainerEngine

Parameters:

regionId - The public region ID.

clusterMigrateToNativeVcn

public ClusterMigrateToNativeVcnResponse clusterMigrateToNativeVcn(ClusterMigrateToNativeVcnRequest request)

Description copied from interface: ContainerEngine

Initiates cluster migration to use native VCN.

Specified by:

clusterMigrateToNativeVcn in interface ContainerEngine

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

completeCredentialRotation

public CompleteCredentialRotationResponse completeCredentialRotation(CompleteCredentialRotationRequest request)

Description copied from interface: ContainerEngine

Complete cluster credential rotation. Retire old credentials from kubernetes components.

Specified by:

completeCredentialRotation in interface ContainerEngine

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createCluster

public CreateClusterResponse createCluster(CreateClusterRequest request)

Description copied from interface: ContainerEngine

Create a new cluster.

Specified by:

createCluster in interface ContainerEngine

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createKubeconfig

public CreateKubeconfigResponse createKubeconfig(CreateKubeconfigRequest request)

Description copied from interface: ContainerEngine

Create the Kubeconfig YAML for a cluster.

Specified by:

createKubeconfig in interface ContainerEngine

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createNodePool

public CreateNodePoolResponse createNodePool(CreateNodePoolRequest request)

Description copied from interface: ContainerEngine

Create a new node pool.

Specified by:

createNodePool in interface ContainerEngine

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createVirtualNodePool

public CreateVirtualNodePoolResponse createVirtualNodePool(CreateVirtualNodePoolRequest request)

Description copied from interface: ContainerEngine

Create a new virtual node pool.

Specified by:

createVirtualNodePool in interface ContainerEngine

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createWorkloadMapping

public CreateWorkloadMappingResponse createWorkloadMapping(CreateWorkloadMappingRequest request)

Description copied from interface: ContainerEngine

Create the specified workloadMapping for a cluster.

Specified by:

createWorkloadMapping in interface ContainerEngine

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteCluster

public DeleteClusterResponse deleteCluster(DeleteClusterRequest request)

Description copied from interface: ContainerEngine

Delete a cluster.

Specified by:

deleteCluster in interface ContainerEngine

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteNode

public DeleteNodeResponse deleteNode(DeleteNodeRequest request)

Description copied from interface: ContainerEngine

Delete node.

Specified by:

deleteNode in interface ContainerEngine

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteNodePool

public DeleteNodePoolResponse deleteNodePool(DeleteNodePoolRequest request)

Description copied from interface: ContainerEngine

Delete a node pool.

Specified by:

deleteNodePool in interface ContainerEngine

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteVirtualNodePool

public DeleteVirtualNodePoolResponse deleteVirtualNodePool(DeleteVirtualNodePoolRequest request)

Description copied from interface: ContainerEngine

Delete a virtual node pool.

Specified by:

deleteVirtualNodePool in interface ContainerEngine

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteWorkRequest

public DeleteWorkRequestResponse deleteWorkRequest(DeleteWorkRequestRequest request)

Description copied from interface: ContainerEngine

Cancel a work request that has not started.

Specified by:

deleteWorkRequest in interface ContainerEngine

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteWorkloadMapping

public DeleteWorkloadMappingResponse deleteWorkloadMapping(DeleteWorkloadMappingRequest request)

Description copied from interface: ContainerEngine

Delete workloadMapping for a provisioned cluster.

Specified by:

deleteWorkloadMapping in interface ContainerEngine

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

disableAddon

public DisableAddonResponse disableAddon(DisableAddonRequest request)

Description copied from interface: ContainerEngine

Disable addon for a provisioned cluster.

Specified by:

disableAddon in interface ContainerEngine

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getAddon

public GetAddonResponse getAddon(GetAddonRequest request)

Description copied from interface: ContainerEngine

Get the specified addon for a cluster.

Specified by:

getAddon in interface ContainerEngine

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getCluster

public GetClusterResponse getCluster(GetClusterRequest request)

Description copied from interface: ContainerEngine

Get the details of a cluster.

Specified by:

getCluster in interface ContainerEngine

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getClusterMigrateToNativeVcnStatus

public GetClusterMigrateToNativeVcnStatusResponse getClusterMigrateToNativeVcnStatus(GetClusterMigrateToNativeVcnStatusRequest request)

Description copied from interface: ContainerEngine

Get details on a cluster’s migration to native VCN.

Specified by:

getClusterMigrateToNativeVcnStatus in interface ContainerEngine

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getClusterOptions

public GetClusterOptionsResponse getClusterOptions(GetClusterOptionsRequest request)

Description copied from interface: ContainerEngine

Get options available for clusters.

Specified by:

getClusterOptions in interface ContainerEngine

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getCredentialRotationStatus

public GetCredentialRotationStatusResponse getCredentialRotationStatus(GetCredentialRotationStatusRequest request)

Description copied from interface: ContainerEngine

Get cluster credential rotation status.

Specified by:

getCredentialRotationStatus in interface ContainerEngine

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getNodePool

public GetNodePoolResponse getNodePool(GetNodePoolRequest request)

Description copied from interface: ContainerEngine

Get the details of a node pool.

Specified by:

getNodePool in interface ContainerEngine

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getNodePoolOptions

public GetNodePoolOptionsResponse getNodePoolOptions(GetNodePoolOptionsRequest request)

Description copied from interface: ContainerEngine

Get options available for node pools.

Specified by:

getNodePoolOptions in interface ContainerEngine

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getVirtualNode

public GetVirtualNodeResponse getVirtualNode(GetVirtualNodeRequest request)

Description copied from interface: ContainerEngine

Get the details of a virtual node.

Specified by:

getVirtualNode in interface ContainerEngine

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getVirtualNodePool

public GetVirtualNodePoolResponse getVirtualNodePool(GetVirtualNodePoolRequest request)

Description copied from interface: ContainerEngine

Get the details of a virtual node pool.

Specified by:

getVirtualNodePool in interface ContainerEngine

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWorkRequest

public GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)

Description copied from interface: ContainerEngine

Get the details of a work request.

Specified by:

getWorkRequest in interface ContainerEngine

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWorkloadMapping

public GetWorkloadMappingResponse getWorkloadMapping(GetWorkloadMappingRequest request)

Description copied from interface: ContainerEngine

Get the specified workloadMapping for a cluster.

Specified by:

getWorkloadMapping in interface ContainerEngine

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

installAddon

public InstallAddonResponse installAddon(InstallAddonRequest request)

Description copied from interface: ContainerEngine

Install the specified addon for a cluster.

Specified by:

installAddon in interface ContainerEngine

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listAddonOptions

public ListAddonOptionsResponse listAddonOptions(ListAddonOptionsRequest request)

Description copied from interface: ContainerEngine

Get list of supported addons for a specific kubernetes version.

Specified by:

listAddonOptions in interface ContainerEngine

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listAddons

public ListAddonsResponse listAddons(ListAddonsRequest request)

Description copied from interface: ContainerEngine

List addon for a provisioned cluster.

Specified by:

listAddons in interface ContainerEngine

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listClusters

public ListClustersResponse listClusters(ListClustersRequest request)

Description copied from interface: ContainerEngine

List all the cluster objects in a compartment.

Specified by:

listClusters in interface ContainerEngine

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listNodePools

public ListNodePoolsResponse listNodePools(ListNodePoolsRequest request)

Description copied from interface: ContainerEngine

List all the node pools in a compartment, and optionally filter by cluster.

Specified by:

listNodePools in interface ContainerEngine

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listPodShapes

public ListPodShapesResponse listPodShapes(ListPodShapesRequest request)

Description copied from interface: ContainerEngine

List all the Pod Shapes in a compartment.

Specified by:

listPodShapes in interface ContainerEngine

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listVirtualNodePools

public ListVirtualNodePoolsResponse listVirtualNodePools(ListVirtualNodePoolsRequest request)

Description copied from interface: ContainerEngine

List all the virtual node pools in a compartment, and optionally filter by cluster.

Specified by:

listVirtualNodePools in interface ContainerEngine

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listVirtualNodes

public ListVirtualNodesResponse listVirtualNodes(ListVirtualNodesRequest request)

Description copied from interface: ContainerEngine

List virtual nodes in a virtual node pool.

Specified by:

listVirtualNodes in interface ContainerEngine

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequestErrors

public ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)

Description copied from interface: ContainerEngine

Get the errors of a work request.

Specified by:

listWorkRequestErrors in interface ContainerEngine

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequestLogs

public ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)

Description copied from interface: ContainerEngine

Get the logs of a work request.

Specified by:

listWorkRequestLogs in interface ContainerEngine

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequests

public ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)

Description copied from interface: ContainerEngine

List all work requests in a compartment.

Specified by:

listWorkRequests in interface ContainerEngine

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkloadMappings

public ListWorkloadMappingsResponse listWorkloadMappings(ListWorkloadMappingsRequest request)

Description copied from interface: ContainerEngine

List workloadMappings for a provisioned cluster.

Specified by:

listWorkloadMappings in interface ContainerEngine

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

startCredentialRotation

public StartCredentialRotationResponse startCredentialRotation(StartCredentialRotationRequest request)

Description copied from interface: ContainerEngine

Start cluster credential rotation by adding new credentials, old credentials will still work after this operation.

Specified by:

startCredentialRotation in interface ContainerEngine

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateAddon

public UpdateAddonResponse updateAddon(UpdateAddonRequest request)

Description copied from interface: ContainerEngine

Update addon details for a cluster.

Specified by:

updateAddon in interface ContainerEngine

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateCluster

public UpdateClusterResponse updateCluster(UpdateClusterRequest request)

Description copied from interface: ContainerEngine

Update the details of a cluster.

Specified by:

updateCluster in interface ContainerEngine

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateClusterEndpointConfig

public UpdateClusterEndpointConfigResponse updateClusterEndpointConfig(UpdateClusterEndpointConfigRequest request)

Description copied from interface: ContainerEngine

Update the details of the cluster endpoint configuration.

Specified by:

updateClusterEndpointConfig in interface ContainerEngine

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateNodePool

public UpdateNodePoolResponse updateNodePool(UpdateNodePoolRequest request)

Description copied from interface: ContainerEngine

Update the details of a node pool.

Specified by:

updateNodePool in interface ContainerEngine

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateVirtualNodePool

public UpdateVirtualNodePoolResponse updateVirtualNodePool(UpdateVirtualNodePoolRequest request)

Description copied from interface: ContainerEngine

Update the details of a virtual node pool.

Specified by:

updateVirtualNodePool in interface ContainerEngine

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateWorkloadMapping

public UpdateWorkloadMappingResponse updateWorkloadMapping(UpdateWorkloadMappingRequest request)

Description copied from interface: ContainerEngine

Update workloadMapping details for a cluster.

Specified by:

updateWorkloadMapping in interface ContainerEngine

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public ContainerEngineWaiters getWaiters()

Description copied from interface: ContainerEngine

Gets the pre-configured waiters available for resources for this service.

Specified by:

getWaiters in interface ContainerEngine

Returns:

The service waiters.

getPaginators

public ContainerEnginePaginators getPaginators()

Description copied from interface: ContainerEngine

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.

Specified by:

getPaginators in interface ContainerEngine

Returns:

The service paginators.

getDefaultConfigurator

protected ClientConfigurator getDefaultConfigurator()

useRealmSpecificEndpointTemplate

public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)

This method should be used to enable or disable the use of realm-specific endpoint template. The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false

Parameters:

useOfRealmSpecificEndpointTemplateEnabled - This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively

populateServiceParametersInEndpoint

public final void populateServiceParametersInEndpoint(String endpoint,
                                                      Map<String,Object> requiredParametersMap)

Populate the parameters in the endpoint with its corresponding value and update the base endpoint. The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.

Parameters:

endpoint - The endpoint template in use

requiredParametersMap - Map of parameter name as key and value set in request path or query parameter as value

updateBaseEndpoint

public final void updateBaseEndpoint(String endpoint)

This method should be used for parameterized endpoint templates only. This does not include {region} and {secondLevelDomain} parameters.

Parameters:

endpoint - The updated endpoint to use

setEndpoint

public final void setEndpoint(String endpoint)

getEndpoint

public final String getEndpoint()

refreshClient

public final void refreshClient()

Rebuild the backing HttpClient. This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.

close

public final void close()

Specified by:

close in interface AutoCloseable

getClientCommonLibraryVersion

public String getClientCommonLibraryVersion()

getMinimumClientCommonLibraryVersionFromClient

public Optional<String> getMinimumClientCommonLibraryVersionFromClient()