RedirectClient (Oracle Cloud Infrastructure Java SDK

java.lang.Object
- com.oracle.bmc.waas.RedirectClient

All Implemented Interfaces:: Redirect, AutoCloseable

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class RedirectClient.Builder
Builder class for this client.

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

static Service SERVICE
Service instance for Redirect.

Fields
Modifier and Type	Field and Description
`static Service`	`SERVICE` Service instance for Redirect.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`RedirectClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)` Creates a new service instance using the given authentication provider and client configuration.
	`RedirectClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)` Creates a new service instance using the given authentication provider and client configuration.
	`RedirectClient(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.
	`RedirectClient(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.
	`RedirectClient(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`	`RedirectClient(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.
	`RedirectClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)` Creates a new service instance using the given authentication provider.
	`RedirectClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)` Creates a new service instance using the given authentication provider and client configuration.
	`RedirectClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)` Creates a new service instance using the given authentication provider and client configuration.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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`	`getEndpoint()` Gets the set endpoint for REST call (ex, https://www.example.com)
`GetHttpRedirectResponse`	`getHttpRedirect(GetHttpRedirectRequest request)` Gets the details of a HTTP Redirect.
`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`	`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’).
`UpdateHttpRedirectResponse`	`updateHttpRedirect(UpdateHttpRedirectRequest request)` Updates the details of a HTTP Redirect, including target and tags.

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 Redirect.
- Constructor Detail
  - RedirectClient
```
public RedirectClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
```
    Creates a new service instance using the given authentication provider.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
  - RedirectClient
```
public RedirectClient(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.
  - RedirectClient
```
public RedirectClient(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.
  - RedirectClient
```
public RedirectClient(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.
  - RedirectClient
```
public RedirectClient(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.
  - RedirectClient
```
public RedirectClient(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)
  - RedirectClient
```
public RedirectClient(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)
  - RedirectClient
```
public RedirectClient(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
  - RedirectClient
```
protected RedirectClient(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 RedirectClient.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 RedirectClient.Builder builder()
```
    Create a builder for this client.
    
    Returns:
    
    builder
  - refreshClient
```
public void refreshClient()
```
    Description copied from interface: Redirect
    
    Rebuilds the client from scratch. Useful to refresh certificates.
    
    Specified by:
    
    refreshClient in interface Redirect
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    Description copied from interface: Redirect
    
    Sets the endpoint to call (ex, https://www.example.com).
    
    Specified by:
    
    setEndpoint in interface Redirect
    
    Parameters:
    
    endpoint - The endpoint of the service.
  - getEndpoint
```
public String getEndpoint()
```
    Description copied from interface: Redirect
    
    Gets the set endpoint for REST call (ex, https://www.example.com)
    
    Specified by:
    
    getEndpoint in interface Redirect
  - 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.
  - close
```
public void close()
```
    Specified by:
    
    close in interface AutoCloseable
  - 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.

Class RedirectClient

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERVICE

Constructor Detail

RedirectClient

RedirectClient

RedirectClient

RedirectClient

RedirectClient

RedirectClient

RedirectClient

RedirectClient

RedirectClient

Method Detail

builder

refreshClient

setEndpoint

getEndpoint

setRegion

setRegion

close

changeHttpRedirectCompartment

createHttpRedirect

deleteHttpRedirect

getHttpRedirect

listHttpRedirects

updateHttpRedirect

getWaiters

getPaginators