com.oracle.bmc.dts

Interface TransferApplianceEntitlement

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

TransferApplianceEntitlementClient

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

Data Transfer Service API Specification 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
CreateTransferApplianceEntitlementResponse	createTransferApplianceEntitlement(CreateTransferApplianceEntitlementRequest request) Create the Entitlement to use a Transfer Appliance.
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
GetTransferApplianceEntitlementResponse	getTransferApplianceEntitlement(GetTransferApplianceEntitlementRequest request) Describes the Transfer Appliance Entitlement in detail
TransferApplianceEntitlementWaiters	getWaiters() Gets the pre-configured waiters available for resources for this service.
ListTransferApplianceEntitlementResponse	listTransferApplianceEntitlement(ListTransferApplianceEntitlementRequest request) Lists Transfer Transfer Appliance Entitlement
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’).

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

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.

createTransferApplianceEntitlement

CreateTransferApplianceEntitlementResponse createTransferApplianceEntitlement(CreateTransferApplianceEntitlementRequest request)

Create the Entitlement to use a Transfer Appliance. 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 will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. 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 CreateTransferApplianceEntitlement API.

getTransferApplianceEntitlement

GetTransferApplianceEntitlementResponse getTransferApplianceEntitlement(GetTransferApplianceEntitlementRequest request)

Describes the Transfer Appliance 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 will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. 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 GetTransferApplianceEntitlement API.

listTransferApplianceEntitlement

ListTransferApplianceEntitlementResponse listTransferApplianceEntitlement(ListTransferApplianceEntitlementRequest request)

Lists Transfer Transfer Appliance 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 will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. 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 ListTransferApplianceEntitlement API.

getWaiters

TransferApplianceEntitlementWaiters getWaiters()

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

Returns:

The service waiters.