public class CloudRedisCluster.CloudRedisClusterClient : ClientBase<CloudRedisCluster.CloudRedisClusterClient>Reference documentation and code samples for the Google Cloud Memorystore for Redis (cluster management) v1 API class CloudRedisCluster.CloudRedisClusterClient.
Client for CloudRedisCluster
Inheritance
object > ClientBase > ClientBaseCloudRedisClusterCloudRedisClusterClient > CloudRedisCluster.CloudRedisClusterClientNamespace
Google.Cloud.Redis.Cluster.V1Assembly
Google.Cloud.Redis.Cluster.V1.dll
Constructors
CloudRedisClusterClient()
protected CloudRedisClusterClient()Protected parameterless constructor to allow creation of test doubles.
CloudRedisClusterClient(CallInvoker)
public CloudRedisClusterClient(CallInvoker callInvoker)Creates a new client for CloudRedisCluster that uses a custom CallInvoker.
| Parameter | |
|---|---|
| Name | Description |
callInvoker |
CallInvokerThe callInvoker to use to make remote calls. |
CloudRedisClusterClient(ChannelBase)
public CloudRedisClusterClient(ChannelBase channel)Creates a new client for CloudRedisCluster
| Parameter | |
|---|---|
| Name | Description |
channel |
ChannelBaseThe channel to use to make remote calls. |
CloudRedisClusterClient(ClientBaseConfiguration)
protected CloudRedisClusterClient(ClientBase.ClientBaseConfiguration configuration)Protected constructor to allow creation of configured clients.
| Parameter | |
|---|---|
| Name | Description |
configuration |
ClientBaseClientBaseConfigurationThe client configuration. |
Methods
AddAuthToken(AddAuthTokenRequest, CallOptions)
public virtual Operation AddAuthToken(AddAuthTokenRequest request, CallOptions options)Adds a auth token for a user of a token based auth enabled cluster.
| Parameters | |
|---|---|
| Name | Description |
request |
AddAuthTokenRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
AddAuthToken(AddAuthTokenRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation AddAuthToken(AddAuthTokenRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Adds a auth token for a user of a token based auth enabled cluster.
| Parameters | |
|---|---|
| Name | Description |
request |
AddAuthTokenRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
AddAuthTokenAsync(AddAuthTokenRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> AddAuthTokenAsync(AddAuthTokenRequest request, CallOptions options)Adds a auth token for a user of a token based auth enabled cluster.
| Parameters | |
|---|---|
| Name | Description |
request |
AddAuthTokenRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
AddAuthTokenAsync(AddAuthTokenRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> AddAuthTokenAsync(AddAuthTokenRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Adds a auth token for a user of a token based auth enabled cluster.
| Parameters | |
|---|---|
| Name | Description |
request |
AddAuthTokenRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
AddTokenAuthUser(AddTokenAuthUserRequest, CallOptions)
public virtual Operation AddTokenAuthUser(AddTokenAuthUserRequest request, CallOptions options)Adds a token auth user for a token based auth enabled cluster.
| Parameters | |
|---|---|
| Name | Description |
request |
AddTokenAuthUserRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
AddTokenAuthUser(AddTokenAuthUserRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation AddTokenAuthUser(AddTokenAuthUserRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Adds a token auth user for a token based auth enabled cluster.
| Parameters | |
|---|---|
| Name | Description |
request |
AddTokenAuthUserRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
AddTokenAuthUserAsync(AddTokenAuthUserRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> AddTokenAuthUserAsync(AddTokenAuthUserRequest request, CallOptions options)Adds a token auth user for a token based auth enabled cluster.
| Parameters | |
|---|---|
| Name | Description |
request |
AddTokenAuthUserRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
AddTokenAuthUserAsync(AddTokenAuthUserRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> AddTokenAuthUserAsync(AddTokenAuthUserRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Adds a token auth user for a token based auth enabled cluster.
| Parameters | |
|---|---|
| Name | Description |
request |
AddTokenAuthUserRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
BackupCluster(BackupClusterRequest, CallOptions)
public virtual Operation BackupCluster(BackupClusterRequest request, CallOptions options)Backup Redis Cluster. If this is the first time a backup is being created, a backup collection will be created at the backend, and this backup belongs to this collection. Both collection and backup will have a resource name. Backup will be executed for each shard. A replica (primary if nonHA) will be selected to perform the execution. Backup call will be rejected if there is an ongoing backup or update operation. Be aware that during preview, if the cluster's internal software version is too old, critical update will be performed before actual backup. Once the internal software version is updated to the minimum version required by the backup feature, subsequent backups will not require critical update. After preview, there will be no critical update needed for backup.
| Parameters | |
|---|---|
| Name | Description |
request |
BackupClusterRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
BackupCluster(BackupClusterRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation BackupCluster(BackupClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Backup Redis Cluster. If this is the first time a backup is being created, a backup collection will be created at the backend, and this backup belongs to this collection. Both collection and backup will have a resource name. Backup will be executed for each shard. A replica (primary if nonHA) will be selected to perform the execution. Backup call will be rejected if there is an ongoing backup or update operation. Be aware that during preview, if the cluster's internal software version is too old, critical update will be performed before actual backup. Once the internal software version is updated to the minimum version required by the backup feature, subsequent backups will not require critical update. After preview, there will be no critical update needed for backup.
| Parameters | |
|---|---|
| Name | Description |
request |
BackupClusterRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
BackupClusterAsync(BackupClusterRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> BackupClusterAsync(BackupClusterRequest request, CallOptions options)Backup Redis Cluster. If this is the first time a backup is being created, a backup collection will be created at the backend, and this backup belongs to this collection. Both collection and backup will have a resource name. Backup will be executed for each shard. A replica (primary if nonHA) will be selected to perform the execution. Backup call will be rejected if there is an ongoing backup or update operation. Be aware that during preview, if the cluster's internal software version is too old, critical update will be performed before actual backup. Once the internal software version is updated to the minimum version required by the backup feature, subsequent backups will not require critical update. After preview, there will be no critical update needed for backup.
| Parameters | |
|---|---|
| Name | Description |
request |
BackupClusterRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
BackupClusterAsync(BackupClusterRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> BackupClusterAsync(BackupClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Backup Redis Cluster. If this is the first time a backup is being created, a backup collection will be created at the backend, and this backup belongs to this collection. Both collection and backup will have a resource name. Backup will be executed for each shard. A replica (primary if nonHA) will be selected to perform the execution. Backup call will be rejected if there is an ongoing backup or update operation. Be aware that during preview, if the cluster's internal software version is too old, critical update will be performed before actual backup. Once the internal software version is updated to the minimum version required by the backup feature, subsequent backups will not require critical update. After preview, there will be no critical update needed for backup.
| Parameters | |
|---|---|
| Name | Description |
request |
BackupClusterRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
CreateAclPolicy(CreateAclPolicyRequest, CallOptions)
public virtual AclPolicy CreateAclPolicy(CreateAclPolicyRequest request, CallOptions options)Creates an ACL policy. The creation is executed synchronously and the policy is available for use immediately after the RPC returns.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateAclPolicyRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AclPolicy |
The response received from the server. |
CreateAclPolicy(CreateAclPolicyRequest, Metadata, DateTime?, CancellationToken)
public virtual AclPolicy CreateAclPolicy(CreateAclPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Creates an ACL policy. The creation is executed synchronously and the policy is available for use immediately after the RPC returns.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateAclPolicyRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AclPolicy |
The response received from the server. |
CreateAclPolicyAsync(CreateAclPolicyRequest, CallOptions)
public virtual AsyncUnaryCall<AclPolicy> CreateAclPolicyAsync(CreateAclPolicyRequest request, CallOptions options)Creates an ACL policy. The creation is executed synchronously and the policy is available for use immediately after the RPC returns.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateAclPolicyRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallAclPolicy |
The call object. |
CreateAclPolicyAsync(CreateAclPolicyRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<AclPolicy> CreateAclPolicyAsync(CreateAclPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Creates an ACL policy. The creation is executed synchronously and the policy is available for use immediately after the RPC returns.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateAclPolicyRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallAclPolicy |
The call object. |
CreateCluster(CreateClusterRequest, CallOptions)
public virtual Operation CreateCluster(CreateClusterRequest request, CallOptions options)Creates a Redis cluster based on the specified properties. The creation is executed asynchronously and callers may check the returned operation to track its progress. Once the operation is completed the Redis cluster will be fully functional. The completed longrunning.Operation will contain the new cluster object in the response field.
The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateClusterRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
CreateCluster(CreateClusterRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation CreateCluster(CreateClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Creates a Redis cluster based on the specified properties. The creation is executed asynchronously and callers may check the returned operation to track its progress. Once the operation is completed the Redis cluster will be fully functional. The completed longrunning.Operation will contain the new cluster object in the response field.
The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateClusterRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
CreateClusterAsync(CreateClusterRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> CreateClusterAsync(CreateClusterRequest request, CallOptions options)Creates a Redis cluster based on the specified properties. The creation is executed asynchronously and callers may check the returned operation to track its progress. Once the operation is completed the Redis cluster will be fully functional. The completed longrunning.Operation will contain the new cluster object in the response field.
The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateClusterRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
CreateClusterAsync(CreateClusterRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> CreateClusterAsync(CreateClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Creates a Redis cluster based on the specified properties. The creation is executed asynchronously and callers may check the returned operation to track its progress. Once the operation is completed the Redis cluster will be fully functional. The completed longrunning.Operation will contain the new cluster object in the response field.
The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateClusterRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
CreateLocationsClient()
public virtual Locations.LocationsClient CreateLocationsClient()Creates a new instance of Locations.LocationsClient using the same call invoker as this client.
| Returns | |
|---|---|
| Type | Description |
LocationsLocationsClient |
A new Locations.LocationsClient for the same target as this client. |
CreateOperationsClient()
public virtual Operations.OperationsClient CreateOperationsClient()Creates a new instance of Operations.OperationsClient using the same call invoker as this client.
| Returns | |
|---|---|
| Type | Description |
OperationsOperationsClient |
A new Operations client for the same target as this client. |
DeleteAclPolicy(DeleteAclPolicyRequest, CallOptions)
public virtual Operation DeleteAclPolicy(DeleteAclPolicyRequest request, CallOptions options)Deletes a specific ACL policy. This action will delete the ACL policy and all the rules associated with it. An ACL policy cannot be deleted if it is attached to a cluster.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteAclPolicyRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
DeleteAclPolicy(DeleteAclPolicyRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation DeleteAclPolicy(DeleteAclPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Deletes a specific ACL policy. This action will delete the ACL policy and all the rules associated with it. An ACL policy cannot be deleted if it is attached to a cluster.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteAclPolicyRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
DeleteAclPolicyAsync(DeleteAclPolicyRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> DeleteAclPolicyAsync(DeleteAclPolicyRequest request, CallOptions options)Deletes a specific ACL policy. This action will delete the ACL policy and all the rules associated with it. An ACL policy cannot be deleted if it is attached to a cluster.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteAclPolicyRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
DeleteAclPolicyAsync(DeleteAclPolicyRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> DeleteAclPolicyAsync(DeleteAclPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Deletes a specific ACL policy. This action will delete the ACL policy and all the rules associated with it. An ACL policy cannot be deleted if it is attached to a cluster.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteAclPolicyRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
DeleteAuthToken(DeleteAuthTokenRequest, CallOptions)
public virtual Operation DeleteAuthToken(DeleteAuthTokenRequest request, CallOptions options)Removes a auth token for a user of a token based auth enabled instance.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteAuthTokenRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
DeleteAuthToken(DeleteAuthTokenRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation DeleteAuthToken(DeleteAuthTokenRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Removes a auth token for a user of a token based auth enabled instance.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteAuthTokenRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
DeleteAuthTokenAsync(DeleteAuthTokenRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> DeleteAuthTokenAsync(DeleteAuthTokenRequest request, CallOptions options)Removes a auth token for a user of a token based auth enabled instance.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteAuthTokenRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
DeleteAuthTokenAsync(DeleteAuthTokenRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> DeleteAuthTokenAsync(DeleteAuthTokenRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Removes a auth token for a user of a token based auth enabled instance.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteAuthTokenRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
DeleteBackup(DeleteBackupRequest, CallOptions)
public virtual Operation DeleteBackup(DeleteBackupRequest request, CallOptions options)Deletes a specific backup.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteBackupRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
DeleteBackup(DeleteBackupRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation DeleteBackup(DeleteBackupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Deletes a specific backup.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteBackupRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
DeleteBackupAsync(DeleteBackupRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> DeleteBackupAsync(DeleteBackupRequest request, CallOptions options)Deletes a specific backup.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteBackupRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
DeleteBackupAsync(DeleteBackupRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> DeleteBackupAsync(DeleteBackupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Deletes a specific backup.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteBackupRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
DeleteCluster(DeleteClusterRequest, CallOptions)
public virtual Operation DeleteCluster(DeleteClusterRequest request, CallOptions options)Deletes a specific Redis cluster. Cluster stops serving and data is deleted.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteClusterRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
DeleteCluster(DeleteClusterRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation DeleteCluster(DeleteClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Deletes a specific Redis cluster. Cluster stops serving and data is deleted.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteClusterRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
DeleteClusterAsync(DeleteClusterRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> DeleteClusterAsync(DeleteClusterRequest request, CallOptions options)Deletes a specific Redis cluster. Cluster stops serving and data is deleted.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteClusterRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
DeleteClusterAsync(DeleteClusterRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> DeleteClusterAsync(DeleteClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Deletes a specific Redis cluster. Cluster stops serving and data is deleted.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteClusterRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
DeleteTokenAuthUser(DeleteTokenAuthUserRequest, CallOptions)
public virtual Operation DeleteTokenAuthUser(DeleteTokenAuthUserRequest request, CallOptions options)Deletes a token auth user for a token based auth enabled cluster.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteTokenAuthUserRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
DeleteTokenAuthUser(DeleteTokenAuthUserRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation DeleteTokenAuthUser(DeleteTokenAuthUserRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Deletes a token auth user for a token based auth enabled cluster.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteTokenAuthUserRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
DeleteTokenAuthUserAsync(DeleteTokenAuthUserRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> DeleteTokenAuthUserAsync(DeleteTokenAuthUserRequest request, CallOptions options)Deletes a token auth user for a token based auth enabled cluster.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteTokenAuthUserRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
DeleteTokenAuthUserAsync(DeleteTokenAuthUserRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> DeleteTokenAuthUserAsync(DeleteTokenAuthUserRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Deletes a token auth user for a token based auth enabled cluster.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteTokenAuthUserRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
ExportBackup(ExportBackupRequest, CallOptions)
public virtual Operation ExportBackup(ExportBackupRequest request, CallOptions options)Exports a specific backup to a customer target Cloud Storage URI.
| Parameters | |
|---|---|
| Name | Description |
request |
ExportBackupRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
ExportBackup(ExportBackupRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation ExportBackup(ExportBackupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Exports a specific backup to a customer target Cloud Storage URI.
| Parameters | |
|---|---|
| Name | Description |
request |
ExportBackupRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
ExportBackupAsync(ExportBackupRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> ExportBackupAsync(ExportBackupRequest request, CallOptions options)Exports a specific backup to a customer target Cloud Storage URI.
| Parameters | |
|---|---|
| Name | Description |
request |
ExportBackupRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
ExportBackupAsync(ExportBackupRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> ExportBackupAsync(ExportBackupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Exports a specific backup to a customer target Cloud Storage URI.
| Parameters | |
|---|---|
| Name | Description |
request |
ExportBackupRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
GetAclPolicy(GetAclPolicyRequest, CallOptions)
public virtual AclPolicy GetAclPolicy(GetAclPolicyRequest request, CallOptions options)Gets the details of a specific Redis Cluster ACL policy.
| Parameters | |
|---|---|
| Name | Description |
request |
GetAclPolicyRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AclPolicy |
The response received from the server. |
GetAclPolicy(GetAclPolicyRequest, Metadata, DateTime?, CancellationToken)
public virtual AclPolicy GetAclPolicy(GetAclPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Gets the details of a specific Redis Cluster ACL policy.
| Parameters | |
|---|---|
| Name | Description |
request |
GetAclPolicyRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AclPolicy |
The response received from the server. |
GetAclPolicyAsync(GetAclPolicyRequest, CallOptions)
public virtual AsyncUnaryCall<AclPolicy> GetAclPolicyAsync(GetAclPolicyRequest request, CallOptions options)Gets the details of a specific Redis Cluster ACL policy.
| Parameters | |
|---|---|
| Name | Description |
request |
GetAclPolicyRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallAclPolicy |
The call object. |
GetAclPolicyAsync(GetAclPolicyRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<AclPolicy> GetAclPolicyAsync(GetAclPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Gets the details of a specific Redis Cluster ACL policy.
| Parameters | |
|---|---|
| Name | Description |
request |
GetAclPolicyRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallAclPolicy |
The call object. |
GetAclPolicyRevision(GetAclPolicyRevisionRequest, CallOptions)
public virtual AclPolicyRevision GetAclPolicyRevision(GetAclPolicyRevisionRequest request, CallOptions options)Gets details of a specific ACL policy revision.
| Parameters | |
|---|---|
| Name | Description |
request |
GetAclPolicyRevisionRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AclPolicyRevision |
The response received from the server. |
GetAclPolicyRevision(GetAclPolicyRevisionRequest, Metadata, DateTime?, CancellationToken)
public virtual AclPolicyRevision GetAclPolicyRevision(GetAclPolicyRevisionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Gets details of a specific ACL policy revision.
| Parameters | |
|---|---|
| Name | Description |
request |
GetAclPolicyRevisionRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AclPolicyRevision |
The response received from the server. |
GetAclPolicyRevisionAsync(GetAclPolicyRevisionRequest, CallOptions)
public virtual AsyncUnaryCall<AclPolicyRevision> GetAclPolicyRevisionAsync(GetAclPolicyRevisionRequest request, CallOptions options)Gets details of a specific ACL policy revision.
| Parameters | |
|---|---|
| Name | Description |
request |
GetAclPolicyRevisionRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallAclPolicyRevision |
The call object. |
GetAclPolicyRevisionAsync(GetAclPolicyRevisionRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<AclPolicyRevision> GetAclPolicyRevisionAsync(GetAclPolicyRevisionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Gets details of a specific ACL policy revision.
| Parameters | |
|---|---|
| Name | Description |
request |
GetAclPolicyRevisionRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallAclPolicyRevision |
The call object. |
GetAuthToken(GetAuthTokenRequest, CallOptions)
public virtual AuthToken GetAuthToken(GetAuthTokenRequest request, CallOptions options)Gets a specific auth token for a specific token auth user.
| Parameters | |
|---|---|
| Name | Description |
request |
GetAuthTokenRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AuthToken |
The response received from the server. |
GetAuthToken(GetAuthTokenRequest, Metadata, DateTime?, CancellationToken)
public virtual AuthToken GetAuthToken(GetAuthTokenRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Gets a specific auth token for a specific token auth user.
| Parameters | |
|---|---|
| Name | Description |
request |
GetAuthTokenRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AuthToken |
The response received from the server. |
GetAuthTokenAsync(GetAuthTokenRequest, CallOptions)
public virtual AsyncUnaryCall<AuthToken> GetAuthTokenAsync(GetAuthTokenRequest request, CallOptions options)Gets a specific auth token for a specific token auth user.
| Parameters | |
|---|---|
| Name | Description |
request |
GetAuthTokenRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallAuthToken |
The call object. |
GetAuthTokenAsync(GetAuthTokenRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<AuthToken> GetAuthTokenAsync(GetAuthTokenRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Gets a specific auth token for a specific token auth user.
| Parameters | |
|---|---|
| Name | Description |
request |
GetAuthTokenRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallAuthToken |
The call object. |
GetBackup(GetBackupRequest, CallOptions)
public virtual Backup GetBackup(GetBackupRequest request, CallOptions options)Gets the details of a specific backup.
| Parameters | |
|---|---|
| Name | Description |
request |
GetBackupRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Backup |
The response received from the server. |
GetBackup(GetBackupRequest, Metadata, DateTime?, CancellationToken)
public virtual Backup GetBackup(GetBackupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Gets the details of a specific backup.
| Parameters | |
|---|---|
| Name | Description |
request |
GetBackupRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Backup |
The response received from the server. |
GetBackupAsync(GetBackupRequest, CallOptions)
public virtual AsyncUnaryCall<Backup> GetBackupAsync(GetBackupRequest request, CallOptions options)Gets the details of a specific backup.
| Parameters | |
|---|---|
| Name | Description |
request |
GetBackupRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallBackup |
The call object. |
GetBackupAsync(GetBackupRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Backup> GetBackupAsync(GetBackupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Gets the details of a specific backup.
| Parameters | |
|---|---|
| Name | Description |
request |
GetBackupRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallBackup |
The call object. |
GetBackupCollection(GetBackupCollectionRequest, CallOptions)
public virtual BackupCollection GetBackupCollection(GetBackupCollectionRequest request, CallOptions options)Get a backup collection.
| Parameters | |
|---|---|
| Name | Description |
request |
GetBackupCollectionRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
BackupCollection |
The response received from the server. |
GetBackupCollection(GetBackupCollectionRequest, Metadata, DateTime?, CancellationToken)
public virtual BackupCollection GetBackupCollection(GetBackupCollectionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Get a backup collection.
| Parameters | |
|---|---|
| Name | Description |
request |
GetBackupCollectionRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
BackupCollection |
The response received from the server. |
GetBackupCollectionAsync(GetBackupCollectionRequest, CallOptions)
public virtual AsyncUnaryCall<BackupCollection> GetBackupCollectionAsync(GetBackupCollectionRequest request, CallOptions options)Get a backup collection.
| Parameters | |
|---|---|
| Name | Description |
request |
GetBackupCollectionRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallBackupCollection |
The call object. |
GetBackupCollectionAsync(GetBackupCollectionRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<BackupCollection> GetBackupCollectionAsync(GetBackupCollectionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Get a backup collection.
| Parameters | |
|---|---|
| Name | Description |
request |
GetBackupCollectionRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallBackupCollection |
The call object. |
GetCluster(GetClusterRequest, CallOptions)
public virtual Cluster GetCluster(GetClusterRequest request, CallOptions options)Gets the details of a specific Redis cluster.
| Parameters | |
|---|---|
| Name | Description |
request |
GetClusterRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Cluster |
The response received from the server. |
GetCluster(GetClusterRequest, Metadata, DateTime?, CancellationToken)
public virtual Cluster GetCluster(GetClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Gets the details of a specific Redis cluster.
| Parameters | |
|---|---|
| Name | Description |
request |
GetClusterRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Cluster |
The response received from the server. |
GetClusterAsync(GetClusterRequest, CallOptions)
public virtual AsyncUnaryCall<Cluster> GetClusterAsync(GetClusterRequest request, CallOptions options)Gets the details of a specific Redis cluster.
| Parameters | |
|---|---|
| Name | Description |
request |
GetClusterRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallCluster |
The call object. |
GetClusterAsync(GetClusterRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Cluster> GetClusterAsync(GetClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Gets the details of a specific Redis cluster.
| Parameters | |
|---|---|
| Name | Description |
request |
GetClusterRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallCluster |
The call object. |
GetClusterCertificateAuthority(GetClusterCertificateAuthorityRequest, CallOptions)
public virtual CertificateAuthority GetClusterCertificateAuthority(GetClusterCertificateAuthorityRequest request, CallOptions options)Gets the details of certificate authority information for Redis cluster.
| Parameters | |
|---|---|
| Name | Description |
request |
GetClusterCertificateAuthorityRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
CertificateAuthority |
The response received from the server. |
GetClusterCertificateAuthority(GetClusterCertificateAuthorityRequest, Metadata, DateTime?, CancellationToken)
public virtual CertificateAuthority GetClusterCertificateAuthority(GetClusterCertificateAuthorityRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Gets the details of certificate authority information for Redis cluster.
| Parameters | |
|---|---|
| Name | Description |
request |
GetClusterCertificateAuthorityRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
CertificateAuthority |
The response received from the server. |
GetClusterCertificateAuthorityAsync(GetClusterCertificateAuthorityRequest, CallOptions)
public virtual AsyncUnaryCall<CertificateAuthority> GetClusterCertificateAuthorityAsync(GetClusterCertificateAuthorityRequest request, CallOptions options)Gets the details of certificate authority information for Redis cluster.
| Parameters | |
|---|---|
| Name | Description |
request |
GetClusterCertificateAuthorityRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallCertificateAuthority |
The call object. |
GetClusterCertificateAuthorityAsync(GetClusterCertificateAuthorityRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<CertificateAuthority> GetClusterCertificateAuthorityAsync(GetClusterCertificateAuthorityRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Gets the details of certificate authority information for Redis cluster.
| Parameters | |
|---|---|
| Name | Description |
request |
GetClusterCertificateAuthorityRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallCertificateAuthority |
The call object. |
GetSharedRegionalCertificateAuthority(GetSharedRegionalCertificateAuthorityRequest, CallOptions)
public virtual SharedRegionalCertificateAuthority GetSharedRegionalCertificateAuthority(GetSharedRegionalCertificateAuthorityRequest request, CallOptions options)Gets the details of regional certificate authority information for Redis cluster.
| Parameters | |
|---|---|
| Name | Description |
request |
GetSharedRegionalCertificateAuthorityRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
SharedRegionalCertificateAuthority |
The response received from the server. |
GetSharedRegionalCertificateAuthority(GetSharedRegionalCertificateAuthorityRequest, Metadata, DateTime?, CancellationToken)
public virtual SharedRegionalCertificateAuthority GetSharedRegionalCertificateAuthority(GetSharedRegionalCertificateAuthorityRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Gets the details of regional certificate authority information for Redis cluster.
| Parameters | |
|---|---|
| Name | Description |
request |
GetSharedRegionalCertificateAuthorityRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
SharedRegionalCertificateAuthority |
The response received from the server. |
GetSharedRegionalCertificateAuthorityAsync(GetSharedRegionalCertificateAuthorityRequest, CallOptions)
public virtual AsyncUnaryCall<SharedRegionalCertificateAuthority> GetSharedRegionalCertificateAuthorityAsync(GetSharedRegionalCertificateAuthorityRequest request, CallOptions options)Gets the details of regional certificate authority information for Redis cluster.
| Parameters | |
|---|---|
| Name | Description |
request |
GetSharedRegionalCertificateAuthorityRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallSharedRegionalCertificateAuthority |
The call object. |
GetSharedRegionalCertificateAuthorityAsync(GetSharedRegionalCertificateAuthorityRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<SharedRegionalCertificateAuthority> GetSharedRegionalCertificateAuthorityAsync(GetSharedRegionalCertificateAuthorityRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Gets the details of regional certificate authority information for Redis cluster.
| Parameters | |
|---|---|
| Name | Description |
request |
GetSharedRegionalCertificateAuthorityRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallSharedRegionalCertificateAuthority |
The call object. |
GetTokenAuthUser(GetTokenAuthUserRequest, CallOptions)
public virtual TokenAuthUser GetTokenAuthUser(GetTokenAuthUserRequest request, CallOptions options)Gets a specific token auth user for a basic auth enabled cluster.
| Parameters | |
|---|---|
| Name | Description |
request |
GetTokenAuthUserRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
TokenAuthUser |
The response received from the server. |
GetTokenAuthUser(GetTokenAuthUserRequest, Metadata, DateTime?, CancellationToken)
public virtual TokenAuthUser GetTokenAuthUser(GetTokenAuthUserRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Gets a specific token auth user for a basic auth enabled cluster.
| Parameters | |
|---|---|
| Name | Description |
request |
GetTokenAuthUserRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
TokenAuthUser |
The response received from the server. |
GetTokenAuthUserAsync(GetTokenAuthUserRequest, CallOptions)
public virtual AsyncUnaryCall<TokenAuthUser> GetTokenAuthUserAsync(GetTokenAuthUserRequest request, CallOptions options)Gets a specific token auth user for a basic auth enabled cluster.
| Parameters | |
|---|---|
| Name | Description |
request |
GetTokenAuthUserRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallTokenAuthUser |
The call object. |
GetTokenAuthUserAsync(GetTokenAuthUserRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<TokenAuthUser> GetTokenAuthUserAsync(GetTokenAuthUserRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Gets a specific token auth user for a basic auth enabled cluster.
| Parameters | |
|---|---|
| Name | Description |
request |
GetTokenAuthUserRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallTokenAuthUser |
The call object. |
ListAclPolicies(ListAclPoliciesRequest, CallOptions)
public virtual ListAclPoliciesResponse ListAclPolicies(ListAclPoliciesRequest request, CallOptions options)Lists all ACL policies owned by a project in either the specified location (region) or all locations.
The location should have the following format:
projects/{project_id}/locations/{location_id}
If location_id is specified as - (wildcard), then all regions
available to the project are queried, and the results are aggregated.
| Parameters | |
|---|---|
| Name | Description |
request |
ListAclPoliciesRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
ListAclPoliciesResponse |
The response received from the server. |
ListAclPolicies(ListAclPoliciesRequest, Metadata, DateTime?, CancellationToken)
public virtual ListAclPoliciesResponse ListAclPolicies(ListAclPoliciesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Lists all ACL policies owned by a project in either the specified location (region) or all locations.
The location should have the following format:
projects/{project_id}/locations/{location_id}
If location_id is specified as - (wildcard), then all regions
available to the project are queried, and the results are aggregated.
| Parameters | |
|---|---|
| Name | Description |
request |
ListAclPoliciesRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
ListAclPoliciesResponse |
The response received from the server. |
ListAclPoliciesAsync(ListAclPoliciesRequest, CallOptions)
public virtual AsyncUnaryCall<ListAclPoliciesResponse> ListAclPoliciesAsync(ListAclPoliciesRequest request, CallOptions options)Lists all ACL policies owned by a project in either the specified location (region) or all locations.
The location should have the following format:
projects/{project_id}/locations/{location_id}
If location_id is specified as - (wildcard), then all regions
available to the project are queried, and the results are aggregated.
| Parameters | |
|---|---|
| Name | Description |
request |
ListAclPoliciesRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallListAclPoliciesResponse |
The call object. |
ListAclPoliciesAsync(ListAclPoliciesRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ListAclPoliciesResponse> ListAclPoliciesAsync(ListAclPoliciesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Lists all ACL policies owned by a project in either the specified location (region) or all locations.
The location should have the following format:
projects/{project_id}/locations/{location_id}
If location_id is specified as - (wildcard), then all regions
available to the project are queried, and the results are aggregated.
| Parameters | |
|---|---|
| Name | Description |
request |
ListAclPoliciesRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallListAclPoliciesResponse |
The call object. |
ListAclPolicyRevisions(ListAclPolicyRevisionsRequest, CallOptions)
public virtual ListAclPolicyRevisionsResponse ListAclPolicyRevisions(ListAclPolicyRevisionsRequest request, CallOptions options)Lists all ACL policy revisions in a given ACL policy.
| Parameters | |
|---|---|
| Name | Description |
request |
ListAclPolicyRevisionsRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
ListAclPolicyRevisionsResponse |
The response received from the server. |
ListAclPolicyRevisions(ListAclPolicyRevisionsRequest, Metadata, DateTime?, CancellationToken)
public virtual ListAclPolicyRevisionsResponse ListAclPolicyRevisions(ListAclPolicyRevisionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Lists all ACL policy revisions in a given ACL policy.
| Parameters | |
|---|---|
| Name | Description |
request |
ListAclPolicyRevisionsRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
ListAclPolicyRevisionsResponse |
The response received from the server. |
ListAclPolicyRevisionsAsync(ListAclPolicyRevisionsRequest, CallOptions)
public virtual AsyncUnaryCall<ListAclPolicyRevisionsResponse> ListAclPolicyRevisionsAsync(ListAclPolicyRevisionsRequest request, CallOptions options)Lists all ACL policy revisions in a given ACL policy.
| Parameters | |
|---|---|
| Name | Description |
request |
ListAclPolicyRevisionsRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallListAclPolicyRevisionsResponse |
The call object. |
ListAclPolicyRevisionsAsync(ListAclPolicyRevisionsRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ListAclPolicyRevisionsResponse> ListAclPolicyRevisionsAsync(ListAclPolicyRevisionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Lists all ACL policy revisions in a given ACL policy.
| Parameters | |
|---|---|
| Name | Description |
request |
ListAclPolicyRevisionsRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallListAclPolicyRevisionsResponse |
The call object. |
ListAuthTokens(ListAuthTokensRequest, CallOptions)
public virtual ListAuthTokensResponse ListAuthTokens(ListAuthTokensRequest request, CallOptions options)Lists all the auth tokens for a specific token auth user.
| Parameters | |
|---|---|
| Name | Description |
request |
ListAuthTokensRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
ListAuthTokensResponse |
The response received from the server. |
ListAuthTokens(ListAuthTokensRequest, Metadata, DateTime?, CancellationToken)
public virtual ListAuthTokensResponse ListAuthTokens(ListAuthTokensRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Lists all the auth tokens for a specific token auth user.
| Parameters | |
|---|---|
| Name | Description |
request |
ListAuthTokensRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
ListAuthTokensResponse |
The response received from the server. |
ListAuthTokensAsync(ListAuthTokensRequest, CallOptions)
public virtual AsyncUnaryCall<ListAuthTokensResponse> ListAuthTokensAsync(ListAuthTokensRequest request, CallOptions options)Lists all the auth tokens for a specific token auth user.
| Parameters | |
|---|---|
| Name | Description |
request |
ListAuthTokensRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallListAuthTokensResponse |
The call object. |
ListAuthTokensAsync(ListAuthTokensRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ListAuthTokensResponse> ListAuthTokensAsync(ListAuthTokensRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Lists all the auth tokens for a specific token auth user.
| Parameters | |
|---|---|
| Name | Description |
request |
ListAuthTokensRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallListAuthTokensResponse |
The call object. |
ListBackupCollections(ListBackupCollectionsRequest, CallOptions)
public virtual ListBackupCollectionsResponse ListBackupCollections(ListBackupCollectionsRequest request, CallOptions options)Lists all backup collections owned by a consumer project in either the specified location (region) or all locations.
If location_id is specified as - (wildcard), then all regions
available to the project are queried, and the results are aggregated.
| Parameters | |
|---|---|
| Name | Description |
request |
ListBackupCollectionsRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
ListBackupCollectionsResponse |
The response received from the server. |
ListBackupCollections(ListBackupCollectionsRequest, Metadata, DateTime?, CancellationToken)
public virtual ListBackupCollectionsResponse ListBackupCollections(ListBackupCollectionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Lists all backup collections owned by a consumer project in either the specified location (region) or all locations.
If location_id is specified as - (wildcard), then all regions
available to the project are queried, and the results are aggregated.
| Parameters | |
|---|---|
| Name | Description |
request |
ListBackupCollectionsRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
ListBackupCollectionsResponse |
The response received from the server. |
ListBackupCollectionsAsync(ListBackupCollectionsRequest, CallOptions)
public virtual AsyncUnaryCall<ListBackupCollectionsResponse> ListBackupCollectionsAsync(ListBackupCollectionsRequest request, CallOptions options)Lists all backup collections owned by a consumer project in either the specified location (region) or all locations.
If location_id is specified as - (wildcard), then all regions
available to the project are queried, and the results are aggregated.
| Parameters | |
|---|---|
| Name | Description |
request |
ListBackupCollectionsRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallListBackupCollectionsResponse |
The call object. |
ListBackupCollectionsAsync(ListBackupCollectionsRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ListBackupCollectionsResponse> ListBackupCollectionsAsync(ListBackupCollectionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Lists all backup collections owned by a consumer project in either the specified location (region) or all locations.
If location_id is specified as - (wildcard), then all regions
available to the project are queried, and the results are aggregated.
| Parameters | |
|---|---|
| Name | Description |
request |
ListBackupCollectionsRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallListBackupCollectionsResponse |
The call object. |
ListBackups(ListBackupsRequest, CallOptions)
public virtual ListBackupsResponse ListBackups(ListBackupsRequest request, CallOptions options)Lists all backups owned by a backup collection.
| Parameters | |
|---|---|
| Name | Description |
request |
ListBackupsRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
ListBackupsResponse |
The response received from the server. |
ListBackups(ListBackupsRequest, Metadata, DateTime?, CancellationToken)
public virtual ListBackupsResponse ListBackups(ListBackupsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Lists all backups owned by a backup collection.
| Parameters | |
|---|---|
| Name | Description |
request |
ListBackupsRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
ListBackupsResponse |
The response received from the server. |
ListBackupsAsync(ListBackupsRequest, CallOptions)
public virtual AsyncUnaryCall<ListBackupsResponse> ListBackupsAsync(ListBackupsRequest request, CallOptions options)Lists all backups owned by a backup collection.
| Parameters | |
|---|---|
| Name | Description |
request |
ListBackupsRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallListBackupsResponse |
The call object. |
ListBackupsAsync(ListBackupsRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ListBackupsResponse> ListBackupsAsync(ListBackupsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Lists all backups owned by a backup collection.
| Parameters | |
|---|---|
| Name | Description |
request |
ListBackupsRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallListBackupsResponse |
The call object. |
ListClusters(ListClustersRequest, CallOptions)
public virtual ListClustersResponse ListClusters(ListClustersRequest request, CallOptions options)Lists all Redis clusters owned by a project in either the specified location (region) or all locations.
The location should have the following format:
projects/{project_id}/locations/{location_id}
If location_id is specified as - (wildcard), then all regions
available to the project are queried, and the results are aggregated.
| Parameters | |
|---|---|
| Name | Description |
request |
ListClustersRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
ListClustersResponse |
The response received from the server. |
ListClusters(ListClustersRequest, Metadata, DateTime?, CancellationToken)
public virtual ListClustersResponse ListClusters(ListClustersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Lists all Redis clusters owned by a project in either the specified location (region) or all locations.
The location should have the following format:
projects/{project_id}/locations/{location_id}
If location_id is specified as - (wildcard), then all regions
available to the project are queried, and the results are aggregated.
| Parameters | |
|---|---|
| Name | Description |
request |
ListClustersRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
ListClustersResponse |
The response received from the server. |
ListClustersAsync(ListClustersRequest, CallOptions)
public virtual AsyncUnaryCall<ListClustersResponse> ListClustersAsync(ListClustersRequest request, CallOptions options)Lists all Redis clusters owned by a project in either the specified location (region) or all locations.
The location should have the following format:
projects/{project_id}/locations/{location_id}
If location_id is specified as - (wildcard), then all regions
available to the project are queried, and the results are aggregated.
| Parameters | |
|---|---|
| Name | Description |
request |
ListClustersRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallListClustersResponse |
The call object. |
ListClustersAsync(ListClustersRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ListClustersResponse> ListClustersAsync(ListClustersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Lists all Redis clusters owned by a project in either the specified location (region) or all locations.
The location should have the following format:
projects/{project_id}/locations/{location_id}
If location_id is specified as - (wildcard), then all regions
available to the project are queried, and the results are aggregated.
| Parameters | |
|---|---|
| Name | Description |
request |
ListClustersRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallListClustersResponse |
The call object. |
ListTokenAuthUsers(ListTokenAuthUsersRequest, CallOptions)
public virtual ListTokenAuthUsersResponse ListTokenAuthUsers(ListTokenAuthUsersRequest request, CallOptions options)Lists all the token auth users for a token based auth enabled cluster.
| Parameters | |
|---|---|
| Name | Description |
request |
ListTokenAuthUsersRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
ListTokenAuthUsersResponse |
The response received from the server. |
ListTokenAuthUsers(ListTokenAuthUsersRequest, Metadata, DateTime?, CancellationToken)
public virtual ListTokenAuthUsersResponse ListTokenAuthUsers(ListTokenAuthUsersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Lists all the token auth users for a token based auth enabled cluster.
| Parameters | |
|---|---|
| Name | Description |
request |
ListTokenAuthUsersRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
ListTokenAuthUsersResponse |
The response received from the server. |
ListTokenAuthUsersAsync(ListTokenAuthUsersRequest, CallOptions)
public virtual AsyncUnaryCall<ListTokenAuthUsersResponse> ListTokenAuthUsersAsync(ListTokenAuthUsersRequest request, CallOptions options)Lists all the token auth users for a token based auth enabled cluster.
| Parameters | |
|---|---|
| Name | Description |
request |
ListTokenAuthUsersRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallListTokenAuthUsersResponse |
The call object. |
ListTokenAuthUsersAsync(ListTokenAuthUsersRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ListTokenAuthUsersResponse> ListTokenAuthUsersAsync(ListTokenAuthUsersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Lists all the token auth users for a token based auth enabled cluster.
| Parameters | |
|---|---|
| Name | Description |
request |
ListTokenAuthUsersRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallListTokenAuthUsersResponse |
The call object. |
NewInstance(ClientBaseConfiguration)
protected override CloudRedisCluster.CloudRedisClusterClient NewInstance(ClientBase.ClientBaseConfiguration configuration)Creates a new instance of client from given ClientBaseConfiguration.
| Parameter | |
|---|---|
| Name | Description |
configuration |
ClientBaseClientBaseConfiguration |
| Returns | |
|---|---|
| Type | Description |
CloudRedisClusterCloudRedisClusterClient |
|
RescheduleClusterMaintenance(RescheduleClusterMaintenanceRequest, CallOptions)
public virtual Operation RescheduleClusterMaintenance(RescheduleClusterMaintenanceRequest request, CallOptions options)Reschedules upcoming maintenance event.
| Parameters | |
|---|---|
| Name | Description |
request |
RescheduleClusterMaintenanceRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
RescheduleClusterMaintenance(RescheduleClusterMaintenanceRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation RescheduleClusterMaintenance(RescheduleClusterMaintenanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Reschedules upcoming maintenance event.
| Parameters | |
|---|---|
| Name | Description |
request |
RescheduleClusterMaintenanceRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
RescheduleClusterMaintenanceAsync(RescheduleClusterMaintenanceRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> RescheduleClusterMaintenanceAsync(RescheduleClusterMaintenanceRequest request, CallOptions options)Reschedules upcoming maintenance event.
| Parameters | |
|---|---|
| Name | Description |
request |
RescheduleClusterMaintenanceRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
RescheduleClusterMaintenanceAsync(RescheduleClusterMaintenanceRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> RescheduleClusterMaintenanceAsync(RescheduleClusterMaintenanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Reschedules upcoming maintenance event.
| Parameters | |
|---|---|
| Name | Description |
request |
RescheduleClusterMaintenanceRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
UpdateAclPolicy(UpdateAclPolicyRequest, CallOptions)
public virtual Operation UpdateAclPolicy(UpdateAclPolicyRequest request, CallOptions options)Updates the ACL policy.
The operation applies the updated ACL policy to all of the linked clusters. If Memorystore can apply the policy to all clusters, then the operation returns a SUCCESS status. If Memorystore can't apply the policy to all clusters, then to ensure eventual consistency, Memorystore uses reconciliation to apply the policy to the failed clusters.
Completed longrunning.Operation will contain the new ACL policy object in the response field.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateAclPolicyRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
UpdateAclPolicy(UpdateAclPolicyRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation UpdateAclPolicy(UpdateAclPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Updates the ACL policy.
The operation applies the updated ACL policy to all of the linked clusters. If Memorystore can apply the policy to all clusters, then the operation returns a SUCCESS status. If Memorystore can't apply the policy to all clusters, then to ensure eventual consistency, Memorystore uses reconciliation to apply the policy to the failed clusters.
Completed longrunning.Operation will contain the new ACL policy object in the response field.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateAclPolicyRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
UpdateAclPolicyAsync(UpdateAclPolicyRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> UpdateAclPolicyAsync(UpdateAclPolicyRequest request, CallOptions options)Updates the ACL policy.
The operation applies the updated ACL policy to all of the linked clusters. If Memorystore can apply the policy to all clusters, then the operation returns a SUCCESS status. If Memorystore can't apply the policy to all clusters, then to ensure eventual consistency, Memorystore uses reconciliation to apply the policy to the failed clusters.
Completed longrunning.Operation will contain the new ACL policy object in the response field.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateAclPolicyRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
UpdateAclPolicyAsync(UpdateAclPolicyRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> UpdateAclPolicyAsync(UpdateAclPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Updates the ACL policy.
The operation applies the updated ACL policy to all of the linked clusters. If Memorystore can apply the policy to all clusters, then the operation returns a SUCCESS status. If Memorystore can't apply the policy to all clusters, then to ensure eventual consistency, Memorystore uses reconciliation to apply the policy to the failed clusters.
Completed longrunning.Operation will contain the new ACL policy object in the response field.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateAclPolicyRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
UpdateCluster(UpdateClusterRequest, CallOptions)
public virtual Operation UpdateCluster(UpdateClusterRequest request, CallOptions options)Updates the metadata and configuration of a specific Redis cluster.
Completed longrunning.Operation will contain the new cluster object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateClusterRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
UpdateCluster(UpdateClusterRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation UpdateCluster(UpdateClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Updates the metadata and configuration of a specific Redis cluster.
Completed longrunning.Operation will contain the new cluster object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateClusterRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
UpdateClusterAsync(UpdateClusterRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> UpdateClusterAsync(UpdateClusterRequest request, CallOptions options)Updates the metadata and configuration of a specific Redis cluster.
Completed longrunning.Operation will contain the new cluster object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateClusterRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
UpdateClusterAsync(UpdateClusterRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> UpdateClusterAsync(UpdateClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Updates the metadata and configuration of a specific Redis cluster.
Completed longrunning.Operation will contain the new cluster object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateClusterRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |