BigtableInstanceGrpcClient (Cloud Bigtable HBase Client for Java 1.3.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)
      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.
    • 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)
        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.
        Specified by:
        createAppProfile in interface BigtableInstanceClient
        Parameters:
        request - a CreateAppProfileRequest object.
        Returns:
        a AppProfile object.
      • getAppProfile

        public 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.
        Specified by:
        getAppProfile in interface BigtableInstanceClient
        Parameters:
        request - a GetAppProfileRequest object.
        Returns:
        a AppProfile object.
      • listAppProfiles

        public 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.
        Specified by:
        listAppProfiles in interface BigtableInstanceClient
        Parameters:
        request - a ListAppProfilesRequest object.
        Returns:
        a ListAppProfilesResponse object.
      • updateAppProfile

        public 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.
        Specified by:
        updateAppProfile in interface BigtableInstanceClient
        Parameters:
        request - a Operation object.
        Returns:
        a UpdateAppProfileRequest object.
      • deleteAppProfile

        public 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.
        Specified by:
        deleteAppProfile in interface BigtableInstanceClient
        Parameters:
        request - a DeleteAppProfileRequest object.
        Returns:
        a Empty object.
      • getIamPolicy

        public 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.
        Specified by:
        getIamPolicy in interface BigtableInstanceClient
        Parameters:
        request - a GetIamPolicyRequest object.
        Returns:
        a Policy object.
      • setIamPolicy

        public 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.
        Specified by:
        setIamPolicy in interface BigtableInstanceClient
        Parameters:
        request - a SetIamPolicyRequest object.
        Returns:
        a Policy object.
      • testIamPermissions

        public 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.
        Specified by:
        testIamPermissions in interface BigtableInstanceClient
        Parameters:
        request - a TestIamPermissionsRequest object.
        Returns:
        a TestIamPermissionsResponse object.


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

Send feedback about...

Cloud Bigtable Documentation