Package com.oracle.bmc.redis

Class OciCacheUserAsyncClient

java.lang.Object

com.oracle.bmc.http.internal.BaseAsyncClient

com.oracle.bmc.redis.OciCacheUserAsyncClient

All Implemented Interfaces:

OciCacheUserAsync, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20220315")
public class OciCacheUserAsyncClient
extends BaseAsyncClient
implements OciCacheUserAsync

Async client implementation for OciCacheUser service.
There are two ways to use async client: 1. Use AsyncHandler: using AsyncHandler, if the response to the call is an InputStream, like getObject Api in object storage service, developers need to process the stream in AsyncHandler, and not anywhere else, because the stream will be closed right after the AsyncHandler is invoked.
2. Use Java Future: using Java Future, developers need to close the stream after they are done with the Java Future.
Accessing the result should be done in a mutually exclusive manner, either through the Future or the AsyncHandler, but not both. If the Future is used, the caller should pass in null as the AsyncHandler. If the AsyncHandler is used, it is still safe to use the Future to determine whether or not the request was completed via Future.isDone/isCancelled.
Please refer to https://github.com/oracle/oci-java-sdk/blob/master/bmc-examples/src/main/java/ResteasyClientWithObjectStorageExample.java

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OciCacheUserAsyncClient.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
OciCacheUserAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)	Deprecated. Use the builder instead.
OciCacheUserAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)	Deprecated. Use the builder instead.
OciCacheUserAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)	Deprecated. Use the builder instead.
OciCacheUserAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)	Deprecated. Use the builder instead.
OciCacheUserAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)	Deprecated. Use the builder instead.
OciCacheUserAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)	Deprecated. Use the builder instead.
OciCacheUserAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)	Deprecated. Use the builder instead.

Method Summary

Modifier and Type	Method	Description
static OciCacheUserAsyncClient.Builder	builder()	Create a builder for this client.
Future<ChangeOciCacheUserCompartmentResponse>	changeOciCacheUserCompartment(ChangeOciCacheUserCompartmentRequest request, AsyncHandler<ChangeOciCacheUserCompartmentRequest,ChangeOciCacheUserCompartmentResponse> handler)	Moves an OCI Cache User from one compartment to another within the same tenancy.
protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER>	clientCall(REQ request, Supplier<RESP_BUILDER> responseBuilder)
void	close()
Future<CreateOciCacheUserResponse>	createOciCacheUser(CreateOciCacheUserRequest request, AsyncHandler<CreateOciCacheUserRequest,CreateOciCacheUserResponse> handler)	Creates a new OCI Cache user.
Future<DeleteOciCacheUserResponse>	deleteOciCacheUser(DeleteOciCacheUserRequest request, AsyncHandler<DeleteOciCacheUserRequest,DeleteOciCacheUserResponse> handler)	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()
Future<GetOciCacheUserResponse>	getOciCacheUser(GetOciCacheUserRequest request, AsyncHandler<GetOciCacheUserRequest,GetOciCacheUserResponse> handler)	Get an existing OCI Cache users based on the ID (OCID).
Future<ListAttachedRedisClustersResponse>	listAttachedRedisClusters(ListAttachedRedisClustersRequest request, AsyncHandler<ListAttachedRedisClustersRequest,ListAttachedRedisClustersResponse> handler)	Gets a list of associated redis cluster for an OCI cache user.
Future<ListOciCacheUsersResponse>	listOciCacheUsers(ListOciCacheUsersRequest request, AsyncHandler<ListOciCacheUsersRequest,ListOciCacheUsersResponse> handler)	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.
Future<UpdateOciCacheUserResponse>	updateOciCacheUser(UpdateOciCacheUserRequest request, AsyncHandler<UpdateOciCacheUserRequest,UpdateOciCacheUserResponse> handler)	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 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.OciCacheUserAsync

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

OciCacheUserAsyncClient

@Deprecated
public OciCacheUserAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

OciCacheUserAsyncClient

@Deprecated
public OciCacheUserAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                               ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

OciCacheUserAsyncClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

OciCacheUserAsyncClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

OciCacheUserAsyncClient

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

OciCacheUserAsyncClient

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

OciCacheUserAsyncClient

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

Method Detail

builder

public static OciCacheUserAsyncClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: OciCacheUserAsync

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 OciCacheUserAsync

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: OciCacheUserAsync

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 OciCacheUserAsync

Parameters:

regionId - The public region ID.

changeOciCacheUserCompartment

public Future<ChangeOciCacheUserCompartmentResponse> changeOciCacheUserCompartment(ChangeOciCacheUserCompartmentRequest request,
                                                                                   AsyncHandler<ChangeOciCacheUserCompartmentRequest,ChangeOciCacheUserCompartmentResponse> handler)

Description copied from interface: OciCacheUserAsync

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

Specified by:

changeOciCacheUserCompartment in interface OciCacheUserAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

createOciCacheUser

public Future<CreateOciCacheUserResponse> createOciCacheUser(CreateOciCacheUserRequest request,
                                                             AsyncHandler<CreateOciCacheUserRequest,CreateOciCacheUserResponse> handler)

Description copied from interface: OciCacheUserAsync

Creates a new OCI Cache user.

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

Specified by:

createOciCacheUser in interface OciCacheUserAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

deleteOciCacheUser

public Future<DeleteOciCacheUserResponse> deleteOciCacheUser(DeleteOciCacheUserRequest request,
                                                             AsyncHandler<DeleteOciCacheUserRequest,DeleteOciCacheUserResponse> handler)

Description copied from interface: OciCacheUserAsync

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

Specified by:

deleteOciCacheUser in interface OciCacheUserAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getOciCacheUser

public Future<GetOciCacheUserResponse> getOciCacheUser(GetOciCacheUserRequest request,
                                                       AsyncHandler<GetOciCacheUserRequest,GetOciCacheUserResponse> handler)

Description copied from interface: OciCacheUserAsync

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

Specified by:

getOciCacheUser in interface OciCacheUserAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listAttachedRedisClusters

public Future<ListAttachedRedisClustersResponse> listAttachedRedisClusters(ListAttachedRedisClustersRequest request,
                                                                           AsyncHandler<ListAttachedRedisClustersRequest,ListAttachedRedisClustersResponse> handler)

Description copied from interface: OciCacheUserAsync

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

Specified by:

listAttachedRedisClusters in interface OciCacheUserAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listOciCacheUsers

public Future<ListOciCacheUsersResponse> listOciCacheUsers(ListOciCacheUsersRequest request,
                                                           AsyncHandler<ListOciCacheUsersRequest,ListOciCacheUsersResponse> handler)

Description copied from interface: OciCacheUserAsync

Lists the OCI Cache users based on the supplied parameters.

Specified by:

listOciCacheUsers in interface OciCacheUserAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

updateOciCacheUser

public Future<UpdateOciCacheUserResponse> updateOciCacheUser(UpdateOciCacheUserRequest request,
                                                             AsyncHandler<UpdateOciCacheUserRequest,UpdateOciCacheUserResponse> handler)

Description copied from interface: OciCacheUserAsync

Update an existing OCI Cache User with new details.

Specified by:

updateOciCacheUser in interface OciCacheUserAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

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

clientCall

protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER> clientCall(REQ request,
                                                                                                                                                                                   Supplier<RESP_BUILDER> responseBuilder)