com.oracle.bmc.rover

Interface RoverEntitlement

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

RoverEntitlementClient

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20201210")
public interface RoverEntitlement
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
ChangeRoverEntitlementCompartmentResponse	changeRoverEntitlementCompartment(ChangeRoverEntitlementCompartmentRequest request) Moves an entitlement into a different compartment.
CreateRoverEntitlementResponse	createRoverEntitlement(CreateRoverEntitlementRequest request) Create the Entitlement to use a Rover Device.
DeleteRoverEntitlementResponse	deleteRoverEntitlement(DeleteRoverEntitlementRequest request) Deletes a rover entitlement
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
RoverEntitlementPaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
GetRoverEntitlementResponse	getRoverEntitlement(GetRoverEntitlementRequest request) Describes the Rover Device Entitlement in detail
RoverEntitlementWaiters	getWaiters() Gets the pre-configured waiters available for resources for this service.
ListRoverEntitlementsResponse	listRoverEntitlements(ListRoverEntitlementsRequest request) Returns a list of RoverEntitlements.
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’).
UpdateRoverEntitlementResponse	updateRoverEntitlement(UpdateRoverEntitlementRequest request) Updates the RoverEntitlement

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.

changeRoverEntitlementCompartment

ChangeRoverEntitlementCompartmentResponse changeRoverEntitlementCompartment(ChangeRoverEntitlementCompartmentRequest request)

Moves an entitlement 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 ChangeRoverEntitlementCompartment API.

createRoverEntitlement

CreateRoverEntitlementResponse createRoverEntitlement(CreateRoverEntitlementRequest request)

Create the Entitlement to use a Rover Device. It requires some offline process of review and signatures before request is granted.

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 CreateRoverEntitlement API.

deleteRoverEntitlement

DeleteRoverEntitlementResponse deleteRoverEntitlement(DeleteRoverEntitlementRequest request)

Deletes a rover entitlement

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 DeleteRoverEntitlement API.

getRoverEntitlement

GetRoverEntitlementResponse getRoverEntitlement(GetRoverEntitlementRequest request)

Describes the Rover Device Entitlement in detail

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 GetRoverEntitlement API.

listRoverEntitlements

ListRoverEntitlementsResponse listRoverEntitlements(ListRoverEntitlementsRequest request)

Returns a list of RoverEntitlements.

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 ListRoverEntitlements API.

updateRoverEntitlement

UpdateRoverEntitlementResponse updateRoverEntitlement(UpdateRoverEntitlementRequest request)

Updates the RoverEntitlement

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 UpdateRoverEntitlement API.

getWaiters

RoverEntitlementWaiters getWaiters()

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

Returns:

The service waiters.

getPaginators

RoverEntitlementPaginators 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.