Package com.oracle.bmc.rover

Class RoverNodeClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.rover.RoverNodeClient

All Implemented Interfaces:

RoverNode, AutoCloseable

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RoverNodeClient.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 RoverNode.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static RoverNodeClient.Builder	builder()	Create a builder for this client.
ChangeRoverNodeCompartmentResponse	changeRoverNodeCompartment(ChangeRoverNodeCompartmentRequest request)	Moves a rover node into a different compartment.
void	close()
CreateRoverNodeResponse	createRoverNode(CreateRoverNodeRequest request)	Creates a new RoverNode.
DeleteRoverNodeResponse	deleteRoverNode(DeleteRoverNodeRequest request)	Deletes a RoverNode resource by identifier
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
RoverNodePaginators	getPaginators()	Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
GetRoverNodeResponse	getRoverNode(GetRoverNodeRequest request)	Gets a RoverNode by identifier.
GetRoverNodeCertificateResponse	getRoverNodeCertificate(GetRoverNodeCertificateRequest request)	Get the certificate for a rover node
GetRoverNodeEncryptionKeyResponse	getRoverNodeEncryptionKey(GetRoverNodeEncryptionKeyRequest request)	Get the data encryption key for a rover node.
GetRoverNodeGetRptResponse	getRoverNodeGetRpt(GetRoverNodeGetRptRequest request)	Get the resource principal token for a rover node
RoverNodeWaiters	getWaiters()	Gets the pre-configured waiters available for resources for this service.
ListRoverNodesResponse	listRoverNodes(ListRoverNodesRequest request)	Returns a list of RoverNodes.
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.
RoverNodeActionRetrieveCaBundleResponse	roverNodeActionRetrieveCaBundle(RoverNodeActionRetrieveCaBundleRequest request)	Retrieve Ca Bundle for a rover node
RoverNodeActionSetKeyResponse	roverNodeActionSetKey(RoverNodeActionSetKeyRequest request)	Get the resource principal public key for a rover node
RoverNodeGenerateCertificateResponse	roverNodeGenerateCertificate(RoverNodeGenerateCertificateRequest request)	Request to generate certificate for a roverNode.
RoverNodeRenewCertificateResponse	roverNodeRenewCertificate(RoverNodeRenewCertificateRequest request)	Request to renew certificate for a roverNode.
RoverNodeReplaceCertificateAuthorityResponse	roverNodeReplaceCertificateAuthority(RoverNodeReplaceCertificateAuthorityRequest request)	Request to replace certificate authority for a roverNode.
RoverNodeRetrieveLeafCertificateResponse	roverNodeRetrieveLeafCertificate(RoverNodeRetrieveLeafCertificateRequest request)	Retrieve the leaf certificate info for a rover node
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.
UpdateRoverNodeResponse	updateRoverNode(UpdateRoverNodeRequest request)	Updates the RoverNode
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 java.lang.AutoCloseable

close

Methods inherited from interface com.oracle.bmc.rover.RoverNode

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Field Detail

SERVICE

public static final Service SERVICE

Service instance for RoverNode.

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

RoverNodeClient

@Deprecated
public RoverNodeClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

RoverNodeClient

@Deprecated
public RoverNodeClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                       ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

RoverNodeClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

RoverNodeClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

RoverNodeClient

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

RoverNodeClient

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

RoverNodeClient

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

RoverNodeClient

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

Method Detail

builder

public static RoverNodeClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: RoverNode

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 RoverNode

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: RoverNode

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 RoverNode

Parameters:

regionId - The public region ID.

changeRoverNodeCompartment

public ChangeRoverNodeCompartmentResponse changeRoverNodeCompartment(ChangeRoverNodeCompartmentRequest request)

Description copied from interface: RoverNode

Moves a rover node into a different compartment.

Specified by:

changeRoverNodeCompartment in interface RoverNode

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createRoverNode

public CreateRoverNodeResponse createRoverNode(CreateRoverNodeRequest request)

Description copied from interface: RoverNode

Creates a new RoverNode.

Specified by:

createRoverNode in interface RoverNode

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteRoverNode

public DeleteRoverNodeResponse deleteRoverNode(DeleteRoverNodeRequest request)

Description copied from interface: RoverNode

Deletes a RoverNode resource by identifier

Specified by:

deleteRoverNode in interface RoverNode

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getRoverNode

public GetRoverNodeResponse getRoverNode(GetRoverNodeRequest request)

Description copied from interface: RoverNode

Gets a RoverNode by identifier.

Specified by:

getRoverNode in interface RoverNode

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getRoverNodeCertificate

public GetRoverNodeCertificateResponse getRoverNodeCertificate(GetRoverNodeCertificateRequest request)

Description copied from interface: RoverNode

Get the certificate for a rover node

Specified by:

getRoverNodeCertificate in interface RoverNode

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getRoverNodeEncryptionKey

public GetRoverNodeEncryptionKeyResponse getRoverNodeEncryptionKey(GetRoverNodeEncryptionKeyRequest request)

Description copied from interface: RoverNode

Get the data encryption key for a rover node.

Specified by:

getRoverNodeEncryptionKey in interface RoverNode

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getRoverNodeGetRpt

public GetRoverNodeGetRptResponse getRoverNodeGetRpt(GetRoverNodeGetRptRequest request)

Description copied from interface: RoverNode

Get the resource principal token for a rover node

Specified by:

getRoverNodeGetRpt in interface RoverNode

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listRoverNodes

public ListRoverNodesResponse listRoverNodes(ListRoverNodesRequest request)

Description copied from interface: RoverNode

Returns a list of RoverNodes.

Specified by:

listRoverNodes in interface RoverNode

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

roverNodeActionRetrieveCaBundle

public RoverNodeActionRetrieveCaBundleResponse roverNodeActionRetrieveCaBundle(RoverNodeActionRetrieveCaBundleRequest request)

Description copied from interface: RoverNode

Retrieve Ca Bundle for a rover node

Specified by:

roverNodeActionRetrieveCaBundle in interface RoverNode

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

roverNodeActionSetKey

public RoverNodeActionSetKeyResponse roverNodeActionSetKey(RoverNodeActionSetKeyRequest request)

Description copied from interface: RoverNode

Get the resource principal public key for a rover node

Specified by:

roverNodeActionSetKey in interface RoverNode

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

roverNodeGenerateCertificate

public RoverNodeGenerateCertificateResponse roverNodeGenerateCertificate(RoverNodeGenerateCertificateRequest request)

Description copied from interface: RoverNode

Request to generate certificate for a roverNode.

Specified by:

roverNodeGenerateCertificate in interface RoverNode

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

roverNodeRenewCertificate

public RoverNodeRenewCertificateResponse roverNodeRenewCertificate(RoverNodeRenewCertificateRequest request)

Description copied from interface: RoverNode

Request to renew certificate for a roverNode.

Specified by:

roverNodeRenewCertificate in interface RoverNode

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

roverNodeReplaceCertificateAuthority

public RoverNodeReplaceCertificateAuthorityResponse roverNodeReplaceCertificateAuthority(RoverNodeReplaceCertificateAuthorityRequest request)

Description copied from interface: RoverNode

Request to replace certificate authority for a roverNode.

Specified by:

roverNodeReplaceCertificateAuthority in interface RoverNode

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

roverNodeRetrieveLeafCertificate

public RoverNodeRetrieveLeafCertificateResponse roverNodeRetrieveLeafCertificate(RoverNodeRetrieveLeafCertificateRequest request)

Description copied from interface: RoverNode

Retrieve the leaf certificate info for a rover node

Specified by:

roverNodeRetrieveLeafCertificate in interface RoverNode

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateRoverNode

public UpdateRoverNodeResponse updateRoverNode(UpdateRoverNodeRequest request)

Description copied from interface: RoverNode

Updates the RoverNode

Specified by:

updateRoverNode in interface RoverNode

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public RoverNodeWaiters getWaiters()

Description copied from interface: RoverNode

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

Specified by:

getWaiters in interface RoverNode

Returns:

The service waiters.

getPaginators

public RoverNodePaginators getPaginators()

Description copied from interface: RoverNode

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 RoverNode

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()