Class ProjectsResource.LocationsResource.ClustersResource

The "clusters" collection of methods.

Inheritance

object

ProjectsResource.LocationsResource.ClustersResource

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

Constructors

ClustersResource(IClientService)

Constructs a new resource.

Declaration

public ClustersResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Methods

Backup(BackupClusterRequest, string)

Backup Redis Cluster. If this is the first time a backup is being created, a backup collection will be created at the backend, and this backup belongs to this collection. Both collection and backup will have a resource name. Backup will be executed for each shard. A replica (primary if nonHA) will be selected to perform the execution. Backup call will be rejected if there is an ongoing backup or update operation. Be aware that during preview, if the cluster's internal software version is too old, critical update will be performed before actual backup. Once the internal software version is updated to the minimum version required by the backup feature, subsequent backups will not require critical update. After preview, there will be no critical update needed for backup.

Declaration

public virtual ProjectsResource.LocationsResource.ClustersResource.BackupRequest Backup(BackupClusterRequest body, string name)

Parameters

Type	Name	Description
BackupClusterRequest	body	The body of the request.
string	name	Required. Redis cluster resource name using the form: projects/{project_id}/locations/{location_id}/clusters/{cluster_id} where location_id refers to a GCP region.

Returns

Type	Description
ProjectsResource.LocationsResource.ClustersResource.BackupRequest

Create(Cluster, string)

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.

Declaration

public virtual ProjectsResource.LocationsResource.ClustersResource.CreateRequest Create(Cluster body, string parent)

Parameters

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

Returns

Type	Description
ProjectsResource.LocationsResource.ClustersResource.CreateRequest

Delete(string)

Deletes a specific Redis cluster. Cluster stops serving and data is deleted.

Declaration

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

Parameters

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

Returns

Type	Description
ProjectsResource.LocationsResource.ClustersResource.DeleteRequest

Get(string)

Gets the details of a specific Redis cluster.

Declaration

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

Parameters

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

Returns

Type	Description
ProjectsResource.LocationsResource.ClustersResource.GetRequest

GetCertificateAuthority(string)

Gets the details of certificate authority information for Redis cluster.

Declaration

public virtual ProjectsResource.LocationsResource.ClustersResource.GetCertificateAuthorityRequest GetCertificateAuthority(string name)

Parameters

Type	Name	Description
string	name	Required. Redis cluster certificate authority resource name using the form: projects/{project_id}/locations/{location_id}/clusters/{cluster_id}/certificateAuthority where location_id refers to a GCP region.

Returns

Type	Description
ProjectsResource.LocationsResource.ClustersResource.GetCertificateAuthorityRequest

List(string)

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.

Declaration

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

Parameters

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

Returns

Type	Description
ProjectsResource.LocationsResource.ClustersResource.ListRequest

Patch(Cluster, string)

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.

Declaration

public virtual ProjectsResource.LocationsResource.ClustersResource.PatchRequest Patch(Cluster body, string name)

Parameters

Type	Name	Description
Cluster	body	The body of the request.
string	name	Required. Identifier. Unique name of the resource in this scope including project and location using the form: projects/{project_id}/locations/{location_id}/clusters/{cluster_id}

Returns

Type	Description
ProjectsResource.LocationsResource.ClustersResource.PatchRequest

RescheduleClusterMaintenance(RescheduleClusterMaintenanceRequest, string)

Reschedules upcoming maintenance event.

Declaration

public virtual ProjectsResource.LocationsResource.ClustersResource.RescheduleClusterMaintenanceRequest RescheduleClusterMaintenance(RescheduleClusterMaintenanceRequest body, string name)

Parameters

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

Returns

Type	Description
ProjectsResource.LocationsResource.ClustersResource.RescheduleClusterMaintenanceRequest