Class OciCacheUserClient

Service client instance for OciCacheUser.

Inheritance

object

ClientBase

RegionalClientBase

OciCacheUserClient

Implements

IDisposable

Inherited Members

RegionalClientBase.logger

RegionalClientBase.SetRegion(Region)

RegionalClientBase.SetRegion(string)

RegionalClientBase.UseRealmSpecificEndpointTemplate(bool)

RegionalClientBase.PopulateServiceParametersInEndpointTemplate(RestClient, Dictionary<string, object>)

RegionalClientBase.parseEndpointForParameters(string)

ClientBase.restClient

ClientBase.service

ClientBase.userAgent

ClientBase.Dispose()

ClientBase.Dispose(bool)

ClientBase.SetEndpoint(string)

ClientBase.GetEndpoint()

ClientBase.GetUserAgent()

ClientBase.SetRealmSpecificEndpointTemplate(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.RedisService

Assembly: OCI.DotNetSDK.Redis.dll

Syntax

public class OciCacheUserClient : RegionalClientBase, IDisposable

Constructors

OciCacheUserClient(IBasicAuthenticationDetailsProvider, ClientConfiguration, string)

Creates a new service instance using the given authentication provider and/or client configuration and/or endpoint. A client configuration can also be provided optionally to adjust REST client behaviors.

Declaration

public OciCacheUserClient(IBasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration clientConfiguration = null, string endpoint = null)

Parameters

Type	Name	Description
IBasicAuthenticationDetailsProvider	authenticationDetailsProvider	The authentication details provider. Required.
ClientConfiguration	clientConfiguration	The client configuration that contains settings to adjust REST client behaviors. Optional.
string	endpoint	The endpoint of the service. If not provided and the client is a regional client, the endpoint will be constructed based on region information. Optional.

Properties

Paginators

Declaration

public OciCacheUserPaginators Paginators { get; }

Property Value

Type	Description
OciCacheUserPaginators

Waiters

Declaration

public OciCacheUserWaiters Waiters { get; }

Property Value

Type	Description
OciCacheUserWaiters

Methods

ChangeOciCacheUserCompartment(ChangeOciCacheUserCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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

Declaration

public Task<ChangeOciCacheUserCompartmentResponse> ChangeOciCacheUserCompartment(ChangeOciCacheUserCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeOciCacheUserCompartmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ChangeOciCacheUserCompartmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeOciCacheUserCompartment API.

CreateOciCacheUser(CreateOciCacheUserRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new OCI Cache user. OCI Cache user is required to authenticate to OCI Cache cluster.

Declaration

public Task<CreateOciCacheUserResponse> CreateOciCacheUser(CreateOciCacheUserRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateOciCacheUserRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateOciCacheUserResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateOciCacheUser API.

DeleteOciCacheUser(DeleteOciCacheUserRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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

Declaration

public Task<DeleteOciCacheUserResponse> DeleteOciCacheUser(DeleteOciCacheUserRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteOciCacheUserRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteOciCacheUserResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteOciCacheUser API.

GetOciCacheUser(GetOciCacheUserRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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

Declaration

public Task<GetOciCacheUserResponse> GetOciCacheUser(GetOciCacheUserRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetOciCacheUserRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetOciCacheUserResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetOciCacheUser API.

ListAttachedRedisClusters(ListAttachedRedisClustersRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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

Declaration

public Task<ListAttachedRedisClustersResponse> ListAttachedRedisClusters(ListAttachedRedisClustersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListAttachedRedisClustersRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListAttachedRedisClustersResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListAttachedRedisClusters API.

ListOciCacheUsers(ListOciCacheUsersRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the OCI Cache users based on the supplied parameters.

Declaration

public Task<ListOciCacheUsersResponse> ListOciCacheUsers(ListOciCacheUsersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListOciCacheUsersRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListOciCacheUsersResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListOciCacheUsers API.

UpdateOciCacheUser(UpdateOciCacheUserRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update an existing OCI Cache User with new details.

Declaration

public Task<UpdateOciCacheUserResponse> UpdateOciCacheUser(UpdateOciCacheUserRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateOciCacheUserRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateOciCacheUserResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateOciCacheUser API.

Implements

IDisposable