Package com.oracle.bmc.dts

Interface TransferApplianceAsync

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

TransferApplianceAsyncClient

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

Data Transfer Service API Specification

Method Summary

Modifier and Type	Method	Description
Future<CreateTransferApplianceResponse>	createTransferAppliance(CreateTransferApplianceRequest request, AsyncHandler<CreateTransferApplianceRequest,CreateTransferApplianceResponse> handler)	Create a new Transfer Appliance
Future<CreateTransferApplianceAdminCredentialsResponse>	createTransferApplianceAdminCredentials(CreateTransferApplianceAdminCredentialsRequest request, AsyncHandler<CreateTransferApplianceAdminCredentialsRequest,CreateTransferApplianceAdminCredentialsResponse> handler)	Creates an X.509 certificate from a public key
Future<DeleteTransferApplianceResponse>	deleteTransferAppliance(DeleteTransferApplianceRequest request, AsyncHandler<DeleteTransferApplianceRequest,DeleteTransferApplianceResponse> handler)	deletes a transfer Appliance
String	getEndpoint()	Gets the set endpoint for REST call (ex, https://www.example.com)
Future<GetTransferApplianceResponse>	getTransferAppliance(GetTransferApplianceRequest request, AsyncHandler<GetTransferApplianceRequest,GetTransferApplianceResponse> handler)	Describes a transfer appliance in detail
Future<GetTransferApplianceCertificateAuthorityCertificateResponse>	getTransferApplianceCertificateAuthorityCertificate(GetTransferApplianceCertificateAuthorityCertificateRequest request, AsyncHandler<GetTransferApplianceCertificateAuthorityCertificateRequest,GetTransferApplianceCertificateAuthorityCertificateResponse> handler)	Gets the x.509 certificate for the Transfer Appliance’s dedicated Certificate Authority (CA)
Future<GetTransferApplianceEncryptionPassphraseResponse>	getTransferApplianceEncryptionPassphrase(GetTransferApplianceEncryptionPassphraseRequest request, AsyncHandler<GetTransferApplianceEncryptionPassphraseRequest,GetTransferApplianceEncryptionPassphraseResponse> handler)	Describes a transfer appliance encryptionPassphrase in detail
Future<ListTransferAppliancesResponse>	listTransferAppliances(ListTransferAppliancesRequest request, AsyncHandler<ListTransferAppliancesRequest,ListTransferAppliancesResponse> handler)	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’).
Future<UpdateTransferApplianceResponse>	updateTransferAppliance(UpdateTransferApplianceRequest request, AsyncHandler<UpdateTransferApplianceRequest,UpdateTransferApplianceResponse> handler)	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 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

createTransferAppliance

Future<CreateTransferApplianceResponse> createTransferAppliance(CreateTransferApplianceRequest request,
                                                                AsyncHandler<CreateTransferApplianceRequest,CreateTransferApplianceResponse> handler)

Create a new Transfer Appliance

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.

createTransferApplianceAdminCredentials

Future<CreateTransferApplianceAdminCredentialsResponse> createTransferApplianceAdminCredentials(CreateTransferApplianceAdminCredentialsRequest request,
                                                                                                AsyncHandler<CreateTransferApplianceAdminCredentialsRequest,CreateTransferApplianceAdminCredentialsResponse> handler)

Creates an X.509 certificate from a public key

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.

deleteTransferAppliance

Future<DeleteTransferApplianceResponse> deleteTransferAppliance(DeleteTransferApplianceRequest request,
                                                                AsyncHandler<DeleteTransferApplianceRequest,DeleteTransferApplianceResponse> handler)

deletes a transfer Appliance

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.

getTransferAppliance

Future<GetTransferApplianceResponse> getTransferAppliance(GetTransferApplianceRequest request,
                                                          AsyncHandler<GetTransferApplianceRequest,GetTransferApplianceResponse> handler)

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

getTransferApplianceCertificateAuthorityCertificate

Future<GetTransferApplianceCertificateAuthorityCertificateResponse> getTransferApplianceCertificateAuthorityCertificate(GetTransferApplianceCertificateAuthorityCertificateRequest request,
                                                                                                                        AsyncHandler<GetTransferApplianceCertificateAuthorityCertificateRequest,GetTransferApplianceCertificateAuthorityCertificateResponse> handler)

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

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.

getTransferApplianceEncryptionPassphrase

Future<GetTransferApplianceEncryptionPassphraseResponse> getTransferApplianceEncryptionPassphrase(GetTransferApplianceEncryptionPassphraseRequest request,
                                                                                                  AsyncHandler<GetTransferApplianceEncryptionPassphraseRequest,GetTransferApplianceEncryptionPassphraseResponse> handler)

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

listTransferAppliances

Future<ListTransferAppliancesResponse> listTransferAppliances(ListTransferAppliancesRequest request,
                                                              AsyncHandler<ListTransferAppliancesRequest,ListTransferAppliancesResponse> handler)

Lists Transfer Appliances associated with a transferJob

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.

updateTransferAppliance

Future<UpdateTransferApplianceResponse> updateTransferAppliance(UpdateTransferApplianceRequest request,
                                                                AsyncHandler<UpdateTransferApplianceRequest,UpdateTransferApplianceResponse> handler)

Updates a Transfer Appliance

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.