BigtableInstanceClient (Cloud Bigtable HBase Client for Java 1.5.0 API)

com.google.cloud.bigtable.grpc

Interface BigtableInstanceClient

  • All Known Implementing Classes:
    BigtableInstanceGrpcClient


    public interface BigtableInstanceClient
    BigtableInstanceClient manages instances and clusters.
    Version:
    $Id: $Id
    Author:
    sduskis
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method and Description
      com.google.bigtable.admin.v2.AppProfile createAppProfile(com.google.bigtable.admin.v2.CreateAppProfileRequest request)
      Create an application profile.
      com.google.longrunning.Operation createCluster(com.google.bigtable.admin.v2.CreateClusterRequest request)
      Create an instance within a project.
      com.google.longrunning.Operation createInstance(com.google.bigtable.admin.v2.CreateInstanceRequest request)
      Create an instance within a project.
      Empty deleteAppProfile(com.google.bigtable.admin.v2.DeleteAppProfileRequest request)
      Delete an application profile.
      Empty deleteCluster(com.google.bigtable.admin.v2.DeleteClusterRequest request)
      Deletes a cluster from an instance.
      Empty deleteInstance(com.google.bigtable.admin.v2.DeleteInstanceRequest request)
      Updates an instance within a project.
      com.google.bigtable.admin.v2.AppProfile getAppProfile(com.google.bigtable.admin.v2.GetAppProfileRequest request)
      Get an application profile.
      com.google.bigtable.admin.v2.Cluster getCluster(com.google.bigtable.admin.v2.GetClusterRequest request)
      Gets information about a cluster.
      com.google.iam.v1.Policy getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request)
      Get an IAM policy.
      com.google.longrunning.Operation getOperation(com.google.longrunning.GetOperationRequest request)
      Gets the latest state of a long-running operation.
      com.google.bigtable.admin.v2.ListAppProfilesResponse listAppProfiles(com.google.bigtable.admin.v2.ListAppProfilesRequest request)
      List application profiles.
      com.google.bigtable.admin.v2.ListClustersResponse listCluster(com.google.bigtable.admin.v2.ListClustersRequest request)
      Lists information about clusters in an instance.
      com.google.bigtable.admin.v2.ListInstancesResponse listInstances(com.google.bigtable.admin.v2.ListInstancesRequest request)
      Lists all instances in the given project.
      com.google.longrunning.Operation partialUpdateInstance(com.google.bigtable.admin.v2.PartialUpdateInstanceRequest request)
      Partially updates an instance within a project.
      com.google.iam.v1.Policy setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request)
      Set an IAM policy.
      com.google.iam.v1.TestIamPermissionsResponse testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request)
      Tests an IAM policy.
      com.google.longrunning.Operation updateAppProfile(com.google.bigtable.admin.v2.UpdateAppProfileRequest request)
      /** Update an application profile.
      com.google.longrunning.Operation updateCluster(com.google.bigtable.admin.v2.Cluster cluster)
      Updates a cluster within an instance.
      com.google.bigtable.admin.v2.Instance updateInstance(com.google.bigtable.admin.v2.Instance instance)
      Updates an instance within a project.
      void waitForOperation(com.google.longrunning.Operation operation)
      Waits for the long running operation to complete by polling with exponential backoff.
      void waitForOperation(com.google.longrunning.Operation operation, long timeout, TimeUnit timeUnit)
      Waits for the long running operation to complete by polling with exponential backoff.
    • Method Detail

      • createInstance

        com.google.longrunning.Operation createInstance(com.google.bigtable.admin.v2.CreateInstanceRequest request)
        Create an instance within a project.
        Parameters:
        request - a CreateInstanceRequest object.
        Returns:
        a Operation object.
      • getOperation

        com.google.longrunning.Operation getOperation(com.google.longrunning.GetOperationRequest request)
        Gets the latest state of a long-running operation. Clients may use this method to poll the operation result at intervals as recommended by the API service.

        createInstance(CreateInstanceRequest) and updateCluster(Cluster) will return a Operation. Use this method and pass in the Operation's name in the request to see if the Operation is done via Operation.getDone(). The instance will not be available until that happens.

        Parameters:
        request - a GetOperationRequest object.
        Returns:
        a Operation object.
      • waitForOperation

        void waitForOperation(com.google.longrunning.Operation operation)
                       throws TimeoutException,
                              IOException
        Waits for the long running operation to complete by polling with exponential backoff. A default timeout of 10 minutes is used.
        Parameters:
        operation -
        Throws:
        IOException
        TimeoutException - If the timeout is exceeded.
      • waitForOperation

        void waitForOperation(com.google.longrunning.Operation operation,
                              long timeout,
                              TimeUnit timeUnit)
                       throws IOException,
                              TimeoutException
        Waits for the long running operation to complete by polling with exponential backoff.
        Parameters:
        operation -
        timeout -
        timeUnit -
        Throws:
        IOException
        TimeoutException - If the timeout is exceeded.
      • listInstances

        com.google.bigtable.admin.v2.ListInstancesResponse listInstances(com.google.bigtable.admin.v2.ListInstancesRequest request)
        Lists all instances in the given project.
        Parameters:
        request - a ListInstancesRequest object.
        Returns:
        a ListInstancesResponse object.
      • updateInstance

        com.google.bigtable.admin.v2.Instance updateInstance(com.google.bigtable.admin.v2.Instance instance)
        Updates an instance within a project.
        Parameters:
        instance - a Instance object.
        Returns:
        a Instance object.
      • deleteInstance

        Empty deleteInstance(com.google.bigtable.admin.v2.DeleteInstanceRequest request)
        Updates an instance within a project.
        Parameters:
        request - a DeleteInstanceRequest object.
        Returns:
        a Empty object.
      • getCluster

        com.google.bigtable.admin.v2.Cluster getCluster(com.google.bigtable.admin.v2.GetClusterRequest request)
        Gets information about a cluster.
        Parameters:
        request - a GetClusterRequest object.
        Returns:
        a Cluster object.
      • listCluster

        com.google.bigtable.admin.v2.ListClustersResponse listCluster(com.google.bigtable.admin.v2.ListClustersRequest request)
        Lists information about clusters in an instance.
        Parameters:
        request - a ListClustersRequest object.
        Returns:
        a ListClustersResponse object.
      • updateCluster

        com.google.longrunning.Operation updateCluster(com.google.bigtable.admin.v2.Cluster cluster)
        Updates a cluster within an instance.
        Parameters:
        cluster - a Cluster object.
        Returns:
        a Operation object.
      • deleteCluster

        Empty deleteCluster(com.google.bigtable.admin.v2.DeleteClusterRequest request)
        Deletes a cluster from an instance.
        Parameters:
        request - a DeleteClusterRequest object.
        Returns:
        a Empty object.
      • partialUpdateInstance

        com.google.longrunning.Operation partialUpdateInstance(com.google.bigtable.admin.v2.PartialUpdateInstanceRequest request)
        Partially updates an instance within a project.
        Parameters:
        request - a PartialUpdateInstanceRequest object.
        Returns:
        a Operation object.
      • createAppProfile

        com.google.bigtable.admin.v2.AppProfile createAppProfile(com.google.bigtable.admin.v2.CreateAppProfileRequest request)
        Create an application profile.
        Parameters:
        request - a CreateAppProfileRequest object.
        Returns:
        a AppProfile object.
        See Also:
        App Profiles
      • getAppProfile

        com.google.bigtable.admin.v2.AppProfile getAppProfile(com.google.bigtable.admin.v2.GetAppProfileRequest request)
        Get an application profile.
        Parameters:
        request - a GetAppProfileRequest object.
        Returns:
        a AppProfile object.
        See Also:
        App Profiles
      • listAppProfiles

        com.google.bigtable.admin.v2.ListAppProfilesResponse listAppProfiles(com.google.bigtable.admin.v2.ListAppProfilesRequest request)
        List application profiles.
        Parameters:
        request - a ListAppProfilesRequest object.
        Returns:
        a ListAppProfilesResponse object.
        See Also:
        App Profiles
      • updateAppProfile

        com.google.longrunning.Operation updateAppProfile(com.google.bigtable.admin.v2.UpdateAppProfileRequest request)
        /** Update an application profile.
        Parameters:
        request - a UpdateAppProfileRequest object.
        Returns:
        a Operation object.
        See Also:
        App Profiles
      • deleteAppProfile

        Empty deleteAppProfile(com.google.bigtable.admin.v2.DeleteAppProfileRequest request)
        Delete an application profile.
        Parameters:
        request - a DeleteAppProfileRequest object.
        Returns:
        a Empty object.
        See Also:
        App Profiles
      • getIamPolicy

        com.google.iam.v1.Policy getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request)
        Get an IAM policy.
        Parameters:
        request - a GetIamPolicyRequest object.
        Returns:
        a Policy object.
        See Also:
        Cloud Bigtable access control
      • setIamPolicy

        com.google.iam.v1.Policy setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request)
        Set an IAM policy.
        Parameters:
        request - a SetIamPolicyRequest object.
        Returns:
        a Policy object.
        See Also:
        Cloud Bigtable access control
      • testIamPermissions

        com.google.iam.v1.TestIamPermissionsResponse testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request)
        Tests an IAM policy.
        Parameters:
        request - a TestIamPermissionsRequest object.
        Returns:
        a TestIamPermissionsResponse object.
        See Also:
        Cloud Bigtable access control
      • createCluster

        com.google.longrunning.Operation createCluster(com.google.bigtable.admin.v2.CreateClusterRequest request)
        Create an instance within a project.
        Parameters:
        request - a CreateClusterRequest object.
        Returns:
        a Operation object.


Was this page helpful? Let us know how we did:

Send feedback about...

Cloud Bigtable Documentation