Google Cloud Memorystore for Redis (cluster management) v1 API - Class CloudRedisCluster.CloudRedisClusterBase (1.9.0)

1.9.0 (latest) 1.8.0 1.7.0 1.6.0 1.5.0 1.4.0 1.3.0 1.2.0 1.1.0 1.0.0

[BindServiceMethod(typeof(CloudRedisCluster), "BindService")]
public abstract class CloudRedisCluster.CloudRedisClusterBase

Reference documentation and code samples for the Google Cloud Memorystore for Redis (cluster management) v1 API class CloudRedisCluster.CloudRedisClusterBase.

Base class for server-side implementations of CloudRedisCluster

Inheritance

object > CloudRedisCluster.CloudRedisClusterBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Redis.Cluster.V1

Assembly

Google.Cloud.Redis.Cluster.V1.dll

Methods

BackupCluster(BackupClusterRequest, ServerCallContext)

public virtual Task<Operation> BackupCluster(BackupClusterRequest request, ServerCallContext context)

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	BackupClusterRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

CreateAclPolicy(CreateAclPolicyRequest, ServerCallContext)

public virtual Task<AclPolicy> CreateAclPolicy(CreateAclPolicyRequest request, ServerCallContext context)

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	CreateAclPolicyRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskAclPolicy	The response to send back to the client (wrapped by a task).

CreateCluster(CreateClusterRequest, ServerCallContext)

public virtual Task<Operation> CreateCluster(CreateClusterRequest request, ServerCallContext context)

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	CreateClusterRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DeleteAclPolicy(DeleteAclPolicyRequest, ServerCallContext)

public virtual Task<Operation> DeleteAclPolicy(DeleteAclPolicyRequest request, ServerCallContext context)

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	DeleteAclPolicyRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DeleteBackup(DeleteBackupRequest, ServerCallContext)

public virtual Task<Operation> DeleteBackup(DeleteBackupRequest request, ServerCallContext context)

Deletes a specific backup.

Parameters
Name	Description
request	DeleteBackupRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DeleteCluster(DeleteClusterRequest, ServerCallContext)

public virtual Task<Operation> DeleteCluster(DeleteClusterRequest request, ServerCallContext context)

Deletes a specific Redis cluster. Cluster stops serving and data is deleted.

Parameters
Name	Description
request	DeleteClusterRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

ExportBackup(ExportBackupRequest, ServerCallContext)

public virtual Task<Operation> ExportBackup(ExportBackupRequest request, ServerCallContext context)

Exports a specific backup to a customer target Cloud Storage URI.

Parameters
Name	Description
request	ExportBackupRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

GetAclPolicy(GetAclPolicyRequest, ServerCallContext)

public virtual Task<AclPolicy> GetAclPolicy(GetAclPolicyRequest request, ServerCallContext context)

Gets the details of a specific Redis Cluster ACL policy.

Parameters
Name	Description
request	GetAclPolicyRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskAclPolicy	The response to send back to the client (wrapped by a task).

GetAclPolicyRevision(GetAclPolicyRevisionRequest, ServerCallContext)

public virtual Task<AclPolicyRevision> GetAclPolicyRevision(GetAclPolicyRevisionRequest request, ServerCallContext context)

Gets details of a specific ACL policy revision.

Parameters
Name	Description
request	GetAclPolicyRevisionRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskAclPolicyRevision	The response to send back to the client (wrapped by a task).

GetBackup(GetBackupRequest, ServerCallContext)

public virtual Task<Backup> GetBackup(GetBackupRequest request, ServerCallContext context)

Gets the details of a specific backup.

Parameters
Name	Description
request	GetBackupRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskBackup	The response to send back to the client (wrapped by a task).

GetBackupCollection(GetBackupCollectionRequest, ServerCallContext)

public virtual Task<BackupCollection> GetBackupCollection(GetBackupCollectionRequest request, ServerCallContext context)

Get a backup collection.

Parameters
Name	Description
request	GetBackupCollectionRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskBackupCollection	The response to send back to the client (wrapped by a task).

GetCluster(GetClusterRequest, ServerCallContext)

public virtual Task<Cluster> GetCluster(GetClusterRequest request, ServerCallContext context)

Gets the details of a specific Redis cluster.

Parameters
Name	Description
request	GetClusterRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskCluster	The response to send back to the client (wrapped by a task).

GetClusterCertificateAuthority(GetClusterCertificateAuthorityRequest, ServerCallContext)

public virtual Task<CertificateAuthority> GetClusterCertificateAuthority(GetClusterCertificateAuthorityRequest request, ServerCallContext context)

Gets the details of certificate authority information for Redis cluster.

Parameters
Name	Description
request	GetClusterCertificateAuthorityRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskCertificateAuthority	The response to send back to the client (wrapped by a task).

GetSharedRegionalCertificateAuthority(GetSharedRegionalCertificateAuthorityRequest, ServerCallContext)

public virtual Task<SharedRegionalCertificateAuthority> GetSharedRegionalCertificateAuthority(GetSharedRegionalCertificateAuthorityRequest request, ServerCallContext context)

Gets the details of regional certificate authority information for Redis cluster.

Parameters
Name	Description
request	GetSharedRegionalCertificateAuthorityRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskSharedRegionalCertificateAuthority	The response to send back to the client (wrapped by a task).

ListAclPolicies(ListAclPoliciesRequest, ServerCallContext)

public virtual Task<ListAclPoliciesResponse> ListAclPolicies(ListAclPoliciesRequest request, ServerCallContext context)

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	ListAclPoliciesRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListAclPoliciesResponse	The response to send back to the client (wrapped by a task).

ListAclPolicyRevisions(ListAclPolicyRevisionsRequest, ServerCallContext)

public virtual Task<ListAclPolicyRevisionsResponse> ListAclPolicyRevisions(ListAclPolicyRevisionsRequest request, ServerCallContext context)

Lists all ACL policy revisions in a given ACL policy.

Parameters
Name	Description
request	ListAclPolicyRevisionsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListAclPolicyRevisionsResponse	The response to send back to the client (wrapped by a task).

ListBackupCollections(ListBackupCollectionsRequest, ServerCallContext)

public virtual Task<ListBackupCollectionsResponse> ListBackupCollections(ListBackupCollectionsRequest request, ServerCallContext context)

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	ListBackupCollectionsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListBackupCollectionsResponse	The response to send back to the client (wrapped by a task).

ListBackups(ListBackupsRequest, ServerCallContext)

public virtual Task<ListBackupsResponse> ListBackups(ListBackupsRequest request, ServerCallContext context)

Lists all backups owned by a backup collection.

Parameters
Name	Description
request	ListBackupsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListBackupsResponse	The response to send back to the client (wrapped by a task).

ListClusters(ListClustersRequest, ServerCallContext)

public virtual Task<ListClustersResponse> ListClusters(ListClustersRequest request, ServerCallContext context)

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	ListClustersRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListClustersResponse	The response to send back to the client (wrapped by a task).

RescheduleClusterMaintenance(RescheduleClusterMaintenanceRequest, ServerCallContext)

public virtual Task<Operation> RescheduleClusterMaintenance(RescheduleClusterMaintenanceRequest request, ServerCallContext context)

Reschedules upcoming maintenance event.

Parameters
Name	Description
request	RescheduleClusterMaintenanceRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

UpdateAclPolicy(UpdateAclPolicyRequest, ServerCallContext)

public virtual Task<Operation> UpdateAclPolicy(UpdateAclPolicyRequest request, ServerCallContext context)

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	UpdateAclPolicyRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

UpdateCluster(UpdateClusterRequest, ServerCallContext)

public virtual Task<Operation> UpdateCluster(UpdateClusterRequest request, ServerCallContext context)

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	UpdateClusterRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).