@Generated(value="OracleSDKGenerator", comments="API Version: 20180222") public class ContainerEngineClient extends Object implements ContainerEngine
Modifier and Type | Class and Description |
---|---|
static class |
ContainerEngineClient.Builder
Builder class for this client.
|
Modifier and Type | Field and Description |
---|---|
static Service |
SERVICE
Service instance for ContainerEngine.
|
Modifier | Constructor and Description |
---|---|
|
ContainerEngineClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration.
|
|
ContainerEngineClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration.
|
|
ContainerEngineClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Creates a new service instance using the given authentication provider and client configuration.
|
|
ContainerEngineClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Creates a new service instance using the given authentication provider and client configuration.
|
|
ContainerEngineClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint,
ExecutorService executorService)
Creates a new service instance using the given authentication provider and client configuration.
|
protected |
ContainerEngineClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint,
ExecutorService executorService,
com.oracle.bmc.http.internal.RestClientFactoryBuilder restClientFactoryBuilder)
Creates a new service instance using the given authentication provider and client configuration.
|
|
ContainerEngineClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
|
|
ContainerEngineClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
|
|
ContainerEngineClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator)
Creates a new service instance using the given authentication provider and client configuration.
|
Modifier and Type | Method and Description |
---|---|
static ContainerEngineClient.Builder |
builder()
Create a builder for this client.
|
void |
close() |
CreateClusterResponse |
createCluster(CreateClusterRequest request)
Create a new cluster.
|
CreateKubeconfigResponse |
createKubeconfig(CreateKubeconfigRequest request)
Create the Kubeconfig YAML for a cluster.
|
CreateNodePoolResponse |
createNodePool(CreateNodePoolRequest request)
Create a new node pool.
|
DeleteClusterResponse |
deleteCluster(DeleteClusterRequest request)
Delete a cluster.
|
DeleteNodePoolResponse |
deleteNodePool(DeleteNodePoolRequest request)
Delete a node pool.
|
DeleteWorkRequestResponse |
deleteWorkRequest(DeleteWorkRequestRequest request)
Cancel a work request that has not started.
|
GetClusterResponse |
getCluster(GetClusterRequest request)
Get the details of a cluster.
|
GetClusterOptionsResponse |
getClusterOptions(GetClusterOptionsRequest request)
Get options available for clusters.
|
String |
getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
|
GetNodePoolResponse |
getNodePool(GetNodePoolRequest request)
Get the details of a node pool.
|
GetNodePoolOptionsResponse |
getNodePoolOptions(GetNodePoolOptionsRequest request)
Get options available for node pools.
|
ContainerEnginePaginators |
getPaginators()
Gets the pre-configured paginators available for list operations in this service which may return multiple
pages of data.
|
ContainerEngineWaiters |
getWaiters()
Gets the pre-configured waiters available for resources for this service.
|
GetWorkRequestResponse |
getWorkRequest(GetWorkRequestRequest request)
Get the details of a work request.
|
ListClustersResponse |
listClusters(ListClustersRequest request)
List all the cluster objects in a compartment.
|
ListNodePoolsResponse |
listNodePools(ListNodePoolsRequest request)
List all the node pools in a compartment, and optionally filter by cluster.
|
ListWorkRequestErrorsResponse |
listWorkRequestErrors(ListWorkRequestErrorsRequest request)
Get the errors of a work request.
|
ListWorkRequestLogsResponse |
listWorkRequestLogs(ListWorkRequestLogsRequest request)
Get the logs of a work request.
|
ListWorkRequestsResponse |
listWorkRequests(ListWorkRequestsRequest request)
List all work requests in a compartment.
|
void |
setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
|
void |
setRegion(Region region)
Sets the region to call (ex, Region.US_PHOENIX_1).
|
void |
setRegion(String regionId)
Sets the region to call (ex, ‘us-phoenix-1’).
|
UpdateClusterResponse |
updateCluster(UpdateClusterRequest request)
Update the details of a cluster.
|
UpdateNodePoolResponse |
updateNodePool(UpdateNodePoolRequest request)
Update the details of a node pool.
|
public static final Service SERVICE
Service instance for ContainerEngine.
public ContainerEngineClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
authenticationDetailsProvider
- The authentication details provider, required.public ContainerEngineClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.public ContainerEngineClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.public ContainerEngineClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.public ContainerEngineClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.additionalClientConfigurators
- Additional client configurators to be run after the primary configurator.public ContainerEngineClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.additionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)public ContainerEngineClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.signingStrategyRequestSignerFactories
- The request signer factories for each signing strategy used to create the request signeradditionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)public ContainerEngineClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.signingStrategyRequestSignerFactories
- The request signer factories for each signing strategy used to create the request signeradditionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)executorService
- ExecutorService used by the client, or null to use the default configured ThreadPoolExecutorprotected ContainerEngineClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService, com.oracle.bmc.http.internal.RestClientFactoryBuilder restClientFactoryBuilder)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
Use the ContainerEngineClient.Builder
to get access to all these parameters.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.signingStrategyRequestSignerFactories
- The request signer factories for each signing strategy used to create the request signeradditionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)executorService
- ExecutorService used by the client, or null to use the default configured ThreadPoolExecutorrestClientFactoryBuilder
- the builder for the RestClientFactory
public static ContainerEngineClient.Builder builder()
Create a builder for this client.
public void setEndpoint(String endpoint)
ContainerEngine
Sets the endpoint to call (ex, https://www.example.com).
setEndpoint
in interface ContainerEngine
endpoint
- The endpoint of the service.public String getEndpoint()
ContainerEngine
Gets the set endpoint for REST call (ex, https://www.example.com)
getEndpoint
in interface ContainerEngine
public void setRegion(Region region)
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.
setRegion
in interface ContainerEngine
region
- The region of the service.public void setRegion(String regionId)
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
.
setRegion
in interface ContainerEngine
regionId
- The public region ID.public void close()
close
in interface AutoCloseable
public CreateClusterResponse createCluster(CreateClusterRequest request)
ContainerEngine
Create a new cluster.
createCluster
in interface ContainerEngine
request
- The request object containing the details to sendpublic CreateKubeconfigResponse createKubeconfig(CreateKubeconfigRequest request)
ContainerEngine
Create the Kubeconfig YAML for a cluster.
createKubeconfig
in interface ContainerEngine
request
- The request object containing the details to sendpublic CreateNodePoolResponse createNodePool(CreateNodePoolRequest request)
ContainerEngine
Create a new node pool.
createNodePool
in interface ContainerEngine
request
- The request object containing the details to sendpublic DeleteClusterResponse deleteCluster(DeleteClusterRequest request)
ContainerEngine
Delete a cluster.
deleteCluster
in interface ContainerEngine
request
- The request object containing the details to sendpublic DeleteNodePoolResponse deleteNodePool(DeleteNodePoolRequest request)
ContainerEngine
Delete a node pool.
deleteNodePool
in interface ContainerEngine
request
- The request object containing the details to sendpublic DeleteWorkRequestResponse deleteWorkRequest(DeleteWorkRequestRequest request)
ContainerEngine
Cancel a work request that has not started.
deleteWorkRequest
in interface ContainerEngine
request
- The request object containing the details to sendpublic GetClusterResponse getCluster(GetClusterRequest request)
ContainerEngine
Get the details of a cluster.
getCluster
in interface ContainerEngine
request
- The request object containing the details to sendpublic GetClusterOptionsResponse getClusterOptions(GetClusterOptionsRequest request)
ContainerEngine
Get options available for clusters.
getClusterOptions
in interface ContainerEngine
request
- The request object containing the details to sendpublic GetNodePoolResponse getNodePool(GetNodePoolRequest request)
ContainerEngine
Get the details of a node pool.
getNodePool
in interface ContainerEngine
request
- The request object containing the details to sendpublic GetNodePoolOptionsResponse getNodePoolOptions(GetNodePoolOptionsRequest request)
ContainerEngine
Get options available for node pools.
getNodePoolOptions
in interface ContainerEngine
request
- The request object containing the details to sendpublic GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
ContainerEngine
Get the details of a work request.
getWorkRequest
in interface ContainerEngine
request
- The request object containing the details to sendpublic ListClustersResponse listClusters(ListClustersRequest request)
ContainerEngine
List all the cluster objects in a compartment.
listClusters
in interface ContainerEngine
request
- The request object containing the details to sendpublic ListNodePoolsResponse listNodePools(ListNodePoolsRequest request)
ContainerEngine
List all the node pools in a compartment, and optionally filter by cluster.
listNodePools
in interface ContainerEngine
request
- The request object containing the details to sendpublic ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
ContainerEngine
Get the errors of a work request.
listWorkRequestErrors
in interface ContainerEngine
request
- The request object containing the details to sendpublic ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
ContainerEngine
Get the logs of a work request.
listWorkRequestLogs
in interface ContainerEngine
request
- The request object containing the details to sendpublic ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
ContainerEngine
List all work requests in a compartment.
listWorkRequests
in interface ContainerEngine
request
- The request object containing the details to sendpublic UpdateClusterResponse updateCluster(UpdateClusterRequest request)
ContainerEngine
Update the details of a cluster.
updateCluster
in interface ContainerEngine
request
- The request object containing the details to sendpublic UpdateNodePoolResponse updateNodePool(UpdateNodePoolRequest request)
ContainerEngine
Update the details of a node pool.
updateNodePool
in interface ContainerEngine
request
- The request object containing the details to sendpublic ContainerEngineWaiters getWaiters()
ContainerEngine
Gets the pre-configured waiters available for resources for this service.
getWaiters
in interface ContainerEngine
public ContainerEnginePaginators getPaginators()
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.
getPaginators
in interface ContainerEngine
Copyright © 2016–2021. All rights reserved.