Class CloudRedisClientImpl (2.3.0)

public sealed class CloudRedisClientImpl : CloudRedisClient

CloudRedis client wrapper implementation, for convenient use.

Inheritance

Object > CloudRedisClient > CloudRedisClientImpl

Inherited Members

CloudRedisClient.DefaultEndpoint

CloudRedisClient.DefaultScopes

CloudRedisClient.CreateAsync(CancellationToken)

CloudRedisClient.Create()

CloudRedisClient.ShutdownDefaultChannelsAsync()

CloudRedisClient.ListInstances(String, String, Nullable<Int32>, CallSettings)

CloudRedisClient.ListInstancesAsync(String, String, Nullable<Int32>, CallSettings)

CloudRedisClient.ListInstances(LocationName, String, Nullable<Int32>, CallSettings)

CloudRedisClient.ListInstancesAsync(LocationName, String, Nullable<Int32>, CallSettings)

CloudRedisClient.GetInstanceAsync(GetInstanceRequest, CancellationToken)

CloudRedisClient.GetInstance(String, CallSettings)

CloudRedisClient.GetInstanceAsync(String, CallSettings)

CloudRedisClient.GetInstanceAsync(String, CancellationToken)

CloudRedisClient.GetInstance(InstanceName, CallSettings)

CloudRedisClient.GetInstanceAsync(InstanceName, CallSettings)

CloudRedisClient.GetInstanceAsync(InstanceName, CancellationToken)

CloudRedisClient.CreateInstanceAsync(CreateInstanceRequest, CancellationToken)

CloudRedisClient.PollOnceCreateInstance(String, CallSettings)

CloudRedisClient.PollOnceCreateInstanceAsync(String, CallSettings)

CloudRedisClient.CreateInstance(String, String, Instance, CallSettings)

CloudRedisClient.CreateInstanceAsync(String, String, Instance, CallSettings)

CloudRedisClient.CreateInstanceAsync(String, String, Instance, CancellationToken)

CloudRedisClient.CreateInstance(LocationName, String, Instance, CallSettings)

CloudRedisClient.CreateInstanceAsync(LocationName, String, Instance, CallSettings)

CloudRedisClient.CreateInstanceAsync(LocationName, String, Instance, CancellationToken)

CloudRedisClient.UpdateInstanceAsync(UpdateInstanceRequest, CancellationToken)

CloudRedisClient.PollOnceUpdateInstance(String, CallSettings)

CloudRedisClient.PollOnceUpdateInstanceAsync(String, CallSettings)

CloudRedisClient.UpdateInstance(FieldMask, Instance, CallSettings)

CloudRedisClient.UpdateInstanceAsync(FieldMask, Instance, CallSettings)

CloudRedisClient.UpdateInstanceAsync(FieldMask, Instance, CancellationToken)

CloudRedisClient.UpgradeInstanceAsync(UpgradeInstanceRequest, CancellationToken)

CloudRedisClient.PollOnceUpgradeInstance(String, CallSettings)

CloudRedisClient.PollOnceUpgradeInstanceAsync(String, CallSettings)

CloudRedisClient.UpgradeInstance(String, String, CallSettings)

CloudRedisClient.UpgradeInstanceAsync(String, String, CallSettings)

CloudRedisClient.UpgradeInstanceAsync(String, String, CancellationToken)

CloudRedisClient.UpgradeInstance(InstanceName, String, CallSettings)

CloudRedisClient.UpgradeInstanceAsync(InstanceName, String, CallSettings)

CloudRedisClient.UpgradeInstanceAsync(InstanceName, String, CancellationToken)

CloudRedisClient.ImportInstanceAsync(ImportInstanceRequest, CancellationToken)

CloudRedisClient.PollOnceImportInstance(String, CallSettings)

CloudRedisClient.PollOnceImportInstanceAsync(String, CallSettings)

CloudRedisClient.ImportInstance(String, InputConfig, CallSettings)

CloudRedisClient.ImportInstanceAsync(String, InputConfig, CallSettings)

CloudRedisClient.ImportInstanceAsync(String, InputConfig, CancellationToken)

CloudRedisClient.ExportInstanceAsync(ExportInstanceRequest, CancellationToken)

CloudRedisClient.PollOnceExportInstance(String, CallSettings)

CloudRedisClient.PollOnceExportInstanceAsync(String, CallSettings)

CloudRedisClient.ExportInstance(String, OutputConfig, CallSettings)

CloudRedisClient.ExportInstanceAsync(String, OutputConfig, CallSettings)

CloudRedisClient.ExportInstanceAsync(String, OutputConfig, CancellationToken)

CloudRedisClient.FailoverInstanceAsync(FailoverInstanceRequest, CancellationToken)

CloudRedisClient.PollOnceFailoverInstance(String, CallSettings)

CloudRedisClient.PollOnceFailoverInstanceAsync(String, CallSettings)

CloudRedisClient.FailoverInstance(String, FailoverInstanceRequest.Types.DataProtectionMode, CallSettings)

CloudRedisClient.FailoverInstanceAsync(String, FailoverInstanceRequest.Types.DataProtectionMode, CallSettings)

CloudRedisClient.FailoverInstanceAsync(String, FailoverInstanceRequest.Types.DataProtectionMode, CancellationToken)

CloudRedisClient.FailoverInstance(InstanceName, FailoverInstanceRequest.Types.DataProtectionMode, CallSettings)

CloudRedisClient.FailoverInstanceAsync(InstanceName, FailoverInstanceRequest.Types.DataProtectionMode, CallSettings)

CloudRedisClient.FailoverInstanceAsync(InstanceName, FailoverInstanceRequest.Types.DataProtectionMode, CancellationToken)

CloudRedisClient.DeleteInstanceAsync(DeleteInstanceRequest, CancellationToken)

CloudRedisClient.PollOnceDeleteInstance(String, CallSettings)

CloudRedisClient.PollOnceDeleteInstanceAsync(String, CallSettings)

CloudRedisClient.DeleteInstance(String, CallSettings)

CloudRedisClient.DeleteInstanceAsync(String, CallSettings)

CloudRedisClient.DeleteInstanceAsync(String, CancellationToken)

CloudRedisClient.DeleteInstance(InstanceName, CallSettings)

CloudRedisClient.DeleteInstanceAsync(InstanceName, CallSettings)

CloudRedisClient.DeleteInstanceAsync(InstanceName, CancellationToken)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Redis.V1

Assembly

Google.Cloud.Redis.V1.dll

Remarks

Configures and manages Cloud Memorystore for Redis instances

Google Cloud Memorystore for Redis v1

The redis.googleapis.com service implements the Google Cloud Memorystore for Redis API and defines the following resource model for managing Redis instances:

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 instances, named: /instances/*
As such, Redis instances are resources of the form: /projects/{project_id}/locations/{location_id}/instances/{instance_id}

Note that location_id must be referring to a GCP region; for example:

projects/redpepper-1290/locations/us-central1/instances/my-redis

Constructors

CloudRedisClientImpl(CloudRedis.CloudRedisClient, CloudRedisSettings)

public CloudRedisClientImpl(CloudRedis.CloudRedisClient grpcClient, CloudRedisSettings settings)

Constructs a client wrapper for the CloudRedis service, with the specified gRPC client and settings.

Parameters
Name	Description
`grpcClient`	`CloudRedis.CloudRedisClient` The underlying gRPC client.
`settings`	`CloudRedisSettings` The base CloudRedisSettings used within this client.

Properties

CreateInstanceOperationsClient

public override OperationsClient CreateInstanceOperationsClient { get; }

The long-running operations client for CreateInstance.

Property Value
Type	Description
`OperationsClient`

Overrides

CloudRedisClient.CreateInstanceOperationsClient

DeleteInstanceOperationsClient

public override OperationsClient DeleteInstanceOperationsClient { get; }

The long-running operations client for DeleteInstance.

Property Value
Type	Description
`OperationsClient`

Overrides

CloudRedisClient.DeleteInstanceOperationsClient

ExportInstanceOperationsClient

public override OperationsClient ExportInstanceOperationsClient { get; }

The long-running operations client for ExportInstance.

Property Value
Type	Description
`OperationsClient`

Overrides

CloudRedisClient.ExportInstanceOperationsClient

FailoverInstanceOperationsClient

public override OperationsClient FailoverInstanceOperationsClient { get; }

The long-running operations client for FailoverInstance.

Property Value
Type	Description
`OperationsClient`

Overrides

CloudRedisClient.FailoverInstanceOperationsClient

GrpcClient

public override CloudRedis.CloudRedisClient GrpcClient { get; }

The underlying gRPC CloudRedis client

Property Value
Type	Description
`CloudRedis.CloudRedisClient`

Overrides

CloudRedisClient.GrpcClient

ImportInstanceOperationsClient

public override OperationsClient ImportInstanceOperationsClient { get; }

The long-running operations client for ImportInstance.

Property Value
Type	Description
`OperationsClient`

Overrides

CloudRedisClient.ImportInstanceOperationsClient

UpdateInstanceOperationsClient

public override OperationsClient UpdateInstanceOperationsClient { get; }

The long-running operations client for UpdateInstance.

Property Value
Type	Description
`OperationsClient`

Overrides

CloudRedisClient.UpdateInstanceOperationsClient

UpgradeInstanceOperationsClient

public override OperationsClient UpgradeInstanceOperationsClient { get; }

The long-running operations client for UpgradeInstance.

Property Value
Type	Description
`OperationsClient`

Overrides

CloudRedisClient.UpgradeInstanceOperationsClient

Methods

CreateInstance(CreateInstanceRequest, CallSettings)

public override Operation<Instance, OperationMetadata> CreateInstance(CreateInstanceRequest request, CallSettings callSettings = null)

Creates a Redis instance based on the specified tier and memory size.

By default, the instance is accessible from the project's default network.

The creation is executed asynchronously and callers may check the returned operation to track its progress. Once the operation is completed the Redis instance will be fully functional. Completed longrunning.Operation will contain the new instance 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`	`CreateInstanceRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Operation<Instance, OperationMetadata>`	The RPC response.

Overrides

CloudRedisClient.CreateInstance(CreateInstanceRequest, CallSettings)

CreateInstanceAsync(CreateInstanceRequest, CallSettings)

public override Task<Operation<Instance, OperationMetadata>> CreateInstanceAsync(CreateInstanceRequest request, CallSettings callSettings = null)

Creates a Redis instance based on the specified tier and memory size.

By default, the instance is accessible from the project's default network.

The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

Parameters
Name	Description
`request`	`CreateInstanceRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Operation<Instance, OperationMetadata>>`	A Task containing the RPC response.

Overrides

CloudRedisClient.CreateInstanceAsync(CreateInstanceRequest, CallSettings)

DeleteInstance(DeleteInstanceRequest, CallSettings)

public override Operation<Empty, OperationMetadata> DeleteInstance(DeleteInstanceRequest request, CallSettings callSettings = null)

Deletes a specific Redis instance. Instance stops serving and data is deleted.

Parameters
Name	Description
`request`	`DeleteInstanceRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Operation<Empty, OperationMetadata>`	The RPC response.

Overrides

CloudRedisClient.DeleteInstance(DeleteInstanceRequest, CallSettings)

DeleteInstanceAsync(DeleteInstanceRequest, CallSettings)

public override Task<Operation<Empty, OperationMetadata>> DeleteInstanceAsync(DeleteInstanceRequest request, CallSettings callSettings = null)

Deletes a specific Redis instance. Instance stops serving and data is deleted.

Parameters
Name	Description
`request`	`DeleteInstanceRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Operation<Empty, OperationMetadata>>`	A Task containing the RPC response.

Overrides

CloudRedisClient.DeleteInstanceAsync(DeleteInstanceRequest, CallSettings)

ExportInstance(ExportInstanceRequest, CallSettings)

public override Operation<Instance, OperationMetadata> ExportInstance(ExportInstanceRequest request, CallSettings callSettings = null)

Export Redis instance data into a Redis RDB format file in Cloud Storage.

Redis will continue serving during this operation.

The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

Parameters
Name	Description
`request`	`ExportInstanceRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Operation<Instance, OperationMetadata>`	The RPC response.

Overrides

CloudRedisClient.ExportInstance(ExportInstanceRequest, CallSettings)

ExportInstanceAsync(ExportInstanceRequest, CallSettings)

public override Task<Operation<Instance, OperationMetadata>> ExportInstanceAsync(ExportInstanceRequest request, CallSettings callSettings = null)

Export Redis instance data into a Redis RDB format file in Cloud Storage.

Redis will continue serving during this operation.

The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

Parameters
Name	Description
`request`	`ExportInstanceRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Operation<Instance, OperationMetadata>>`	A Task containing the RPC response.

Overrides

CloudRedisClient.ExportInstanceAsync(ExportInstanceRequest, CallSettings)

FailoverInstance(FailoverInstanceRequest, CallSettings)

public override Operation<Instance, OperationMetadata> FailoverInstance(FailoverInstanceRequest request, CallSettings callSettings = null)

Initiates a failover of the master node to current replica node for a specific STANDARD tier Cloud Memorystore for Redis instance.

Parameters
Name	Description
`request`	`FailoverInstanceRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Operation<Instance, OperationMetadata>`	The RPC response.

Overrides

CloudRedisClient.FailoverInstance(FailoverInstanceRequest, CallSettings)

FailoverInstanceAsync(FailoverInstanceRequest, CallSettings)

public override Task<Operation<Instance, OperationMetadata>> FailoverInstanceAsync(FailoverInstanceRequest request, CallSettings callSettings = null)

Initiates a failover of the master node to current replica node for a specific STANDARD tier Cloud Memorystore for Redis instance.

Parameters
Name	Description
`request`	`FailoverInstanceRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Operation<Instance, OperationMetadata>>`	A Task containing the RPC response.

Overrides

CloudRedisClient.FailoverInstanceAsync(FailoverInstanceRequest, CallSettings)

GetInstance(GetInstanceRequest, CallSettings)

public override Instance GetInstance(GetInstanceRequest request, CallSettings callSettings = null)

Gets the details of a specific Redis instance.

Parameters
Name	Description
`request`	`GetInstanceRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Instance`	The RPC response.

Overrides

CloudRedisClient.GetInstance(GetInstanceRequest, CallSettings)

GetInstanceAsync(GetInstanceRequest, CallSettings)

public override Task<Instance> GetInstanceAsync(GetInstanceRequest request, CallSettings callSettings = null)

Gets the details of a specific Redis instance.

Parameters
Name	Description
`request`	`GetInstanceRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Instance>`	A Task containing the RPC response.

Overrides

CloudRedisClient.GetInstanceAsync(GetInstanceRequest, CallSettings)

ImportInstance(ImportInstanceRequest, CallSettings)

public override Operation<Instance, OperationMetadata> ImportInstance(ImportInstanceRequest request, CallSettings callSettings = null)

Import a Redis RDB snapshot file from Cloud Storage into a Redis instance.

Redis may stop serving during this operation. Instance state will be IMPORTING for entire operation. When complete, the instance will contain only data from the imported file.

The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

Parameters
Name	Description
`request`	`ImportInstanceRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Operation<Instance, OperationMetadata>`	The RPC response.

Overrides

CloudRedisClient.ImportInstance(ImportInstanceRequest, CallSettings)

ImportInstanceAsync(ImportInstanceRequest, CallSettings)

public override Task<Operation<Instance, OperationMetadata>> ImportInstanceAsync(ImportInstanceRequest request, CallSettings callSettings = null)

Import a Redis RDB snapshot file from Cloud Storage into a Redis instance.

Redis may stop serving during this operation. Instance state will be IMPORTING for entire operation. When complete, the instance will contain only data from the imported file.

The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

Parameters
Name	Description
`request`	`ImportInstanceRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Operation<Instance, OperationMetadata>>`	A Task containing the RPC response.

Overrides

CloudRedisClient.ImportInstanceAsync(ImportInstanceRequest, CallSettings)

ListInstances(ListInstancesRequest, CallSettings)

public override PagedEnumerable<ListInstancesResponse, Instance> ListInstances(ListInstancesRequest request, CallSettings callSettings = null)

Lists all Redis instances 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`	`ListInstancesRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedEnumerable<ListInstancesResponse, Instance>`	A pageable sequence of Instance resources.

Overrides

CloudRedisClient.ListInstances(ListInstancesRequest, CallSettings)

ListInstancesAsync(ListInstancesRequest, CallSettings)

public override PagedAsyncEnumerable<ListInstancesResponse, Instance> ListInstancesAsync(ListInstancesRequest request, CallSettings callSettings = null)

Lists all Redis instances 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`	`ListInstancesRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedAsyncEnumerable<ListInstancesResponse, Instance>`	A pageable asynchronous sequence of Instance resources.

Overrides

CloudRedisClient.ListInstancesAsync(ListInstancesRequest, CallSettings)

UpdateInstance(UpdateInstanceRequest, CallSettings)

public override Operation<Instance, OperationMetadata> UpdateInstance(UpdateInstanceRequest request, CallSettings callSettings = null)

Updates the metadata and configuration of a specific Redis instance.

Completed longrunning.Operation will contain the new instance 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`	`UpdateInstanceRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Operation<Instance, OperationMetadata>`	The RPC response.

Overrides

CloudRedisClient.UpdateInstance(UpdateInstanceRequest, CallSettings)

UpdateInstanceAsync(UpdateInstanceRequest, CallSettings)

public override Task<Operation<Instance, OperationMetadata>> UpdateInstanceAsync(UpdateInstanceRequest request, CallSettings callSettings = null)

Updates the metadata and configuration of a specific Redis instance.

Parameters
Name	Description
`request`	`UpdateInstanceRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Operation<Instance, OperationMetadata>>`	A Task containing the RPC response.

Overrides

CloudRedisClient.UpdateInstanceAsync(UpdateInstanceRequest, CallSettings)

UpgradeInstance(UpgradeInstanceRequest, CallSettings)

public override Operation<Instance, OperationMetadata> UpgradeInstance(UpgradeInstanceRequest request, CallSettings callSettings = null)

Upgrades Redis instance to the newer Redis version specified in the request.

Parameters
Name	Description
`request`	`UpgradeInstanceRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Operation<Instance, OperationMetadata>`	The RPC response.

Overrides

CloudRedisClient.UpgradeInstance(UpgradeInstanceRequest, CallSettings)

UpgradeInstanceAsync(UpgradeInstanceRequest, CallSettings)

public override Task<Operation<Instance, OperationMetadata>> UpgradeInstanceAsync(UpgradeInstanceRequest request, CallSettings callSettings = null)

Upgrades Redis instance to the newer Redis version specified in the request.

Parameters
Name	Description
`request`	`UpgradeInstanceRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Operation<Instance, OperationMetadata>>`	A Task containing the RPC response.

Overrides

CloudRedisClient.UpgradeInstanceAsync(UpgradeInstanceRequest, CallSettings)