BigtableInstanceGrpcClient (Cloud Bigtable HBase Client for Java 1.5.0 API)

com.google.cloud.bigtable.grpc

Class BigtableInstanceGrpcClient

    • Constructor Summary

      Constructors 
      Constructor and Description
      BigtableInstanceGrpcClient(io.grpc.Channel channel)
      Constructor for BigtableInstanceGrpcClient.
    • Method Summary

      All Methods Instance Methods Concrete 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.
    • Constructor Detail

      • BigtableInstanceGrpcClient

        public BigtableInstanceGrpcClient(io.grpc.Channel channel)

        Constructor for BigtableInstanceGrpcClient.

        Parameters:
        channel - a Channel object.
    • Method Detail

      • createInstance

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

        public 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.

        BigtableInstanceClient.createInstance(CreateInstanceRequest) and BigtableInstanceClient.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.

        Specified by:
        getOperation in interface BigtableInstanceClient
        Parameters:
        request - a GetOperationRequest object.
        Returns:
        a Operation object.
      • listInstances

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

        public com.google.bigtable.admin.v2.Instance updateInstance(com.google.bigtable.admin.v2.Instance instance)
        Updates an instance within a project.
        Specified by:
        updateInstance in interface BigtableInstanceClient
        Parameters:
        instance - a Instance object.
        Returns:
        a Instance object.
      • deleteInstance

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

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

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

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

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

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

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

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

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

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

        public Empty deleteAppProfile(com.google.bigtable.admin.v2.DeleteAppProfileRequest request)
        Delete an application profile.
        Specified by:
        deleteAppProfile in interface BigtableInstanceClient
        Parameters:
        request - a DeleteAppProfileRequest object.
        Returns:
        a Empty object.
        See Also:
        App Profiles
      • testIamPermissions

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

        public com.google.longrunning.Operation createCluster(com.google.bigtable.admin.v2.CreateClusterRequest request)
        Create an instance within a project.
        Specified by:
        createCluster in interface BigtableInstanceClient
        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