Show / Hide Table of Contents

Class ProjectsResource.InstancesResource

The "instances" collection of methods.

Inheritance
object
ProjectsResource.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.BigtableAdmin.v2
Assembly: Google.Apis.BigtableAdmin.v2.dll
Syntax
public class ProjectsResource.InstancesResource

Constructors

InstancesResource(IClientService)

Constructs a new resource.

Declaration
public InstancesResource(IClientService service)
Parameters
Type Name Description
IClientService service

Properties

AppProfiles

Gets the AppProfiles resource.

Declaration
public virtual ProjectsResource.InstancesResource.AppProfilesResource AppProfiles { get; }
Property Value
Type Description
ProjectsResource.InstancesResource.AppProfilesResource

Clusters

Gets the Clusters resource.

Declaration
public virtual ProjectsResource.InstancesResource.ClustersResource Clusters { get; }
Property Value
Type Description
ProjectsResource.InstancesResource.ClustersResource

Tables

Gets the Tables resource.

Declaration
public virtual ProjectsResource.InstancesResource.TablesResource Tables { get; }
Property Value
Type Description
ProjectsResource.InstancesResource.TablesResource

Methods

Create(CreateInstanceRequest, string)

Create an instance within a project. Note that exactly one of Cluster.serve_nodes and Cluster.cluster_config.cluster_autoscaling_config can be set. If serve_nodes is set to non-zero, then the cluster is manually scaled. If cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is enabled.

Declaration
public virtual ProjectsResource.InstancesResource.CreateRequest Create(CreateInstanceRequest body, string parent)
Parameters
Type Name Description
CreateInstanceRequest body

The body of the request.

string parent

Required. The unique name of the project in which to create the new instance. Values are of the form projects/{project}.

Returns
Type Description
ProjectsResource.InstancesResource.CreateRequest

Delete(string)

Delete an instance from a project.

Declaration
public virtual ProjectsResource.InstancesResource.DeleteRequest Delete(string name)
Parameters
Type Name Description
string name

Required. The unique name of the instance to be deleted. Values are of the form projects/{project}/instances/{instance}.

Returns
Type Description
ProjectsResource.InstancesResource.DeleteRequest

Get(string)

Gets information about an instance.

Declaration
public virtual ProjectsResource.InstancesResource.GetRequest Get(string name)
Parameters
Type Name Description
string name

Required. The unique name of the requested instance. Values are of the form projects/{project}/instances/{instance}.

Returns
Type Description
ProjectsResource.InstancesResource.GetRequest

GetIamPolicy(GetIamPolicyRequest, string)

Gets the access control policy for an instance resource. Returns an empty policy if an instance exists but does not have a policy set.

Declaration
public virtual ProjectsResource.InstancesResource.GetIamPolicyRequest GetIamPolicy(GetIamPolicyRequest body, string resource)
Parameters
Type Name Description
GetIamPolicyRequest body

The body of the request.

string resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

Returns
Type Description
ProjectsResource.InstancesResource.GetIamPolicyRequest

List(string)

Lists information about instances in a project.

Declaration
public virtual ProjectsResource.InstancesResource.ListRequest List(string parent)
Parameters
Type Name Description
string parent

Required. The unique name of the project for which a list of instances is requested. Values are of the form projects/{project}.

Returns
Type Description
ProjectsResource.InstancesResource.ListRequest

PartialUpdateInstance(Instance, string)

Partially updates an instance within a project. This method can modify all fields of an Instance and is the preferred way to update an Instance.

Declaration
public virtual ProjectsResource.InstancesResource.PartialUpdateInstanceRequest PartialUpdateInstance(Instance body, string name)
Parameters
Type Name Description
Instance body

The body of the request.

string name

The unique name of the instance. Values are of the form projects/{project}/instances/a-z+[a-z0-9].

Returns
Type Description
ProjectsResource.InstancesResource.PartialUpdateInstanceRequest

SetIamPolicy(SetIamPolicyRequest, string)

Sets the access control policy on an instance resource. Replaces any existing policy.

Declaration
public virtual ProjectsResource.InstancesResource.SetIamPolicyRequest SetIamPolicy(SetIamPolicyRequest body, string resource)
Parameters
Type Name Description
SetIamPolicyRequest body

The body of the request.

string resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

Returns
Type Description
ProjectsResource.InstancesResource.SetIamPolicyRequest

TestIamPermissions(TestIamPermissionsRequest, string)

Returns permissions that the caller has on the specified instance resource.

Declaration
public virtual ProjectsResource.InstancesResource.TestIamPermissionsRequest TestIamPermissions(TestIamPermissionsRequest body, string resource)
Parameters
Type Name Description
TestIamPermissionsRequest body

The body of the request.

string resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

Returns
Type Description
ProjectsResource.InstancesResource.TestIamPermissionsRequest

Update(Instance, string)

Updates an instance within a project. This method updates only the display name and type for an Instance. To update other Instance properties, such as labels, use PartialUpdateInstance.

Declaration
public virtual ProjectsResource.InstancesResource.UpdateRequest Update(Instance body, string name)
Parameters
Type Name Description
Instance body

The body of the request.

string name

The unique name of the instance. Values are of the form projects/{project}/instances/a-z+[a-z0-9].

Returns
Type Description
ProjectsResource.InstancesResource.UpdateRequest
In This Article
Back to top Generated by DocFX