Class BigtableTableAdminGrpc.BigtableTableAdminStub (2.10.3)

public static final class BigtableTableAdminGrpc.BigtableTableAdminStub extends AbstractAsyncStub<BigtableTableAdminGrpc.BigtableTableAdminStub>

Service for creating, configuring, and deleting Cloud Bigtable tables. Provides access to the table schemas only, not the data stored within the tables.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractAsyncStub > BigtableTableAdminGrpc.BigtableTableAdminStub

Inherited Members

io.grpc.stub.AbstractAsyncStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)

io.grpc.stub.AbstractAsyncStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.<T>withOption(io.grpc.CallOptions.Key<T>,T)

io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.getCallOptions()

io.grpc.stub.AbstractStub.getChannel()

io.grpc.stub.AbstractStub.withCallCredentials(io.grpc.CallCredentials)

io.grpc.stub.AbstractStub.withChannel(io.grpc.Channel)

io.grpc.stub.AbstractStub.withCompression(java.lang.String)

io.grpc.stub.AbstractStub.withDeadline(io.grpc.Deadline)

io.grpc.stub.AbstractStub.withDeadlineAfter(long,java.util.concurrent.TimeUnit)

io.grpc.stub.AbstractStub.withExecutor(java.util.concurrent.Executor)

io.grpc.stub.AbstractStub.withInterceptors(io.grpc.ClientInterceptor...)

io.grpc.stub.AbstractStub.withMaxInboundMessageSize(int)

io.grpc.stub.AbstractStub.withMaxOutboundMessageSize(int)

io.grpc.stub.AbstractStub.withWaitForReady()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Methods

build(Channel channel, CallOptions callOptions)

protected BigtableTableAdminGrpc.BigtableTableAdminStub build(Channel channel, CallOptions callOptions)

Parameters

Name	Description
channel	`io.grpc.Channel`
callOptions	`io.grpc.CallOptions`

Returns

Type	Description
BigtableTableAdminGrpc.BigtableTableAdminStub

Overrides

io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

checkConsistency(CheckConsistencyRequest request, StreamObserver<CheckConsistencyResponse> responseObserver)

public void checkConsistency(CheckConsistencyRequest request, 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.

Parameters

Name	Description
request	`CheckConsistencyRequest`
responseObserver	`io.grpc.stub.StreamObserver<CheckConsistencyResponse>`

createBackup(CreateBackupRequest request, StreamObserver<Operation> responseObserver)

public void createBackup(CreateBackupRequest request, StreamObserver<Operation> responseObserver)

Starts creating a new Cloud Bigtable Backup. The returned backup long-running operation can be used to track creation of the backup. The metadata field type is CreateBackupMetadata. The response field type is Backup, if successful. Cancelling the returned operation will stop the creation and delete the backup.

Parameters

Name	Description
request	`CreateBackupRequest`
responseObserver	`io.grpc.stub.StreamObserver<Operation>`

createTable(CreateTableRequest request, StreamObserver<Table> responseObserver)

public void createTable(CreateTableRequest request, 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.

Parameters

Name	Description
request	`CreateTableRequest`
responseObserver	`io.grpc.stub.StreamObserver<Table>`

createTableFromSnapshot(CreateTableFromSnapshotRequest request, StreamObserver<Operation> responseObserver)

public void createTableFromSnapshot(CreateTableFromSnapshotRequest request, StreamObserver<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.

Parameters

Name	Description
request	`CreateTableFromSnapshotRequest`
responseObserver	`io.grpc.stub.StreamObserver<Operation>`

deleteBackup(DeleteBackupRequest request, StreamObserver<Empty> responseObserver)

public void deleteBackup(DeleteBackupRequest request, StreamObserver<Empty> responseObserver)

Deletes a pending or completed Cloud Bigtable backup.

Parameters

Name	Description
request	`DeleteBackupRequest`
responseObserver	`io.grpc.stub.StreamObserver<Empty>`

deleteSnapshot(DeleteSnapshotRequest request, StreamObserver<Empty> responseObserver)

public void deleteSnapshot(DeleteSnapshotRequest request, StreamObserver<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.

Parameters

Name	Description
request	`DeleteSnapshotRequest`
responseObserver	`io.grpc.stub.StreamObserver<Empty>`

deleteTable(DeleteTableRequest request, StreamObserver<Empty> responseObserver)

public void deleteTable(DeleteTableRequest request, StreamObserver<Empty> responseObserver)

Permanently deletes a specified table and all of its data.

Parameters

Name	Description
request	`DeleteTableRequest`
responseObserver	`io.grpc.stub.StreamObserver<Empty>`

dropRowRange(DropRowRangeRequest request, StreamObserver<Empty> responseObserver)

public void dropRowRange(DropRowRangeRequest request, StreamObserver<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.

Parameters

Name	Description
request	`DropRowRangeRequest`
responseObserver	`io.grpc.stub.StreamObserver<Empty>`

generateConsistencyToken(GenerateConsistencyTokenRequest request, StreamObserver<GenerateConsistencyTokenResponse> responseObserver)

public void generateConsistencyToken(GenerateConsistencyTokenRequest request, 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.

Parameters

Name	Description
request	`GenerateConsistencyTokenRequest`
responseObserver	`io.grpc.stub.StreamObserver<GenerateConsistencyTokenResponse>`

getBackup(GetBackupRequest request, StreamObserver<Backup> responseObserver)

public void getBackup(GetBackupRequest request, StreamObserver<Backup> responseObserver)

Gets metadata on a pending or completed Cloud Bigtable Backup.

Parameters

Name	Description
request	`GetBackupRequest`
responseObserver	`io.grpc.stub.StreamObserver<Backup>`

getIamPolicy(GetIamPolicyRequest request, StreamObserver<Policy> responseObserver)

public void getIamPolicy(GetIamPolicyRequest request, StreamObserver<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.

Parameters

Name	Description
request	`com.google.iam.v1.GetIamPolicyRequest`
responseObserver	`io.grpc.stub.StreamObserver<com.google.iam.v1.Policy>`

getSnapshot(GetSnapshotRequest request, StreamObserver<Snapshot> responseObserver)

public void getSnapshot(GetSnapshotRequest request, 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.

Parameters

Name	Description
request	`GetSnapshotRequest`
responseObserver	`io.grpc.stub.StreamObserver<Snapshot>`

getTable(GetTableRequest request, StreamObserver<Table> responseObserver)

public void getTable(GetTableRequest request, StreamObserver<Table> responseObserver)

Gets metadata information about the specified table.

Parameters

Name	Description
request	`GetTableRequest`
responseObserver	`io.grpc.stub.StreamObserver<Table>`

listBackups(ListBackupsRequest request, StreamObserver<ListBackupsResponse> responseObserver)

public void listBackups(ListBackupsRequest request, StreamObserver<ListBackupsResponse> responseObserver)

Lists Cloud Bigtable backups. Returns both completed and pending backups.

Parameters

Name	Description
request	`ListBackupsRequest`
responseObserver	`io.grpc.stub.StreamObserver<ListBackupsResponse>`

listSnapshots(ListSnapshotsRequest request, StreamObserver<ListSnapshotsResponse> responseObserver)

public void listSnapshots(ListSnapshotsRequest request, 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.

Parameters

Name	Description
request	`ListSnapshotsRequest`
responseObserver	`io.grpc.stub.StreamObserver<ListSnapshotsResponse>`

listTables(ListTablesRequest request, StreamObserver<ListTablesResponse> responseObserver)

public void listTables(ListTablesRequest request, StreamObserver<ListTablesResponse> responseObserver)

Lists all tables served from a specified instance.

Parameters

Name	Description
request	`ListTablesRequest`
responseObserver	`io.grpc.stub.StreamObserver<ListTablesResponse>`

modifyColumnFamilies(ModifyColumnFamiliesRequest request, StreamObserver<Table> responseObserver)

public void modifyColumnFamilies(ModifyColumnFamiliesRequest request, 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.

Parameters

Name	Description
request	`ModifyColumnFamiliesRequest`
responseObserver	`io.grpc.stub.StreamObserver<Table>`

restoreTable(RestoreTableRequest request, StreamObserver<Operation> responseObserver)

public void restoreTable(RestoreTableRequest request, StreamObserver<Operation> responseObserver)

Create a new table by restoring from a completed backup. The new table must be in the same project as the instance containing the backup. The returned table long-running operation can be used to track the progress of the operation, and to cancel it. The metadata field type is RestoreTableMetadata. The response type is Table, if successful.

Parameters

Name	Description
request	`RestoreTableRequest`
responseObserver	`io.grpc.stub.StreamObserver<Operation>`

setIamPolicy(SetIamPolicyRequest request, StreamObserver<Policy> responseObserver)

public void setIamPolicy(SetIamPolicyRequest request, StreamObserver<Policy> responseObserver)

Sets the access control policy on a Table or Backup resource. Replaces any existing policy.

Parameters

Name	Description
request	`com.google.iam.v1.SetIamPolicyRequest`
responseObserver	`io.grpc.stub.StreamObserver<com.google.iam.v1.Policy>`

snapshotTable(SnapshotTableRequest request, StreamObserver<Operation> responseObserver)

public void snapshotTable(SnapshotTableRequest request, StreamObserver<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.

Parameters

Name	Description
request	`SnapshotTableRequest`
responseObserver	`io.grpc.stub.StreamObserver<Operation>`

testIamPermissions(TestIamPermissionsRequest request, StreamObserver<TestIamPermissionsResponse> responseObserver)

public void testIamPermissions(TestIamPermissionsRequest request, StreamObserver<TestIamPermissionsResponse> responseObserver)

Returns permissions that the caller has on the specified Table or Backup resource.

Parameters

Name	Description
request	`com.google.iam.v1.TestIamPermissionsRequest`
responseObserver	`io.grpc.stub.StreamObserver<com.google.iam.v1.TestIamPermissionsResponse>`

undeleteTable(UndeleteTableRequest request, StreamObserver<Operation> responseObserver)

public void undeleteTable(UndeleteTableRequest request, StreamObserver<Operation> responseObserver)

Restores a specified table which was accidentally deleted.

Parameters

Name	Description
request	`UndeleteTableRequest`
responseObserver	`io.grpc.stub.StreamObserver<Operation>`

updateBackup(UpdateBackupRequest request, StreamObserver<Backup> responseObserver)

public void updateBackup(UpdateBackupRequest request, StreamObserver<Backup> responseObserver)

Updates a pending or completed Cloud Bigtable Backup.

Parameters

Name	Description
request	`UpdateBackupRequest`
responseObserver	`io.grpc.stub.StreamObserver<Backup>`