com.oracle.bmc.dts

Class ApplianceExportJobClient

java.lang.Object

com.oracle.bmc.dts.ApplianceExportJobClient

All Implemented Interfaces:

ApplianceExportJob, AutoCloseable

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

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	ApplianceExportJobClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory) Creates a new service instance using the given authentication provider and client configuration.
	ApplianceExportJobClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Creates a new service instance using the given authentication provider and client configuration.
	ApplianceExportJobClient(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.
	ApplianceExportJobClient(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.
	ApplianceExportJobClient(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	ApplianceExportJobClient(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.
	ApplianceExportJobClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Creates a new service instance using the given authentication provider.
	ApplianceExportJobClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Creates a new service instance using the given authentication provider and client configuration.
	ApplianceExportJobClient(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 ApplianceExportJobClient.Builder	builder() Create a builder for this client.
ChangeApplianceExportJobCompartmentResponse	changeApplianceExportJobCompartment(ChangeApplianceExportJobCompartmentRequest request) Moves a ApplianceExportJob into a different compartment.
void	close()
CreateApplianceExportJobResponse	createApplianceExportJob(CreateApplianceExportJobRequest request) Creates a new Appliance Export Job that corresponds with customer’s logical dataset
DeleteApplianceExportJobResponse	deleteApplianceExportJob(DeleteApplianceExportJobRequest request) deletes a Appliance Export Job
GetApplianceExportJobResponse	getApplianceExportJob(GetApplianceExportJobRequest request) Describes a Appliance Export Job in detail
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
ApplianceExportJobPaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
ApplianceExportJobWaiters	getWaiters() Gets the pre-configured waiters available for resources for this service.
ListApplianceExportJobsResponse	listApplianceExportJobs(ListApplianceExportJobsRequest request) Lists Appliance Export 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’).
UpdateApplianceExportJobResponse	updateApplianceExportJob(UpdateApplianceExportJobRequest request) Updates a Appliance Export Job that corresponds with customer’s logical dataset.

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

Constructor Detail

ApplianceExportJobClient

public ApplianceExportJobClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Creates a new service instance using the given authentication provider.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

ApplianceExportJobClient

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

ApplianceExportJobClient

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

ApplianceExportJobClient

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

ApplianceExportJobClient

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

ApplianceExportJobClient

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

ApplianceExportJobClient

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

ApplianceExportJobClient

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

ApplianceExportJobClient

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

Create a builder for this client.

Returns:

builder

refreshClient

public void refreshClient()

Description copied from interface: ApplianceExportJob

Rebuilds the client from scratch. Useful to refresh certificates.

Specified by:

refreshClient in interface ApplianceExportJob

setEndpoint

public void setEndpoint(String endpoint)

Description copied from interface: ApplianceExportJob

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

Specified by:

setEndpoint in interface ApplianceExportJob

Parameters:

endpoint - The endpoint of the service.

getEndpoint

public String getEndpoint()

Description copied from interface: ApplianceExportJob

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

Specified by:

getEndpoint in interface ApplianceExportJob

setRegion

public void setRegion(Region region)

Description copied from interface: ApplianceExportJob

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 ApplianceExportJob

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: ApplianceExportJob

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 ApplianceExportJob

Parameters:

regionId - The public region ID.

close

public void close()

Specified by:

close in interface AutoCloseable

changeApplianceExportJobCompartment

public ChangeApplianceExportJobCompartmentResponse changeApplianceExportJobCompartment(ChangeApplianceExportJobCompartmentRequest request)

Description copied from interface: ApplianceExportJob

Moves a ApplianceExportJob into a different compartment.

Specified by:

changeApplianceExportJobCompartment in interface ApplianceExportJob

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createApplianceExportJob

public CreateApplianceExportJobResponse createApplianceExportJob(CreateApplianceExportJobRequest request)

Description copied from interface: ApplianceExportJob

Creates a new Appliance Export Job that corresponds with customer’s logical dataset

Specified by:

createApplianceExportJob in interface ApplianceExportJob

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteApplianceExportJob

public DeleteApplianceExportJobResponse deleteApplianceExportJob(DeleteApplianceExportJobRequest request)

Description copied from interface: ApplianceExportJob

deletes a Appliance Export Job

Specified by:

deleteApplianceExportJob in interface ApplianceExportJob

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getApplianceExportJob

public GetApplianceExportJobResponse getApplianceExportJob(GetApplianceExportJobRequest request)

Description copied from interface: ApplianceExportJob

Describes a Appliance Export Job in detail

Specified by:

getApplianceExportJob in interface ApplianceExportJob

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listApplianceExportJobs

public ListApplianceExportJobsResponse listApplianceExportJobs(ListApplianceExportJobsRequest request)

Description copied from interface: ApplianceExportJob

Lists Appliance Export Jobs in a given compartment

Specified by:

listApplianceExportJobs in interface ApplianceExportJob

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateApplianceExportJob

public UpdateApplianceExportJobResponse updateApplianceExportJob(UpdateApplianceExportJobRequest request)

Description copied from interface: ApplianceExportJob

Updates a Appliance Export Job that corresponds with customer’s logical dataset.

Specified by:

updateApplianceExportJob in interface ApplianceExportJob

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public ApplianceExportJobWaiters getWaiters()

Description copied from interface: ApplianceExportJob

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

Specified by:

getWaiters in interface ApplianceExportJob

Returns:

The service waiters.

getPaginators

public ApplianceExportJobPaginators getPaginators()

Description copied from interface: ApplianceExportJob

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 ApplianceExportJob

Returns:

The service paginators.