com.oracle.bmc.dts

Class TransferApplianceEntitlementClient

java.lang.Object

com.oracle.bmc.dts.TransferApplianceEntitlementClient

All Implemented Interfaces:

TransferApplianceEntitlement, AutoCloseable

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

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	TransferApplianceEntitlementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory) Creates a new service instance using the given authentication provider and client configuration.
	TransferApplianceEntitlementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Creates a new service instance using the given authentication provider and client configuration.
	TransferApplianceEntitlementClient(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.
	TransferApplianceEntitlementClient(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.
	TransferApplianceEntitlementClient(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	TransferApplianceEntitlementClient(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.
	TransferApplianceEntitlementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Creates a new service instance using the given authentication provider.
	TransferApplianceEntitlementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Creates a new service instance using the given authentication provider and client configuration.
	TransferApplianceEntitlementClient(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
static TransferApplianceEntitlementClient.Builder	builder() Create a builder for this client.
void	close()
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	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’).

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

Constructor Detail

TransferApplianceEntitlementClient

public TransferApplianceEntitlementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Creates a new service instance using the given authentication provider.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

TransferApplianceEntitlementClient

public TransferApplianceEntitlementClient(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.

TransferApplianceEntitlementClient

public TransferApplianceEntitlementClient(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.

TransferApplianceEntitlementClient

public TransferApplianceEntitlementClient(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.

TransferApplianceEntitlementClient

public TransferApplianceEntitlementClient(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.

TransferApplianceEntitlementClient

public TransferApplianceEntitlementClient(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)

TransferApplianceEntitlementClient

public TransferApplianceEntitlementClient(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)

TransferApplianceEntitlementClient

public TransferApplianceEntitlementClient(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

TransferApplianceEntitlementClient

protected TransferApplianceEntitlementClient(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 TransferApplianceEntitlementClient.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 TransferApplianceEntitlementClient.Builder builder()

Create a builder for this client.

Returns:

builder

refreshClient

public void refreshClient()

Description copied from interface: TransferApplianceEntitlement

Rebuilds the client from scratch. Useful to refresh certificates.

Specified by:

refreshClient in interface TransferApplianceEntitlement

setEndpoint

public void setEndpoint(String endpoint)

Description copied from interface: TransferApplianceEntitlement

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

Specified by:

setEndpoint in interface TransferApplianceEntitlement

Parameters:

endpoint - The endpoint of the service.

getEndpoint

public String getEndpoint()

Description copied from interface: TransferApplianceEntitlement

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

Specified by:

getEndpoint in interface TransferApplianceEntitlement

setRegion

public void setRegion(Region region)

Description copied from interface: TransferApplianceEntitlement

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 TransferApplianceEntitlement

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: TransferApplianceEntitlement

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 TransferApplianceEntitlement

Parameters:

regionId - The public region ID.

close

public void close()

Specified by:

close in interface AutoCloseable

createTransferApplianceEntitlement

public CreateTransferApplianceEntitlementResponse createTransferApplianceEntitlement(CreateTransferApplianceEntitlementRequest request)

Description copied from interface: TransferApplianceEntitlement

Create the Entitlement to use a Transfer Appliance. It requires some offline process of review and signatures before request is granted.

Specified by:

createTransferApplianceEntitlement in interface TransferApplianceEntitlement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getTransferApplianceEntitlement

public GetTransferApplianceEntitlementResponse getTransferApplianceEntitlement(GetTransferApplianceEntitlementRequest request)

Description copied from interface: TransferApplianceEntitlement

Describes the Transfer Appliance Entitlement in detail

Specified by:

getTransferApplianceEntitlement in interface TransferApplianceEntitlement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listTransferApplianceEntitlement

public ListTransferApplianceEntitlementResponse listTransferApplianceEntitlement(ListTransferApplianceEntitlementRequest request)

Description copied from interface: TransferApplianceEntitlement

Lists Transfer Transfer Appliance Entitlement

Specified by:

listTransferApplianceEntitlement in interface TransferApplianceEntitlement

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public TransferApplianceEntitlementWaiters getWaiters()

Description copied from interface: TransferApplianceEntitlement

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

Specified by:

getWaiters in interface TransferApplianceEntitlement

Returns:

The service waiters.