BigtableInstanceClient (Cloud Bigtable HBase Client for Java 1.3.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)
      This is a private alpha release of Cloud Bigtable replication.
      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)
      This is a private alpha release of Cloud Bigtable replication.
      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)
      This is a private alpha release of Cloud Bigtable replication.
      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)
      This is a private alpha release of Cloud Bigtable instance level permissions.
      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)
      This is a private alpha release of Cloud Bigtable replication.
      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)
      This is a private alpha release of Cloud Bigtable instance level permissions.
      com.google.iam.v1.TestIamPermissionsResponse testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request)
      This is a private alpha release of Cloud Bigtable instance level permissions.
      com.google.longrunning.Operation updateAppProfile(com.google.bigtable.admin.v2.UpdateAppProfileRequest request)
      This is a private alpha release of Cloud Bigtable replication.
      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)
        This is a private alpha release of Cloud Bigtable replication. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy. Creates an app profile within an instance.
        Parameters:
        request - a CreateAppProfileRequest object.
        Returns:
        a AppProfile object.
      • getAppProfile

        com.google.bigtable.admin.v2.AppProfile getAppProfile(com.google.bigtable.admin.v2.GetAppProfileRequest request)
        This is a private alpha release of Cloud Bigtable replication. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy. Gets information about an app profile.
        Parameters:
        request - a GetAppProfileRequest object.
        Returns:
        a AppProfile object.
      • listAppProfiles

        com.google.bigtable.admin.v2.ListAppProfilesResponse listAppProfiles(com.google.bigtable.admin.v2.ListAppProfilesRequest request)
        This is a private alpha release of Cloud Bigtable replication. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy. Lists information about app profiles in an instance.
        Parameters:
        request - a ListAppProfilesRequest object.
        Returns:
        a ListAppProfilesResponse object.
      • updateAppProfile

        com.google.longrunning.Operation updateAppProfile(com.google.bigtable.admin.v2.UpdateAppProfileRequest request)
        This is a private alpha release of Cloud Bigtable replication. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy. Updates an app profile within an instance.
        Parameters:
        request - a Operation object.
        Returns:
        a UpdateAppProfileRequest object.
      • deleteAppProfile

        Empty deleteAppProfile(com.google.bigtable.admin.v2.DeleteAppProfileRequest request)
        This is a private alpha release of Cloud Bigtable replication. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy. Deletes an app profile from an instance.
        Parameters:
        request - a DeleteAppProfileRequest object.
        Returns:
        a Empty object.
      • getIamPolicy

        com.google.iam.v1.Policy getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request)
        This is a private alpha release of Cloud Bigtable instance level permissions. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy. Gets the access control policy for an instance resource. Returns an empty policy if an instance exists but does not have a policy set.
        Parameters:
        request - a GetIamPolicyRequest object.
        Returns:
        a Policy object.
      • setIamPolicy

        com.google.iam.v1.Policy setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request)
        This is a private alpha release of Cloud Bigtable instance level permissions. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy. Sets the access control policy on an instance resource. Replaces any existing policy.
        Parameters:
        request - a SetIamPolicyRequest object.
        Returns:
        a Policy object.
      • testIamPermissions

        com.google.iam.v1.TestIamPermissionsResponse testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request)
        This is a private alpha release of Cloud Bigtable instance level permissions. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy. Returns permissions that the caller has on the specified instance resource.
        Parameters:
        request - a TestIamPermissionsRequest object.
        Returns:
        a TestIamPermissionsResponse object.


Send feedback about...

Cloud Bigtable Documentation