com.oracle.bmc.waas

Class RedirectClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.waas.RedirectClient

All Implemented Interfaces:

Redirect, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20181116")
public class RedirectClient
extends BaseSyncClient
implements Redirect

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and 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 Redirect.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static RedirectClient.Builder	builder() Create a builder for this client.
ChangeHttpRedirectCompartmentResponse	changeHttpRedirectCompartment(ChangeHttpRedirectCompartmentRequest request) Moves HTTP Redirect into a different compartment.
void	close()
CreateHttpRedirectResponse	createHttpRedirect(CreateHttpRedirectRequest request) Creates a new HTTP Redirect on the WAF edge.
DeleteHttpRedirectResponse	deleteHttpRedirect(DeleteHttpRedirectRequest request) Deletes a redirect.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
GetHttpRedirectResponse	getHttpRedirect(GetHttpRedirectRequest request) Gets the details of a HTTP Redirect.
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
RedirectPaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
RedirectWaiters	getWaiters() Gets the pre-configured waiters available for resources for this service.
ListHttpRedirectsResponse	listHttpRedirects(ListHttpRedirectsRequest request) Gets a list of HTTP Redirects.
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.
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.
UpdateHttpRedirectResponse	updateHttpRedirect(UpdateHttpRedirectRequest request) Updates the details of a HTTP Redirect, including target and tags.
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 com.oracle.bmc.waas.Redirect

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for Redirect.

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

RedirectClient

@Deprecated
public RedirectClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

RedirectClient

@Deprecated
public RedirectClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                  ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

RedirectClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

RedirectClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

RedirectClient

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

RedirectClient

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

RedirectClient

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

RedirectClient

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

Method Detail

builder

public static RedirectClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: Redirect

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 Redirect

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: Redirect

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 Redirect

Parameters:

regionId - The public region ID.

changeHttpRedirectCompartment

public ChangeHttpRedirectCompartmentResponse changeHttpRedirectCompartment(ChangeHttpRedirectCompartmentRequest request)

Description copied from interface: Redirect

Moves HTTP Redirect into a different compartment. When provided, If-Match is checked against ETag values of the WAAS policy.

Specified by:

changeHttpRedirectCompartment in interface Redirect

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createHttpRedirect

public CreateHttpRedirectResponse createHttpRedirect(CreateHttpRedirectRequest request)

Description copied from interface: Redirect

Creates a new HTTP Redirect on the WAF edge.

Specified by:

createHttpRedirect in interface Redirect

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteHttpRedirect

public DeleteHttpRedirectResponse deleteHttpRedirect(DeleteHttpRedirectRequest request)

Description copied from interface: Redirect

Deletes a redirect.

Specified by:

deleteHttpRedirect in interface Redirect

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getHttpRedirect

public GetHttpRedirectResponse getHttpRedirect(GetHttpRedirectRequest request)

Description copied from interface: Redirect

Gets the details of a HTTP Redirect.

Specified by:

getHttpRedirect in interface Redirect

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listHttpRedirects

public ListHttpRedirectsResponse listHttpRedirects(ListHttpRedirectsRequest request)

Description copied from interface: Redirect

Gets a list of HTTP Redirects.

Specified by:

listHttpRedirects in interface Redirect

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateHttpRedirect

public UpdateHttpRedirectResponse updateHttpRedirect(UpdateHttpRedirectRequest request)

Description copied from interface: Redirect

Updates the details of a HTTP Redirect, including target and tags. Only the fields specified in the request body will be updated; all other properties will remain unchanged.

Specified by:

updateHttpRedirect in interface Redirect

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public RedirectWaiters getWaiters()

Description copied from interface: Redirect

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

Specified by:

getWaiters in interface Redirect

Returns:

The service waiters.

getPaginators

public RedirectPaginators getPaginators()

Description copied from interface: Redirect

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 Redirect

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