public sealed class CloudRedisClusterClientImpl : CloudRedisClusterClientReference documentation and code samples for the Google Cloud Memorystore for Redis (cluster management) v1 API class CloudRedisClusterClientImpl.
CloudRedisCluster client wrapper implementation, for convenient use.
Namespace
Google.Cloud.Redis.Cluster.V1Assembly
Google.Cloud.Redis.Cluster.V1.dll
Remarks
Configures and manages Cloud Memorystore for Redis clusters
Google Cloud Memorystore for Redis Cluster
The redis.googleapis.com service implements the Google Cloud Memorystore
for Redis API and defines the following resource model for managing Redis
clusters:
- The service works with a collection of cloud projects, named:
/projects/* - Each project has a collection of available locations, named:
/locations/* - Each location has a collection of Redis clusters, named:
/clusters/* - As such, Redis clusters are resources of the form:
/projects/{project_id}/locations/{location_id}/clusters/{instance_id}
Note that location_id must be a GCP region; for example:
projects/redpepper-1290/locations/us-central1/clusters/my-redis
We use API version selector for Flex APIs
- The versioning strategy is release-based versioning
- Our backend CLH only deals with the superset version (called v1main)
- Existing backend for Redis Gen1 and MRR is not touched.
- More details in go/redis-flex-api-versioning
Constructors
CloudRedisClusterClientImpl(CloudRedisClusterClient, CloudRedisClusterSettings, ILogger)
public CloudRedisClusterClientImpl(CloudRedisCluster.CloudRedisClusterClient grpcClient, CloudRedisClusterSettings settings, ILogger logger)Constructs a client wrapper for the CloudRedisCluster service, with the specified gRPC client and settings.
| Parameters | |
|---|---|
| Name | Description |
grpcClient | CloudRedisClusterCloudRedisClusterClientThe underlying gRPC client. |
settings | CloudRedisClusterSettingsThe base CloudRedisClusterSettings used within this client. |
logger | ILoggerOptional ILogger to use within this client. |
Properties
CreateClusterOperationsClient
public override OperationsClient CreateClusterOperationsClient { get; }The long-running operations client for CreateCluster.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
DeleteClusterOperationsClient
public override OperationsClient DeleteClusterOperationsClient { get; }The long-running operations client for DeleteCluster.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
GrpcClient
public override CloudRedisCluster.CloudRedisClusterClient GrpcClient { get; }The underlying gRPC CloudRedisCluster client
| Property Value | |
|---|---|
| Type | Description |
CloudRedisClusterCloudRedisClusterClient | |
LocationsClient
public override LocationsClient LocationsClient { get; }The LocationsClient associated with this client.
| Property Value | |
|---|---|
| Type | Description |
LocationsClient | |
UpdateClusterOperationsClient
public override OperationsClient UpdateClusterOperationsClient { get; }The long-running operations client for UpdateCluster.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
Methods
CreateCluster(CreateClusterRequest, CallSettings)
public override Operation<Cluster, Any> CreateCluster(CreateClusterRequest request, CallSettings callSettings = null)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 object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationClusterAny | The RPC response. |
CreateClusterAsync(CreateClusterRequest, CallSettings)
public override Task<Operation<Cluster, Any>> CreateClusterAsync(CreateClusterRequest request, CallSettings callSettings = null)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 object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationClusterAny | A Task containing the RPC response. |
DeleteCluster(DeleteClusterRequest, CallSettings)
public override Operation<Empty, Any> DeleteCluster(DeleteClusterRequest request, CallSettings callSettings = null)Deletes a specific Redis cluster. Cluster stops serving and data is deleted.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteClusterRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationEmptyAny | The RPC response. |
DeleteClusterAsync(DeleteClusterRequest, CallSettings)
public override Task<Operation<Empty, Any>> DeleteClusterAsync(DeleteClusterRequest request, CallSettings callSettings = null)Deletes a specific Redis cluster. Cluster stops serving and data is deleted.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteClusterRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationEmptyAny | A Task containing the RPC response. |
GetCluster(GetClusterRequest, CallSettings)
public override Cluster GetCluster(GetClusterRequest request, CallSettings callSettings = null)Gets the details of a specific Redis cluster.
| Parameters | |
|---|---|
| Name | Description |
request | GetClusterRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Cluster | The RPC response. |
GetClusterAsync(GetClusterRequest, CallSettings)
public override Task<Cluster> GetClusterAsync(GetClusterRequest request, CallSettings callSettings = null)Gets the details of a specific Redis cluster.
| Parameters | |
|---|---|
| Name | Description |
request | GetClusterRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskCluster | A Task containing the RPC response. |
ListClusters(ListClustersRequest, CallSettings)
public override PagedEnumerable<ListClustersResponse, Cluster> ListClusters(ListClustersRequest request, CallSettings callSettings = null)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 object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListClustersResponseCluster | A pageable sequence of Cluster resources. |
ListClustersAsync(ListClustersRequest, CallSettings)
public override PagedAsyncEnumerable<ListClustersResponse, Cluster> ListClustersAsync(ListClustersRequest request, CallSettings callSettings = null)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 object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListClustersResponseCluster | A pageable asynchronous sequence of Cluster resources. |
UpdateCluster(UpdateClusterRequest, CallSettings)
public override Operation<Cluster, Any> UpdateCluster(UpdateClusterRequest request, CallSettings callSettings = null)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 object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationClusterAny | The RPC response. |
UpdateClusterAsync(UpdateClusterRequest, CallSettings)
public override Task<Operation<Cluster, Any>> UpdateClusterAsync(UpdateClusterRequest request, CallSettings callSettings = null)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 object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationClusterAny | A Task containing the RPC response. |