com.oracle.bmc.dts

Interface TransferAppliance

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

TransferApplianceClient

@Generated(value="OracleSDKGenerator",
           comments="API Version: 1.0.017")
public interface TransferAppliance
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
CreateTransferApplianceResponse	createTransferAppliance(CreateTransferApplianceRequest request) Create a new Transfer Appliance
CreateTransferApplianceAdminCredentialsResponse	createTransferApplianceAdminCredentials(CreateTransferApplianceAdminCredentialsRequest request) Creates an X.509 certificate from a public key
DeleteTransferApplianceResponse	deleteTransferAppliance(DeleteTransferApplianceRequest request) deletes a transfer Appliance
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
GetTransferApplianceResponse	getTransferAppliance(GetTransferApplianceRequest request) Describes a transfer appliance in detail
GetTransferApplianceCertificateAuthorityCertificateResponse	getTransferApplianceCertificateAuthorityCertificate(GetTransferApplianceCertificateAuthorityCertificateRequest request) Gets the x.509 certificate for the Transfer Appliance’s dedicated Certificate Authority (CA)
GetTransferApplianceEncryptionPassphraseResponse	getTransferApplianceEncryptionPassphrase(GetTransferApplianceEncryptionPassphraseRequest request) Describes a transfer appliance encryptionPassphrase in detail
TransferApplianceWaiters	getWaiters() Gets the pre-configured waiters available for resources for this service.
ListTransferAppliancesResponse	listTransferAppliances(ListTransferAppliancesRequest request) Lists Transfer Appliances associated with a transferJob
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’).
UpdateTransferApplianceResponse	updateTransferAppliance(UpdateTransferApplianceRequest request) Updates a Transfer Appliance
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 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.

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

createTransferAppliance

CreateTransferApplianceResponse createTransferAppliance(CreateTransferApplianceRequest request)

Create a new Transfer Appliance

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

createTransferApplianceAdminCredentials

CreateTransferApplianceAdminCredentialsResponse createTransferApplianceAdminCredentials(CreateTransferApplianceAdminCredentialsRequest request)

Creates an X.509 certificate from a public key

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

deleteTransferAppliance

DeleteTransferApplianceResponse deleteTransferAppliance(DeleteTransferApplianceRequest request)

deletes a transfer Appliance

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

getTransferAppliance

GetTransferApplianceResponse getTransferAppliance(GetTransferApplianceRequest request)

Describes a transfer appliance 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 GetTransferAppliance API.

getTransferApplianceCertificateAuthorityCertificate

GetTransferApplianceCertificateAuthorityCertificateResponse getTransferApplianceCertificateAuthorityCertificate(GetTransferApplianceCertificateAuthorityCertificateRequest request)

Gets the x.509 certificate for the Transfer Appliance’s dedicated Certificate Authority (CA)

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

getTransferApplianceEncryptionPassphrase

GetTransferApplianceEncryptionPassphraseResponse getTransferApplianceEncryptionPassphrase(GetTransferApplianceEncryptionPassphraseRequest request)

Describes a transfer appliance encryptionPassphrase 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 GetTransferApplianceEncryptionPassphrase API.

listTransferAppliances

ListTransferAppliancesResponse listTransferAppliances(ListTransferAppliancesRequest request)

Lists Transfer Appliances associated with a transferJob

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

updateTransferAppliance

UpdateTransferApplianceResponse updateTransferAppliance(UpdateTransferApplianceRequest request)

Updates a Transfer Appliance

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

getWaiters

TransferApplianceWaiters getWaiters()

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

Returns:

The service waiters.