RoverCluster (Oracle Cloud Infrastructure Java SDK

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

RoverClusterClient
```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20201210")
public interface RoverCluster
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

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`ChangeRoverClusterCompartmentResponse`	`changeRoverClusterCompartment(ChangeRoverClusterCompartmentRequest request)` Moves a cluster into a different compartment.
`CreateRoverClusterResponse`	`createRoverCluster(CreateRoverClusterRequest request)` Creates a new RoverCluster.
`DeleteRoverClusterResponse`	`deleteRoverCluster(DeleteRoverClusterRequest request)` Deletes a RoverCluster resource by identifier
`String`	`getEndpoint()` Gets the set endpoint for REST call (ex, https://www.example.com)
`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`	`refreshClient()` Rebuilds the client from scratch.
`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’).
`UpdateRoverClusterResponse`	`updateRoverCluster(UpdateRoverClusterRequest request)` Updates the RoverCluster

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.
  - changeRoverClusterCompartment
```
ChangeRoverClusterCompartmentResponse changeRoverClusterCompartment(ChangeRoverClusterCompartmentRequest request)
```
    Moves a cluster 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 ChangeRoverClusterCompartment API.
  - createRoverCluster
```
CreateRoverClusterResponse createRoverCluster(CreateRoverClusterRequest request)
```
    Creates a new RoverCluster.
    
    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 CreateRoverCluster API.
  - deleteRoverCluster
```
DeleteRoverClusterResponse deleteRoverCluster(DeleteRoverClusterRequest request)
```
    Deletes a RoverCluster 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 DeleteRoverCluster API.
  - getRoverCluster
```
GetRoverClusterResponse getRoverCluster(GetRoverClusterRequest request)
```
    Gets a RoverCluster 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 GetRoverCluster API.
  - getRoverClusterCertificate
```
GetRoverClusterCertificateResponse getRoverClusterCertificate(GetRoverClusterCertificateRequest request)
```
    Get the certificate for a rover cluster
    
    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 GetRoverClusterCertificate API.
  - listRoverClusters
```
ListRoverClustersResponse listRoverClusters(ListRoverClustersRequest request)
```
    Returns a list of RoverClusters.
    
    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 ListRoverClusters API.
  - updateRoverCluster
```
UpdateRoverClusterResponse updateRoverCluster(UpdateRoverClusterRequest request)
```
    Updates the RoverCluster
    
    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 UpdateRoverCluster API.
  - getWaiters
```
RoverClusterWaiters getWaiters()
```
    Gets the pre-configured waiters available for resources for this service.
    
    Returns:
    
    The service waiters.
  - getPaginators
```
RoverClusterPaginators 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.

Interface RoverCluster

Method Summary

Methods inherited from interface java.lang.AutoCloseable

Method Detail

refreshClient

setEndpoint

getEndpoint

setRegion

setRegion

changeRoverClusterCompartment

createRoverCluster

deleteRoverCluster

getRoverCluster

getRoverClusterCertificate

listRoverClusters

updateRoverCluster

getWaiters

getPaginators