Class ProjectsResource.LocationsResource.InstancesResource

The "instances" collection of methods.

Inheritance

object

ProjectsResource.LocationsResource.InstancesResource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.CloudRedis.v1

Assembly: Google.Apis.CloudRedis.v1.dll

Syntax

public class ProjectsResource.LocationsResource.InstancesResource

Constructors

InstancesResource(IClientService)

Constructs a new resource.

Declaration

public InstancesResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Methods

Create(Instance, string)

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.

Declaration

public virtual ProjectsResource.LocationsResource.InstancesResource.CreateRequest Create(Instance body, string parent)

Parameters

Type	Name	Description
Instance	body	The body of the request.
string	parent	Required. The resource name of the instance location using the form: projects/{project_id}/locations/{location_id} where location_id refers to a GCP region.

Returns

Type	Description
ProjectsResource.LocationsResource.InstancesResource.CreateRequest

Delete(string)

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

Declaration

public virtual ProjectsResource.LocationsResource.InstancesResource.DeleteRequest Delete(string name)

Parameters

Type	Name	Description
string	name	Required. Redis instance resource name using the form: projects/{project_id}/locations/{location_id}/instances/{instance_id} where location_id refers to a GCP region.

Returns

Type	Description
ProjectsResource.LocationsResource.InstancesResource.DeleteRequest

Export(ExportInstanceRequest, string)

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.

Declaration

public virtual ProjectsResource.LocationsResource.InstancesResource.ExportRequest Export(ExportInstanceRequest body, string name)

Parameters

Type	Name	Description
ExportInstanceRequest	body	The body of the request.
string	name	Required. Redis instance resource name using the form: projects/{project_id}/locations/{location_id}/instances/{instance_id} where location_id refers to a GCP region.

Returns

Type	Description
ProjectsResource.LocationsResource.InstancesResource.ExportRequest

Failover(FailoverInstanceRequest, string)

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

Declaration

public virtual ProjectsResource.LocationsResource.InstancesResource.FailoverRequest Failover(FailoverInstanceRequest body, string name)

Parameters

Type	Name	Description
FailoverInstanceRequest	body	The body of the request.
string	name	Required. Redis instance resource name using the form: projects/{project_id}/locations/{location_id}/instances/{instance_id} where location_id refers to a GCP region.

Returns

Type	Description
ProjectsResource.LocationsResource.InstancesResource.FailoverRequest

Get(string)

Gets the details of a specific Redis instance.

Declaration

public virtual ProjectsResource.LocationsResource.InstancesResource.GetRequest Get(string name)

Parameters

Type	Name	Description
string	name	Required. Redis instance resource name using the form: projects/{project_id}/locations/{location_id}/instances/{instance_id} where location_id refers to a GCP region.

Returns

Type	Description
ProjectsResource.LocationsResource.InstancesResource.GetRequest

GetAuthString(string)

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.

Declaration

public virtual ProjectsResource.LocationsResource.InstancesResource.GetAuthStringRequest GetAuthString(string name)

Parameters

Type	Name	Description
string	name	Required. Redis instance resource name using the form: projects/{project_id}/locations/{location_id}/instances/{instance_id} where location_id refers to a GCP region.

Returns

Type	Description
ProjectsResource.LocationsResource.InstancesResource.GetAuthStringRequest

Import(ImportInstanceRequest, string)

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.

Declaration

public virtual ProjectsResource.LocationsResource.InstancesResource.ImportRequest Import(ImportInstanceRequest body, string name)

Parameters

Type	Name	Description
ImportInstanceRequest	body	The body of the request.
string	name	Required. Redis instance resource name using the form: projects/{project_id}/locations/{location_id}/instances/{instance_id} where location_id refers to a GCP region.

Returns

Type	Description
ProjectsResource.LocationsResource.InstancesResource.ImportRequest

List(string)

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.

Declaration

public virtual ProjectsResource.LocationsResource.InstancesResource.ListRequest List(string parent)

Parameters

Type	Name	Description
string	parent	Required. The resource name of the instance location using the form: projects/{project_id}/locations/{location_id} where location_id refers to a GCP region.

Returns

Type	Description
ProjectsResource.LocationsResource.InstancesResource.ListRequest

Patch(Instance, string)

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.

Declaration

public virtual ProjectsResource.LocationsResource.InstancesResource.PatchRequest Patch(Instance body, string name)

Parameters

Type	Name	Description
Instance	body	The body of the request.
string	name	Required. Unique name of the resource in this scope including project and location using the form: projects/{project_id}/locations/{location_id}/instances/{instance_id} Note: Redis instances are managed and addressed at regional level so location_id here refers to a GCP region; however, users may choose which specific zone (or collection of zones for cross-zone instances) an instance should be provisioned in. Refer to location_id and alternative_location_id fields for more details.

Returns

Type	Description
ProjectsResource.LocationsResource.InstancesResource.PatchRequest

RescheduleMaintenance(RescheduleMaintenanceRequest, string)

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

Declaration

public virtual ProjectsResource.LocationsResource.InstancesResource.RescheduleMaintenanceRequest RescheduleMaintenance(RescheduleMaintenanceRequest body, string name)

Parameters

Type	Name	Description
RescheduleMaintenanceRequest	body	The body of the request.
string	name	Required. Redis instance resource name using the form: projects/{project_id}/locations/{location_id}/instances/{instance_id} where location_id refers to a GCP region.

Returns

Type	Description
ProjectsResource.LocationsResource.InstancesResource.RescheduleMaintenanceRequest

Upgrade(UpgradeInstanceRequest, string)

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

Declaration

public virtual ProjectsResource.LocationsResource.InstancesResource.UpgradeRequest Upgrade(UpgradeInstanceRequest body, string name)

Parameters

Type	Name	Description
UpgradeInstanceRequest	body	The body of the request.
string	name	Required. Redis instance resource name using the form: projects/{project_id}/locations/{location_id}/instances/{instance_id} where location_id refers to a GCP region.

Returns

Type	Description
ProjectsResource.LocationsResource.InstancesResource.UpgradeRequest