com.oracle.bmc.dts

Class TransferPackageClient

java.lang.Object

com.oracle.bmc.dts.TransferPackageClient

All Implemented Interfaces:

TransferPackage, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 1.0.017")
public class TransferPackageClient
extends Object
implements TransferPackage

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TransferPackageClient.Builder Builder class for this client.

Field Summary

Fields

Modifier and Type	Field and Description
static Service	SERVICE Service instance for TransferPackage.

Constructor Summary

Constructors

Modifier	Constructor and Description
	TransferPackageClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory) Creates a new service instance using the given authentication provider and client configuration.
	TransferPackageClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Creates a new service instance using the given authentication provider and client configuration.
	TransferPackageClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Creates a new service instance using the given authentication provider and client configuration.
	TransferPackageClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Creates a new service instance using the given authentication provider and client configuration.
	TransferPackageClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService) Creates a new service instance using the given authentication provider and client configuration.
protected	TransferPackageClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService, RestClientFactoryBuilder restClientFactoryBuilder) Creates a new service instance using the given authentication provider and client configuration.
	TransferPackageClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Creates a new service instance using the given authentication provider.
	TransferPackageClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Creates a new service instance using the given authentication provider and client configuration.
	TransferPackageClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator) Creates a new service instance using the given authentication provider and client configuration.

Method Summary

Modifier and Type	Method and Description
AttachDevicesToTransferPackageResponse	attachDevicesToTransferPackage(AttachDevicesToTransferPackageRequest request) Attaches Devices to a Transfer Package
static TransferPackageClient.Builder	builder() Create a builder for this client.
void	close()
CreateTransferPackageResponse	createTransferPackage(CreateTransferPackageRequest request) Create a new Transfer Package
DeleteTransferPackageResponse	deleteTransferPackage(DeleteTransferPackageRequest request) deletes a transfer Package
DetachDevicesFromTransferPackageResponse	detachDevicesFromTransferPackage(DetachDevicesFromTransferPackageRequest request) Detaches Devices from a Transfer Package
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
GetTransferPackageResponse	getTransferPackage(GetTransferPackageRequest request) Describes a transfer package in detail
TransferPackageWaiters	getWaiters() Gets the pre-configured waiters available for resources for this service.
ListTransferPackagesResponse	listTransferPackages(ListTransferPackagesRequest request) Lists Transfer Packages 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’).
UpdateTransferPackageResponse	updateTransferPackage(UpdateTransferPackageRequest request) Updates a Transfer Package

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SERVICE

public static final Service SERVICE

Service instance for TransferPackage.

Constructor Detail

TransferPackageClient

public TransferPackageClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Creates a new service instance using the given authentication provider.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

TransferPackageClient

public TransferPackageClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                             ClientConfiguration configuration)

Creates a new service instance using the given authentication provider and client configuration.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

TransferPackageClient

public TransferPackageClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                             ClientConfiguration configuration,
                             ClientConfigurator clientConfigurator)

Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.

TransferPackageClient

public TransferPackageClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                             ClientConfiguration configuration,
                             ClientConfigurator clientConfigurator,
                             RequestSignerFactory defaultRequestSignerFactory)

Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.

This is an advanced constructor for clients that want to take control over how requests are signed.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.

defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.

TransferPackageClient

public TransferPackageClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                             ClientConfiguration configuration,
                             ClientConfigurator clientConfigurator,
                             RequestSignerFactory defaultRequestSignerFactory,
                             List<ClientConfigurator> additionalClientConfigurators)

Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.

This is an advanced constructor for clients that want to take control over how requests are signed.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.

defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.

additionalClientConfigurators - Additional client configurators to be run after the primary configurator.

TransferPackageClient

public TransferPackageClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                             ClientConfiguration configuration,
                             ClientConfigurator clientConfigurator,
                             RequestSignerFactory defaultRequestSignerFactory,
                             List<ClientConfigurator> additionalClientConfigurators,
                             String endpoint)

Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.

This is an advanced constructor for clients that want to take control over how requests are signed.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.

defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.

additionalClientConfigurators - Additional client configurators to be run after the primary configurator.

endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)

TransferPackageClient

public TransferPackageClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                             ClientConfiguration configuration,
                             ClientConfigurator clientConfigurator,
                             RequestSignerFactory defaultRequestSignerFactory,
                             Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                             List<ClientConfigurator> additionalClientConfigurators,
                             String endpoint)

Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.

This is an advanced constructor for clients that want to take control over how requests are signed.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.

defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.

signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signer

additionalClientConfigurators - Additional client configurators to be run after the primary configurator.

endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)

TransferPackageClient

public TransferPackageClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                             ClientConfiguration configuration,
                             ClientConfigurator clientConfigurator,
                             RequestSignerFactory defaultRequestSignerFactory,
                             Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                             List<ClientConfigurator> additionalClientConfigurators,
                             String endpoint,
                             ExecutorService executorService)

Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.

This is an advanced constructor for clients that want to take control over how requests are signed.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.

defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.

signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signer

additionalClientConfigurators - Additional client configurators to be run after the primary configurator.

endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)

executorService - ExecutorService used by the client, or null to use the default configured ThreadPoolExecutor

TransferPackageClient

protected TransferPackageClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                ClientConfiguration configuration,
                                ClientConfigurator clientConfigurator,
                                RequestSignerFactory defaultRequestSignerFactory,
                                Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                List<ClientConfigurator> additionalClientConfigurators,
                                String endpoint,
                                ExecutorService executorService,
                                RestClientFactoryBuilder restClientFactoryBuilder)

Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.

This is an advanced constructor for clients that want to take control over how requests are signed. Use the TransferPackageClient.Builder to get access to all these parameters.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.

defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.

signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signer

additionalClientConfigurators - Additional client configurators to be run after the primary configurator.

endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)

executorService - ExecutorService used by the client, or null to use the default configured ThreadPoolExecutor

restClientFactoryBuilder - the builder for the RestClientFactory

Method Detail

builder

public static TransferPackageClient.Builder builder()

Create a builder for this client.

Returns:

builder

refreshClient

public void refreshClient()

Description copied from interface: TransferPackage

Rebuilds the client from scratch. Useful to refresh certificates.

Specified by:

refreshClient in interface TransferPackage

setEndpoint

public void setEndpoint(String endpoint)

Description copied from interface: TransferPackage

Sets the endpoint to call (ex, https://www.example.com).

Specified by:

setEndpoint in interface TransferPackage

Parameters:

endpoint - The endpoint of the service.

getEndpoint

public String getEndpoint()

Description copied from interface: TransferPackage

Gets the set endpoint for REST call (ex, https://www.example.com)

Specified by:

getEndpoint in interface TransferPackage

setRegion

public void setRegion(Region region)

Description copied from interface: TransferPackage

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.

Specified by:

setRegion in interface TransferPackage

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: TransferPackage

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.

Specified by:

setRegion in interface TransferPackage

Parameters:

regionId - The public region ID.

close

public void close()

Specified by:

close in interface AutoCloseable

attachDevicesToTransferPackage

public AttachDevicesToTransferPackageResponse attachDevicesToTransferPackage(AttachDevicesToTransferPackageRequest request)

Description copied from interface: TransferPackage

Attaches Devices to a Transfer Package

Specified by:

attachDevicesToTransferPackage in interface TransferPackage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createTransferPackage

public CreateTransferPackageResponse createTransferPackage(CreateTransferPackageRequest request)

Description copied from interface: TransferPackage

Create a new Transfer Package

Specified by:

createTransferPackage in interface TransferPackage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteTransferPackage

public DeleteTransferPackageResponse deleteTransferPackage(DeleteTransferPackageRequest request)

Description copied from interface: TransferPackage

deletes a transfer Package

Specified by:

deleteTransferPackage in interface TransferPackage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

detachDevicesFromTransferPackage

public DetachDevicesFromTransferPackageResponse detachDevicesFromTransferPackage(DetachDevicesFromTransferPackageRequest request)

Description copied from interface: TransferPackage

Detaches Devices from a Transfer Package

Specified by:

detachDevicesFromTransferPackage in interface TransferPackage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getTransferPackage

public GetTransferPackageResponse getTransferPackage(GetTransferPackageRequest request)

Description copied from interface: TransferPackage

Describes a transfer package in detail

Specified by:

getTransferPackage in interface TransferPackage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listTransferPackages

public ListTransferPackagesResponse listTransferPackages(ListTransferPackagesRequest request)

Description copied from interface: TransferPackage

Lists Transfer Packages associated with a transferJob

Specified by:

listTransferPackages in interface TransferPackage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateTransferPackage

public UpdateTransferPackageResponse updateTransferPackage(UpdateTransferPackageRequest request)

Description copied from interface: TransferPackage

Updates a Transfer Package

Specified by:

updateTransferPackage in interface TransferPackage

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public TransferPackageWaiters getWaiters()

Description copied from interface: TransferPackage

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

Specified by:

getWaiters in interface TransferPackage

Returns:

The service waiters.