Class ProjectsResource.LocationsResource.ClustersResource.InstancesResource

The "instances" collection of methods.

Inheritance

object

ProjectsResource.LocationsResource.ClustersResource.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.CloudAlloyDBAdmin.v1

Assembly: Google.Apis.CloudAlloyDBAdmin.v1.dll

Syntax

public class ProjectsResource.LocationsResource.ClustersResource.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 new Instance in a given project and location.

Declaration

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

Parameters

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

Returns

Type	Description
ProjectsResource.LocationsResource.ClustersResource.InstancesResource.CreateRequest

Createsecondary(Instance, string)

Creates a new SECONDARY Instance in a given project and location.

Declaration

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

Parameters

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

Returns

Type	Description
ProjectsResource.LocationsResource.ClustersResource.InstancesResource.CreatesecondaryRequest

Delete(string)

Deletes a single Instance.

Declaration

public virtual ProjectsResource.LocationsResource.ClustersResource.InstancesResource.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 Instance.name field.

Returns

Type	Description
ProjectsResource.LocationsResource.ClustersResource.InstancesResource.DeleteRequest

Failover(FailoverInstanceRequest, string)

Forces a Failover for a highly available instance. Failover promotes the HA standby instance as the new primary. Imperative only.

Declaration

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

Parameters

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

Returns

Type	Description
ProjectsResource.LocationsResource.ClustersResource.InstancesResource.FailoverRequest

Get(string)

Gets details of a single Instance.

Declaration

public virtual ProjectsResource.LocationsResource.ClustersResource.InstancesResource.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 Instance.name field.

Returns

Type	Description
ProjectsResource.LocationsResource.ClustersResource.InstancesResource.GetRequest

GetConnectionInfo(string)

Get instance metadata used for a connection.

Declaration

public virtual ProjectsResource.LocationsResource.ClustersResource.InstancesResource.GetConnectionInfoRequest GetConnectionInfo(string parent)

Parameters

Type	Name	Description
string	parent	Required. The name of the parent resource. The required format is: projects/{project}/locations/{location}/clusters/{cluster}/instances/{instance}

Returns

Type	Description
ProjectsResource.LocationsResource.ClustersResource.InstancesResource.GetConnectionInfoRequest

InjectFault(InjectFaultRequest, string)

Injects fault in an instance. Imperative only.

Declaration

public virtual ProjectsResource.LocationsResource.ClustersResource.InstancesResource.InjectFaultRequest InjectFault(InjectFaultRequest body, string name)

Parameters

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

Returns

Type	Description
ProjectsResource.LocationsResource.ClustersResource.InstancesResource.InjectFaultRequest

List(string)

Lists Instances in a given project and location.

Declaration

public virtual ProjectsResource.LocationsResource.ClustersResource.InstancesResource.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 Instance.name field. Additionally, you can perform an aggregated list operation by specifying a value with one of the following formats: * projects/{project}/locations/-/clusters/- * projects/{project}/locations/{region}/clusters/-

Returns

Type	Description
ProjectsResource.LocationsResource.ClustersResource.InstancesResource.ListRequest

Patch(Instance, string)

Updates the parameters of a single Instance.

Declaration

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

Parameters

Type	Name	Description
Instance	body	The body of the request.
string	name	Output only. The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression [a-z]([a-z0-9-]{0,61}[a-z0-9])?, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id}

Returns

Type	Description
ProjectsResource.LocationsResource.ClustersResource.InstancesResource.PatchRequest

Restart(RestartInstanceRequest, string)

Restart an Instance in a cluster. Imperative only.

Declaration

public virtual ProjectsResource.LocationsResource.ClustersResource.InstancesResource.RestartRequest Restart(RestartInstanceRequest body, string name)

Parameters

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

Returns

Type	Description
ProjectsResource.LocationsResource.ClustersResource.InstancesResource.RestartRequest