Class CloudRedis.CloudRedisClient (3.0.0)

Stay organized with collections Save and categorize content based on your preferences.
public class CloudRedisClient : ClientBase<CloudRedis.CloudRedisClient>

Client for CloudRedis

Inheritance

System.Object > ClientBase > ClientBase<CloudRedis.CloudRedisClient> > CloudRedis.CloudRedisClient

Namespace

Google.Cloud.Redis.V1

Assembly

Google.Cloud.Redis.V1.dll

Constructors

CloudRedisClient()

protected CloudRedisClient()

Protected parameterless constructor to allow creation of test doubles.

CloudRedisClient(CallInvoker)

public CloudRedisClient(CallInvoker callInvoker)

Creates a new client for CloudRedis that uses a custom CallInvoker.

Parameter
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

CloudRedisClient(ChannelBase)

public CloudRedisClient(ChannelBase channel)

Creates a new client for CloudRedis

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

CloudRedisClient(ClientBase.ClientBaseConfiguration)

protected CloudRedisClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration

The client configuration.

Methods

CreateInstance(CreateInstanceRequest, CallOptions)

public virtual Operation CreateInstance(CreateInstanceRequest request, CallOptions options)

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
NameDescription
requestCreateInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateInstance(CreateInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation CreateInstance(CreateInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

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
NameDescription
requestCreateInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineSystem.Nullable<System.DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenSystem.Threading.CancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateInstanceAsync(CreateInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateInstanceAsync(CreateInstanceRequest request, CallOptions options)

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
NameDescription
requestCreateInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

CreateInstanceAsync(CreateInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateInstanceAsync(CreateInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

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
NameDescription
requestCreateInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineSystem.Nullable<System.DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenSystem.Threading.CancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
TypeDescription
Operations.OperationsClient

A new Operations client for the same target as this client.

DeleteInstance(DeleteInstanceRequest, CallOptions)

public virtual Operation DeleteInstance(DeleteInstanceRequest request, CallOptions options)

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

Parameters
NameDescription
requestDeleteInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteInstance(DeleteInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation DeleteInstance(DeleteInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
NameDescription
requestDeleteInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineSystem.Nullable<System.DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenSystem.Threading.CancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteInstanceAsync(DeleteInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteInstanceAsync(DeleteInstanceRequest request, CallOptions options)

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

Parameters
NameDescription
requestDeleteInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

DeleteInstanceAsync(DeleteInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteInstanceAsync(DeleteInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
NameDescription
requestDeleteInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineSystem.Nullable<System.DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenSystem.Threading.CancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

ExportInstance(ExportInstanceRequest, CallOptions)

public virtual Operation ExportInstance(ExportInstanceRequest request, CallOptions options)

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
NameDescription
requestExportInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

ExportInstance(ExportInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation ExportInstance(ExportInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

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
NameDescription
requestExportInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineSystem.Nullable<System.DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenSystem.Threading.CancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

ExportInstanceAsync(ExportInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ExportInstanceAsync(ExportInstanceRequest request, CallOptions options)

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
NameDescription
requestExportInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

ExportInstanceAsync(ExportInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> ExportInstanceAsync(ExportInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

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
NameDescription
requestExportInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineSystem.Nullable<System.DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenSystem.Threading.CancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

FailoverInstance(FailoverInstanceRequest, CallOptions)

public virtual Operation FailoverInstance(FailoverInstanceRequest request, CallOptions options)

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

Parameters
NameDescription
requestFailoverInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

FailoverInstance(FailoverInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation FailoverInstance(FailoverInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
NameDescription
requestFailoverInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineSystem.Nullable<System.DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenSystem.Threading.CancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

FailoverInstanceAsync(FailoverInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> FailoverInstanceAsync(FailoverInstanceRequest request, CallOptions options)

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

Parameters
NameDescription
requestFailoverInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

FailoverInstanceAsync(FailoverInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> FailoverInstanceAsync(FailoverInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
NameDescription
requestFailoverInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineSystem.Nullable<System.DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenSystem.Threading.CancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

GetInstance(GetInstanceRequest, CallOptions)

public virtual Instance GetInstance(GetInstanceRequest request, CallOptions options)

Gets the details of a specific Redis instance.

Parameters
NameDescription
requestGetInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Instance

The response received from the server.

GetInstance(GetInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Instance GetInstance(GetInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Gets the details of a specific Redis instance.

Parameters
NameDescription
requestGetInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineSystem.Nullable<System.DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenSystem.Threading.CancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Instance

The response received from the server.

GetInstanceAsync(GetInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Instance> GetInstanceAsync(GetInstanceRequest request, CallOptions options)

Gets the details of a specific Redis instance.

Parameters
NameDescription
requestGetInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Instance>

The call object.

GetInstanceAsync(GetInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Instance> GetInstanceAsync(GetInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Gets the details of a specific Redis instance.

Parameters
NameDescription
requestGetInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineSystem.Nullable<System.DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenSystem.Threading.CancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Instance>

The call object.

GetInstanceAuthString(GetInstanceAuthStringRequest, CallOptions)

public virtual InstanceAuthString GetInstanceAuthString(GetInstanceAuthStringRequest request, CallOptions options)

Gets the AUTH string for a Redis instance. If AUTH is not enabled for the instance the response will be empty. This information is not included in the details returned to GetInstance.

Parameters
NameDescription
requestGetInstanceAuthStringRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
InstanceAuthString

The response received from the server.

GetInstanceAuthString(GetInstanceAuthStringRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual InstanceAuthString GetInstanceAuthString(GetInstanceAuthStringRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Gets the AUTH string for a Redis instance. If AUTH is not enabled for the instance the response will be empty. This information is not included in the details returned to GetInstance.

Parameters
NameDescription
requestGetInstanceAuthStringRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineSystem.Nullable<System.DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenSystem.Threading.CancellationToken

An optional token for canceling the call.

Returns
TypeDescription
InstanceAuthString

The response received from the server.

GetInstanceAuthStringAsync(GetInstanceAuthStringRequest, CallOptions)

public virtual AsyncUnaryCall<InstanceAuthString> GetInstanceAuthStringAsync(GetInstanceAuthStringRequest request, CallOptions options)

Gets the AUTH string for a Redis instance. If AUTH is not enabled for the instance the response will be empty. This information is not included in the details returned to GetInstance.

Parameters
NameDescription
requestGetInstanceAuthStringRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<InstanceAuthString>

The call object.

GetInstanceAuthStringAsync(GetInstanceAuthStringRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<InstanceAuthString> GetInstanceAuthStringAsync(GetInstanceAuthStringRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Gets the AUTH string for a Redis instance. If AUTH is not enabled for the instance the response will be empty. This information is not included in the details returned to GetInstance.

Parameters
NameDescription
requestGetInstanceAuthStringRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineSystem.Nullable<System.DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenSystem.Threading.CancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<InstanceAuthString>

The call object.

ImportInstance(ImportInstanceRequest, CallOptions)

public virtual Operation ImportInstance(ImportInstanceRequest request, CallOptions options)

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
NameDescription
requestImportInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

ImportInstance(ImportInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation ImportInstance(ImportInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

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
NameDescription
requestImportInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineSystem.Nullable<System.DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenSystem.Threading.CancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

ImportInstanceAsync(ImportInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ImportInstanceAsync(ImportInstanceRequest request, CallOptions options)

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
NameDescription
requestImportInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

ImportInstanceAsync(ImportInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> ImportInstanceAsync(ImportInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

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
NameDescription
requestImportInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineSystem.Nullable<System.DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenSystem.Threading.CancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

ListInstances(ListInstancesRequest, CallOptions)

public virtual ListInstancesResponse ListInstances(ListInstancesRequest request, CallOptions options)

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
NameDescription
requestListInstancesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListInstancesResponse

The response received from the server.

ListInstances(ListInstancesRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListInstancesResponse ListInstances(ListInstancesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

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
NameDescription
requestListInstancesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineSystem.Nullable<System.DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenSystem.Threading.CancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListInstancesResponse

The response received from the server.

ListInstancesAsync(ListInstancesRequest, CallOptions)

public virtual AsyncUnaryCall<ListInstancesResponse> ListInstancesAsync(ListInstancesRequest request, CallOptions options)

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
NameDescription
requestListInstancesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ListInstancesResponse>

The call object.

ListInstancesAsync(ListInstancesRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListInstancesResponse> ListInstancesAsync(ListInstancesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

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
NameDescription
requestListInstancesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineSystem.Nullable<System.DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenSystem.Threading.CancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<ListInstancesResponse>

The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

protected override CloudRedis.CloudRedisClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration
Returns
TypeDescription
CloudRedis.CloudRedisClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.Redis.V1.CloudRedis.CloudRedisClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

RescheduleMaintenance(RescheduleMaintenanceRequest, CallOptions)

public virtual Operation RescheduleMaintenance(RescheduleMaintenanceRequest request, CallOptions options)

Reschedule maintenance for a given instance in a given project and location.

Parameters
NameDescription
requestRescheduleMaintenanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

RescheduleMaintenance(RescheduleMaintenanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation RescheduleMaintenance(RescheduleMaintenanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Reschedule maintenance for a given instance in a given project and location.

Parameters
NameDescription
requestRescheduleMaintenanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineSystem.Nullable<System.DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenSystem.Threading.CancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

RescheduleMaintenanceAsync(RescheduleMaintenanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> RescheduleMaintenanceAsync(RescheduleMaintenanceRequest request, CallOptions options)

Reschedule maintenance for a given instance in a given project and location.

Parameters
NameDescription
requestRescheduleMaintenanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

RescheduleMaintenanceAsync(RescheduleMaintenanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> RescheduleMaintenanceAsync(RescheduleMaintenanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Reschedule maintenance for a given instance in a given project and location.

Parameters
NameDescription
requestRescheduleMaintenanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineSystem.Nullable<System.DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenSystem.Threading.CancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

UpdateInstance(UpdateInstanceRequest, CallOptions)

public virtual Operation UpdateInstance(UpdateInstanceRequest request, CallOptions options)

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
NameDescription
requestUpdateInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

UpdateInstance(UpdateInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation UpdateInstance(UpdateInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

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
NameDescription
requestUpdateInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineSystem.Nullable<System.DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenSystem.Threading.CancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

UpdateInstanceAsync(UpdateInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateInstanceAsync(UpdateInstanceRequest request, CallOptions options)

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
NameDescription
requestUpdateInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

UpdateInstanceAsync(UpdateInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> UpdateInstanceAsync(UpdateInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

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
NameDescription
requestUpdateInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineSystem.Nullable<System.DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenSystem.Threading.CancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

UpgradeInstance(UpgradeInstanceRequest, CallOptions)

public virtual Operation UpgradeInstance(UpgradeInstanceRequest request, CallOptions options)

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

Parameters
NameDescription
requestUpgradeInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

UpgradeInstance(UpgradeInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation UpgradeInstance(UpgradeInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
NameDescription
requestUpgradeInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineSystem.Nullable<System.DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenSystem.Threading.CancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

UpgradeInstanceAsync(UpgradeInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpgradeInstanceAsync(UpgradeInstanceRequest request, CallOptions options)

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

Parameters
NameDescription
requestUpgradeInstanceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

UpgradeInstanceAsync(UpgradeInstanceRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> UpgradeInstanceAsync(UpgradeInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
NameDescription
requestUpgradeInstanceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineSystem.Nullable<System.DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenSystem.Threading.CancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.