com.oracle.bmc.rover

Class RoverClusterClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.rover.RoverClusterClient

All Implemented Interfaces:

RoverCluster, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20201210")
public class RoverClusterClient
extends BaseSyncClient
implements RoverCluster

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static Service	SERVICE Service instance for RoverCluster.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static RoverClusterClient.Builder	builder() Create a builder for this client.
ChangeRoverClusterCompartmentResponse	changeRoverClusterCompartment(ChangeRoverClusterCompartmentRequest request) Moves a cluster into a different compartment.
void	close()
CreateRoverClusterResponse	createRoverCluster(CreateRoverClusterRequest request) Creates a new RoverCluster.
DeleteRoverClusterResponse	deleteRoverCluster(DeleteRoverClusterRequest request) Deletes a RoverCluster resource by identifier
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
RoverClusterPaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
GetRoverClusterResponse	getRoverCluster(GetRoverClusterRequest request) Gets a RoverCluster by identifier
GetRoverClusterCertificateResponse	getRoverClusterCertificate(GetRoverClusterCertificateRequest request) Get the certificate for a rover cluster
RoverClusterWaiters	getWaiters() Gets the pre-configured waiters available for resources for this service.
ListRoverClustersResponse	listRoverClusters(ListRoverClustersRequest request) Returns a list of RoverClusters.
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.
RequestAdditionalNodesResponse	requestAdditionalNodes(RequestAdditionalNodesRequest request) Submit additional nodes request for a roverCluster.
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’).
void	updateBaseEndpoint(String endpoint) This method should be used for parameterized endpoint templates only.
UpdateRoverClusterResponse	updateRoverCluster(UpdateRoverClusterRequest request) Updates the RoverCluster
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.rover.RoverCluster

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for RoverCluster.

Constructor Detail

RoverClusterClient

@Deprecated
public RoverClusterClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

RoverClusterClient

@Deprecated
public RoverClusterClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                      ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

RoverClusterClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

RoverClusterClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

RoverClusterClient

@Deprecated
public RoverClusterClient(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 RoverClusterClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

RoverClusterClient

@Deprecated
public RoverClusterClient(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 RoverClusterClient.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)

RoverClusterClient

@Deprecated
public RoverClusterClient(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 RoverClusterClient.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

RoverClusterClient

@Deprecated
public RoverClusterClient(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 RoverClusterClient.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 - RoverClusterClient.Builder.executorService

Method Detail

builder

public static RoverClusterClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: RoverCluster

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 RoverCluster

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: RoverCluster

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 RoverCluster

Parameters:

regionId - The public region ID.

changeRoverClusterCompartment

public ChangeRoverClusterCompartmentResponse changeRoverClusterCompartment(ChangeRoverClusterCompartmentRequest request)

Description copied from interface: RoverCluster

Moves a cluster into a different compartment.

Specified by:

changeRoverClusterCompartment in interface RoverCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createRoverCluster

public CreateRoverClusterResponse createRoverCluster(CreateRoverClusterRequest request)

Description copied from interface: RoverCluster

Creates a new RoverCluster.

Specified by:

createRoverCluster in interface RoverCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteRoverCluster

public DeleteRoverClusterResponse deleteRoverCluster(DeleteRoverClusterRequest request)

Description copied from interface: RoverCluster

Deletes a RoverCluster resource by identifier

Specified by:

deleteRoverCluster in interface RoverCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getRoverCluster

public GetRoverClusterResponse getRoverCluster(GetRoverClusterRequest request)

Description copied from interface: RoverCluster

Gets a RoverCluster by identifier

Specified by:

getRoverCluster in interface RoverCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getRoverClusterCertificate

public GetRoverClusterCertificateResponse getRoverClusterCertificate(GetRoverClusterCertificateRequest request)

Description copied from interface: RoverCluster

Get the certificate for a rover cluster

Specified by:

getRoverClusterCertificate in interface RoverCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listRoverClusters

public ListRoverClustersResponse listRoverClusters(ListRoverClustersRequest request)

Description copied from interface: RoverCluster

Returns a list of RoverClusters.

Specified by:

listRoverClusters in interface RoverCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

requestAdditionalNodes

public RequestAdditionalNodesResponse requestAdditionalNodes(RequestAdditionalNodesRequest request)

Description copied from interface: RoverCluster

Submit additional nodes request for a roverCluster.

Specified by:

requestAdditionalNodes in interface RoverCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateRoverCluster

public UpdateRoverClusterResponse updateRoverCluster(UpdateRoverClusterRequest request)

Description copied from interface: RoverCluster

Updates the RoverCluster

Specified by:

updateRoverCluster in interface RoverCluster

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public RoverClusterWaiters getWaiters()

Description copied from interface: RoverCluster

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

Specified by:

getWaiters in interface RoverCluster

Returns:

The service waiters.

getPaginators

public RoverClusterPaginators getPaginators()

Description copied from interface: RoverCluster

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 RoverCluster

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