Class ContainerEngineAsyncClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseAsyncClient
-
- com.oracle.bmc.containerengine.ContainerEngineAsyncClient
-
- All Implemented Interfaces:
ContainerEngineAsync
,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20180222") public class ContainerEngineAsyncClient extends BaseAsyncClient implements ContainerEngineAsync
Async client implementation for ContainerEngine service.
There are two ways to use async client: 1. Use AsyncHandler: using AsyncHandler, if the response to the call is anInputStream
, like getObject Api in object storage service, developers need to process the stream in AsyncHandler, and not anywhere else, because the stream will be closed right after the AsyncHandler is invoked.
2. Use Java Future: using Java Future, developers need to close the stream after they are done with the Java Future.
Accessing the result should be done in a mutually exclusive manner, either through the Future or the AsyncHandler, but not both. If the Future is used, the caller should pass in null as the AsyncHandler. If the AsyncHandler is used, it is still safe to use the Future to determine whether or not the request was completed via Future.isDone/isCancelled.
Please refer to https://github.com/oracle/oci-java-sdk/blob/master/bmc-examples/src/main/java/ResteasyClientWithObjectStorageExample.java
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ContainerEngineAsyncClient.Builder
Builder class for this client.
-
Field Summary
Fields Modifier and Type Field 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 Description ContainerEngineAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.ContainerEngineAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.ContainerEngineAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.ContainerEngineAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.ContainerEngineAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.ContainerEngineAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.ContainerEngineAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.
-
Method Summary
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface java.lang.AutoCloseable
close
-
Methods inherited from interface com.oracle.bmc.containerengine.ContainerEngineAsync
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
ContainerEngineAsyncClient
@Deprecated public ContainerEngineAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeContainerEngineAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)
-
ContainerEngineAsyncClient
@Deprecated public ContainerEngineAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeContainerEngineAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
-
ContainerEngineAsyncClient
@Deprecated public ContainerEngineAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeContainerEngineAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
ContainerEngineAsyncClient
@Deprecated public ContainerEngineAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeContainerEngineAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
-
ContainerEngineAsyncClient
@Deprecated public ContainerEngineAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeContainerEngineAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
-
ContainerEngineAsyncClient
@Deprecated public ContainerEngineAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeContainerEngineAsyncClient.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)
-
ContainerEngineAsyncClient
@Deprecated public ContainerEngineAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeContainerEngineAsyncClient.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
-
-
Method Detail
-
builder
public static ContainerEngineAsyncClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:ContainerEngineAsync
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 interfaceContainerEngineAsync
- Parameters:
region
- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:ContainerEngineAsync
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 callsetEndpoint
.- Specified by:
setRegion
in interfaceContainerEngineAsync
- Parameters:
regionId
- The public region ID.
-
clusterMigrateToNativeVcn
public Future<ClusterMigrateToNativeVcnResponse> clusterMigrateToNativeVcn(ClusterMigrateToNativeVcnRequest request, AsyncHandler<ClusterMigrateToNativeVcnRequest,ClusterMigrateToNativeVcnResponse> handler)
Description copied from interface:ContainerEngineAsync
Initiates cluster migration to use native VCN.- Specified by:
clusterMigrateToNativeVcn
in interfaceContainerEngineAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
completeCredentialRotation
public Future<CompleteCredentialRotationResponse> completeCredentialRotation(CompleteCredentialRotationRequest request, AsyncHandler<CompleteCredentialRotationRequest,CompleteCredentialRotationResponse> handler)
Description copied from interface:ContainerEngineAsync
Complete cluster credential rotation.Retire old credentials from kubernetes components.
- Specified by:
completeCredentialRotation
in interfaceContainerEngineAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
createCluster
public Future<CreateClusterResponse> createCluster(CreateClusterRequest request, AsyncHandler<CreateClusterRequest,CreateClusterResponse> handler)
Description copied from interface:ContainerEngineAsync
Create a new cluster.- Specified by:
createCluster
in interfaceContainerEngineAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
createKubeconfig
public Future<CreateKubeconfigResponse> createKubeconfig(CreateKubeconfigRequest request, AsyncHandler<CreateKubeconfigRequest,CreateKubeconfigResponse> handler)
Description copied from interface:ContainerEngineAsync
Create the Kubeconfig YAML for a cluster.- Specified by:
createKubeconfig
in interfaceContainerEngineAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
createNodePool
public Future<CreateNodePoolResponse> createNodePool(CreateNodePoolRequest request, AsyncHandler<CreateNodePoolRequest,CreateNodePoolResponse> handler)
Description copied from interface:ContainerEngineAsync
Create a new node pool.- Specified by:
createNodePool
in interfaceContainerEngineAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
createVirtualNodePool
public Future<CreateVirtualNodePoolResponse> createVirtualNodePool(CreateVirtualNodePoolRequest request, AsyncHandler<CreateVirtualNodePoolRequest,CreateVirtualNodePoolResponse> handler)
Description copied from interface:ContainerEngineAsync
Create a new virtual node pool.- Specified by:
createVirtualNodePool
in interfaceContainerEngineAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
createWorkloadMapping
public Future<CreateWorkloadMappingResponse> createWorkloadMapping(CreateWorkloadMappingRequest request, AsyncHandler<CreateWorkloadMappingRequest,CreateWorkloadMappingResponse> handler)
Description copied from interface:ContainerEngineAsync
Create the specified workloadMapping for a cluster.- Specified by:
createWorkloadMapping
in interfaceContainerEngineAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
deleteCluster
public Future<DeleteClusterResponse> deleteCluster(DeleteClusterRequest request, AsyncHandler<DeleteClusterRequest,DeleteClusterResponse> handler)
Description copied from interface:ContainerEngineAsync
Delete a cluster.- Specified by:
deleteCluster
in interfaceContainerEngineAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
deleteNode
public Future<DeleteNodeResponse> deleteNode(DeleteNodeRequest request, AsyncHandler<DeleteNodeRequest,DeleteNodeResponse> handler)
Description copied from interface:ContainerEngineAsync
Delete node.- Specified by:
deleteNode
in interfaceContainerEngineAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
deleteNodePool
public Future<DeleteNodePoolResponse> deleteNodePool(DeleteNodePoolRequest request, AsyncHandler<DeleteNodePoolRequest,DeleteNodePoolResponse> handler)
Description copied from interface:ContainerEngineAsync
Delete a node pool.- Specified by:
deleteNodePool
in interfaceContainerEngineAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
deleteVirtualNodePool
public Future<DeleteVirtualNodePoolResponse> deleteVirtualNodePool(DeleteVirtualNodePoolRequest request, AsyncHandler<DeleteVirtualNodePoolRequest,DeleteVirtualNodePoolResponse> handler)
Description copied from interface:ContainerEngineAsync
Delete a virtual node pool.- Specified by:
deleteVirtualNodePool
in interfaceContainerEngineAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
deleteWorkRequest
public Future<DeleteWorkRequestResponse> deleteWorkRequest(DeleteWorkRequestRequest request, AsyncHandler<DeleteWorkRequestRequest,DeleteWorkRequestResponse> handler)
Description copied from interface:ContainerEngineAsync
Cancel a work request that has not started.- Specified by:
deleteWorkRequest
in interfaceContainerEngineAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
deleteWorkloadMapping
public Future<DeleteWorkloadMappingResponse> deleteWorkloadMapping(DeleteWorkloadMappingRequest request, AsyncHandler<DeleteWorkloadMappingRequest,DeleteWorkloadMappingResponse> handler)
Description copied from interface:ContainerEngineAsync
Delete workloadMapping for a provisioned cluster.- Specified by:
deleteWorkloadMapping
in interfaceContainerEngineAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
disableAddon
public Future<DisableAddonResponse> disableAddon(DisableAddonRequest request, AsyncHandler<DisableAddonRequest,DisableAddonResponse> handler)
Description copied from interface:ContainerEngineAsync
Disable addon for a provisioned cluster.- Specified by:
disableAddon
in interfaceContainerEngineAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getAddon
public Future<GetAddonResponse> getAddon(GetAddonRequest request, AsyncHandler<GetAddonRequest,GetAddonResponse> handler)
Description copied from interface:ContainerEngineAsync
Get the specified addon for a cluster.- Specified by:
getAddon
in interfaceContainerEngineAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getCluster
public Future<GetClusterResponse> getCluster(GetClusterRequest request, AsyncHandler<GetClusterRequest,GetClusterResponse> handler)
Description copied from interface:ContainerEngineAsync
Get the details of a cluster.- Specified by:
getCluster
in interfaceContainerEngineAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getClusterMigrateToNativeVcnStatus
public Future<GetClusterMigrateToNativeVcnStatusResponse> getClusterMigrateToNativeVcnStatus(GetClusterMigrateToNativeVcnStatusRequest request, AsyncHandler<GetClusterMigrateToNativeVcnStatusRequest,GetClusterMigrateToNativeVcnStatusResponse> handler)
Description copied from interface:ContainerEngineAsync
Get details on a cluster’s migration to native VCN.- Specified by:
getClusterMigrateToNativeVcnStatus
in interfaceContainerEngineAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getClusterOptions
public Future<GetClusterOptionsResponse> getClusterOptions(GetClusterOptionsRequest request, AsyncHandler<GetClusterOptionsRequest,GetClusterOptionsResponse> handler)
Description copied from interface:ContainerEngineAsync
Get options available for clusters.- Specified by:
getClusterOptions
in interfaceContainerEngineAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getCredentialRotationStatus
public Future<GetCredentialRotationStatusResponse> getCredentialRotationStatus(GetCredentialRotationStatusRequest request, AsyncHandler<GetCredentialRotationStatusRequest,GetCredentialRotationStatusResponse> handler)
Description copied from interface:ContainerEngineAsync
Get cluster credential rotation status.- Specified by:
getCredentialRotationStatus
in interfaceContainerEngineAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getNodePool
public Future<GetNodePoolResponse> getNodePool(GetNodePoolRequest request, AsyncHandler<GetNodePoolRequest,GetNodePoolResponse> handler)
Description copied from interface:ContainerEngineAsync
Get the details of a node pool.- Specified by:
getNodePool
in interfaceContainerEngineAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getNodePoolOptions
public Future<GetNodePoolOptionsResponse> getNodePoolOptions(GetNodePoolOptionsRequest request, AsyncHandler<GetNodePoolOptionsRequest,GetNodePoolOptionsResponse> handler)
Description copied from interface:ContainerEngineAsync
Get options available for node pools.- Specified by:
getNodePoolOptions
in interfaceContainerEngineAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getVirtualNode
public Future<GetVirtualNodeResponse> getVirtualNode(GetVirtualNodeRequest request, AsyncHandler<GetVirtualNodeRequest,GetVirtualNodeResponse> handler)
Description copied from interface:ContainerEngineAsync
Get the details of a virtual node.- Specified by:
getVirtualNode
in interfaceContainerEngineAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getVirtualNodePool
public Future<GetVirtualNodePoolResponse> getVirtualNodePool(GetVirtualNodePoolRequest request, AsyncHandler<GetVirtualNodePoolRequest,GetVirtualNodePoolResponse> handler)
Description copied from interface:ContainerEngineAsync
Get the details of a virtual node pool.- Specified by:
getVirtualNodePool
in interfaceContainerEngineAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getWorkRequest
public Future<GetWorkRequestResponse> getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)
Description copied from interface:ContainerEngineAsync
Get the details of a work request.- Specified by:
getWorkRequest
in interfaceContainerEngineAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
getWorkloadMapping
public Future<GetWorkloadMappingResponse> getWorkloadMapping(GetWorkloadMappingRequest request, AsyncHandler<GetWorkloadMappingRequest,GetWorkloadMappingResponse> handler)
Description copied from interface:ContainerEngineAsync
Get the specified workloadMapping for a cluster.- Specified by:
getWorkloadMapping
in interfaceContainerEngineAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
installAddon
public Future<InstallAddonResponse> installAddon(InstallAddonRequest request, AsyncHandler<InstallAddonRequest,InstallAddonResponse> handler)
Description copied from interface:ContainerEngineAsync
Install the specified addon for a cluster.- Specified by:
installAddon
in interfaceContainerEngineAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listAddonOptions
public Future<ListAddonOptionsResponse> listAddonOptions(ListAddonOptionsRequest request, AsyncHandler<ListAddonOptionsRequest,ListAddonOptionsResponse> handler)
Description copied from interface:ContainerEngineAsync
Get list of supported addons for a specific kubernetes version.- Specified by:
listAddonOptions
in interfaceContainerEngineAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listAddons
public Future<ListAddonsResponse> listAddons(ListAddonsRequest request, AsyncHandler<ListAddonsRequest,ListAddonsResponse> handler)
Description copied from interface:ContainerEngineAsync
List addon for a provisioned cluster.- Specified by:
listAddons
in interfaceContainerEngineAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listClusters
public Future<ListClustersResponse> listClusters(ListClustersRequest request, AsyncHandler<ListClustersRequest,ListClustersResponse> handler)
Description copied from interface:ContainerEngineAsync
List all the cluster objects in a compartment.- Specified by:
listClusters
in interfaceContainerEngineAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listNodePools
public Future<ListNodePoolsResponse> listNodePools(ListNodePoolsRequest request, AsyncHandler<ListNodePoolsRequest,ListNodePoolsResponse> handler)
Description copied from interface:ContainerEngineAsync
List all the node pools in a compartment, and optionally filter by cluster.- Specified by:
listNodePools
in interfaceContainerEngineAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listPodShapes
public Future<ListPodShapesResponse> listPodShapes(ListPodShapesRequest request, AsyncHandler<ListPodShapesRequest,ListPodShapesResponse> handler)
Description copied from interface:ContainerEngineAsync
List all the Pod Shapes in a compartment.- Specified by:
listPodShapes
in interfaceContainerEngineAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listVirtualNodePools
public Future<ListVirtualNodePoolsResponse> listVirtualNodePools(ListVirtualNodePoolsRequest request, AsyncHandler<ListVirtualNodePoolsRequest,ListVirtualNodePoolsResponse> handler)
Description copied from interface:ContainerEngineAsync
List all the virtual node pools in a compartment, and optionally filter by cluster.- Specified by:
listVirtualNodePools
in interfaceContainerEngineAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listVirtualNodes
public Future<ListVirtualNodesResponse> listVirtualNodes(ListVirtualNodesRequest request, AsyncHandler<ListVirtualNodesRequest,ListVirtualNodesResponse> handler)
Description copied from interface:ContainerEngineAsync
List virtual nodes in a virtual node pool.- Specified by:
listVirtualNodes
in interfaceContainerEngineAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listWorkRequestErrors
public Future<ListWorkRequestErrorsResponse> listWorkRequestErrors(ListWorkRequestErrorsRequest request, AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)
Description copied from interface:ContainerEngineAsync
Get the errors of a work request.- Specified by:
listWorkRequestErrors
in interfaceContainerEngineAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listWorkRequestLogs
public Future<ListWorkRequestLogsResponse> listWorkRequestLogs(ListWorkRequestLogsRequest request, AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)
Description copied from interface:ContainerEngineAsync
Get the logs of a work request.- Specified by:
listWorkRequestLogs
in interfaceContainerEngineAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listWorkRequests
public Future<ListWorkRequestsResponse> listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)
Description copied from interface:ContainerEngineAsync
List all work requests in a compartment.- Specified by:
listWorkRequests
in interfaceContainerEngineAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
listWorkloadMappings
public Future<ListWorkloadMappingsResponse> listWorkloadMappings(ListWorkloadMappingsRequest request, AsyncHandler<ListWorkloadMappingsRequest,ListWorkloadMappingsResponse> handler)
Description copied from interface:ContainerEngineAsync
List workloadMappings for a provisioned cluster.- Specified by:
listWorkloadMappings
in interfaceContainerEngineAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
startCredentialRotation
public Future<StartCredentialRotationResponse> startCredentialRotation(StartCredentialRotationRequest request, AsyncHandler<StartCredentialRotationRequest,StartCredentialRotationResponse> handler)
Description copied from interface:ContainerEngineAsync
Start cluster credential rotation by adding new credentials, old credentials will still work after this operation.- Specified by:
startCredentialRotation
in interfaceContainerEngineAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
updateAddon
public Future<UpdateAddonResponse> updateAddon(UpdateAddonRequest request, AsyncHandler<UpdateAddonRequest,UpdateAddonResponse> handler)
Description copied from interface:ContainerEngineAsync
Update addon details for a cluster.- Specified by:
updateAddon
in interfaceContainerEngineAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
updateCluster
public Future<UpdateClusterResponse> updateCluster(UpdateClusterRequest request, AsyncHandler<UpdateClusterRequest,UpdateClusterResponse> handler)
Description copied from interface:ContainerEngineAsync
Update the details of a cluster.- Specified by:
updateCluster
in interfaceContainerEngineAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
updateClusterEndpointConfig
public Future<UpdateClusterEndpointConfigResponse> updateClusterEndpointConfig(UpdateClusterEndpointConfigRequest request, AsyncHandler<UpdateClusterEndpointConfigRequest,UpdateClusterEndpointConfigResponse> handler)
Description copied from interface:ContainerEngineAsync
Update the details of the cluster endpoint configuration.- Specified by:
updateClusterEndpointConfig
in interfaceContainerEngineAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
updateNodePool
public Future<UpdateNodePoolResponse> updateNodePool(UpdateNodePoolRequest request, AsyncHandler<UpdateNodePoolRequest,UpdateNodePoolResponse> handler)
Description copied from interface:ContainerEngineAsync
Update the details of a node pool.- Specified by:
updateNodePool
in interfaceContainerEngineAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
updateVirtualNodePool
public Future<UpdateVirtualNodePoolResponse> updateVirtualNodePool(UpdateVirtualNodePoolRequest request, AsyncHandler<UpdateVirtualNodePoolRequest,UpdateVirtualNodePoolResponse> handler)
Description copied from interface:ContainerEngineAsync
Update the details of a virtual node pool.- Specified by:
updateVirtualNodePool
in interfaceContainerEngineAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
updateWorkloadMapping
public Future<UpdateWorkloadMappingResponse> updateWorkloadMapping(UpdateWorkloadMappingRequest request, AsyncHandler<UpdateWorkloadMappingRequest,UpdateWorkloadMappingResponse> handler)
Description copied from interface:ContainerEngineAsync
Update workloadMapping details for a cluster.- Specified by:
updateWorkloadMapping
in interfaceContainerEngineAsync
- Parameters:
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.- Returns:
- A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
-
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 userequiredParametersMap
- 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 backingHttpClient
.This will call
ClientConfigurator
s again, and can be used to e.g. refresh the SSL certificate.
-
close
public final void close()
- Specified by:
close
in interfaceAutoCloseable
-
getClientCommonLibraryVersion
public String getClientCommonLibraryVersion()
-
getMinimumClientCommonLibraryVersionFromClient
public Optional<String> getMinimumClientCommonLibraryVersionFromClient()
-
clientCall
protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER> clientCall(REQ request, Supplier<RESP_BUILDER> responseBuilder)
-
-