Package com.oracle.bmc.apigateway

Class GatewayClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.apigateway.GatewayClient

All Implemented Interfaces:

Gateway, AutoCloseable

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

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
String	clientCommonLibraryVersion	Compatible SDK version, provided by the codegen.
Optional<String>	minimumClientCommonLibraryVersionFromClient	Minimum compatible SDK version, maybe provided by the codegen.
static Service	SERVICE	Service instance for Gateway.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
AddGatewayLockResponse	addGatewayLock(AddGatewayLockRequest request)	Adds a lock to a Gateway resource.
static GatewayClient.Builder	builder()	Create a builder for this client.
ChangeGatewayCompartmentResponse	changeGatewayCompartment(ChangeGatewayCompartmentRequest request)	Changes the gateway compartment.
void	close()
CreateGatewayResponse	createGateway(CreateGatewayRequest request)	Creates a new gateway.
DeleteGatewayResponse	deleteGateway(DeleteGatewayRequest request)	Deletes the gateway with the given identifier.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
GetGatewayResponse	getGateway(GetGatewayRequest request)	Gets a gateway by identifier.
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
GatewayPaginators	getPaginators()	Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
GatewayWaiters	getWaiters()	Gets the pre-configured waiters available for resources for this service.
ListGatewaysResponse	listGateways(ListGatewaysRequest request)	Returns a list of gateways.
void	populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)	Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
void	refreshClient()	Rebuild the backing HttpClient.
RemoveGatewayLockResponse	removeGatewayLock(RemoveGatewayLockRequest request)	Removes a lock from a Gateway resource.
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’).
void	updateBaseEndpoint(String endpoint)	This method should be used for parameterized endpoint templates only.
UpdateGatewayResponse	updateGateway(UpdateGatewayRequest request)	Updates the gateway with the given identifier.
void	useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)	This method should be used to enable or disable the use of realm-specific endpoint template.

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 java.lang.AutoCloseable

close

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

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Field Detail

SERVICE

public static final Service SERVICE

Service instance for Gateway.

clientCommonLibraryVersion

public final String clientCommonLibraryVersion

Compatible SDK version, provided by the codegen.

minimumClientCommonLibraryVersionFromClient

public final Optional<String> minimumClientCommonLibraryVersionFromClient

Minimum compatible SDK version, maybe provided by the codegen.

Constructor Detail

GatewayClient

@Deprecated
public GatewayClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

GatewayClient

@Deprecated
public GatewayClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                     ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

GatewayClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

GatewayClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

GatewayClient

@Deprecated
public GatewayClient(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 GatewayClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

GatewayClient

@Deprecated
public GatewayClient(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 GatewayClient.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)

GatewayClient

@Deprecated
public GatewayClient(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 GatewayClient.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

GatewayClient

@Deprecated
public GatewayClient(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 GatewayClient.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 - GatewayClient.Builder.executorService

Method Detail

builder

public static GatewayClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: Gateway

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 Gateway

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: Gateway

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 Gateway

Parameters:

regionId - The public region ID.

addGatewayLock

public AddGatewayLockResponse addGatewayLock(AddGatewayLockRequest request)

Description copied from interface: Gateway

Adds a lock to a Gateway resource.

Specified by:

addGatewayLock in interface Gateway

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changeGatewayCompartment

public ChangeGatewayCompartmentResponse changeGatewayCompartment(ChangeGatewayCompartmentRequest request)

Description copied from interface: Gateway

Changes the gateway compartment.

Specified by:

changeGatewayCompartment in interface Gateway

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createGateway

public CreateGatewayResponse createGateway(CreateGatewayRequest request)

Description copied from interface: Gateway

Creates a new gateway.

Specified by:

createGateway in interface Gateway

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteGateway

public DeleteGatewayResponse deleteGateway(DeleteGatewayRequest request)

Description copied from interface: Gateway

Deletes the gateway with the given identifier.

Specified by:

deleteGateway in interface Gateway

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getGateway

public GetGatewayResponse getGateway(GetGatewayRequest request)

Description copied from interface: Gateway

Gets a gateway by identifier.

Specified by:

getGateway in interface Gateway

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listGateways

public ListGatewaysResponse listGateways(ListGatewaysRequest request)

Description copied from interface: Gateway

Returns a list of gateways.

Specified by:

listGateways in interface Gateway

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

removeGatewayLock

public RemoveGatewayLockResponse removeGatewayLock(RemoveGatewayLockRequest request)

Description copied from interface: Gateway

Removes a lock from a Gateway resource.

Specified by:

removeGatewayLock in interface Gateway

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateGateway

public UpdateGatewayResponse updateGateway(UpdateGatewayRequest request)

Description copied from interface: Gateway

Updates the gateway with the given identifier.

Specified by:

updateGateway in interface Gateway

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public GatewayWaiters getWaiters()

Description copied from interface: Gateway

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

Specified by:

getWaiters in interface Gateway

Returns:

The service waiters.

getPaginators

public GatewayPaginators getPaginators()

Description copied from interface: Gateway

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 Gateway

Returns:

The service paginators.

getDefaultConfigurator

protected ClientConfigurator getDefaultConfigurator()

useRealmSpecificEndpointTemplate

public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)

This method should be used to enable or disable the use of realm-specific endpoint template.

The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false

Parameters:

useOfRealmSpecificEndpointTemplateEnabled - This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively

populateServiceParametersInEndpoint

public final void populateServiceParametersInEndpoint(String endpoint,
                                                      Map<String,Object> requiredParametersMap)

Populate the parameters in the endpoint with its corresponding value and update the base endpoint.

The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.

Parameters:

endpoint - The endpoint template in use

requiredParametersMap - Map of parameter name as key and value set in request path or query parameter as value

updateBaseEndpoint

public final void updateBaseEndpoint(String endpoint)

This method should be used for parameterized endpoint templates only.

This does not include {region} and {secondLevelDomain} parameters.

Parameters:

endpoint - The updated endpoint to use

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

getClientCommonLibraryVersion

public String getClientCommonLibraryVersion()

getMinimumClientCommonLibraryVersionFromClient

public Optional<String> getMinimumClientCommonLibraryVersionFromClient()