Package com.google.bigtable.admin.v2

Class BigtableTableAdminGrpc.BigtableTableAdminStub

  • Enclosing class:
    BigtableTableAdminGrpc
    public static final class BigtableTableAdminGrpc.BigtableTableAdminStub
extends io.grpc.stub.AbstractAsyncStub<BigtableTableAdminGrpc.BigtableTableAdminStub>
    A stub to allow clients to do asynchronous rpc calls to service BigtableTableAdmin. 
     Service for creating, configuring, and deleting Cloud Bigtable tables.
 Provides access to the table schemas only, not the data stored within
 the tables.

    • Nested Class Summary

      • Nested classes/interfaces inherited from class io.grpc.stub.AbstractStub

        io.grpc.stub.AbstractStub.StubFactory<T extends io.grpc.stub.AbstractStub<T>>

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected BigtableTableAdminGrpc.BigtableTableAdminStub build​(io.grpc.Channel channel, io.grpc.CallOptions callOptions)  
      void checkConsistency​(CheckConsistencyRequest request, io.grpc.stub.StreamObserver<CheckConsistencyResponse> responseObserver)
      Checks replication consistency based on a consistency token, that is, if replication has caught up based on the conditions specified in the token and the check request.
      void copyBackup​(CopyBackupRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
      Copy a Cloud Bigtable backup to a new backup in the destination cluster located in the destination instance and project.
      void createBackup​(CreateBackupRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
      Starts creating a new Cloud Bigtable Backup.
      void createTable​(CreateTableRequest request, io.grpc.stub.StreamObserver<Table> responseObserver)
      Creates a new table in the specified instance.
      void createTableFromSnapshot​(CreateTableFromSnapshotRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
      Creates a new table from the specified snapshot.
      void deleteBackup​(DeleteBackupRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)
      Deletes a pending or completed Cloud Bigtable backup.
      void deleteSnapshot​(DeleteSnapshotRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)
      Permanently deletes the specified snapshot.
      void deleteTable​(DeleteTableRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)
      Permanently deletes a specified table and all of its data.
      void dropRowRange​(DropRowRangeRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)
      Permanently drop/delete a row range from a specified table.
      void generateConsistencyToken​(GenerateConsistencyTokenRequest request, io.grpc.stub.StreamObserver<GenerateConsistencyTokenResponse> responseObserver)
      Generates a consistency token for a Table, which can be used in CheckConsistency to check whether mutations to the table that finished before this call started have been replicated.
      void getBackup​(GetBackupRequest request, io.grpc.stub.StreamObserver<Backup> responseObserver)
      Gets metadata on a pending or completed Cloud Bigtable Backup.
      void getIamPolicy​(com.google.iam.v1.GetIamPolicyRequest request, io.grpc.stub.StreamObserver<com.google.iam.v1.Policy> responseObserver)
      Gets the access control policy for a Table or Backup resource.
      void getSnapshot​(GetSnapshotRequest request, io.grpc.stub.StreamObserver<Snapshot> responseObserver)
      Gets metadata information about the specified snapshot.
      void getTable​(GetTableRequest request, io.grpc.stub.StreamObserver<Table> responseObserver)
      Gets metadata information about the specified table.
      void listBackups​(ListBackupsRequest request, io.grpc.stub.StreamObserver<ListBackupsResponse> responseObserver)
      Lists Cloud Bigtable backups.
      void listSnapshots​(ListSnapshotsRequest request, io.grpc.stub.StreamObserver<ListSnapshotsResponse> responseObserver)
      Lists all snapshots associated with the specified cluster.
      void listTables​(ListTablesRequest request, io.grpc.stub.StreamObserver<ListTablesResponse> responseObserver)
      Lists all tables served from a specified instance.
      void modifyColumnFamilies​(ModifyColumnFamiliesRequest request, io.grpc.stub.StreamObserver<Table> responseObserver)
      Performs a series of column family modifications on the specified table.
      void restoreTable​(RestoreTableRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
      Create a new table by restoring from a completed backup.
      void setIamPolicy​(com.google.iam.v1.SetIamPolicyRequest request, io.grpc.stub.StreamObserver<com.google.iam.v1.Policy> responseObserver)
      Sets the access control policy on a Table or Backup resource.
      void snapshotTable​(SnapshotTableRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
      Creates a new snapshot in the specified cluster from the specified source table.
      void testIamPermissions​(com.google.iam.v1.TestIamPermissionsRequest request, io.grpc.stub.StreamObserver<com.google.iam.v1.TestIamPermissionsResponse> responseObserver)
      Returns permissions that the caller has on the specified Table or Backup resource.
      void undeleteTable​(UndeleteTableRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
      Restores a specified table which was accidentally deleted.
      void updateBackup​(UpdateBackupRequest request, io.grpc.stub.StreamObserver<Backup> responseObserver)
      Updates a pending or completed Cloud Bigtable Backup.
      void updateTable​(UpdateTableRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
      Updates a specified table.

      • Methods inherited from class io.grpc.stub.AbstractAsyncStub

        newStub, newStub

      • Methods inherited from class io.grpc.stub.AbstractStub

        getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOption, withWaitForReady

    • Method Detail

      • createTable

        public void createTable​(CreateTableRequest request,
                        io.grpc.stub.StreamObserver<Table> responseObserver)
         Creates a new table in the specified instance.
 The table can be created with a full set of initial column families,
 specified in the request.

      • createTableFromSnapshot

        public void createTableFromSnapshot​(CreateTableFromSnapshotRequest request,
                                    io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
         Creates a new table from the specified snapshot. The target table must
 not exist. The snapshot and the table must be in the same instance.
 Note: This is a private alpha release of Cloud Bigtable snapshots. 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.

      • listTables

        public void listTables​(ListTablesRequest request,
                       io.grpc.stub.StreamObserver<ListTablesResponse> responseObserver)
         Lists all tables served from a specified instance.

      • getTable

        public void getTable​(GetTableRequest request,
                     io.grpc.stub.StreamObserver<Table> responseObserver)
         Gets metadata information about the specified table.

      • updateTable

        public void updateTable​(UpdateTableRequest request,
                        io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
         Updates a specified table.

      • deleteTable

        public void deleteTable​(DeleteTableRequest request,
                        io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)
         Permanently deletes a specified table and all of its data.

      • undeleteTable

        public void undeleteTable​(UndeleteTableRequest request,
                          io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
         Restores a specified table which was accidentally deleted.

      • modifyColumnFamilies

        public void modifyColumnFamilies​(ModifyColumnFamiliesRequest request,
                                 io.grpc.stub.StreamObserver<Table> responseObserver)
         Performs a series of column family modifications on the specified table.
 Either all or none of the modifications will occur before this method
 returns, but data requests received prior to that point may see a table
 where only some modifications have taken effect.

      • dropRowRange

        public void dropRowRange​(DropRowRangeRequest request,
                         io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)
         Permanently drop/delete a row range from a specified table. The request can
 specify whether to delete all rows in a table, or only those that match a
 particular prefix.

      • generateConsistencyToken

        public void generateConsistencyToken​(GenerateConsistencyTokenRequest request,
                                     io.grpc.stub.StreamObserver<GenerateConsistencyTokenResponse> responseObserver)
         Generates a consistency token for a Table, which can be used in
 CheckConsistency to check whether mutations to the table that finished
 before this call started have been replicated. The tokens will be available
 for 90 days.

      • checkConsistency

        public void checkConsistency​(CheckConsistencyRequest request,
                             io.grpc.stub.StreamObserver<CheckConsistencyResponse> responseObserver)
         Checks replication consistency based on a consistency token, that is, if
 replication has caught up based on the conditions specified in the token
 and the check request.

      • snapshotTable

        public void snapshotTable​(SnapshotTableRequest request,
                          io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
         Creates a new snapshot in the specified cluster from the specified
 source table. The cluster and the table must be in the same instance.
 Note: This is a private alpha release of Cloud Bigtable snapshots. 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.

      • getSnapshot

        public void getSnapshot​(GetSnapshotRequest request,
                        io.grpc.stub.StreamObserver<Snapshot> responseObserver)
         Gets metadata information about the specified snapshot.
 Note: This is a private alpha release of Cloud Bigtable snapshots. 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.

      • listSnapshots

        public void listSnapshots​(ListSnapshotsRequest request,
                          io.grpc.stub.StreamObserver<ListSnapshotsResponse> responseObserver)
         Lists all snapshots associated with the specified cluster.
 Note: This is a private alpha release of Cloud Bigtable snapshots. 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.

      • deleteSnapshot

        public void deleteSnapshot​(DeleteSnapshotRequest request,
                           io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)
         Permanently deletes the specified snapshot.
 Note: This is a private alpha release of Cloud Bigtable snapshots. 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.

      • createBackup

        public void createBackup​(CreateBackupRequest request,
                         io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
         Starts creating a new Cloud Bigtable Backup.  The returned backup
 [long-running operation][google.longrunning.Operation] can be used to
 track creation of the backup. The
 [metadata][google.longrunning.Operation.metadata] field type is
 [CreateBackupMetadata][google.bigtable.admin.v2.CreateBackupMetadata]. The
 [response][google.longrunning.Operation.response] field type is
 [Backup][google.bigtable.admin.v2.Backup], if successful. Cancelling the
 returned operation will stop the creation and delete the backup.

      • getBackup

        public void getBackup​(GetBackupRequest request,
                      io.grpc.stub.StreamObserver<Backup> responseObserver)
         Gets metadata on a pending or completed Cloud Bigtable Backup.

      • updateBackup

        public void updateBackup​(UpdateBackupRequest request,
                         io.grpc.stub.StreamObserver<Backup> responseObserver)
         Updates a pending or completed Cloud Bigtable Backup.

      • deleteBackup

        public void deleteBackup​(DeleteBackupRequest request,
                         io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)
         Deletes a pending or completed Cloud Bigtable backup.

      • listBackups

        public void listBackups​(ListBackupsRequest request,
                        io.grpc.stub.StreamObserver<ListBackupsResponse> responseObserver)
         Lists Cloud Bigtable backups. Returns both completed and pending
 backups.

      • restoreTable

        public void restoreTable​(RestoreTableRequest request,
                         io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
         Create a new table by restoring from a completed backup.  The
 returned table [long-running operation][google.longrunning.Operation] can
 be used to track the progress of the operation, and to cancel it.  The
 [metadata][google.longrunning.Operation.metadata] field type is
 [RestoreTableMetadata][google.bigtable.admin.RestoreTableMetadata].  The
 [response][google.longrunning.Operation.response] type is
 [Table][google.bigtable.admin.v2.Table], if successful.

      • copyBackup

        public void copyBackup​(CopyBackupRequest request,
                       io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
         Copy a Cloud Bigtable backup to a new backup in the destination cluster
 located in the destination instance and project.

      • getIamPolicy

        public void getIamPolicy​(com.google.iam.v1.GetIamPolicyRequest request,
                         io.grpc.stub.StreamObserver<com.google.iam.v1.Policy> responseObserver)
         Gets the access control policy for a Table or Backup resource.
 Returns an empty policy if the resource exists but does not have a policy
 set.

      • setIamPolicy

        public void setIamPolicy​(com.google.iam.v1.SetIamPolicyRequest request,
                         io.grpc.stub.StreamObserver<com.google.iam.v1.Policy> responseObserver)
         Sets the access control policy on a Table or Backup resource.
 Replaces any existing policy.

      • testIamPermissions

        public void testIamPermissions​(com.google.iam.v1.TestIamPermissionsRequest request,
                               io.grpc.stub.StreamObserver<com.google.iam.v1.TestIamPermissionsResponse> responseObserver)
         Returns permissions that the caller has on the specified Table or Backup
 resource.