Package com.oracle.bmc.redis

Class OciCacheUserClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.redis.OciCacheUserClient

All Implemented Interfaces:

OciCacheUser, AutoCloseable

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

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static OciCacheUserClient.Builder	builder()	Create a builder for this client.
ChangeOciCacheUserCompartmentResponse	changeOciCacheUserCompartment(ChangeOciCacheUserCompartmentRequest request)	Moves an OCI Cache User from one compartment to another within the same tenancy.
void	close()
CreateOciCacheUserResponse	createOciCacheUser(CreateOciCacheUserRequest request)	Creates a new OCI Cache user.
DeleteOciCacheUserResponse	deleteOciCacheUser(DeleteOciCacheUserRequest request)	Deletes an existing OCI Cache User based on the OCI cache user unique ID (OCID).
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
GetOciCacheUserResponse	getOciCacheUser(GetOciCacheUserRequest request)	Get an existing OCI Cache users based on the ID (OCID).
OciCacheUserPaginators	getPaginators()	Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
OciCacheUserWaiters	getWaiters()	Gets the pre-configured waiters available for resources for this service.
ListAttachedRedisClustersResponse	listAttachedRedisClusters(ListAttachedRedisClustersRequest request)	Gets a list of associated redis cluster for an OCI cache user.
ListOciCacheUsersResponse	listOciCacheUsers(ListOciCacheUsersRequest request)	Lists the OCI Cache users based on the supplied parameters.
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.
UpdateOciCacheUserResponse	updateOciCacheUser(UpdateOciCacheUserRequest request)	Update an existing OCI Cache User with new details.
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.OciCacheUser

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Field Detail

SERVICE

public static final Service SERVICE

Service instance for OciCacheUser.

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

OciCacheUserClient

@Deprecated
public OciCacheUserClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

OciCacheUserClient

@Deprecated
public OciCacheUserClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                          ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

OciCacheUserClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

OciCacheUserClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

OciCacheUserClient

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

OciCacheUserClient

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

OciCacheUserClient

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

OciCacheUserClient

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

Method Detail

builder

public static OciCacheUserClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: OciCacheUser

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 OciCacheUser

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: OciCacheUser

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 OciCacheUser

Parameters:

regionId - The public region ID.

changeOciCacheUserCompartment

public ChangeOciCacheUserCompartmentResponse changeOciCacheUserCompartment(ChangeOciCacheUserCompartmentRequest request)

Description copied from interface: OciCacheUser

Moves an OCI Cache User from one compartment to another within the same tenancy.

Specified by:

changeOciCacheUserCompartment in interface OciCacheUser

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createOciCacheUser

public CreateOciCacheUserResponse createOciCacheUser(CreateOciCacheUserRequest request)

Description copied from interface: OciCacheUser

Creates a new OCI Cache user.

OCI Cache user is required to authenticate to OCI Cache cluster.

Specified by:

createOciCacheUser in interface OciCacheUser

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteOciCacheUser

public DeleteOciCacheUserResponse deleteOciCacheUser(DeleteOciCacheUserRequest request)

Description copied from interface: OciCacheUser

Deletes an existing OCI Cache User based on the OCI cache user unique ID (OCID).

Specified by:

deleteOciCacheUser in interface OciCacheUser

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getOciCacheUser

public GetOciCacheUserResponse getOciCacheUser(GetOciCacheUserRequest request)

Description copied from interface: OciCacheUser

Get an existing OCI Cache users based on the ID (OCID).

Specified by:

getOciCacheUser in interface OciCacheUser

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listAttachedRedisClusters

public ListAttachedRedisClustersResponse listAttachedRedisClusters(ListAttachedRedisClustersRequest request)

Description copied from interface: OciCacheUser

Gets a list of associated redis cluster for an OCI cache user.

Specified by:

listAttachedRedisClusters in interface OciCacheUser

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listOciCacheUsers

public ListOciCacheUsersResponse listOciCacheUsers(ListOciCacheUsersRequest request)

Description copied from interface: OciCacheUser

Lists the OCI Cache users based on the supplied parameters.

Specified by:

listOciCacheUsers in interface OciCacheUser

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateOciCacheUser

public UpdateOciCacheUserResponse updateOciCacheUser(UpdateOciCacheUserRequest request)

Description copied from interface: OciCacheUser

Update an existing OCI Cache User with new details.

Specified by:

updateOciCacheUser in interface OciCacheUser

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public OciCacheUserWaiters getWaiters()

Description copied from interface: OciCacheUser

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

Specified by:

getWaiters in interface OciCacheUser

Returns:

The service waiters.

getPaginators

public OciCacheUserPaginators getPaginators()

Description copied from interface: OciCacheUser

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 OciCacheUser

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