Class BigtableTableAdminGrpc.BigtableTableAdminBlockingStub (2.13.0)

public static final class BigtableTableAdminGrpc.BigtableTableAdminBlockingStub extends AbstractBlockingStub<BigtableTableAdminGrpc.BigtableTableAdminBlockingStub>

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.AbstractBlockingStub > BigtableTableAdminGrpc.BigtableTableAdminBlockingStub

Inherited Members

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

io.grpc.stub.AbstractBlockingStub.<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.BigtableTableAdminBlockingStub build(Channel channel, CallOptions callOptions)

Parameters

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

Returns

Type	Description
BigtableTableAdminGrpc.BigtableTableAdminBlockingStub

Overrides

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

checkConsistency(CheckConsistencyRequest request)

public CheckConsistencyResponse checkConsistency(CheckConsistencyRequest request)

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.

Parameter

Name	Description
request	`CheckConsistencyRequest`

Returns

Type	Description
CheckConsistencyResponse

createBackup(CreateBackupRequest request)

public Operation createBackup(CreateBackupRequest request)

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.

Parameter

Name	Description
request	`CreateBackupRequest`

Returns

Type	Description
Operation

createTable(CreateTableRequest request)

public Table createTable(CreateTableRequest request)

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.

Parameter

Name	Description
request	`CreateTableRequest`

Returns

Type	Description
Table

createTableFromSnapshot(CreateTableFromSnapshotRequest request)

public Operation createTableFromSnapshot(CreateTableFromSnapshotRequest request)

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.

Parameter

Name	Description
request	`CreateTableFromSnapshotRequest`

Returns

Type	Description
Operation

deleteBackup(DeleteBackupRequest request)

public Empty deleteBackup(DeleteBackupRequest request)

Deletes a pending or completed Cloud Bigtable backup.

Parameter

Name	Description
request	`DeleteBackupRequest`

Returns

Type	Description
Empty

deleteSnapshot(DeleteSnapshotRequest request)

public Empty deleteSnapshot(DeleteSnapshotRequest request)

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.

Parameter

Name	Description
request	`DeleteSnapshotRequest`

Returns

Type	Description
Empty

deleteTable(DeleteTableRequest request)

public Empty deleteTable(DeleteTableRequest request)

Permanently deletes a specified table and all of its data.

Parameter

Name	Description
request	`DeleteTableRequest`

Returns

Type	Description
Empty

dropRowRange(DropRowRangeRequest request)

public Empty dropRowRange(DropRowRangeRequest request)

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.

Parameter

Name	Description
request	`DropRowRangeRequest`

Returns

Type	Description
Empty

generateConsistencyToken(GenerateConsistencyTokenRequest request)

public GenerateConsistencyTokenResponse generateConsistencyToken(GenerateConsistencyTokenRequest request)

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.

Parameter

Name	Description
request	`GenerateConsistencyTokenRequest`

Returns

Type	Description
GenerateConsistencyTokenResponse

getBackup(GetBackupRequest request)

public Backup getBackup(GetBackupRequest request)

Gets metadata on a pending or completed Cloud Bigtable Backup.

Parameter

Name	Description
request	`GetBackupRequest`

Returns

Type	Description
Backup

getIamPolicy(GetIamPolicyRequest request)

public Policy getIamPolicy(GetIamPolicyRequest request)

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.

Parameter

Name	Description
request	`com.google.iam.v1.GetIamPolicyRequest`

Returns

Type	Description
com.google.iam.v1.Policy

getSnapshot(GetSnapshotRequest request)

public Snapshot getSnapshot(GetSnapshotRequest request)

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.

Parameter

Name	Description
request	`GetSnapshotRequest`

Returns

Type	Description
Snapshot

getTable(GetTableRequest request)

public Table getTable(GetTableRequest request)

Gets metadata information about the specified table.

Parameter

Name	Description
request	`GetTableRequest`

Returns

Type	Description
Table

listBackups(ListBackupsRequest request)

public ListBackupsResponse listBackups(ListBackupsRequest request)

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

Parameter

Name	Description
request	`ListBackupsRequest`

Returns

Type	Description
ListBackupsResponse

listSnapshots(ListSnapshotsRequest request)

public ListSnapshotsResponse listSnapshots(ListSnapshotsRequest request)

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.

Parameter

Name	Description
request	`ListSnapshotsRequest`

Returns

Type	Description
ListSnapshotsResponse

listTables(ListTablesRequest request)

public ListTablesResponse listTables(ListTablesRequest request)

Lists all tables served from a specified instance.

Parameter

Name	Description
request	`ListTablesRequest`

Returns

Type	Description
ListTablesResponse

modifyColumnFamilies(ModifyColumnFamiliesRequest request)

public Table modifyColumnFamilies(ModifyColumnFamiliesRequest request)

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.

Parameter

Name	Description
request	`ModifyColumnFamiliesRequest`

Returns

Type	Description
Table

restoreTable(RestoreTableRequest request)

public Operation restoreTable(RestoreTableRequest request)

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.

Parameter

Name	Description
request	`RestoreTableRequest`

Returns

Type	Description
Operation

setIamPolicy(SetIamPolicyRequest request)

public Policy setIamPolicy(SetIamPolicyRequest request)

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

Parameter

Name	Description
request	`com.google.iam.v1.SetIamPolicyRequest`

Returns

Type	Description
com.google.iam.v1.Policy

snapshotTable(SnapshotTableRequest request)

public Operation snapshotTable(SnapshotTableRequest request)

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.

Parameter

Name	Description
request	`SnapshotTableRequest`

Returns

Type	Description
Operation

testIamPermissions(TestIamPermissionsRequest request)

public TestIamPermissionsResponse testIamPermissions(TestIamPermissionsRequest request)

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

Parameter

Name	Description
request	`com.google.iam.v1.TestIamPermissionsRequest`

Returns

Type	Description
com.google.iam.v1.TestIamPermissionsResponse

undeleteTable(UndeleteTableRequest request)

public Operation undeleteTable(UndeleteTableRequest request)

Restores a specified table which was accidentally deleted.

Parameter

Name	Description
request	`UndeleteTableRequest`

Returns

Type	Description
Operation

updateBackup(UpdateBackupRequest request)

public Backup updateBackup(UpdateBackupRequest request)

Updates a pending or completed Cloud Bigtable Backup.

Parameter

Name	Description
request	`UpdateBackupRequest`

Returns

Type	Description
Backup

updateTable(UpdateTableRequest request)

public Operation updateTable(UpdateTableRequest request)

Updates a specified table.

Parameter

Name	Description
request	`UpdateTableRequest`

Returns

Type	Description
Operation