com.oracle.bmc.rover

Interface RoverEntitlementAsync

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

RoverEntitlementAsyncClient

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

A description of the RoverCloudService API.

Method Summary

Modifier and Type	Method and Description
Future<ChangeRoverEntitlementCompartmentResponse>	changeRoverEntitlementCompartment(ChangeRoverEntitlementCompartmentRequest request, AsyncHandler<ChangeRoverEntitlementCompartmentRequest,ChangeRoverEntitlementCompartmentResponse> handler) Moves an entitlement into a different compartment.
Future<CreateRoverEntitlementResponse>	createRoverEntitlement(CreateRoverEntitlementRequest request, AsyncHandler<CreateRoverEntitlementRequest,CreateRoverEntitlementResponse> handler) Create the Entitlement to use a Rover Device.
Future<DeleteRoverEntitlementResponse>	deleteRoverEntitlement(DeleteRoverEntitlementRequest request, AsyncHandler<DeleteRoverEntitlementRequest,DeleteRoverEntitlementResponse> handler) Deletes a rover entitlement
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
Future<GetRoverEntitlementResponse>	getRoverEntitlement(GetRoverEntitlementRequest request, AsyncHandler<GetRoverEntitlementRequest,GetRoverEntitlementResponse> handler) Describes the Rover Device Entitlement in detail
Future<ListRoverEntitlementsResponse>	listRoverEntitlements(ListRoverEntitlementsRequest request, AsyncHandler<ListRoverEntitlementsRequest,ListRoverEntitlementsResponse> handler) 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’).
Future<UpdateRoverEntitlementResponse>	updateRoverEntitlement(UpdateRoverEntitlementRequest request, AsyncHandler<UpdateRoverEntitlementRequest,UpdateRoverEntitlementResponse> handler) Updates the RoverEntitlement
void	useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled) Determines whether realm specific endpoint should be used or not.

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

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.

useRealmSpecificEndpointTemplate

void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)

Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”

Parameters:

realmSpecificEndpointTemplateEnabled - flag to enable the use of realm specific endpoint template

changeRoverEntitlementCompartment

Future<ChangeRoverEntitlementCompartmentResponse> changeRoverEntitlementCompartment(ChangeRoverEntitlementCompartmentRequest request,
                                                                                    AsyncHandler<ChangeRoverEntitlementCompartmentRequest,ChangeRoverEntitlementCompartmentResponse> handler)

Moves an entitlement into a different compartment.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

createRoverEntitlement

Future<CreateRoverEntitlementResponse> createRoverEntitlement(CreateRoverEntitlementRequest request,
                                                              AsyncHandler<CreateRoverEntitlementRequest,CreateRoverEntitlementResponse> handler)

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

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

deleteRoverEntitlement

Future<DeleteRoverEntitlementResponse> deleteRoverEntitlement(DeleteRoverEntitlementRequest request,
                                                              AsyncHandler<DeleteRoverEntitlementRequest,DeleteRoverEntitlementResponse> handler)

Deletes a rover entitlement

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getRoverEntitlement

Future<GetRoverEntitlementResponse> getRoverEntitlement(GetRoverEntitlementRequest request,
                                                        AsyncHandler<GetRoverEntitlementRequest,GetRoverEntitlementResponse> handler)

Describes the Rover Device Entitlement in detail

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listRoverEntitlements

Future<ListRoverEntitlementsResponse> listRoverEntitlements(ListRoverEntitlementsRequest request,
                                                            AsyncHandler<ListRoverEntitlementsRequest,ListRoverEntitlementsResponse> handler)

Returns a list of RoverEntitlements.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

updateRoverEntitlement

Future<UpdateRoverEntitlementResponse> updateRoverEntitlement(UpdateRoverEntitlementRequest request,
                                                              AsyncHandler<UpdateRoverEntitlementRequest,UpdateRoverEntitlementResponse> handler)

Updates the RoverEntitlement

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.