com.oracle.bmc.apigateway

Class DeploymentClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.apigateway.DeploymentClient

All Implemented Interfaces:

Deployment, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190501")
public class DeploymentClient
extends BaseSyncClient
implements Deployment

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
DeploymentClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory) Deprecated. Use the builder instead.
DeploymentClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Deprecated. Use the builder instead.
DeploymentClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
DeploymentClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
DeploymentClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService) Deprecated. Use the builder instead.
DeploymentClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Deprecated. Use the builder instead.
DeploymentClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Deprecated. Use the builder instead.
DeploymentClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator) Deprecated. Use the builder instead.

Method Summary

Modifier and Type	Method and Description
static DeploymentClient.Builder	builder() Create a builder for this client.
ChangeDeploymentCompartmentResponse	changeDeploymentCompartment(ChangeDeploymentCompartmentRequest request) Changes the deployment compartment.
void	close()
CreateDeploymentResponse	createDeployment(CreateDeploymentRequest request) Creates a new deployment.
DeleteDeploymentResponse	deleteDeployment(DeleteDeploymentRequest request) Deletes the deployment with the given identifier.
protected ClientConfigurator	getDefaultConfigurator()
GetDeploymentResponse	getDeployment(GetDeploymentRequest request) Gets a deployment by identifier.
String	getEndpoint()
DeploymentPaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
DeploymentWaiters	getWaiters() Gets the pre-configured waiters available for resources for this service.
ListDeploymentsResponse	listDeployments(ListDeploymentsRequest request) Returns a list of deployments.
void	refreshClient() Rebuild the backing HttpClient.
void	setEndpoint(String endpoint)
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’).
UpdateDeploymentResponse	updateDeployment(UpdateDeploymentRequest request) Updates the deployment with the given identifier.

Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient

clientCall

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.oracle.bmc.apigateway.Deployment

getEndpoint, refreshClient, setEndpoint

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for Deployment.

Constructor Detail

DeploymentClient

@Deprecated
public DeploymentClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DeploymentClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

DeploymentClient

@Deprecated
public DeploymentClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                    ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DeploymentClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

DeploymentClient

@Deprecated
public DeploymentClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                    ClientConfiguration configuration,
                                    ClientConfigurator clientConfigurator)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DeploymentClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

DeploymentClient

@Deprecated
public DeploymentClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                    ClientConfiguration configuration,
                                    ClientConfigurator clientConfigurator,
                                    RequestSignerFactory defaultRequestSignerFactory)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DeploymentClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

DeploymentClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DeploymentClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

DeploymentClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DeploymentClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

DeploymentClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DeploymentClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

DeploymentClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DeploymentClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

executorService - DeploymentClient.Builder.executorService

Method Detail

builder

public static DeploymentClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: Deployment

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 Deployment

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: Deployment

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 Deployment

Parameters:

regionId - The public region ID.

changeDeploymentCompartment

public ChangeDeploymentCompartmentResponse changeDeploymentCompartment(ChangeDeploymentCompartmentRequest request)

Description copied from interface: Deployment

Changes the deployment compartment.

Specified by:

changeDeploymentCompartment in interface Deployment

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createDeployment

public CreateDeploymentResponse createDeployment(CreateDeploymentRequest request)

Description copied from interface: Deployment

Creates a new deployment.

Specified by:

createDeployment in interface Deployment

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteDeployment

public DeleteDeploymentResponse deleteDeployment(DeleteDeploymentRequest request)

Description copied from interface: Deployment

Deletes the deployment with the given identifier.

Specified by:

deleteDeployment in interface Deployment

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getDeployment

public GetDeploymentResponse getDeployment(GetDeploymentRequest request)

Description copied from interface: Deployment

Gets a deployment by identifier.

Specified by:

getDeployment in interface Deployment

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listDeployments

public ListDeploymentsResponse listDeployments(ListDeploymentsRequest request)

Description copied from interface: Deployment

Returns a list of deployments.

Specified by:

listDeployments in interface Deployment

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateDeployment

public UpdateDeploymentResponse updateDeployment(UpdateDeploymentRequest request)

Description copied from interface: Deployment

Updates the deployment with the given identifier.

Specified by:

updateDeployment in interface Deployment

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public DeploymentWaiters getWaiters()

Description copied from interface: Deployment

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

Specified by:

getWaiters in interface Deployment

Returns:

The service waiters.

getPaginators

public DeploymentPaginators getPaginators()

Description copied from interface: Deployment

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 Deployment

Returns:

The service paginators.

getDefaultConfigurator

protected ClientConfigurator getDefaultConfigurator()

setEndpoint

public final void setEndpoint(String endpoint)

getEndpoint

public final String getEndpoint()

refreshClient

public final void refreshClient()

Rebuild the backing HttpClient. This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.

close

public final void close()

Specified by:

close in interface AutoCloseable