Package com.oracle.bmc.redis

Class OciCacheConfigSetClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.redis.OciCacheConfigSetClient

All Implemented Interfaces:

OciCacheConfigSet, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20220315")
public class OciCacheConfigSetClient
extends BaseSyncClient
implements OciCacheConfigSet

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OciCacheConfigSetClient.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 OciCacheConfigSet.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static OciCacheConfigSetClient.Builder	builder()	Create a builder for this client.
ChangeOciCacheConfigSetCompartmentResponse	changeOciCacheConfigSetCompartment(ChangeOciCacheConfigSetCompartmentRequest request)	Moves an OCI Cache Config Set into a different compartment within the same tenancy.
void	close()
CreateOciCacheConfigSetResponse	createOciCacheConfigSet(CreateOciCacheConfigSetRequest request)	Create a new OCI Cache Config Set for the given OCI cache engine version.
DeleteOciCacheConfigSetResponse	deleteOciCacheConfigSet(DeleteOciCacheConfigSetRequest request)	Deletes the specified OCI Cache Config Set.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
GetOciCacheConfigSetResponse	getOciCacheConfigSet(GetOciCacheConfigSetRequest request)	Retrieves the specified OCI Cache Config Set.
OciCacheConfigSetPaginators	getPaginators()	Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
OciCacheConfigSetWaiters	getWaiters()	Gets the pre-configured waiters available for resources for this service.
ListAssociatedOciCacheClustersResponse	listAssociatedOciCacheClusters(ListAssociatedOciCacheClustersRequest request)	Gets a list of associated OCI Cache clusters for an OCI Cache Config Set.
ListOciCacheConfigSetsResponse	listOciCacheConfigSets(ListOciCacheConfigSetsRequest request)	Lists the OCI Cache Config Sets in the specified compartment.
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.
UpdateOciCacheConfigSetResponse	updateOciCacheConfigSet(UpdateOciCacheConfigSetRequest request)	Updates the specified OCI Cache Config Set.
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.redis.OciCacheConfigSet

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Field Detail

SERVICE

public static final Service SERVICE

Service instance for OciCacheConfigSet.

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

OciCacheConfigSetClient

@Deprecated
public OciCacheConfigSetClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

OciCacheConfigSetClient

@Deprecated
public OciCacheConfigSetClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                               ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

OciCacheConfigSetClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

OciCacheConfigSetClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

OciCacheConfigSetClient

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

OciCacheConfigSetClient

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

OciCacheConfigSetClient

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

OciCacheConfigSetClient

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

Method Detail

builder

public static OciCacheConfigSetClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: OciCacheConfigSet

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 OciCacheConfigSet

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: OciCacheConfigSet

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 OciCacheConfigSet

Parameters:

regionId - The public region ID.

changeOciCacheConfigSetCompartment

public ChangeOciCacheConfigSetCompartmentResponse changeOciCacheConfigSetCompartment(ChangeOciCacheConfigSetCompartmentRequest request)

Description copied from interface: OciCacheConfigSet

Moves an OCI Cache Config Set into a different compartment within the same tenancy.

Specified by:

changeOciCacheConfigSetCompartment in interface OciCacheConfigSet

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createOciCacheConfigSet

public CreateOciCacheConfigSetResponse createOciCacheConfigSet(CreateOciCacheConfigSetRequest request)

Description copied from interface: OciCacheConfigSet

Create a new OCI Cache Config Set for the given OCI cache engine version.

Specified by:

createOciCacheConfigSet in interface OciCacheConfigSet

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteOciCacheConfigSet

public DeleteOciCacheConfigSetResponse deleteOciCacheConfigSet(DeleteOciCacheConfigSetRequest request)

Description copied from interface: OciCacheConfigSet

Deletes the specified OCI Cache Config Set.

Specified by:

deleteOciCacheConfigSet in interface OciCacheConfigSet

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getOciCacheConfigSet

public GetOciCacheConfigSetResponse getOciCacheConfigSet(GetOciCacheConfigSetRequest request)

Description copied from interface: OciCacheConfigSet

Retrieves the specified OCI Cache Config Set.

Specified by:

getOciCacheConfigSet in interface OciCacheConfigSet

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listAssociatedOciCacheClusters

public ListAssociatedOciCacheClustersResponse listAssociatedOciCacheClusters(ListAssociatedOciCacheClustersRequest request)

Description copied from interface: OciCacheConfigSet

Gets a list of associated OCI Cache clusters for an OCI Cache Config Set.

Specified by:

listAssociatedOciCacheClusters in interface OciCacheConfigSet

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listOciCacheConfigSets

public ListOciCacheConfigSetsResponse listOciCacheConfigSets(ListOciCacheConfigSetsRequest request)

Description copied from interface: OciCacheConfigSet

Lists the OCI Cache Config Sets in the specified compartment.

Specified by:

listOciCacheConfigSets in interface OciCacheConfigSet

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateOciCacheConfigSet

public UpdateOciCacheConfigSetResponse updateOciCacheConfigSet(UpdateOciCacheConfigSetRequest request)

Description copied from interface: OciCacheConfigSet

Updates the specified OCI Cache Config Set.

Specified by:

updateOciCacheConfigSet in interface OciCacheConfigSet

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public OciCacheConfigSetWaiters getWaiters()

Description copied from interface: OciCacheConfigSet

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

Specified by:

getWaiters in interface OciCacheConfigSet

Returns:

The service waiters.

getPaginators

public OciCacheConfigSetPaginators getPaginators()

Description copied from interface: OciCacheConfigSet

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 OciCacheConfigSet

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