Google Cloud Memorystore for Redis v1 API - Class CloudRedis.CloudRedisBase (3.4.0)

[BindServiceMethod(typeof(CloudRedis), "BindService")]
public abstract class CloudRedis.CloudRedisBase

Reference documentation and code samples for the Google Cloud Memorystore for Redis v1 API class CloudRedis.CloudRedisBase.

Base class for server-side implementations of CloudRedis

Inheritance

object > CloudRedis.CloudRedisBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Redis.V1

Assembly

Google.Cloud.Redis.V1.dll

Methods

CreateInstance(CreateInstanceRequest, ServerCallContext)

public virtual Task<Operation> CreateInstance(CreateInstanceRequest request, ServerCallContext context)

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 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).

DeleteInstance(DeleteInstanceRequest, ServerCallContext)

public virtual Task<Operation> DeleteInstance(DeleteInstanceRequest request, ServerCallContext context)

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

Parameters
Name	Description
`request`	`DeleteInstanceRequest` 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).

ExportInstance(ExportInstanceRequest, ServerCallContext)

public virtual Task<Operation> ExportInstance(ExportInstanceRequest request, ServerCallContext context)

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 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).

FailoverInstance(FailoverInstanceRequest, ServerCallContext)

public virtual Task<Operation> FailoverInstance(FailoverInstanceRequest request, ServerCallContext context)

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

Parameters
Name	Description
`request`	`FailoverInstanceRequest` 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).

GetInstance(GetInstanceRequest, ServerCallContext)

public virtual Task<Instance> GetInstance(GetInstanceRequest request, ServerCallContext context)

Gets the details of a specific Redis instance.

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

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

GetInstanceAuthString(GetInstanceAuthStringRequest, ServerCallContext)

public virtual Task<InstanceAuthString> GetInstanceAuthString(GetInstanceAuthStringRequest request, ServerCallContext context)

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

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

ImportInstance(ImportInstanceRequest, ServerCallContext)

public virtual Task<Operation> ImportInstance(ImportInstanceRequest request, ServerCallContext context)

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 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).

ListInstances(ListInstancesRequest, ServerCallContext)

public virtual Task<ListInstancesResponse> ListInstances(ListInstancesRequest request, ServerCallContext context)

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

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

RescheduleMaintenance(RescheduleMaintenanceRequest, ServerCallContext)

public virtual Task<Operation> RescheduleMaintenance(RescheduleMaintenanceRequest request, ServerCallContext context)

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

Parameters
Name	Description
`request`	`RescheduleMaintenanceRequest` 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).

UpdateInstance(UpdateInstanceRequest, ServerCallContext)

public virtual Task<Operation> UpdateInstance(UpdateInstanceRequest request, ServerCallContext context)

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 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).

UpgradeInstance(UpgradeInstanceRequest, ServerCallContext)

public virtual Task<Operation> UpgradeInstance(UpgradeInstanceRequest request, ServerCallContext context)

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

Parameters
Name	Description
`request`	`UpgradeInstanceRequest` 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).