com.oracle.bmc.rover

Interface RoverNode

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

RoverNodeClient

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20201210")
public interface RoverNode
extends AutoCloseable

A description of the RoverCloudService API. This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.

Method Summary

Modifier and Type	Method and Description
ChangeRoverNodeCompartmentResponse	changeRoverNodeCompartment(ChangeRoverNodeCompartmentRequest request) Moves a rover node into a different compartment.
CreateRoverNodeResponse	createRoverNode(CreateRoverNodeRequest request) Creates a new RoverNode.
DeleteRoverNodeResponse	deleteRoverNode(DeleteRoverNodeRequest request) Deletes a RoverNode resource by identifier
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
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	refreshClient() Rebuilds the client from scratch.
RoverNodeActionSetKeyResponse	roverNodeActionSetKey(RoverNodeActionSetKeyRequest request) Get the resource principal public key for a rover node
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’).
UpdateRoverNodeResponse	updateRoverNode(UpdateRoverNodeRequest request) Updates the RoverNode

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

refreshClient

void refreshClient()

Rebuilds the client from scratch. Useful to refresh certificates.

setEndpoint

void setEndpoint(String endpoint)

Sets the endpoint to call (ex, https://www.example.com).

Parameters:

endpoint - The endpoint of the service.

getEndpoint

String getEndpoint()

Gets the set endpoint for REST call (ex, https://www.example.com)

setRegion

void setRegion(Region region)

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.

Parameters:

region - The region of the service.

setRegion

void setRegion(String regionId)

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.

Parameters:

regionId - The public region ID.

changeRoverNodeCompartment

ChangeRoverNodeCompartmentResponse changeRoverNodeCompartment(ChangeRoverNodeCompartmentRequest request)

Moves a rover node into a different compartment.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ChangeRoverNodeCompartment API.

createRoverNode

CreateRoverNodeResponse createRoverNode(CreateRoverNodeRequest request)

Creates a new RoverNode.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use CreateRoverNode API.

deleteRoverNode

DeleteRoverNodeResponse deleteRoverNode(DeleteRoverNodeRequest request)

Deletes a RoverNode resource by identifier

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use DeleteRoverNode API.

getRoverNode

GetRoverNodeResponse getRoverNode(GetRoverNodeRequest request)

Gets a RoverNode by identifier.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use GetRoverNode API.

getRoverNodeCertificate

GetRoverNodeCertificateResponse getRoverNodeCertificate(GetRoverNodeCertificateRequest request)

Get the certificate for a rover node

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use GetRoverNodeCertificate API.

getRoverNodeEncryptionKey

GetRoverNodeEncryptionKeyResponse getRoverNodeEncryptionKey(GetRoverNodeEncryptionKeyRequest request)

Get the data encryption key for a rover node.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use GetRoverNodeEncryptionKey API.

getRoverNodeGetRpt

GetRoverNodeGetRptResponse getRoverNodeGetRpt(GetRoverNodeGetRptRequest request)

Get the resource principal token for a rover node

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use GetRoverNodeGetRpt API.

listRoverNodes

ListRoverNodesResponse listRoverNodes(ListRoverNodesRequest request)

Returns a list of RoverNodes.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ListRoverNodes API.

roverNodeActionSetKey

RoverNodeActionSetKeyResponse roverNodeActionSetKey(RoverNodeActionSetKeyRequest request)

Get the resource principal public key for a rover node

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use RoverNodeActionSetKey API.

updateRoverNode

UpdateRoverNodeResponse updateRoverNode(UpdateRoverNodeRequest request)

Updates the RoverNode

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use UpdateRoverNode API.

getWaiters

RoverNodeWaiters getWaiters()

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

Returns:

The service waiters.

getPaginators

RoverNodePaginators getPaginators()

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.

Returns:

The service paginators.