• Home
• com.google.apis
• google-api-services-bigtableadmin
• v2-rev20241203-2.0.0
• source code
• BigtableAdmin.Projects.Instances.html

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

target.apidocs.com.google.api.services.bigtableadmin.v2.BigtableAdmin.Projects.Instances.html Maven / Gradle / Ivy

Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.bigtableadmin.v2
Class BigtableAdmin.Projects.Instances



java.lang.Object


com.google.api.services.bigtableadmin.v2.BigtableAdmin.Projects.Instances







Enclosing class:
BigtableAdmin.Projects




public class BigtableAdmin.Projects.Instances
extends Object
The "instances" collection of methods.











Nested Class Summary

Nested Classes 

Modifier and Type
Class and Description


class 
BigtableAdmin.Projects.Instances.AppProfiles
The "appProfiles" collection of methods.



class 
BigtableAdmin.Projects.Instances.Clusters
The "clusters" collection of methods.



class 
BigtableAdmin.Projects.Instances.Create 


class 
BigtableAdmin.Projects.Instances.Delete 


class 
BigtableAdmin.Projects.Instances.Get 


class 
BigtableAdmin.Projects.Instances.GetIamPolicy 


class 
BigtableAdmin.Projects.Instances.List 


class 
BigtableAdmin.Projects.Instances.PartialUpdateInstance 


class 
BigtableAdmin.Projects.Instances.SetIamPolicy 


class 
BigtableAdmin.Projects.Instances.Tables
The "tables" collection of methods.



class 
BigtableAdmin.Projects.Instances.TestIamPermissions 


class 
BigtableAdmin.Projects.Instances.Update 









Constructor Summary

Constructors 

Constructor and Description


Instances() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


BigtableAdmin.Projects.Instances.AppProfiles
appProfiles()
An accessor for creating requests from the AppProfiles collection.



BigtableAdmin.Projects.Instances.Clusters
clusters()
An accessor for creating requests from the Clusters collection.



BigtableAdmin.Projects.Instances.Create
create(String parent,
      CreateInstanceRequest content)
Create an instance within a project.



BigtableAdmin.Projects.Instances.Delete
delete(String name)
Delete an instance from a project.



BigtableAdmin.Projects.Instances.Get
get(String name)
Gets information about an instance.



BigtableAdmin.Projects.Instances.GetIamPolicy
getIamPolicy(String resource,
            GetIamPolicyRequest content)
Gets the access control policy for an instance resource.



BigtableAdmin.Projects.Instances.List
list(String parent)
Lists information about instances in a project.



BigtableAdmin.Projects.Instances.PartialUpdateInstance
partialUpdateInstance(String name,
                     Instance content)
Partially updates an instance within a project.



BigtableAdmin.Projects.Instances.SetIamPolicy
setIamPolicy(String resource,
            SetIamPolicyRequest content)
Sets the access control policy on an instance resource.



BigtableAdmin.Projects.Instances.Tables
tables()
An accessor for creating requests from the Tables collection.



BigtableAdmin.Projects.Instances.TestIamPermissions
testIamPermissions(String resource,
                  TestIamPermissionsRequest content)
Returns permissions that the caller has on the specified instance resource.



BigtableAdmin.Projects.Instances.Update
update(String name,
      Instance content)
Updates an instance within a project.







Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait














Constructor Detail





Instances
public Instances()









Method Detail





create
public BigtableAdmin.Projects.Instances.Create create(String parent,
                                                      CreateInstanceRequest content)
                                               throws IOException
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.

 Create a request for the method "instances.create".

 This request holds the parameters needed by the bigtableadmin server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
parent - Required. The unique name of the project in which to create the new instance. Values are of the form
        `projects/{project}`.
content - the CreateInstanceRequest
Returns:
the request
Throws:
IOException








delete
public BigtableAdmin.Projects.Instances.Delete delete(String name)
                                               throws IOException
Delete an instance from a project.

 Create a request for the method "instances.delete".

 This request holds the parameters needed by the bigtableadmin server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - Required. The unique name of the instance to be deleted. Values are of the form
        `projects/{project}/instances/{instance}`.
Returns:
the request
Throws:
IOException








get
public BigtableAdmin.Projects.Instances.Get get(String name)
                                         throws IOException
Gets information about an instance.

 Create a request for the method "instances.get".

 This request holds the parameters needed by the bigtableadmin server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - Required. The unique name of the requested instance. Values are of the form
        `projects/{project}/instances/{instance}`.
Returns:
the request
Throws:
IOException








getIamPolicy
public BigtableAdmin.Projects.Instances.GetIamPolicy getIamPolicy(String resource,
                                                                  GetIamPolicyRequest content)
                                                           throws IOException
Gets the access control policy for an instance resource. Returns an empty policy if an instance
 exists but does not have a policy set.

 Create a request for the method "instances.getIamPolicy".

 This request holds the parameters needed by the bigtableadmin server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
resource - REQUIRED: The resource for which the policy is being requested. See [Resource
        names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for
        this field.
content - the GetIamPolicyRequest
Returns:
the request
Throws:
IOException








list
public BigtableAdmin.Projects.Instances.List list(String parent)
                                           throws IOException
Lists information about instances in a project.

 Create a request for the method "instances.list".

 This request holds the parameters needed by the bigtableadmin server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
parent - Required. The unique name of the project for which a list of instances is requested. Values are of
        the form `projects/{project}`.
Returns:
the request
Throws:
IOException








partialUpdateInstance
public BigtableAdmin.Projects.Instances.PartialUpdateInstance partialUpdateInstance(String name,
                                                                                    Instance content)
                                                                             throws IOException
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.

 Create a request for the method "instances.partialUpdateInstance".

 This request holds the parameters needed by the bigtableadmin server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote
 operation.

Parameters:
name - The unique name of the instance. Values are of the form `projects/{project}/instances/a-z+[a-z0-9]`.
content - the Instance
Returns:
the request
Throws:
IOException








setIamPolicy
public BigtableAdmin.Projects.Instances.SetIamPolicy setIamPolicy(String resource,
                                                                  SetIamPolicyRequest content)
                                                           throws IOException
Sets the access control policy on an instance resource. Replaces any existing policy.

 Create a request for the method "instances.setIamPolicy".

 This request holds the parameters needed by the bigtableadmin server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
resource - REQUIRED: The resource for which the policy is being specified. See [Resource
        names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for
        this field.
content - the SetIamPolicyRequest
Returns:
the request
Throws:
IOException








testIamPermissions
public BigtableAdmin.Projects.Instances.TestIamPermissions testIamPermissions(String resource,
                                                                              TestIamPermissionsRequest content)
                                                                       throws IOException
Returns permissions that the caller has on the specified instance resource.

 Create a request for the method "instances.testIamPermissions".

 This request holds the parameters needed by the bigtableadmin server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
resource - REQUIRED: The resource for which the policy detail is being requested. See [Resource
        names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for
        this field.
content - the TestIamPermissionsRequest
Returns:
the request
Throws:
IOException








update
public BigtableAdmin.Projects.Instances.Update update(String name,
                                                      Instance content)
                                               throws IOException
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.

 Create a request for the method "instances.update".

 This request holds the parameters needed by the bigtableadmin server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - The unique name of the instance. Values are of the form `projects/{project}/instances/a-z+[a-z0-9]`.
content - the Instance
Returns:
the request
Throws:
IOException








appProfiles
public BigtableAdmin.Projects.Instances.AppProfiles appProfiles()
An accessor for creating requests from the AppProfiles collection.

 
The typical use is:
 
    BigtableAdmin bigtableadmin = new BigtableAdmin(...);
    BigtableAdmin.AppProfiles.List request = bigtableadmin.appProfiles().list(parameters ...)
 

Returns:
the resource collection








clusters
public BigtableAdmin.Projects.Instances.Clusters clusters()
An accessor for creating requests from the Clusters collection.

 
The typical use is:
 
    BigtableAdmin bigtableadmin = new BigtableAdmin(...);
    BigtableAdmin.Clusters.List request = bigtableadmin.clusters().list(parameters ...)
 

Returns:
the resource collection








tables
public BigtableAdmin.Projects.Instances.Tables tables()
An accessor for creating requests from the Tables collection.

 
The typical use is:
 
    BigtableAdmin bigtableadmin = new BigtableAdmin(...);
    BigtableAdmin.Tables.List request = bigtableadmin.tables().list(parameters ...)
 

Returns:
the resource collection














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2024 Google. All rights reserved.