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.CloudAlloyDBAdmin.v1

Assembly: Google.Apis.CloudAlloyDBAdmin.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

Properties

Instances

Gets the Instances resource.

Declaration

public virtual ProjectsResource.LocationsResource.ClustersResource.InstancesResource Instances { get; }

Property Value

Type	Description
ProjectsResource.LocationsResource.ClustersResource.InstancesResource

Users

Gets the Users resource.

Declaration

public virtual ProjectsResource.LocationsResource.ClustersResource.UsersResource Users { get; }

Property Value

Type	Description
ProjectsResource.LocationsResource.ClustersResource.UsersResource

Methods

Create(Cluster, string)

Creates a new Cluster in a given project and location.

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 location of the new cluster. For the required format, see the comment on the Cluster.name field.

Returns

Type	Description
ProjectsResource.LocationsResource.ClustersResource.CreateRequest

Createsecondary(Cluster, string)

Creates a cluster of type SECONDARY in the given location using the primary cluster as the source.

Declaration

public virtual ProjectsResource.LocationsResource.ClustersResource.CreatesecondaryRequest Createsecondary(Cluster body, string parent)

Parameters

Type	Name	Description
Cluster	body	The body of the request.
string	parent	Required. The location of the new cluster. For the required format, see the comment on the Cluster.name field.

Returns

Type	Description
ProjectsResource.LocationsResource.ClustersResource.CreatesecondaryRequest

Delete(string)

Deletes a single Cluster.

Declaration

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

Parameters

Type	Name	Description
string	name	Required. The name of the resource. For the required format, see the comment on the Cluster.name field.

Returns

Type	Description
ProjectsResource.LocationsResource.ClustersResource.DeleteRequest

Export(ExportClusterRequest, string)

Exports data from the cluster. Imperative only.

Declaration

public virtual ProjectsResource.LocationsResource.ClustersResource.ExportRequest Export(ExportClusterRequest body, string name)

Parameters

Type	Name	Description
ExportClusterRequest	body	The body of the request.
string	name	Required. The resource name of the cluster.

Returns

Type	Description
ProjectsResource.LocationsResource.ClustersResource.ExportRequest

Get(string)

Gets details of a single Cluster.

Declaration

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

Parameters

Type	Name	Description
string	name	Required. The name of the resource. For the required format, see the comment on the Cluster.name field.

Returns

Type	Description
ProjectsResource.LocationsResource.ClustersResource.GetRequest

Import(ImportClusterRequest, string)

Imports data to the cluster. Imperative only.

Declaration

public virtual ProjectsResource.LocationsResource.ClustersResource.ImportRequest Import(ImportClusterRequest body, string name)

Parameters

Type	Name	Description
ImportClusterRequest	body	The body of the request.
string	name	Required. The resource name of the cluster.

Returns

Type	Description
ProjectsResource.LocationsResource.ClustersResource.ImportRequest

List(string)

Lists Clusters in a given project and location.

Declaration

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

Parameters

Type	Name	Description
string	parent	Required. The name of the parent resource. For the required format, see the comment on the Cluster.name field. Additionally, you can perform an aggregated list operation by specifying a value with the following format: * projects/{project}/locations/-

Returns

Type	Description
ProjectsResource.LocationsResource.ClustersResource.ListRequest

Patch(Cluster, string)

Updates the parameters of a single Cluster.

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	Output only. The name of the cluster resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} where the cluster ID segment should satisfy the regex expression [a-z0-9-]+. For more details see https://google.aip.dev/122. The prefix of the cluster resource name is the name of the parent resource: * projects/{project}/locations/{region}

Returns

Type	Description
ProjectsResource.LocationsResource.ClustersResource.PatchRequest

Promote(PromoteClusterRequest, string)

Promotes a SECONDARY cluster. This turns down replication from the PRIMARY cluster and promotes a secondary cluster into its own standalone cluster. Imperative only.

Declaration

public virtual ProjectsResource.LocationsResource.ClustersResource.PromoteRequest Promote(PromoteClusterRequest body, string name)

Parameters

Type	Name	Description
PromoteClusterRequest	body	The body of the request.
string	name	Required. The name of the resource. For the required format, see the comment on the Cluster.name field

Returns

Type	Description
ProjectsResource.LocationsResource.ClustersResource.PromoteRequest

Restore(RestoreClusterRequest, string)

Creates a new Cluster in a given project and location, with a volume restored from the provided source, either a backup ID or a point-in-time and a source cluster.

Declaration

public virtual ProjectsResource.LocationsResource.ClustersResource.RestoreRequest Restore(RestoreClusterRequest body, string parent)

Parameters

Type	Name	Description
RestoreClusterRequest	body	The body of the request.
string	parent	Required. The name of the parent resource. For the required format, see the comment on the Cluster.name field.

Returns

Type	Description
ProjectsResource.LocationsResource.ClustersResource.RestoreRequest

RestoreFromCloudSQL(RestoreFromCloudSQLRequest, string)

Restores an AlloyDB cluster from a CloudSQL resource.

Declaration

public virtual ProjectsResource.LocationsResource.ClustersResource.RestoreFromCloudSQLRequest RestoreFromCloudSQL(RestoreFromCloudSQLRequest body, string parent)

Parameters

Type	Name	Description
RestoreFromCloudSQLRequest	body	The body of the request.
string	parent	Required. The location of the new cluster. For the required format, see the comment on Cluster.name field.

Returns

Type	Description
ProjectsResource.LocationsResource.ClustersResource.RestoreFromCloudSQLRequest

Switchover(SwitchoverClusterRequest, string)

Switches the roles of PRIMARY and SECONDARY clusters without any data loss. This promotes the SECONDARY cluster to PRIMARY and sets up the original PRIMARY cluster to replicate from this newly promoted cluster.

Declaration

public virtual ProjectsResource.LocationsResource.ClustersResource.SwitchoverRequest Switchover(SwitchoverClusterRequest body, string name)

Parameters

Type	Name	Description
SwitchoverClusterRequest	body	The body of the request.
string	name	Required. The name of the resource. For the required format, see the comment on the Cluster.name field

Returns

Type	Description
ProjectsResource.LocationsResource.ClustersResource.SwitchoverRequest

Upgrade(UpgradeClusterRequest, string)

Upgrades a single Cluster. Imperative only.

Declaration

public virtual ProjectsResource.LocationsResource.ClustersResource.UpgradeRequest Upgrade(UpgradeClusterRequest body, string name)

Parameters

Type	Name	Description
UpgradeClusterRequest	body	The body of the request.
string	name	Required. The resource name of the cluster.

Returns

Type	Description
ProjectsResource.LocationsResource.ClustersResource.UpgradeRequest