com.oracle.bmc.dts

Class TransferJobClient

java.lang.Object

com.oracle.bmc.dts.TransferJobClient

All Implemented Interfaces:

TransferJob, AutoCloseable

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

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	TransferJobClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory) Creates a new service instance using the given authentication provider and client configuration.
	TransferJobClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Creates a new service instance using the given authentication provider and client configuration.
	TransferJobClient(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.
	TransferJobClient(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.
	TransferJobClient(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	TransferJobClient(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.
	TransferJobClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Creates a new service instance using the given authentication provider.
	TransferJobClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Creates a new service instance using the given authentication provider and client configuration.
	TransferJobClient(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 TransferJobClient.Builder	builder() Create a builder for this client.
ChangeTransferJobCompartmentResponse	changeTransferJobCompartment(ChangeTransferJobCompartmentRequest request) Moves a TransferJob into a different compartment.
void	close()
CreateTransferJobResponse	createTransferJob(CreateTransferJobRequest request) Create a new Transfer Job that corresponds with customer’s logical dataset e.g.
DeleteTransferJobResponse	deleteTransferJob(DeleteTransferJobRequest request) deletes a transfer job
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
TransferJobPaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
GetTransferJobResponse	getTransferJob(GetTransferJobRequest request) Describes a transfer job in detail
TransferJobWaiters	getWaiters() Gets the pre-configured waiters available for resources for this service.
ListTransferJobsResponse	listTransferJobs(ListTransferJobsRequest request) Lists Transfer Jobs in a given compartment
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’).
UpdateTransferJobResponse	updateTransferJob(UpdateTransferJobRequest request) Updates a Transfer Job that corresponds with customer’s logical dataset e.g.

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

Constructor Detail

TransferJobClient

public TransferJobClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Creates a new service instance using the given authentication provider.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

TransferJobClient

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

TransferJobClient

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

TransferJobClient

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

TransferJobClient

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

TransferJobClient

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

TransferJobClient

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

TransferJobClient

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

TransferJobClient

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

Create a builder for this client.

Returns:

builder

refreshClient

public void refreshClient()

Description copied from interface: TransferJob

Rebuilds the client from scratch. Useful to refresh certificates.

Specified by:

refreshClient in interface TransferJob

setEndpoint

public void setEndpoint(String endpoint)

Description copied from interface: TransferJob

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

Specified by:

setEndpoint in interface TransferJob

Parameters:

endpoint - The endpoint of the service.

getEndpoint

public String getEndpoint()

Description copied from interface: TransferJob

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

Specified by:

getEndpoint in interface TransferJob

setRegion

public void setRegion(Region region)

Description copied from interface: TransferJob

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 TransferJob

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: TransferJob

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 TransferJob

Parameters:

regionId - The public region ID.

close

public void close()

Specified by:

close in interface AutoCloseable

changeTransferJobCompartment

public ChangeTransferJobCompartmentResponse changeTransferJobCompartment(ChangeTransferJobCompartmentRequest request)

Description copied from interface: TransferJob

Moves a TransferJob into a different compartment.

Specified by:

changeTransferJobCompartment in interface TransferJob

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createTransferJob

public CreateTransferJobResponse createTransferJob(CreateTransferJobRequest request)

Description copied from interface: TransferJob

Create a new Transfer Job that corresponds with customer’s logical dataset e.g. a DB or a filesystem.

Specified by:

createTransferJob in interface TransferJob

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteTransferJob

public DeleteTransferJobResponse deleteTransferJob(DeleteTransferJobRequest request)

Description copied from interface: TransferJob

deletes a transfer job

Specified by:

deleteTransferJob in interface TransferJob

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getTransferJob

public GetTransferJobResponse getTransferJob(GetTransferJobRequest request)

Description copied from interface: TransferJob

Describes a transfer job in detail

Specified by:

getTransferJob in interface TransferJob

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listTransferJobs

public ListTransferJobsResponse listTransferJobs(ListTransferJobsRequest request)

Description copied from interface: TransferJob

Lists Transfer Jobs in a given compartment

Specified by:

listTransferJobs in interface TransferJob

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateTransferJob

public UpdateTransferJobResponse updateTransferJob(UpdateTransferJobRequest request)

Description copied from interface: TransferJob

Updates a Transfer Job that corresponds with customer’s logical dataset e.g. a DB or a filesystem.

Specified by:

updateTransferJob in interface TransferJob

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public TransferJobWaiters getWaiters()

Description copied from interface: TransferJob

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

Specified by:

getWaiters in interface TransferJob

Returns:

The service waiters.

getPaginators

public TransferJobPaginators getPaginators()

Description copied from interface: TransferJob

Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data. These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.

Specified by:

getPaginators in interface TransferJob

Returns:

The service paginators.