Summary of entries of Methods for bigtable.
google.cloud.bigtable.app_profile.AppProfile.create
create(ignore_warnings=None)
Create this AppProfile.
See more: google.cloud.bigtable.app_profile.AppProfile.create
google.cloud.bigtable.app_profile.AppProfile.delete
delete(ignore_warnings=None)
Delete this AppProfile.
See more: google.cloud.bigtable.app_profile.AppProfile.delete
google.cloud.bigtable.app_profile.AppProfile.exists
exists()
Check whether the AppProfile already exists.
See more: google.cloud.bigtable.app_profile.AppProfile.exists
google.cloud.bigtable.app_profile.AppProfile.from_pb
from_pb(app_profile_pb, instance)
Creates an instance app_profile from a protobuf.
See more: google.cloud.bigtable.app_profile.AppProfile.from_pb
google.cloud.bigtable.app_profile.AppProfile.reload
reload()
Reload the metadata for this cluster.
See more: google.cloud.bigtable.app_profile.AppProfile.reload
google.cloud.bigtable.app_profile.AppProfile.update
update(ignore_warnings=None)
Update this app_profile.
See more: google.cloud.bigtable.app_profile.AppProfile.update
google.cloud.bigtable.backup.Backup.create
create(cluster_id=None)
Creates this backup within its instance.
google.cloud.bigtable.backup.Backup.delete
delete()
Delete this Backup.
google.cloud.bigtable.backup.Backup.exists
exists()
Tests whether this Backup exists.
google.cloud.bigtable.backup.Backup.from_pb
from_pb(backup_pb, instance)
Creates a Backup instance from a protobuf message.
google.cloud.bigtable.backup.Backup.get
get()
Retrieves metadata of a pending or completed Backup.
See more: google.cloud.bigtable.backup.Backup.get
google.cloud.bigtable.backup.Backup.get_iam_policy
get_iam_policy()
Gets the IAM access control policy for this backup.
See more: google.cloud.bigtable.backup.Backup.get_iam_policy
google.cloud.bigtable.backup.Backup.reload
reload()
Refreshes the stored backup properties.
google.cloud.bigtable.backup.Backup.restore
restore(table_id, instance_id=None)
Creates a new Table by restoring from this Backup.
google.cloud.bigtable.backup.Backup.set_iam_policy
set_iam_policy(policy)
Sets the IAM access control policy for this backup.
See more: google.cloud.bigtable.backup.Backup.set_iam_policy
google.cloud.bigtable.backup.Backup.test_iam_permissions
test_iam_permissions(permissions)
Tests whether the caller has the given permissions for this backup.
See more: google.cloud.bigtable.backup.Backup.test_iam_permissions
google.cloud.bigtable.backup.Backup.update_expire_time
update_expire_time(new_expire_time)
Update the expire time of this Backup.
See more: google.cloud.bigtable.backup.Backup.update_expire_time
google.cloud.bigtable.batcher.MutationsBatcher.__enter__
__enter__()
Starting the MutationsBatcher as a context manager.
See more: google.cloud.bigtable.batcher.MutationsBatcher.enter
google.cloud.bigtable.batcher.MutationsBatcher.__exit__
__exit__(exc_type, exc_value, exc_traceback)
Clean up resources.
See more: google.cloud.bigtable.batcher.MutationsBatcher.exit
google.cloud.bigtable.batcher.MutationsBatcher.close
close()
Clean up resources.
See more: google.cloud.bigtable.batcher.MutationsBatcher.close
google.cloud.bigtable.batcher.MutationsBatcher.flush
flush()
Sends the current batch to Cloud Bigtable synchronously.
See more: google.cloud.bigtable.batcher.MutationsBatcher.flush
google.cloud.bigtable.batcher.MutationsBatcher.mutate
mutate(row)
Add a row to the batch.
See more: google.cloud.bigtable.batcher.MutationsBatcher.mutate
google.cloud.bigtable.batcher.MutationsBatcher.mutate_rows
mutate_rows(rows)
Add multiple rows to the batch.
See more: google.cloud.bigtable.batcher.MutationsBatcher.mutate_rows
google.cloud.bigtable.client.Client.instance
instance(instance_id, display_name=None, instance_type=None, labels=None)
Factory to create a instance associated with this client.
google.cloud.bigtable.client.Client.list_clusters
list_clusters()
List the clusters in the project.
google.cloud.bigtable.client.Client.list_instances
list_instances()
List instances owned by the project.
See more: google.cloud.bigtable.client.Client.list_instances
google.cloud.bigtable.cluster.Cluster.create
create()
Create this cluster.
google.cloud.bigtable.cluster.Cluster.delete
delete()
Delete this cluster.
google.cloud.bigtable.cluster.Cluster.disable_autoscaling
disable_autoscaling(serve_nodes)
Disable autoscaling by specifying the number of nodes.
See more: google.cloud.bigtable.cluster.Cluster.disable_autoscaling
google.cloud.bigtable.cluster.Cluster.exists
exists()
Check whether the cluster already exists.
google.cloud.bigtable.cluster.Cluster.from_pb
from_pb(cluster_pb, instance)
Creates a cluster instance from a protobuf.
google.cloud.bigtable.cluster.Cluster.reload
reload()
Reload the metadata for this cluster.
google.cloud.bigtable.cluster.Cluster.update
update()
Update this cluster.
google.cloud.bigtable.column_family.ColumnFamily.create
create()
Create this column family.
See more: google.cloud.bigtable.column_family.ColumnFamily.create
google.cloud.bigtable.column_family.ColumnFamily.delete
delete()
Delete this column family.
See more: google.cloud.bigtable.column_family.ColumnFamily.delete
google.cloud.bigtable.column_family.ColumnFamily.to_pb
to_pb()
Converts the column family to a protobuf.
See more: google.cloud.bigtable.column_family.ColumnFamily.to_pb
google.cloud.bigtable.column_family.ColumnFamily.update
update()
Update this column family.
See more: google.cloud.bigtable.column_family.ColumnFamily.update
google.cloud.bigtable.column_family.GCRuleIntersection.to_pb
to_pb()
Converts the intersection into a single GC rule as a protobuf.
See more: google.cloud.bigtable.column_family.GCRuleIntersection.to_pb
google.cloud.bigtable.column_family.GCRuleUnion.to_pb
to_pb()
Converts the union into a single GC rule as a protobuf.
See more: google.cloud.bigtable.column_family.GCRuleUnion.to_pb
google.cloud.bigtable.column_family.MaxAgeGCRule.to_pb
to_pb()
Converts the garbage collection rule to a protobuf.
See more: google.cloud.bigtable.column_family.MaxAgeGCRule.to_pb
google.cloud.bigtable.column_family.MaxVersionsGCRule.to_pb
to_pb()
Converts the garbage collection rule to a protobuf.
See more: google.cloud.bigtable.column_family.MaxVersionsGCRule.to_pb
google.cloud.bigtable.data.BigtableDataClient.close
close(timeout: float | None = 2.0)
Cancel all background tasks.
See more: google.cloud.bigtable.data.BigtableDataClient.close
google.cloud.bigtable.data.BigtableDataClient.execute_query
execute_query(query: str, instance_id: str, *, parameters: dict[str, ExecuteQueryValueType] | None = None, parameter_types: dict[str, SqlType.Type] | None = None, app_profile_id: str | None = None, operation_timeout: float = 600, attempt_timeout: float | None = 20, retryable_errors: Sequence[type[Exception]] = (
Executes an SQL query on an instance.
See more: google.cloud.bigtable.data.BigtableDataClient.execute_query
google.cloud.bigtable.data.BigtableDataClient.get_authorized_view
get_authorized_view(
instance_id: str, table_id: str, authorized_view_id: str, *args, **kwargs
) -> google.cloud.bigtable.data._sync_autogen.client.AuthorizedView
Returns an authorized view instance for making data API requests.
See more: google.cloud.bigtable.data.BigtableDataClient.get_authorized_view
google.cloud.bigtable.data.BigtableDataClient.get_table
get_table(
instance_id: str, table_id: str, *args, **kwargs
) -> google.cloud.bigtable.data._sync_autogen.client.Table
Returns a table instance for making data API requests.
See more: google.cloud.bigtable.data.BigtableDataClient.get_table
google.cloud.bigtable.data.BigtableDataClientAsync.close
close(timeout: float | None = 2.0)
Cancel all background tasks.
See more: google.cloud.bigtable.data.BigtableDataClientAsync.close
google.cloud.bigtable.data.BigtableDataClientAsync.execute_query
execute_query(query: str, instance_id: str, *, parameters: dict[str, ExecuteQueryValueType] | None = None, parameter_types: dict[str, SqlType.Type] | None = None, app_profile_id: str | None = None, operation_timeout: float = 600, attempt_timeout: float | None = 20, retryable_errors: Sequence[type[Exception]] = (
Executes an SQL query on an instance.
See more: google.cloud.bigtable.data.BigtableDataClientAsync.execute_query
google.cloud.bigtable.data.BigtableDataClientAsync.get_authorized_view
get_authorized_view(
instance_id: str, table_id: str, authorized_view_id: str, *args, **kwargs
) -> google.cloud.bigtable.data._async.client.AuthorizedViewAsync
Returns an authorized view instance for making data API requests.
See more: google.cloud.bigtable.data.BigtableDataClientAsync.get_authorized_view
google.cloud.bigtable.data.BigtableDataClientAsync.get_table
get_table(
instance_id: str, table_id: str, *args, **kwargs
) -> google.cloud.bigtable.data._async.client.TableAsync
Returns a table instance for making data API requests.
See more: google.cloud.bigtable.data.BigtableDataClientAsync.get_table
google.cloud.bigtable.data.Table
Table(client: google.cloud.bigtable.data._sync_autogen.client.BigtableDataClient, instance_id: str, table_id: str, app_profile_id: typing.Optional[str] = None, *, default_read_rows_operation_timeout: float = 600, default_read_rows_attempt_timeout: float | None = 20, default_mutate_rows_operation_timeout: float = 600, default_mutate_rows_attempt_timeout: float | None = 60, default_operation_timeout: float = 60, default_attempt_timeout: float | None = 20, default_read_rows_retryable_errors: typing.Sequence[type[Exception]] = (
Initialize a Table instance.
See more: google.cloud.bigtable.data.Table
google.cloud.bigtable.data._async.client.AuthorizedViewAsync
AuthorizedViewAsync(
client,
instance_id,
table_id,
authorized_view_id,
app_profile_id: typing.Optional[str] = None,
**kwargs
)
Initialize an AuthorizedView instance.
See more: google.cloud.bigtable.data._async.client.AuthorizedViewAsync
google.cloud.bigtable.data._async.client.AuthorizedViewAsync.__aenter__
__aenter__()
Implement async context manager protocol.
See more: google.cloud.bigtable.data.async.client.AuthorizedViewAsync._aenter
google.cloud.bigtable.data._async.client.AuthorizedViewAsync.__aexit__
__aexit__(exc_type, exc_val, exc_tb)
Implement async context manager protocol.
See more: google.cloud.bigtable.data.async.client.AuthorizedViewAsync._aexit
google.cloud.bigtable.data._async.client.AuthorizedViewAsync.bulk_mutate_rows
bulk_mutate_rows(
mutation_entries: list[google.cloud.bigtable.data.mutations.RowMutationEntry],
*,
operation_timeout: (
float | google.cloud.bigtable.data._helpers.TABLE_DEFAULT
) = TABLE_DEFAULT.MUTATE_ROWS,
attempt_timeout: (
float | None | google.cloud.bigtable.data._helpers.TABLE_DEFAULT
) = TABLE_DEFAULT.MUTATE_ROWS,
retryable_errors: typing.Union[
typing.Sequence[type[Exception]],
google.cloud.bigtable.data._helpers.TABLE_DEFAULT,
] = TABLE_DEFAULT.MUTATE_ROWS
)
Applies mutations for multiple rows in a single batched request.
See more: google.cloud.bigtable.data._async.client.AuthorizedViewAsync.bulk_mutate_rows
google.cloud.bigtable.data._async.client.AuthorizedViewAsync.check_and_mutate_row
check_and_mutate_row(
row_key: str | bytes,
predicate: google.cloud.bigtable.data.row_filters.RowFilter | None,
*,
true_case_mutations: typing.Optional[
typing.Union[
google.cloud.bigtable.data.mutations.Mutation,
list[google.cloud.bigtable.data.mutations.Mutation],
]
] = None,
false_case_mutations: typing.Optional[
typing.Union[
google.cloud.bigtable.data.mutations.Mutation,
list[google.cloud.bigtable.data.mutations.Mutation],
]
] = None,
operation_timeout: (
float | google.cloud.bigtable.data._helpers.TABLE_DEFAULT
) = TABLE_DEFAULT.DEFAULT
) -> bool
Mutates a row atomically based on the output of a predicate filter.
See more: google.cloud.bigtable.data._async.client.AuthorizedViewAsync.check_and_mutate_row
google.cloud.bigtable.data._async.client.AuthorizedViewAsync.close
close()
Called to close the Table instance and release any resources held by it.
See more: google.cloud.bigtable.data._async.client.AuthorizedViewAsync.close
google.cloud.bigtable.data._async.client.AuthorizedViewAsync.mutate_row
mutate_row(
row_key: str | bytes,
mutations: (
list[google.cloud.bigtable.data.mutations.Mutation]
| google.cloud.bigtable.data.mutations.Mutation
),
*,
operation_timeout: (
float | google.cloud.bigtable.data._helpers.TABLE_DEFAULT
) = TABLE_DEFAULT.DEFAULT,
attempt_timeout: (
float | None | google.cloud.bigtable.data._helpers.TABLE_DEFAULT
) = TABLE_DEFAULT.DEFAULT,
retryable_errors: typing.Union[
typing.Sequence[type[Exception]],
google.cloud.bigtable.data._helpers.TABLE_DEFAULT,
] = TABLE_DEFAULT.DEFAULT
)
Mutates a row atomically.
See more: google.cloud.bigtable.data._async.client.AuthorizedViewAsync.mutate_row
google.cloud.bigtable.data._async.client.AuthorizedViewAsync.mutations_batcher
mutations_batcher(
*,
flush_interval: float | None = 5,
flush_limit_mutation_count: int | None = 1000,
flush_limit_bytes: int = 20971520,
flow_control_max_mutation_count: int = 100000,
flow_control_max_bytes: int = 104857600,
batch_operation_timeout: float | TABLE_DEFAULT = TABLE_DEFAULT.MUTATE_ROWS,
batch_attempt_timeout: float | None | TABLE_DEFAULT = TABLE_DEFAULT.MUTATE_ROWS,
batch_retryable_errors: (
Sequence[type[Exception]] | TABLE_DEFAULT
) = TABLE_DEFAULT.MUTATE_ROWS
) -> MutationsBatcherAsync
Returns a new mutations batcher instance.
See more: google.cloud.bigtable.data._async.client.AuthorizedViewAsync.mutations_batcher
google.cloud.bigtable.data._async.client.AuthorizedViewAsync.read_modify_write_row
read_modify_write_row(
row_key: str | bytes,
rules: (
google.cloud.bigtable.data.read_modify_write_rules.ReadModifyWriteRule
| list[google.cloud.bigtable.data.read_modify_write_rules.ReadModifyWriteRule]
),
*,
operation_timeout: (
float | google.cloud.bigtable.data._helpers.TABLE_DEFAULT
) = TABLE_DEFAULT.DEFAULT
) -> google.cloud.bigtable.data.row.Row
Reads and modifies a row atomically according to input ReadModifyWriteRules, and returns the contents of all modified cells.
See more: google.cloud.bigtable.data._async.client.AuthorizedViewAsync.read_modify_write_row
google.cloud.bigtable.data._async.client.AuthorizedViewAsync.read_row
read_row(
row_key: str | bytes,
*,
row_filter: typing.Optional[
google.cloud.bigtable.data.row_filters.RowFilter
] = None,
operation_timeout: (
float | google.cloud.bigtable.data._helpers.TABLE_DEFAULT
) = TABLE_DEFAULT.READ_ROWS,
attempt_timeout: (
float | None | google.cloud.bigtable.data._helpers.TABLE_DEFAULT
) = TABLE_DEFAULT.READ_ROWS,
retryable_errors: typing.Union[
typing.Sequence[type[Exception]],
google.cloud.bigtable.data._helpers.TABLE_DEFAULT,
] = TABLE_DEFAULT.READ_ROWS
) -> google.cloud.bigtable.data.row.Row | None
Read a single row from the table, based on the specified key.
See more: google.cloud.bigtable.data._async.client.AuthorizedViewAsync.read_row
google.cloud.bigtable.data._async.client.AuthorizedViewAsync.read_rows
read_rows(
query: google.cloud.bigtable.data.read_rows_query.ReadRowsQuery,
*,
operation_timeout: (
float | google.cloud.bigtable.data._helpers.TABLE_DEFAULT
) = TABLE_DEFAULT.READ_ROWS,
attempt_timeout: (
float | None | google.cloud.bigtable.data._helpers.TABLE_DEFAULT
) = TABLE_DEFAULT.READ_ROWS,
retryable_errors: typing.Union[
typing.Sequence[type[Exception]],
google.cloud.bigtable.data._helpers.TABLE_DEFAULT,
] = TABLE_DEFAULT.READ_ROWS
) -> list[google.cloud.bigtable.data.row.Row]
Read a set of rows from the table, based on the specified query.
See more: google.cloud.bigtable.data._async.client.AuthorizedViewAsync.read_rows
google.cloud.bigtable.data._async.client.AuthorizedViewAsync.read_rows_sharded
read_rows_sharded(
sharded_query: ShardedQuery,
*,
operation_timeout: float | TABLE_DEFAULT = TABLE_DEFAULT.READ_ROWS,
attempt_timeout: float | None | TABLE_DEFAULT = TABLE_DEFAULT.READ_ROWS,
retryable_errors: (
Sequence[type[Exception]] | TABLE_DEFAULT
) = TABLE_DEFAULT.READ_ROWS
) -> list[Row]
Runs a sharded query in parallel, then return the results in a single list.
See more: google.cloud.bigtable.data._async.client.AuthorizedViewAsync.read_rows_sharded
google.cloud.bigtable.data._async.client.AuthorizedViewAsync.read_rows_stream
read_rows_stream(
query: google.cloud.bigtable.data.read_rows_query.ReadRowsQuery,
*,
operation_timeout: (
float | google.cloud.bigtable.data._helpers.TABLE_DEFAULT
) = TABLE_DEFAULT.READ_ROWS,
attempt_timeout: (
float | None | google.cloud.bigtable.data._helpers.TABLE_DEFAULT
) = TABLE_DEFAULT.READ_ROWS,
retryable_errors: typing.Union[
typing.Sequence[type[Exception]],
google.cloud.bigtable.data._helpers.TABLE_DEFAULT,
] = TABLE_DEFAULT.READ_ROWS
) -> typing.AsyncIterable[google.cloud.bigtable.data.row.Row]
Read a set of rows from the table, based on the specified query.
See more: google.cloud.bigtable.data._async.client.AuthorizedViewAsync.read_rows_stream
google.cloud.bigtable.data._async.client.AuthorizedViewAsync.row_exists
row_exists(
row_key: str | bytes,
*,
operation_timeout: (
float | google.cloud.bigtable.data._helpers.TABLE_DEFAULT
) = TABLE_DEFAULT.READ_ROWS,
attempt_timeout: (
float | None | google.cloud.bigtable.data._helpers.TABLE_DEFAULT
) = TABLE_DEFAULT.READ_ROWS,
retryable_errors: typing.Union[
typing.Sequence[type[Exception]],
google.cloud.bigtable.data._helpers.TABLE_DEFAULT,
] = TABLE_DEFAULT.READ_ROWS
) -> bool
Return a boolean indicating whether the specified row exists in the table.
See more: google.cloud.bigtable.data._async.client.AuthorizedViewAsync.row_exists
google.cloud.bigtable.data._async.client.AuthorizedViewAsync.sample_row_keys
sample_row_keys(
*,
operation_timeout: float | TABLE_DEFAULT = TABLE_DEFAULT.DEFAULT,
attempt_timeout: float | None | TABLE_DEFAULT = TABLE_DEFAULT.DEFAULT,
retryable_errors: Sequence[type[Exception]] | TABLE_DEFAULT = TABLE_DEFAULT.DEFAULT
) -> RowKeySamples
Return a set of RowKeySamples that delimit contiguous sections of the table of approximately equal size.
See more: google.cloud.bigtable.data._async.client.AuthorizedViewAsync.sample_row_keys
google.cloud.bigtable.data._async.client.TableAsync
TableAsync(client: google.cloud.bigtable.data._async.client.BigtableDataClientAsync, instance_id: str, table_id: str, app_profile_id: typing.Optional[str] = None, *, default_read_rows_operation_timeout: float = 600, default_read_rows_attempt_timeout: float | None = 20, default_mutate_rows_operation_timeout: float = 600, default_mutate_rows_attempt_timeout: float | None = 60, default_operation_timeout: float = 60, default_attempt_timeout: float | None = 20, default_read_rows_retryable_errors: typing.Sequence[type[Exception]] = (
Initialize a Table instance.
See more: google.cloud.bigtable.data._async.client.TableAsync
google.cloud.bigtable.data._async.client.TableAsync.__aenter__
__aenter__()
Implement async context manager protocol.
See more: google.cloud.bigtable.data.async.client.TableAsync._aenter
google.cloud.bigtable.data._async.client.TableAsync.__aexit__
__aexit__(exc_type, exc_val, exc_tb)
Implement async context manager protocol.
See more: google.cloud.bigtable.data.async.client.TableAsync._aexit
google.cloud.bigtable.data._async.client.TableAsync.bulk_mutate_rows
bulk_mutate_rows(
mutation_entries: list[google.cloud.bigtable.data.mutations.RowMutationEntry],
*,
operation_timeout: (
float | google.cloud.bigtable.data._helpers.TABLE_DEFAULT
) = TABLE_DEFAULT.MUTATE_ROWS,
attempt_timeout: (
float | None | google.cloud.bigtable.data._helpers.TABLE_DEFAULT
) = TABLE_DEFAULT.MUTATE_ROWS,
retryable_errors: typing.Union[
typing.Sequence[type[Exception]],
google.cloud.bigtable.data._helpers.TABLE_DEFAULT,
] = TABLE_DEFAULT.MUTATE_ROWS
)
Applies mutations for multiple rows in a single batched request.
See more: google.cloud.bigtable.data._async.client.TableAsync.bulk_mutate_rows
google.cloud.bigtable.data._async.client.TableAsync.check_and_mutate_row
check_and_mutate_row(
row_key: str | bytes,
predicate: google.cloud.bigtable.data.row_filters.RowFilter | None,
*,
true_case_mutations: typing.Optional[
typing.Union[
google.cloud.bigtable.data.mutations.Mutation,
list[google.cloud.bigtable.data.mutations.Mutation],
]
] = None,
false_case_mutations: typing.Optional[
typing.Union[
google.cloud.bigtable.data.mutations.Mutation,
list[google.cloud.bigtable.data.mutations.Mutation],
]
] = None,
operation_timeout: (
float | google.cloud.bigtable.data._helpers.TABLE_DEFAULT
) = TABLE_DEFAULT.DEFAULT
) -> bool
Mutates a row atomically based on the output of a predicate filter.
See more: google.cloud.bigtable.data._async.client.TableAsync.check_and_mutate_row
google.cloud.bigtable.data._async.client.TableAsync.close
close()
Called to close the Table instance and release any resources held by it.
See more: google.cloud.bigtable.data._async.client.TableAsync.close
google.cloud.bigtable.data._async.client.TableAsync.mutate_row
mutate_row(
row_key: str | bytes,
mutations: (
list[google.cloud.bigtable.data.mutations.Mutation]
| google.cloud.bigtable.data.mutations.Mutation
),
*,
operation_timeout: (
float | google.cloud.bigtable.data._helpers.TABLE_DEFAULT
) = TABLE_DEFAULT.DEFAULT,
attempt_timeout: (
float | None | google.cloud.bigtable.data._helpers.TABLE_DEFAULT
) = TABLE_DEFAULT.DEFAULT,
retryable_errors: typing.Union[
typing.Sequence[type[Exception]],
google.cloud.bigtable.data._helpers.TABLE_DEFAULT,
] = TABLE_DEFAULT.DEFAULT
)
Mutates a row atomically.
See more: google.cloud.bigtable.data._async.client.TableAsync.mutate_row
google.cloud.bigtable.data._async.client.TableAsync.mutations_batcher
mutations_batcher(
*,
flush_interval: float | None = 5,
flush_limit_mutation_count: int | None = 1000,
flush_limit_bytes: int = 20971520,
flow_control_max_mutation_count: int = 100000,
flow_control_max_bytes: int = 104857600,
batch_operation_timeout: float | TABLE_DEFAULT = TABLE_DEFAULT.MUTATE_ROWS,
batch_attempt_timeout: float | None | TABLE_DEFAULT = TABLE_DEFAULT.MUTATE_ROWS,
batch_retryable_errors: (
Sequence[type[Exception]] | TABLE_DEFAULT
) = TABLE_DEFAULT.MUTATE_ROWS
) -> MutationsBatcherAsync
Returns a new mutations batcher instance.
See more: google.cloud.bigtable.data._async.client.TableAsync.mutations_batcher
google.cloud.bigtable.data._async.client.TableAsync.read_modify_write_row
read_modify_write_row(
row_key: str | bytes,
rules: (
google.cloud.bigtable.data.read_modify_write_rules.ReadModifyWriteRule
| list[google.cloud.bigtable.data.read_modify_write_rules.ReadModifyWriteRule]
),
*,
operation_timeout: (
float | google.cloud.bigtable.data._helpers.TABLE_DEFAULT
) = TABLE_DEFAULT.DEFAULT
) -> google.cloud.bigtable.data.row.Row
Reads and modifies a row atomically according to input ReadModifyWriteRules, and returns the contents of all modified cells.
See more: google.cloud.bigtable.data._async.client.TableAsync.read_modify_write_row
google.cloud.bigtable.data._async.client.TableAsync.read_row
read_row(
row_key: str | bytes,
*,
row_filter: typing.Optional[
google.cloud.bigtable.data.row_filters.RowFilter
] = None,
operation_timeout: (
float | google.cloud.bigtable.data._helpers.TABLE_DEFAULT
) = TABLE_DEFAULT.READ_ROWS,
attempt_timeout: (
float | None | google.cloud.bigtable.data._helpers.TABLE_DEFAULT
) = TABLE_DEFAULT.READ_ROWS,
retryable_errors: typing.Union[
typing.Sequence[type[Exception]],
google.cloud.bigtable.data._helpers.TABLE_DEFAULT,
] = TABLE_DEFAULT.READ_ROWS
) -> google.cloud.bigtable.data.row.Row | None
Read a single row from the table, based on the specified key.
See more: google.cloud.bigtable.data._async.client.TableAsync.read_row
google.cloud.bigtable.data._async.client.TableAsync.read_rows
read_rows(
query: google.cloud.bigtable.data.read_rows_query.ReadRowsQuery,
*,
operation_timeout: (
float | google.cloud.bigtable.data._helpers.TABLE_DEFAULT
) = TABLE_DEFAULT.READ_ROWS,
attempt_timeout: (
float | None | google.cloud.bigtable.data._helpers.TABLE_DEFAULT
) = TABLE_DEFAULT.READ_ROWS,
retryable_errors: typing.Union[
typing.Sequence[type[Exception]],
google.cloud.bigtable.data._helpers.TABLE_DEFAULT,
] = TABLE_DEFAULT.READ_ROWS
) -> list[google.cloud.bigtable.data.row.Row]
Read a set of rows from the table, based on the specified query.
See more: google.cloud.bigtable.data._async.client.TableAsync.read_rows
google.cloud.bigtable.data._async.client.TableAsync.read_rows_sharded
read_rows_sharded(
sharded_query: ShardedQuery,
*,
operation_timeout: float | TABLE_DEFAULT = TABLE_DEFAULT.READ_ROWS,
attempt_timeout: float | None | TABLE_DEFAULT = TABLE_DEFAULT.READ_ROWS,
retryable_errors: (
Sequence[type[Exception]] | TABLE_DEFAULT
) = TABLE_DEFAULT.READ_ROWS
) -> list[Row]
Runs a sharded query in parallel, then return the results in a single list.
See more: google.cloud.bigtable.data._async.client.TableAsync.read_rows_sharded
google.cloud.bigtable.data._async.client.TableAsync.read_rows_stream
read_rows_stream(
query: google.cloud.bigtable.data.read_rows_query.ReadRowsQuery,
*,
operation_timeout: (
float | google.cloud.bigtable.data._helpers.TABLE_DEFAULT
) = TABLE_DEFAULT.READ_ROWS,
attempt_timeout: (
float | None | google.cloud.bigtable.data._helpers.TABLE_DEFAULT
) = TABLE_DEFAULT.READ_ROWS,
retryable_errors: typing.Union[
typing.Sequence[type[Exception]],
google.cloud.bigtable.data._helpers.TABLE_DEFAULT,
] = TABLE_DEFAULT.READ_ROWS
) -> typing.AsyncIterable[google.cloud.bigtable.data.row.Row]
Read a set of rows from the table, based on the specified query.
See more: google.cloud.bigtable.data._async.client.TableAsync.read_rows_stream
google.cloud.bigtable.data._async.client.TableAsync.row_exists
row_exists(
row_key: str | bytes,
*,
operation_timeout: (
float | google.cloud.bigtable.data._helpers.TABLE_DEFAULT
) = TABLE_DEFAULT.READ_ROWS,
attempt_timeout: (
float | None | google.cloud.bigtable.data._helpers.TABLE_DEFAULT
) = TABLE_DEFAULT.READ_ROWS,
retryable_errors: typing.Union[
typing.Sequence[type[Exception]],
google.cloud.bigtable.data._helpers.TABLE_DEFAULT,
] = TABLE_DEFAULT.READ_ROWS
) -> bool
Return a boolean indicating whether the specified row exists in the table.
See more: google.cloud.bigtable.data._async.client.TableAsync.row_exists
google.cloud.bigtable.data._async.client.TableAsync.sample_row_keys
sample_row_keys(
*,
operation_timeout: float | TABLE_DEFAULT = TABLE_DEFAULT.DEFAULT,
attempt_timeout: float | None | TABLE_DEFAULT = TABLE_DEFAULT.DEFAULT,
retryable_errors: Sequence[type[Exception]] | TABLE_DEFAULT = TABLE_DEFAULT.DEFAULT
) -> RowKeySamples
Return a set of RowKeySamples that delimit contiguous sections of the table of approximately equal size.
See more: google.cloud.bigtable.data._async.client.TableAsync.sample_row_keys
google.cloud.bigtable.data._async.mutations_batcher.MutationsBatcherAsync.__aenter__
__aenter__()
Allow use of context manager API.
See more: google.cloud.bigtable.data.async.mutations_batcher.MutationsBatcherAsync._aenter
google.cloud.bigtable.data._async.mutations_batcher.MutationsBatcherAsync.__aexit__
__aexit__(exc_type, exc, tb)
Allow use of context manager API.
See more: google.cloud.bigtable.data.async.mutations_batcher.MutationsBatcherAsync._aexit
google.cloud.bigtable.data._async.mutations_batcher.MutationsBatcherAsync.append
append(mutation_entry: RowMutationEntry)
Add a new set of mutations to the internal queue .
See more: google.cloud.bigtable.data._async.mutations_batcher.MutationsBatcherAsync.append
google.cloud.bigtable.data._async.mutations_batcher.MutationsBatcherAsync.close
close()
Flush queue and clean up resources.
See more: google.cloud.bigtable.data._async.mutations_batcher.MutationsBatcherAsync.close
google.cloud.bigtable.data._sync_autogen.client.AuthorizedView
AuthorizedView(
client,
instance_id,
table_id,
authorized_view_id,
app_profile_id: typing.Optional[str] = None,
**kwargs
)
Initialize an AuthorizedView instance.
See more: google.cloud.bigtable.data._sync_autogen.client.AuthorizedView
google.cloud.bigtable.data._sync_autogen.client.AuthorizedView.__enter__
__enter__()
Implement async context manager protocol.
See more: google.cloud.bigtable.data.sync_autogen.client.AuthorizedView._enter
google.cloud.bigtable.data._sync_autogen.client.AuthorizedView.__exit__
__exit__(exc_type, exc_val, exc_tb)
Implement async context manager protocol.
See more: google.cloud.bigtable.data.sync_autogen.client.AuthorizedView._exit
google.cloud.bigtable.data._sync_autogen.client.AuthorizedView.bulk_mutate_rows
bulk_mutate_rows(
mutation_entries: list[google.cloud.bigtable.data.mutations.RowMutationEntry],
*,
operation_timeout: (
float | google.cloud.bigtable.data._helpers.TABLE_DEFAULT
) = TABLE_DEFAULT.MUTATE_ROWS,
attempt_timeout: (
float | None | google.cloud.bigtable.data._helpers.TABLE_DEFAULT
) = TABLE_DEFAULT.MUTATE_ROWS,
retryable_errors: typing.Union[
typing.Sequence[type[Exception]],
google.cloud.bigtable.data._helpers.TABLE_DEFAULT,
] = TABLE_DEFAULT.MUTATE_ROWS
)
Applies mutations for multiple rows in a single batched request.
See more: google.cloud.bigtable.data._sync_autogen.client.AuthorizedView.bulk_mutate_rows
google.cloud.bigtable.data._sync_autogen.client.AuthorizedView.check_and_mutate_row
check_and_mutate_row(
row_key: str | bytes,
predicate: google.cloud.bigtable.data.row_filters.RowFilter | None,
*,
true_case_mutations: typing.Optional[
typing.Union[
google.cloud.bigtable.data.mutations.Mutation,
list[google.cloud.bigtable.data.mutations.Mutation],
]
] = None,
false_case_mutations: typing.Optional[
typing.Union[
google.cloud.bigtable.data.mutations.Mutation,
list[google.cloud.bigtable.data.mutations.Mutation],
]
] = None,
operation_timeout: (
float | google.cloud.bigtable.data._helpers.TABLE_DEFAULT
) = TABLE_DEFAULT.DEFAULT
) -> bool
Mutates a row atomically based on the output of a predicate filter.
See more: google.cloud.bigtable.data._sync_autogen.client.AuthorizedView.check_and_mutate_row
google.cloud.bigtable.data._sync_autogen.client.AuthorizedView.close
close()
Called to close the Table instance and release any resources held by it.
See more: google.cloud.bigtable.data._sync_autogen.client.AuthorizedView.close
google.cloud.bigtable.data._sync_autogen.client.AuthorizedView.mutate_row
mutate_row(
row_key: str | bytes,
mutations: (
list[google.cloud.bigtable.data.mutations.Mutation]
| google.cloud.bigtable.data.mutations.Mutation
),
*,
operation_timeout: (
float | google.cloud.bigtable.data._helpers.TABLE_DEFAULT
) = TABLE_DEFAULT.DEFAULT,
attempt_timeout: (
float | None | google.cloud.bigtable.data._helpers.TABLE_DEFAULT
) = TABLE_DEFAULT.DEFAULT,
retryable_errors: typing.Union[
typing.Sequence[type[Exception]],
google.cloud.bigtable.data._helpers.TABLE_DEFAULT,
] = TABLE_DEFAULT.DEFAULT
)
Mutates a row atomically.
See more: google.cloud.bigtable.data._sync_autogen.client.AuthorizedView.mutate_row
google.cloud.bigtable.data._sync_autogen.client.AuthorizedView.mutations_batcher
mutations_batcher(
*,
flush_interval: float | None = 5,
flush_limit_mutation_count: int | None = 1000,
flush_limit_bytes: int = 20971520,
flow_control_max_mutation_count: int = 100000,
flow_control_max_bytes: int = 104857600,
batch_operation_timeout: float | TABLE_DEFAULT = TABLE_DEFAULT.MUTATE_ROWS,
batch_attempt_timeout: float | None | TABLE_DEFAULT = TABLE_DEFAULT.MUTATE_ROWS,
batch_retryable_errors: (
Sequence[type[Exception]] | TABLE_DEFAULT
) = TABLE_DEFAULT.MUTATE_ROWS
) -> MutationsBatcher
Returns a new mutations batcher instance.
See more: google.cloud.bigtable.data._sync_autogen.client.AuthorizedView.mutations_batcher
google.cloud.bigtable.data._sync_autogen.client.AuthorizedView.read_modify_write_row
read_modify_write_row(
row_key: str | bytes,
rules: (
google.cloud.bigtable.data.read_modify_write_rules.ReadModifyWriteRule
| list[google.cloud.bigtable.data.read_modify_write_rules.ReadModifyWriteRule]
),
*,
operation_timeout: (
float | google.cloud.bigtable.data._helpers.TABLE_DEFAULT
) = TABLE_DEFAULT.DEFAULT
) -> google.cloud.bigtable.data.row.Row
Reads and modifies a row atomically according to input ReadModifyWriteRules, and returns the contents of all modified cells.
See more: google.cloud.bigtable.data._sync_autogen.client.AuthorizedView.read_modify_write_row
google.cloud.bigtable.data._sync_autogen.client.AuthorizedView.read_row
read_row(
row_key: str | bytes,
*,
row_filter: typing.Optional[
google.cloud.bigtable.data.row_filters.RowFilter
] = None,
operation_timeout: (
float | google.cloud.bigtable.data._helpers.TABLE_DEFAULT
) = TABLE_DEFAULT.READ_ROWS,
attempt_timeout: (
float | None | google.cloud.bigtable.data._helpers.TABLE_DEFAULT
) = TABLE_DEFAULT.READ_ROWS,
retryable_errors: typing.Union[
typing.Sequence[type[Exception]],
google.cloud.bigtable.data._helpers.TABLE_DEFAULT,
] = TABLE_DEFAULT.READ_ROWS
) -> google.cloud.bigtable.data.row.Row | None
Read a single row from the table, based on the specified key.
See more: google.cloud.bigtable.data._sync_autogen.client.AuthorizedView.read_row
google.cloud.bigtable.data._sync_autogen.client.AuthorizedView.read_rows
read_rows(
query: google.cloud.bigtable.data.read_rows_query.ReadRowsQuery,
*,
operation_timeout: (
float | google.cloud.bigtable.data._helpers.TABLE_DEFAULT
) = TABLE_DEFAULT.READ_ROWS,
attempt_timeout: (
float | None | google.cloud.bigtable.data._helpers.TABLE_DEFAULT
) = TABLE_DEFAULT.READ_ROWS,
retryable_errors: typing.Union[
typing.Sequence[type[Exception]],
google.cloud.bigtable.data._helpers.TABLE_DEFAULT,
] = TABLE_DEFAULT.READ_ROWS
) -> list[google.cloud.bigtable.data.row.Row]
Read a set of rows from the table, based on the specified query.
See more: google.cloud.bigtable.data._sync_autogen.client.AuthorizedView.read_rows
google.cloud.bigtable.data._sync_autogen.client.AuthorizedView.read_rows_sharded
read_rows_sharded(
sharded_query: ShardedQuery,
*,
operation_timeout: float | TABLE_DEFAULT = TABLE_DEFAULT.READ_ROWS,
attempt_timeout: float | None | TABLE_DEFAULT = TABLE_DEFAULT.READ_ROWS,
retryable_errors: (
Sequence[type[Exception]] | TABLE_DEFAULT
) = TABLE_DEFAULT.READ_ROWS
) -> list[Row]
Runs a sharded query in parallel, then return the results in a single list.
See more: google.cloud.bigtable.data._sync_autogen.client.AuthorizedView.read_rows_sharded
google.cloud.bigtable.data._sync_autogen.client.AuthorizedView.read_rows_stream
read_rows_stream(
query: google.cloud.bigtable.data.read_rows_query.ReadRowsQuery,
*,
operation_timeout: (
float | google.cloud.bigtable.data._helpers.TABLE_DEFAULT
) = TABLE_DEFAULT.READ_ROWS,
attempt_timeout: (
float | None | google.cloud.bigtable.data._helpers.TABLE_DEFAULT
) = TABLE_DEFAULT.READ_ROWS,
retryable_errors: typing.Union[
typing.Sequence[type[Exception]],
google.cloud.bigtable.data._helpers.TABLE_DEFAULT,
] = TABLE_DEFAULT.READ_ROWS
) -> typing.Iterable[google.cloud.bigtable.data.row.Row]
Read a set of rows from the table, based on the specified query.
See more: google.cloud.bigtable.data._sync_autogen.client.AuthorizedView.read_rows_stream
google.cloud.bigtable.data._sync_autogen.client.AuthorizedView.row_exists
row_exists(
row_key: str | bytes,
*,
operation_timeout: (
float | google.cloud.bigtable.data._helpers.TABLE_DEFAULT
) = TABLE_DEFAULT.READ_ROWS,
attempt_timeout: (
float | None | google.cloud.bigtable.data._helpers.TABLE_DEFAULT
) = TABLE_DEFAULT.READ_ROWS,
retryable_errors: typing.Union[
typing.Sequence[type[Exception]],
google.cloud.bigtable.data._helpers.TABLE_DEFAULT,
] = TABLE_DEFAULT.READ_ROWS
) -> bool
Return a boolean indicating whether the specified row exists in the table.
See more: google.cloud.bigtable.data._sync_autogen.client.AuthorizedView.row_exists
google.cloud.bigtable.data._sync_autogen.client.AuthorizedView.sample_row_keys
sample_row_keys(
*,
operation_timeout: float | TABLE_DEFAULT = TABLE_DEFAULT.DEFAULT,
attempt_timeout: float | None | TABLE_DEFAULT = TABLE_DEFAULT.DEFAULT,
retryable_errors: Sequence[type[Exception]] | TABLE_DEFAULT = TABLE_DEFAULT.DEFAULT
) -> RowKeySamples
Return a set of RowKeySamples that delimit contiguous sections of the table of approximately equal size.
See more: google.cloud.bigtable.data._sync_autogen.client.AuthorizedView.sample_row_keys
google.cloud.bigtable.data._sync_autogen.mutations_batcher.MutationsBatcher.__enter__
__enter__()
Allow use of context manager API.
See more: google.cloud.bigtable.data.sync_autogen.mutations_batcher.MutationsBatcher._enter
google.cloud.bigtable.data._sync_autogen.mutations_batcher.MutationsBatcher.__exit__
__exit__(exc_type, exc, tb)
Allow use of context manager API.
See more: google.cloud.bigtable.data.sync_autogen.mutations_batcher.MutationsBatcher._exit
google.cloud.bigtable.data._sync_autogen.mutations_batcher.MutationsBatcher.append
append(mutation_entry: RowMutationEntry)
Add a new set of mutations to the internal queue .
See more: google.cloud.bigtable.data._sync_autogen.mutations_batcher.MutationsBatcher.append
google.cloud.bigtable.data._sync_autogen.mutations_batcher.MutationsBatcher.close
close()
Flush queue and clean up resources.
See more: google.cloud.bigtable.data._sync_autogen.mutations_batcher.MutationsBatcher.close
google.cloud.bigtable.data.exceptions.MutationsExceptionGroup.__new__
__new__(
cls, excs: list[Exception], total_entries: int, message: typing.Optional[str] = None
)
google.cloud.bigtable.data.exceptions.MutationsExceptionGroup.from_truncated_lists
from_truncated_lists(
first_list: list[Exception],
last_list: list[Exception],
total_excs: int,
entry_count: int,
) -> google.cloud.bigtable.data.exceptions.MutationsExceptionGroup
Create a MutationsExceptionGroup from two lists of exceptions, representing a larger set that has been truncated.
See more: google.cloud.bigtable.data.exceptions.MutationsExceptionGroup.from_truncated_lists
google.cloud.bigtable.data.execute_query.ExecuteQueryIterator.__next__
__next__() -> google.cloud.bigtable.data.execute_query.values.QueryResultRow
Yields QueryResultRows representing the results of the query.
See more: google.cloud.bigtable.data.execute_query.ExecuteQueryIterator.next
google.cloud.bigtable.data.execute_query.ExecuteQueryIterator.close
close() -> None
Cancel all background tasks.
See more: google.cloud.bigtable.data.execute_query.ExecuteQueryIterator.close
google.cloud.bigtable.data.execute_query.ExecuteQueryIteratorAsync.__anext__
__anext__() -> google.cloud.bigtable.data.execute_query.values.QueryResultRow
Yields QueryResultRows representing the results of the query.
See more: google.cloud.bigtable.data.execute_query.ExecuteQueryIteratorAsync.anext
google.cloud.bigtable.data.execute_query.ExecuteQueryIteratorAsync.close
close() -> None
Cancel all background tasks.
See more: google.cloud.bigtable.data.execute_query.ExecuteQueryIteratorAsync.close
google.cloud.bigtable.data.mutations.AddToCell.is_idempotent
is_idempotent() -> bool
Check if the mutation is idempotent.
See more: google.cloud.bigtable.data.mutations.AddToCell.is_idempotent
google.cloud.bigtable.data.mutations.Mutation.__str__
__str__() -> str
Return a string representation of the mutation.
google.cloud.bigtable.data.mutations.Mutation.is_idempotent
is_idempotent() -> bool
Check if the mutation is idempotent.
See more: google.cloud.bigtable.data.mutations.Mutation.is_idempotent
google.cloud.bigtable.data.mutations.Mutation.size
size() -> int
Get the size of the mutation in bytes .
See more: google.cloud.bigtable.data.mutations.Mutation.size
google.cloud.bigtable.data.mutations.RowMutationEntry.is_idempotent
is_idempotent() -> bool
Check if all mutations in the entry are idempotent.
See more: google.cloud.bigtable.data.mutations.RowMutationEntry.is_idempotent
google.cloud.bigtable.data.mutations.RowMutationEntry.size
size() -> int
Get the size of the mutation entry in bytes.
See more: google.cloud.bigtable.data.mutations.RowMutationEntry.size
google.cloud.bigtable.data.mutations.SetCell.is_idempotent
is_idempotent() -> bool
Check if the mutation is idempotent.
See more: google.cloud.bigtable.data.mutations.SetCell.is_idempotent
google.cloud.bigtable.data.read_rows_query.ReadRowsQuery.__eq__
__eq__(other)
RowRanges are equal if they have the same row keys, row ranges, filter and limit, or if they both represent a full scan with the same filter and limit .
See more: google.cloud.bigtable.data.read_rows_query.ReadRowsQuery.eq
google.cloud.bigtable.data.read_rows_query.ReadRowsQuery.add_key
add_key(row_key: str | bytes)
Add a row key to this query.
See more: google.cloud.bigtable.data.read_rows_query.ReadRowsQuery.add_key
google.cloud.bigtable.data.read_rows_query.ReadRowsQuery.add_range
add_range(row_range: google.cloud.bigtable.data.read_rows_query.RowRange)
Add a range of row keys to this query.
See more: google.cloud.bigtable.data.read_rows_query.ReadRowsQuery.add_range
google.cloud.bigtable.data.read_rows_query.ReadRowsQuery.shard
shard(shard_keys: RowKeySamples) -> ShardedQuery
Split this query into multiple queries that can be evenly distributed across nodes and run in parallel .
See more: google.cloud.bigtable.data.read_rows_query.ReadRowsQuery.shard
google.cloud.bigtable.data.read_rows_query.RowRange.__bool__
__bool__() -> bool
Empty RowRanges (representing a full table scan) are falsy, because they can be substituted with None.
See more: google.cloud.bigtable.data.read_rows_query.RowRange.bool
google.cloud.bigtable.data.read_rows_query.RowRange.__str__
__str__() -> str
Represent range as a string, e.g.
See more: google.cloud.bigtable.data.read_rows_query.RowRange.str
google.cloud.bigtable.data.row.Cell.__eq__
__eq__(other) -> bool
Implements ==
operator
.
See more: google.cloud.bigtable.data.row.Cell.eq
google.cloud.bigtable.data.row.Cell.__hash__
__hash__()
Implements hash()
function to fingerprint cell
.
See more: google.cloud.bigtable.data.row.Cell.hash
google.cloud.bigtable.data.row.Cell.__int__
__int__() -> int
Allows casting cell to int Interprets value as a 64-bit big-endian signed integer, as expected by ReadModifyWrite increment rule .
See more: google.cloud.bigtable.data.row.Cell.int
google.cloud.bigtable.data.row.Cell.__lt__
__lt__(other) -> bool
Implements <
operator
.
See more: google.cloud.bigtable.data.row.Cell.lt
google.cloud.bigtable.data.row.Cell.__ne__
__ne__(other) -> bool
Implements !=
operator
.
See more: google.cloud.bigtable.data.row.Cell.ne
google.cloud.bigtable.data.row.Cell.__repr__
__repr__()
Returns a string representation of the cell .
See more: google.cloud.bigtable.data.row.Cell.repr
google.cloud.bigtable.data.row.Cell.__str__
__str__() -> str
Allows casting cell to str Prints encoded byte string, same as printing value directly.
See more: google.cloud.bigtable.data.row.Cell.str
google.cloud.bigtable.data.row.Row
Row(key: bytes, cells: list[google.cloud.bigtable.data.row.Cell])
Row objects are not intended to be created by users.
See more: google.cloud.bigtable.data.row.Row
google.cloud.bigtable.data.row.Row.__contains__
__contains__(item)
Implements in
operator.
google.cloud.bigtable.data.row.Row.__eq__
__eq__(other)
Implements ==
operator
.
See more: google.cloud.bigtable.data.row.Row.eq
google.cloud.bigtable.data.row.Row.__getitem__
Implements [] indexing.
google.cloud.bigtable.data.row.Row.__iter__
__iter__()
Allow iterating over all cells in the row .
See more: google.cloud.bigtable.data.row.Row.iter
google.cloud.bigtable.data.row.Row.__len__
__len__()
Returns the number of cells in the row .
See more: google.cloud.bigtable.data.row.Row.len
google.cloud.bigtable.data.row.Row.__ne__
__ne__(other) -> bool
Implements !=
operator
.
See more: google.cloud.bigtable.data.row.Row.ne
google.cloud.bigtable.data.row.Row.__str__
__str__() -> str
Human-readable string representation::.
See more: google.cloud.bigtable.data.row.Row.str
google.cloud.bigtable.data.row.Row.get_cells
get_cells(
family: typing.Optional[str] = None,
qualifier: typing.Optional[typing.Union[str, bytes]] = None,
) -> list[google.cloud.bigtable.data.row.Cell]
Returns cells sorted in Bigtable native order:
- Family lexicographically ascending
- Qualifier ascending
- Timestamp in reverse chronological order.
google.cloud.bigtable.instance.Instance.app_profile
app_profile(
app_profile_id,
routing_policy_type=None,
description=None,
cluster_id=None,
multi_cluster_ids=None,
allow_transactional_writes=None,
)
Factory to create AppProfile associated with this instance.
See more: google.cloud.bigtable.instance.Instance.app_profile
google.cloud.bigtable.instance.Instance.cluster
cluster(
cluster_id,
location_id=None,
serve_nodes=None,
default_storage_type=None,
kms_key_name=None,
min_serve_nodes=None,
max_serve_nodes=None,
cpu_utilization_percent=None,
)
Factory to create a cluster associated with this instance.
google.cloud.bigtable.instance.Instance.create
create(
location_id=None,
serve_nodes=None,
default_storage_type=None,
clusters=None,
min_serve_nodes=None,
max_serve_nodes=None,
cpu_utilization_percent=None,
)
Create this instance.
google.cloud.bigtable.instance.Instance.delete
delete()
Delete this instance.
google.cloud.bigtable.instance.Instance.exists
exists()
Check whether the instance already exists.
google.cloud.bigtable.instance.Instance.from_pb
from_pb(instance_pb, client)
Creates an instance instance from a protobuf.
google.cloud.bigtable.instance.Instance.get_iam_policy
get_iam_policy(requested_policy_version=None)
Gets the access control policy for an instance resource.
See more: google.cloud.bigtable.instance.Instance.get_iam_policy
google.cloud.bigtable.instance.Instance.list_app_profiles
list_app_profiles()
Lists information about AppProfiles in an instance.
See more: google.cloud.bigtable.instance.Instance.list_app_profiles
google.cloud.bigtable.instance.Instance.list_clusters
list_clusters()
List the clusters in this instance.
See more: google.cloud.bigtable.instance.Instance.list_clusters
google.cloud.bigtable.instance.Instance.list_tables
list_tables()
List the tables in this instance.
See more: google.cloud.bigtable.instance.Instance.list_tables
google.cloud.bigtable.instance.Instance.reload
reload()
Reload the metadata for this instance.
google.cloud.bigtable.instance.Instance.set_iam_policy
set_iam_policy(policy)
Sets the access control policy on an instance resource.
See more: google.cloud.bigtable.instance.Instance.set_iam_policy
google.cloud.bigtable.instance.Instance.table
table(table_id, mutation_timeout=None, app_profile_id=None)
Factory to create a table associated with this instance.
google.cloud.bigtable.instance.Instance.test_iam_permissions
test_iam_permissions(permissions)
Returns permissions that the caller has on the specified instance resource.
See more: google.cloud.bigtable.instance.Instance.test_iam_permissions
google.cloud.bigtable.instance.Instance.update
update()
Updates an instance within a project.
google.cloud.bigtable.row.AppendRow.append_cell_value
append_cell_value(column_family_id, column, value)
Appends a value to an existing cell.
See more: google.cloud.bigtable.row.AppendRow.append_cell_value
google.cloud.bigtable.row.AppendRow.clear
clear()
Removes all currently accumulated modifications on current row.
google.cloud.bigtable.row.AppendRow.commit
commit()
Makes a ReadModifyWriteRow
API request.
google.cloud.bigtable.row.AppendRow.increment_cell_value
increment_cell_value(column_family_id, column, int_value)
Increments a value in an existing cell.
See more: google.cloud.bigtable.row.AppendRow.increment_cell_value
google.cloud.bigtable.row.Cell.from_pb
from_pb(cell_pb)
Create a new cell from a Cell protobuf.
See more: google.cloud.bigtable.row.Cell.from_pb
google.cloud.bigtable.row.ConditionalRow.clear
clear()
Removes all currently accumulated mutations on the current row.
google.cloud.bigtable.row.ConditionalRow.commit
commit()
Makes a CheckAndMutateRow
API request.
google.cloud.bigtable.row.ConditionalRow.delete
delete(state=True)
Deletes this row from the table.
google.cloud.bigtable.row.ConditionalRow.delete_cell
delete_cell(column_family_id, column, time_range=None, state=True)
Deletes cell in this row.
See more: google.cloud.bigtable.row.ConditionalRow.delete_cell
google.cloud.bigtable.row.ConditionalRow.delete_cells
delete_cells(column_family_id, columns, time_range=None, state=True)
Deletes cells in this row.
See more: google.cloud.bigtable.row.ConditionalRow.delete_cells
google.cloud.bigtable.row.ConditionalRow.set_cell
set_cell(column_family_id, column, value, timestamp=None, state=True)
Sets a value in this row.
google.cloud.bigtable.row.DirectRow.clear
clear()
Removes all currently accumulated mutations on the current row.
google.cloud.bigtable.row.DirectRow.commit
commit()
Makes a MutateRow
API request.
google.cloud.bigtable.row.DirectRow.delete
delete()
Deletes this row from the table.
google.cloud.bigtable.row.DirectRow.delete_cell
delete_cell(column_family_id, column, time_range=None)
Deletes cell in this row.
google.cloud.bigtable.row.DirectRow.delete_cells
delete_cells(column_family_id, columns, time_range=None)
Deletes cells in this row.
google.cloud.bigtable.row.DirectRow.get_mutations_size
get_mutations_size()
Gets the total mutations size for current row.
See more: google.cloud.bigtable.row.DirectRow.get_mutations_size
google.cloud.bigtable.row.DirectRow.set_cell
set_cell(column_family_id, column, value, timestamp=None)
Sets a value in this row.
google.cloud.bigtable.row.InvalidChunk.with_traceback
Exception.with_traceback(tb) -- set self.traceback to tb and return self.
See more: google.cloud.bigtable.row.InvalidChunk.with_traceback
google.cloud.bigtable.row.PartialRowData.cell_value
cell_value(column_family_id, column, index=0)
Get a single cell value stored on this instance.
See more: google.cloud.bigtable.row.PartialRowData.cell_value
google.cloud.bigtable.row.PartialRowData.cell_values
cell_values(column_family_id, column, max_count=None)
Get a time series of cells stored on this instance.
See more: google.cloud.bigtable.row.PartialRowData.cell_values
google.cloud.bigtable.row.PartialRowData.find_cells
find_cells(column_family_id, column)
Get a time series of cells stored on this instance.
See more: google.cloud.bigtable.row.PartialRowData.find_cells
google.cloud.bigtable.row.PartialRowData.to_dict
to_dict()
Convert the cells to a dictionary.
google.cloud.bigtable.row_data.PartialRowsData.__iter__
__iter__()
Consume the ReadRowsResponse
s from the stream.
See more: google.cloud.bigtable.row_data.PartialRowsData.iter
google.cloud.bigtable.row_data.PartialRowsData.cancel
cancel()
Cancels the iterator, closing the stream.
See more: google.cloud.bigtable.row_data.PartialRowsData.cancel
google.cloud.bigtable.row_data.PartialRowsData.consume_all
consume_all(max_loops=None)
Consume the streamed responses until there are no more.
See more: google.cloud.bigtable.row_data.PartialRowsData.consume_all
google.cloud.bigtable.row_filters.ApplyLabelFilter.to_pb
to_pb()
Converts the row filter to a protobuf.
See more: google.cloud.bigtable.row_filters.ApplyLabelFilter.to_pb
google.cloud.bigtable.row_filters.BlockAllFilter.to_pb
to_pb()
Converts the row filter to a protobuf.
See more: google.cloud.bigtable.row_filters.BlockAllFilter.to_pb
google.cloud.bigtable.row_filters.CellsColumnLimitFilter.to_pb
to_pb()
Converts the row filter to a protobuf.
See more: google.cloud.bigtable.row_filters.CellsColumnLimitFilter.to_pb
google.cloud.bigtable.row_filters.CellsRowLimitFilter.to_pb
to_pb()
Converts the row filter to a protobuf.
See more: google.cloud.bigtable.row_filters.CellsRowLimitFilter.to_pb
google.cloud.bigtable.row_filters.CellsRowOffsetFilter.to_pb
to_pb()
Converts the row filter to a protobuf.
See more: google.cloud.bigtable.row_filters.CellsRowOffsetFilter.to_pb
google.cloud.bigtable.row_filters.ColumnQualifierRegexFilter.to_pb
to_pb()
Converts the row filter to a protobuf.
See more: google.cloud.bigtable.row_filters.ColumnQualifierRegexFilter.to_pb
google.cloud.bigtable.row_filters.ColumnRangeFilter.to_pb
to_pb()
Converts the row filter to a protobuf.
See more: google.cloud.bigtable.row_filters.ColumnRangeFilter.to_pb
google.cloud.bigtable.row_filters.ConditionalRowFilter.to_pb
to_pb()
Converts the row filter to a protobuf.
See more: google.cloud.bigtable.row_filters.ConditionalRowFilter.to_pb
google.cloud.bigtable.row_filters.FamilyNameRegexFilter.to_pb
to_pb()
Converts the row filter to a protobuf.
See more: google.cloud.bigtable.row_filters.FamilyNameRegexFilter.to_pb
google.cloud.bigtable.row_filters.PassAllFilter.to_pb
to_pb()
Converts the row filter to a protobuf.
See more: google.cloud.bigtable.row_filters.PassAllFilter.to_pb
google.cloud.bigtable.row_filters.RowFilterChain.to_pb
to_pb()
Converts the row filter to a protobuf.
See more: google.cloud.bigtable.row_filters.RowFilterChain.to_pb
google.cloud.bigtable.row_filters.RowFilterUnion.to_pb
to_pb()
Converts the row filter to a protobuf.
See more: google.cloud.bigtable.row_filters.RowFilterUnion.to_pb
google.cloud.bigtable.row_filters.RowKeyRegexFilter.to_pb
to_pb()
Converts the row filter to a protobuf.
See more: google.cloud.bigtable.row_filters.RowKeyRegexFilter.to_pb
google.cloud.bigtable.row_filters.RowSampleFilter.to_pb
to_pb()
Converts the row filter to a protobuf.
See more: google.cloud.bigtable.row_filters.RowSampleFilter.to_pb
google.cloud.bigtable.row_filters.SinkFilter.to_pb
to_pb()
Converts the row filter to a protobuf.
See more: google.cloud.bigtable.row_filters.SinkFilter.to_pb
google.cloud.bigtable.row_filters.StripValueTransformerFilter.to_pb
to_pb()
Converts the row filter to a protobuf.
See more: google.cloud.bigtable.row_filters.StripValueTransformerFilter.to_pb
google.cloud.bigtable.row_filters.TimestampRange.to_pb
to_pb()
Converts the TimestampRange
to a protobuf.
See more: google.cloud.bigtable.row_filters.TimestampRange.to_pb
google.cloud.bigtable.row_filters.TimestampRangeFilter.to_pb
to_pb()
Converts the row filter to a protobuf.
See more: google.cloud.bigtable.row_filters.TimestampRangeFilter.to_pb
google.cloud.bigtable.row_filters.ValueRangeFilter.to_pb
to_pb()
Converts the row filter to a protobuf.
See more: google.cloud.bigtable.row_filters.ValueRangeFilter.to_pb
google.cloud.bigtable.row_filters.ValueRegexFilter.to_pb
to_pb()
Converts the row filter to a protobuf.
See more: google.cloud.bigtable.row_filters.ValueRegexFilter.to_pb
google.cloud.bigtable.row_set.RowRange.get_range_kwargs
get_range_kwargs()
Convert row range object to dict which can be passed to google.bigtable.v2.RowRange add method.
See more: google.cloud.bigtable.row_set.RowRange.get_range_kwargs
google.cloud.bigtable.row_set.RowSet.add_row_key
add_row_key(row_key)
Add row key to row_keys list.
google.cloud.bigtable.row_set.RowSet.add_row_range
add_row_range(row_range)
Add row_range to row_ranges list.
See more: google.cloud.bigtable.row_set.RowSet.add_row_range
google.cloud.bigtable.row_set.RowSet.add_row_range_from_keys
add_row_range_from_keys(
start_key=None, end_key=None, start_inclusive=True, end_inclusive=False
)
Add row range to row_ranges list from the row keys.
See more: google.cloud.bigtable.row_set.RowSet.add_row_range_from_keys
google.cloud.bigtable.row_set.RowSet.add_row_range_with_prefix
add_row_range_with_prefix(row_key_prefix)
Add row range to row_ranges list that start with the row_key_prefix from the row keys.
See more: google.cloud.bigtable.row_set.RowSet.add_row_range_with_prefix
google.cloud.bigtable.table.ClusterState.__eq__
__eq__(other)
Checks if two ClusterState instances(self and other) are equal on the basis of instance variable 'replication_state'.
google.cloud.bigtable.table.ClusterState.__ne__
__ne__(other)
Checks if two ClusterState instances(self and other) are not equal.
google.cloud.bigtable.table.ClusterState.__repr__
__repr__()
Representation of cluster state instance as string value for cluster state.
google.cloud.bigtable.table.Table.append_row
append_row(row_key)
Create a xref_AppendRow associated with this table.
google.cloud.bigtable.table.Table.backup
backup(backup_id, cluster_id=None, expire_time=None)
Factory to create a Backup linked to this Table.
See more: google.cloud.bigtable.table.Table.backup
google.cloud.bigtable.table.Table.column_family
column_family(column_family_id, gc_rule=None)
Factory to create a column family associated with this table.
google.cloud.bigtable.table.Table.conditional_row
conditional_row(row_key, filter_)
Create a xref_ConditionalRow associated with this table.
google.cloud.bigtable.table.Table.create
create(initial_split_keys=[], column_families={})
Creates this table.
See more: google.cloud.bigtable.table.Table.create
google.cloud.bigtable.table.Table.delete
delete()
Delete this table.
See more: google.cloud.bigtable.table.Table.delete
google.cloud.bigtable.table.Table.direct_row
direct_row(row_key)
Create a xref_DirectRow associated with this table.
google.cloud.bigtable.table.Table.drop_by_prefix
drop_by_prefix(row_key_prefix, timeout=None)
For example:.
google.cloud.bigtable.table.Table.exists
exists()
Check whether the table exists.
See more: google.cloud.bigtable.table.Table.exists
google.cloud.bigtable.table.Table.get_cluster_states
get_cluster_states()
List the cluster states owned by this table.
See more: google.cloud.bigtable.table.Table.get_cluster_states
google.cloud.bigtable.table.Table.get_encryption_info
get_encryption_info()
List the encryption info for each cluster owned by this table.
See more: google.cloud.bigtable.table.Table.get_encryption_info
google.cloud.bigtable.table.Table.get_iam_policy
get_iam_policy()
Gets the IAM access control policy for this table.
google.cloud.bigtable.table.Table.list_backups
list_backups(cluster_id=None, filter_=None, order_by=None, page_size=0)
List Backups for this Table.
google.cloud.bigtable.table.Table.list_column_families
list_column_families()
List the column families owned by this table.
See more: google.cloud.bigtable.table.Table.list_column_families
google.cloud.bigtable.table.Table.mutate_rows
mutate_rows(rows, retry=
Mutates multiple rows in bulk.
google.cloud.bigtable.table.Table.mutations_batcher
mutations_batcher(flush_count=100, max_row_bytes=20971520)
Factory to create a mutation batcher associated with this instance.
See more: google.cloud.bigtable.table.Table.mutations_batcher
google.cloud.bigtable.table.Table.read_row
read_row(row_key, filter_=None, retry=
Read a single row from this table.
google.cloud.bigtable.table.Table.read_rows
read_rows(start_key=None, end_key=None, limit=None, filter_=None, end_inclusive=False, row_set=None, retry=
Read rows from this table.
google.cloud.bigtable.table.Table.restore
restore(new_table_id, cluster_id=None, backup_id=None, backup_name=None)
Creates a new Table by restoring from the Backup specified by either
backup_id
or backup_name
.
google.cloud.bigtable.table.Table.row
row(row_key, filter_=None, append=False)
Factory to create a row associated with this table.
See more: google.cloud.bigtable.table.Table.row
google.cloud.bigtable.table.Table.sample_row_keys
sample_row_keys()
Read a sample of row keys in the table.
google.cloud.bigtable.table.Table.set_iam_policy
set_iam_policy(policy)
Sets the IAM access control policy for this table.
google.cloud.bigtable.table.Table.test_iam_permissions
test_iam_permissions(permissions)
Tests whether the caller has the given permissions for this table.
See more: google.cloud.bigtable.table.Table.test_iam_permissions
google.cloud.bigtable.table.Table.truncate
truncate(timeout=None)
Truncate the table.
google.cloud.bigtable.table.Table.yield_rows
yield_rows(**kwargs)
Read rows from this table.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.authorized_view_path
authorized_view_path(
project: str, instance: str, table: str, authorized_view: str
) -> str
Returns a fully-qualified authorized_view string.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.backup_path
backup_path(project: str, instance: str, cluster: str, backup: str) -> str
Returns a fully-qualified backup string.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.check_consistency
check_consistency(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.CheckConsistencyRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
consistency_token: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.bigtable_admin_v2.types.bigtable_table_admin.CheckConsistencyResponse
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.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.cluster_path
cluster_path(project: str, instance: str, cluster: str) -> str
Returns a fully-qualified cluster string.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.common_location_path
common_location_path(project: str, ___location: str) -> str
Returns a fully-qualified ___location string.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.copy_backup
copy_backup(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.CopyBackupRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
backup_id: typing.Optional[str] = None,
source_backup: typing.Optional[str] = None,
expire_time: typing.Optional[google.protobuf.timestamp_pb2.Timestamp] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Copy a Cloud Bigtable backup to a new backup in the destination cluster located in the destination instance and project.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.create_authorized_view
create_authorized_view(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.CreateAuthorizedViewRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
authorized_view: typing.Optional[
google.cloud.bigtable_admin_v2.types.table.AuthorizedView
] = None,
authorized_view_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a new AuthorizedView in a table.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.create_backup
create_backup(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.CreateBackupRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
backup_id: typing.Optional[str] = None,
backup: typing.Optional[google.cloud.bigtable_admin_v2.types.table.Backup] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Starts creating a new Cloud Bigtable Backup.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.create_schema_bundle
create_schema_bundle(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.CreateSchemaBundleRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
schema_bundle_id: typing.Optional[str] = None,
schema_bundle: typing.Optional[
google.cloud.bigtable_admin_v2.types.table.SchemaBundle
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a new schema bundle in the specified table.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.create_table
create_table(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.CreateTableRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
table_id: typing.Optional[str] = None,
table: typing.Optional[google.cloud.bigtable_admin_v2.types.table.Table] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.bigtable_admin_v2.types.table.Table
Creates a new table in the specified instance.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.create_table_from_snapshot
create_table_from_snapshot(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.CreateTableFromSnapshotRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
table_id: typing.Optional[str] = None,
source_snapshot: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a new table from the specified snapshot.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.crypto_key_version_path
crypto_key_version_path(
project: str, ___location: str, key_ring: str, crypto_key: str, crypto_key_version: str
) -> str
Returns a fully-qualified crypto_key_version string.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.delete_authorized_view
delete_authorized_view(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.DeleteAuthorizedViewRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None
Permanently deletes a specified AuthorizedView.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.delete_backup
delete_backup(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.DeleteBackupRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None
Deletes a pending or completed Cloud Bigtable backup.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.delete_schema_bundle
delete_schema_bundle(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.DeleteSchemaBundleRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None
Deletes a schema bundle in the specified table.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.delete_snapshot
delete_snapshot(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.DeleteSnapshotRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None
Permanently deletes the specified snapshot.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.delete_table
delete_table(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.DeleteTableRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None
Permanently deletes a specified table and all of its data.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.drop_row_range
drop_row_range(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.DropRowRangeRequest,
dict,
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None
Permanently drop/delete a row range from a specified table.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.generate_consistency_token
generate_consistency_token(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.GenerateConsistencyTokenRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.GenerateConsistencyTokenResponse
)
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.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.get_authorized_view
get_authorized_view(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.GetAuthorizedViewRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.bigtable_admin_v2.types.table.AuthorizedView
Gets information from a specified AuthorizedView.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.get_backup
get_backup(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.GetBackupRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.bigtable_admin_v2.types.table.Backup
Gets metadata on a pending or completed Cloud Bigtable Backup.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.get_iam_policy
get_iam_policy(
request: typing.Optional[
typing.Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]
] = None,
*,
resource: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the access control policy for a Bigtable resource.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.get_schema_bundle
get_schema_bundle(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.GetSchemaBundleRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.bigtable_admin_v2.types.table.SchemaBundle
Gets metadata information about the specified schema bundle.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.get_snapshot
get_snapshot(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.GetSnapshotRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.bigtable_admin_v2.types.table.Snapshot
Gets metadata information about the specified snapshot.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.get_table
get_table(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.GetTableRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.bigtable_admin_v2.types.table.Table
Gets metadata information about the specified table.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.get_transport_class
get_transport_class(
label: typing.Optional[str] = None,
) -> typing.Type[
google.cloud.bigtable_admin_v2.services.bigtable_table_admin.transports.base.BigtableTableAdminTransport
]
Returns an appropriate transport class.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.instance_path
instance_path(project: str, instance: str) -> str
Returns a fully-qualified instance string.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.list_authorized_views
list_authorized_views(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.ListAuthorizedViewsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
google.cloud.bigtable_admin_v2.services.bigtable_table_admin.pagers.ListAuthorizedViewsAsyncPager
)
Lists all AuthorizedViews from a specific table.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.list_backups
list_backups(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.ListBackupsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
google.cloud.bigtable_admin_v2.services.bigtable_table_admin.pagers.ListBackupsAsyncPager
)
Lists Cloud Bigtable backups.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.list_schema_bundles
list_schema_bundles(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.ListSchemaBundlesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
google.cloud.bigtable_admin_v2.services.bigtable_table_admin.pagers.ListSchemaBundlesAsyncPager
)
Lists all schema bundles associated with the specified table.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.list_snapshots
list_snapshots(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.ListSnapshotsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
google.cloud.bigtable_admin_v2.services.bigtable_table_admin.pagers.ListSnapshotsAsyncPager
)
Lists all snapshots associated with the specified cluster.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.list_tables
list_tables(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.ListTablesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
google.cloud.bigtable_admin_v2.services.bigtable_table_admin.pagers.ListTablesAsyncPager
)
Lists all tables served from a specified instance.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.modify_column_families
modify_column_families(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.ModifyColumnFamiliesRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
modifications: typing.Optional[
typing.MutableSequence[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.ModifyColumnFamiliesRequest.Modification
]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.bigtable_admin_v2.types.table.Table
Performs a series of column family modifications on the specified table.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.parse_authorized_view_path
parse_authorized_view_path(path: str) -> typing.Dict[str, str]
Parses a authorized_view path into its component segments.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.parse_backup_path
parse_backup_path(path: str) -> typing.Dict[str, str]
Parses a backup path into its component segments.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.parse_cluster_path
parse_cluster_path(path: str) -> typing.Dict[str, str]
Parses a cluster path into its component segments.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a ___location path into its component segments.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.parse_crypto_key_version_path
parse_crypto_key_version_path(path: str) -> typing.Dict[str, str]
Parses a crypto_key_version path into its component segments.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.parse_instance_path
parse_instance_path(path: str) -> typing.Dict[str, str]
Parses a instance path into its component segments.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.parse_schema_bundle_path
parse_schema_bundle_path(path: str) -> typing.Dict[str, str]
Parses a schema_bundle path into its component segments.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.parse_snapshot_path
parse_snapshot_path(path: str) -> typing.Dict[str, str]
Parses a snapshot path into its component segments.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.parse_table_path
parse_table_path(path: str) -> typing.Dict[str, str]
Parses a table path into its component segments.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.restore_table
restore_table(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.RestoreTableRequest,
dict,
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
google.cloud.bigtable_admin_v2.overlay.types.async_restore_table.AsyncRestoreTableOperation
)
Create a new table by restoring from a completed backup.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.schema_bundle_path
schema_bundle_path(
project: str, instance: str, table: str, schema_bundle: str
) -> str
Returns a fully-qualified schema_bundle string.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.set_iam_policy
set_iam_policy(
request: typing.Optional[
typing.Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]
] = None,
*,
resource: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the access control policy on a Bigtable resource.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.snapshot_path
snapshot_path(project: str, instance: str, cluster: str, snapshot: str) -> str
Returns a fully-qualified snapshot string.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.snapshot_table
snapshot_table(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.SnapshotTableRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
cluster: typing.Optional[str] = None,
snapshot_id: typing.Optional[str] = None,
description: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a new snapshot in the specified cluster from the specified source table.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.table_path
table_path(project: str, instance: str, table: str) -> str
Returns a fully-qualified table string.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
typing.Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]
] = None,
*,
resource: typing.Optional[str] = None,
permissions: typing.Optional[typing.MutableSequence[str]] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Returns permissions that the caller has on the specified Bigtable resource.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.undelete_table
undelete_table(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.UndeleteTableRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Restores a specified table which was accidentally deleted.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.update_authorized_view
update_authorized_view(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.UpdateAuthorizedViewRequest,
dict,
]
] = None,
*,
authorized_view: typing.Optional[
google.cloud.bigtable_admin_v2.types.table.AuthorizedView
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Updates an AuthorizedView in a table.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.update_backup
update_backup(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.UpdateBackupRequest,
dict,
]
] = None,
*,
backup: typing.Optional[google.cloud.bigtable_admin_v2.types.table.Backup] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.bigtable_admin_v2.types.table.Backup
Updates a pending or completed Cloud Bigtable Backup.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.update_schema_bundle
update_schema_bundle(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.UpdateSchemaBundleRequest,
dict,
]
] = None,
*,
schema_bundle: typing.Optional[
google.cloud.bigtable_admin_v2.types.table.SchemaBundle
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Updates a schema bundle in the specified table.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.update_table
update_table(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.UpdateTableRequest,
dict,
]
] = None,
*,
table: typing.Optional[google.cloud.bigtable_admin_v2.types.table.Table] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Updates a specified table.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminAsyncClient.wait_for_consistency
wait_for_consistency(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.overlay.types.wait_for_consistency_request.WaitForConsistencyRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> bool
Blocks until the mutations for the specified Table that have been
made before the call have been replicated or reads using an app profile with DataBoostIsolationReadOnly
can see all writes committed before the token was created.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.exit
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.authorized_view_path
authorized_view_path(
project: str, instance: str, table: str, authorized_view: str
) -> str
Returns a fully-qualified authorized_view string.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.backup_path
backup_path(project: str, instance: str, cluster: str, backup: str) -> str
Returns a fully-qualified backup string.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.check_consistency
check_consistency(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.CheckConsistencyRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
consistency_token: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.bigtable_admin_v2.types.bigtable_table_admin.CheckConsistencyResponse
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.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.cluster_path
cluster_path(project: str, instance: str, cluster: str) -> str
Returns a fully-qualified cluster string.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.common_location_path
common_location_path(project: str, ___location: str) -> str
Returns a fully-qualified ___location string.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.copy_backup
copy_backup(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.CopyBackupRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
backup_id: typing.Optional[str] = None,
source_backup: typing.Optional[str] = None,
expire_time: typing.Optional[google.protobuf.timestamp_pb2.Timestamp] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Copy a Cloud Bigtable backup to a new backup in the destination cluster located in the destination instance and project.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.create_authorized_view
create_authorized_view(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.CreateAuthorizedViewRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
authorized_view: typing.Optional[
google.cloud.bigtable_admin_v2.types.table.AuthorizedView
] = None,
authorized_view_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Creates a new AuthorizedView in a table.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.create_backup
create_backup(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.CreateBackupRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
backup_id: typing.Optional[str] = None,
backup: typing.Optional[google.cloud.bigtable_admin_v2.types.table.Backup] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Starts creating a new Cloud Bigtable Backup.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.create_schema_bundle
create_schema_bundle(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.CreateSchemaBundleRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
schema_bundle_id: typing.Optional[str] = None,
schema_bundle: typing.Optional[
google.cloud.bigtable_admin_v2.types.table.SchemaBundle
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Creates a new schema bundle in the specified table.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.create_table
create_table(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.CreateTableRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
table_id: typing.Optional[str] = None,
table: typing.Optional[google.cloud.bigtable_admin_v2.types.table.Table] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.bigtable_admin_v2.types.table.Table
Creates a new table in the specified instance.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.create_table_from_snapshot
create_table_from_snapshot(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.CreateTableFromSnapshotRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
table_id: typing.Optional[str] = None,
source_snapshot: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Creates a new table from the specified snapshot.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.crypto_key_version_path
crypto_key_version_path(
project: str, ___location: str, key_ring: str, crypto_key: str, crypto_key_version: str
) -> str
Returns a fully-qualified crypto_key_version string.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.delete_authorized_view
delete_authorized_view(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.DeleteAuthorizedViewRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None
Permanently deletes a specified AuthorizedView.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.delete_backup
delete_backup(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.DeleteBackupRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None
Deletes a pending or completed Cloud Bigtable backup.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.delete_schema_bundle
delete_schema_bundle(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.DeleteSchemaBundleRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None
Deletes a schema bundle in the specified table.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.delete_snapshot
delete_snapshot(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.DeleteSnapshotRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None
Permanently deletes the specified snapshot.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.delete_table
delete_table(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.DeleteTableRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None
Permanently deletes a specified table and all of its data.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.drop_row_range
drop_row_range(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.DropRowRangeRequest,
dict,
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None
Permanently drop/delete a row range from a specified table.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.generate_consistency_token
generate_consistency_token(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.GenerateConsistencyTokenRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.GenerateConsistencyTokenResponse
)
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.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.get_authorized_view
get_authorized_view(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.GetAuthorizedViewRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.bigtable_admin_v2.types.table.AuthorizedView
Gets information from a specified AuthorizedView.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.get_backup
get_backup(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.GetBackupRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.bigtable_admin_v2.types.table.Backup
Gets metadata on a pending or completed Cloud Bigtable Backup.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.get_iam_policy
get_iam_policy(
request: typing.Optional[
typing.Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]
] = None,
*,
resource: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the access control policy for a Bigtable resource.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.get_schema_bundle
get_schema_bundle(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.GetSchemaBundleRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.bigtable_admin_v2.types.table.SchemaBundle
Gets metadata information about the specified schema bundle.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.get_snapshot
get_snapshot(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.GetSnapshotRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.bigtable_admin_v2.types.table.Snapshot
Gets metadata information about the specified snapshot.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.get_table
get_table(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.GetTableRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.bigtable_admin_v2.types.table.Table
Gets metadata information about the specified table.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.instance_path
instance_path(project: str, instance: str) -> str
Returns a fully-qualified instance string.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.list_authorized_views
list_authorized_views(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.ListAuthorizedViewsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
google.cloud.bigtable_admin_v2.services.bigtable_table_admin.pagers.ListAuthorizedViewsPager
)
Lists all AuthorizedViews from a specific table.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.list_backups
list_backups(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.ListBackupsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
google.cloud.bigtable_admin_v2.services.bigtable_table_admin.pagers.ListBackupsPager
)
Lists Cloud Bigtable backups.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.list_schema_bundles
list_schema_bundles(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.ListSchemaBundlesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
google.cloud.bigtable_admin_v2.services.bigtable_table_admin.pagers.ListSchemaBundlesPager
)
Lists all schema bundles associated with the specified table.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.list_snapshots
list_snapshots(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.ListSnapshotsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
google.cloud.bigtable_admin_v2.services.bigtable_table_admin.pagers.ListSnapshotsPager
)
Lists all snapshots associated with the specified cluster.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.list_tables
list_tables(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.ListTablesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
google.cloud.bigtable_admin_v2.services.bigtable_table_admin.pagers.ListTablesPager
)
Lists all tables served from a specified instance.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.modify_column_families
modify_column_families(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.ModifyColumnFamiliesRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
modifications: typing.Optional[
typing.MutableSequence[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.ModifyColumnFamiliesRequest.Modification
]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.bigtable_admin_v2.types.table.Table
Performs a series of column family modifications on the specified table.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.parse_authorized_view_path
parse_authorized_view_path(path: str) -> typing.Dict[str, str]
Parses a authorized_view path into its component segments.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.parse_backup_path
parse_backup_path(path: str) -> typing.Dict[str, str]
Parses a backup path into its component segments.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.parse_cluster_path
parse_cluster_path(path: str) -> typing.Dict[str, str]
Parses a cluster path into its component segments.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a ___location path into its component segments.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.parse_crypto_key_version_path
parse_crypto_key_version_path(path: str) -> typing.Dict[str, str]
Parses a crypto_key_version path into its component segments.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.parse_instance_path
parse_instance_path(path: str) -> typing.Dict[str, str]
Parses a instance path into its component segments.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.parse_schema_bundle_path
parse_schema_bundle_path(path: str) -> typing.Dict[str, str]
Parses a schema_bundle path into its component segments.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.parse_snapshot_path
parse_snapshot_path(path: str) -> typing.Dict[str, str]
Parses a snapshot path into its component segments.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.parse_table_path
parse_table_path(path: str) -> typing.Dict[str, str]
Parses a table path into its component segments.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.restore_table
restore_table(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.RestoreTableRequest,
dict,
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.bigtable_admin_v2.overlay.types.restore_table.RestoreTableOperation
Create a new table by restoring from a completed backup.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.schema_bundle_path
schema_bundle_path(
project: str, instance: str, table: str, schema_bundle: str
) -> str
Returns a fully-qualified schema_bundle string.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.set_iam_policy
set_iam_policy(
request: typing.Optional[
typing.Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]
] = None,
*,
resource: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the access control policy on a Bigtable resource.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.snapshot_path
snapshot_path(project: str, instance: str, cluster: str, snapshot: str) -> str
Returns a fully-qualified snapshot string.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.snapshot_table
snapshot_table(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.SnapshotTableRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
cluster: typing.Optional[str] = None,
snapshot_id: typing.Optional[str] = None,
description: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Creates a new snapshot in the specified cluster from the specified source table.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.table_path
table_path(project: str, instance: str, table: str) -> str
Returns a fully-qualified table string.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
typing.Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]
] = None,
*,
resource: typing.Optional[str] = None,
permissions: typing.Optional[typing.MutableSequence[str]] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Returns permissions that the caller has on the specified Bigtable resource.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.undelete_table
undelete_table(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.UndeleteTableRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Restores a specified table which was accidentally deleted.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.update_authorized_view
update_authorized_view(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.UpdateAuthorizedViewRequest,
dict,
]
] = None,
*,
authorized_view: typing.Optional[
google.cloud.bigtable_admin_v2.types.table.AuthorizedView
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Updates an AuthorizedView in a table.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.update_backup
update_backup(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.UpdateBackupRequest,
dict,
]
] = None,
*,
backup: typing.Optional[google.cloud.bigtable_admin_v2.types.table.Backup] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.bigtable_admin_v2.types.table.Backup
Updates a pending or completed Cloud Bigtable Backup.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.update_schema_bundle
update_schema_bundle(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.UpdateSchemaBundleRequest,
dict,
]
] = None,
*,
schema_bundle: typing.Optional[
google.cloud.bigtable_admin_v2.types.table.SchemaBundle
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Updates a schema bundle in the specified table.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.update_table
update_table(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.UpdateTableRequest,
dict,
]
] = None,
*,
table: typing.Optional[google.cloud.bigtable_admin_v2.types.table.Table] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Updates a specified table.
google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin.BigtableTableAdminClient.wait_for_consistency
wait_for_consistency(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.overlay.types.wait_for_consistency_request.WaitForConsistencyRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> bool
Blocks until the mutations for the specified Table that have been
made before the call have been replicated or reads using an app profile with DataBoostIsolationReadOnly
can see all writes committed before the token was created.
google.cloud.bigtable_admin_v2.overlay.types.AsyncRestoreTableOperation.optimize_restored_table_operation
optimize_restored_table_operation() -> (
typing.Optional[google.api_core.operation_async.AsyncOperation]
)
Gets the OptimizeRestoredTable long-running operation that runs after this operation finishes.
google.cloud.bigtable_admin_v2.overlay.types.RestoreTableOperation.optimize_restored_table_operation
optimize_restored_table_operation() -> (
typing.Optional[google.api_core.operation.Operation]
)
Gets the OptimizeRestoredTable long-running operation that runs after this operation finishes.
See more: google.cloud.bigtable_admin_v2.overlay.types.RestoreTableOperation.optimize_restored_table_operation
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminAsyncClient
BigtableInstanceAdminAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.transports.base.BigtableInstanceAdminTransport, typing.Callable[[...], google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.transports.base.BigtableInstanceAdminTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the bigtable instance admin async client.
See more: google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminAsyncClient
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminAsyncClient.app_profile_path
app_profile_path(project: str, instance: str, app_profile: str) -> str
Returns a fully-qualified app_profile string.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminAsyncClient.cluster_path
cluster_path(project: str, instance: str, cluster: str) -> str
Returns a fully-qualified cluster string.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminAsyncClient.common_location_path
common_location_path(project: str, ___location: str) -> str
Returns a fully-qualified ___location string.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminAsyncClient.create_app_profile
create_app_profile(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.CreateAppProfileRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
app_profile_id: typing.Optional[str] = None,
app_profile: typing.Optional[
google.cloud.bigtable_admin_v2.types.instance.AppProfile
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.bigtable_admin_v2.types.instance.AppProfile
Creates an app profile within an instance.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminAsyncClient.create_cluster
create_cluster(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.CreateClusterRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
cluster_id: typing.Optional[str] = None,
cluster: typing.Optional[
google.cloud.bigtable_admin_v2.types.instance.Cluster
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a cluster within an instance.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminAsyncClient.create_instance
create_instance(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.CreateInstanceRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
instance_id: typing.Optional[str] = None,
instance: typing.Optional[
google.cloud.bigtable_admin_v2.types.instance.Instance
] = None,
clusters: typing.Optional[
typing.MutableMapping[
str, google.cloud.bigtable_admin_v2.types.instance.Cluster
]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Create an instance within a project.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminAsyncClient.create_logical_view
create_logical_view(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.CreateLogicalViewRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
logical_view: typing.Optional[
google.cloud.bigtable_admin_v2.types.instance.LogicalView
] = None,
logical_view_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a logical view within an instance.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminAsyncClient.create_materialized_view
create_materialized_view(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.CreateMaterializedViewRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
materialized_view: typing.Optional[
google.cloud.bigtable_admin_v2.types.instance.MaterializedView
] = None,
materialized_view_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a materialized view within an instance.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminAsyncClient.crypto_key_path
crypto_key_path(project: str, ___location: str, key_ring: str, crypto_key: str) -> str
Returns a fully-qualified crypto_key string.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminAsyncClient.delete_app_profile
delete_app_profile(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.DeleteAppProfileRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
ignore_warnings: typing.Optional[bool] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None
Deletes an app profile from an instance.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminAsyncClient.delete_cluster
delete_cluster(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.DeleteClusterRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None
Deletes a cluster from an instance.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminAsyncClient.delete_instance
delete_instance(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.DeleteInstanceRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None
Delete an instance from a project.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminAsyncClient.delete_logical_view
delete_logical_view(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.DeleteLogicalViewRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None
Deletes a logical view from an instance.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminAsyncClient.delete_materialized_view
delete_materialized_view(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.DeleteMaterializedViewRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None
Deletes a materialized view from an instance.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminAsyncClient.get_app_profile
get_app_profile(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.GetAppProfileRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.bigtable_admin_v2.types.instance.AppProfile
Gets information about an app profile.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminAsyncClient.get_cluster
get_cluster(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.GetClusterRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.bigtable_admin_v2.types.instance.Cluster
Gets information about a cluster.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminAsyncClient.get_iam_policy
get_iam_policy(
request: typing.Optional[
typing.Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]
] = None,
*,
resource: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the access control policy for an instance resource.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminAsyncClient.get_instance
get_instance(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.GetInstanceRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.bigtable_admin_v2.types.instance.Instance
Gets information about an instance.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminAsyncClient.get_logical_view
get_logical_view(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.GetLogicalViewRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.bigtable_admin_v2.types.instance.LogicalView
Gets information about a logical view.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminAsyncClient.get_materialized_view
get_materialized_view(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.GetMaterializedViewRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.bigtable_admin_v2.types.instance.MaterializedView
Gets information about a materialized view.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminAsyncClient.get_transport_class
get_transport_class(
label: typing.Optional[str] = None,
) -> typing.Type[
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.transports.base.BigtableInstanceAdminTransport
]
Returns an appropriate transport class.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminAsyncClient.hot_tablet_path
hot_tablet_path(project: str, instance: str, cluster: str, hot_tablet: str) -> str
Returns a fully-qualified hot_tablet string.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminAsyncClient.instance_path
instance_path(project: str, instance: str) -> str
Returns a fully-qualified instance string.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminAsyncClient.list_app_profiles
list_app_profiles(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.ListAppProfilesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.pagers.ListAppProfilesAsyncPager
)
Lists information about app profiles in an instance.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminAsyncClient.list_clusters
list_clusters(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.ListClustersRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.ListClustersResponse
Lists information about clusters in an instance.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminAsyncClient.list_hot_tablets
list_hot_tablets(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.ListHotTabletsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.pagers.ListHotTabletsAsyncPager
)
Lists hot tablets in a cluster, within the time range provided.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminAsyncClient.list_instances
list_instances(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.ListInstancesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.ListInstancesResponse
Lists information about instances in a project.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminAsyncClient.list_logical_views
list_logical_views(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.ListLogicalViewsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.pagers.ListLogicalViewsAsyncPager
)
Lists information about logical views in an instance.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminAsyncClient.list_materialized_views
list_materialized_views(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.ListMaterializedViewsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.pagers.ListMaterializedViewsAsyncPager
)
Lists information about materialized views in an instance.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminAsyncClient.logical_view_path
logical_view_path(project: str, instance: str, logical_view: str) -> str
Returns a fully-qualified logical_view string.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminAsyncClient.materialized_view_path
materialized_view_path(project: str, instance: str, materialized_view: str) -> str
Returns a fully-qualified materialized_view string.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminAsyncClient.parse_app_profile_path
parse_app_profile_path(path: str) -> typing.Dict[str, str]
Parses a app_profile path into its component segments.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminAsyncClient.parse_cluster_path
parse_cluster_path(path: str) -> typing.Dict[str, str]
Parses a cluster path into its component segments.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a ___location path into its component segments.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminAsyncClient.parse_crypto_key_path
parse_crypto_key_path(path: str) -> typing.Dict[str, str]
Parses a crypto_key path into its component segments.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminAsyncClient.parse_hot_tablet_path
parse_hot_tablet_path(path: str) -> typing.Dict[str, str]
Parses a hot_tablet path into its component segments.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminAsyncClient.parse_instance_path
parse_instance_path(path: str) -> typing.Dict[str, str]
Parses a instance path into its component segments.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminAsyncClient.parse_logical_view_path
parse_logical_view_path(path: str) -> typing.Dict[str, str]
Parses a logical_view path into its component segments.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminAsyncClient.parse_materialized_view_path
parse_materialized_view_path(path: str) -> typing.Dict[str, str]
Parses a materialized_view path into its component segments.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminAsyncClient.parse_table_path
parse_table_path(path: str) -> typing.Dict[str, str]
Parses a table path into its component segments.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminAsyncClient.partial_update_cluster
partial_update_cluster(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.PartialUpdateClusterRequest,
dict,
]
] = None,
*,
cluster: typing.Optional[
google.cloud.bigtable_admin_v2.types.instance.Cluster
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Partially updates a cluster within a project.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminAsyncClient.partial_update_instance
partial_update_instance(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.PartialUpdateInstanceRequest,
dict,
]
] = None,
*,
instance: typing.Optional[
google.cloud.bigtable_admin_v2.types.instance.Instance
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Partially updates an instance within a project.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminAsyncClient.set_iam_policy
set_iam_policy(
request: typing.Optional[
typing.Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]
] = None,
*,
resource: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the access control policy on an instance resource.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminAsyncClient.table_path
table_path(project: str, instance: str, table: str) -> str
Returns a fully-qualified table string.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminAsyncClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
typing.Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]
] = None,
*,
resource: typing.Optional[str] = None,
permissions: typing.Optional[typing.MutableSequence[str]] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Returns permissions that the caller has on the specified instance resource.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminAsyncClient.update_app_profile
update_app_profile(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.UpdateAppProfileRequest,
dict,
]
] = None,
*,
app_profile: typing.Optional[
google.cloud.bigtable_admin_v2.types.instance.AppProfile
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Updates an app profile within an instance.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminAsyncClient.update_cluster
update_cluster(
request: typing.Optional[
typing.Union[google.cloud.bigtable_admin_v2.types.instance.Cluster, dict]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Updates a cluster within an instance.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminAsyncClient.update_instance
update_instance(
request: typing.Optional[
typing.Union[google.cloud.bigtable_admin_v2.types.instance.Instance, dict]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.bigtable_admin_v2.types.instance.Instance
Updates an instance within a project.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminAsyncClient.update_logical_view
update_logical_view(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.UpdateLogicalViewRequest,
dict,
]
] = None,
*,
logical_view: typing.Optional[
google.cloud.bigtable_admin_v2.types.instance.LogicalView
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Updates a logical view within an instance.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminAsyncClient.update_materialized_view
update_materialized_view(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.UpdateMaterializedViewRequest,
dict,
]
] = None,
*,
materialized_view: typing.Optional[
google.cloud.bigtable_admin_v2.types.instance.MaterializedView
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Updates a materialized view within an instance.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient
BigtableInstanceAdminClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.transports.base.BigtableInstanceAdminTransport, typing.Callable[[...], google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.transports.base.BigtableInstanceAdminTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the bigtable instance admin client.
See more: google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.exit
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.app_profile_path
app_profile_path(project: str, instance: str, app_profile: str) -> str
Returns a fully-qualified app_profile string.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.cluster_path
cluster_path(project: str, instance: str, cluster: str) -> str
Returns a fully-qualified cluster string.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.common_location_path
common_location_path(project: str, ___location: str) -> str
Returns a fully-qualified ___location string.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.create_app_profile
create_app_profile(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.CreateAppProfileRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
app_profile_id: typing.Optional[str] = None,
app_profile: typing.Optional[
google.cloud.bigtable_admin_v2.types.instance.AppProfile
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.bigtable_admin_v2.types.instance.AppProfile
Creates an app profile within an instance.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.create_cluster
create_cluster(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.CreateClusterRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
cluster_id: typing.Optional[str] = None,
cluster: typing.Optional[
google.cloud.bigtable_admin_v2.types.instance.Cluster
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Creates a cluster within an instance.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.create_instance
create_instance(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.CreateInstanceRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
instance_id: typing.Optional[str] = None,
instance: typing.Optional[
google.cloud.bigtable_admin_v2.types.instance.Instance
] = None,
clusters: typing.Optional[
typing.MutableMapping[
str, google.cloud.bigtable_admin_v2.types.instance.Cluster
]
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Create an instance within a project.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.create_logical_view
create_logical_view(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.CreateLogicalViewRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
logical_view: typing.Optional[
google.cloud.bigtable_admin_v2.types.instance.LogicalView
] = None,
logical_view_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Creates a logical view within an instance.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.create_materialized_view
create_materialized_view(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.CreateMaterializedViewRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
materialized_view: typing.Optional[
google.cloud.bigtable_admin_v2.types.instance.MaterializedView
] = None,
materialized_view_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Creates a materialized view within an instance.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.crypto_key_path
crypto_key_path(project: str, ___location: str, key_ring: str, crypto_key: str) -> str
Returns a fully-qualified crypto_key string.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.delete_app_profile
delete_app_profile(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.DeleteAppProfileRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
ignore_warnings: typing.Optional[bool] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None
Deletes an app profile from an instance.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.delete_cluster
delete_cluster(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.DeleteClusterRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None
Deletes a cluster from an instance.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.delete_instance
delete_instance(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.DeleteInstanceRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None
Delete an instance from a project.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.delete_logical_view
delete_logical_view(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.DeleteLogicalViewRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None
Deletes a logical view from an instance.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.delete_materialized_view
delete_materialized_view(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.DeleteMaterializedViewRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None
Deletes a materialized view from an instance.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.get_app_profile
get_app_profile(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.GetAppProfileRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.bigtable_admin_v2.types.instance.AppProfile
Gets information about an app profile.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.get_cluster
get_cluster(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.GetClusterRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.bigtable_admin_v2.types.instance.Cluster
Gets information about a cluster.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.get_iam_policy
get_iam_policy(
request: typing.Optional[
typing.Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]
] = None,
*,
resource: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.iam.v1.policy_pb2.Policy
Gets the access control policy for an instance resource.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.get_instance
get_instance(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.GetInstanceRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.bigtable_admin_v2.types.instance.Instance
Gets information about an instance.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.get_logical_view
get_logical_view(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.GetLogicalViewRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.bigtable_admin_v2.types.instance.LogicalView
Gets information about a logical view.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.get_materialized_view
get_materialized_view(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.GetMaterializedViewRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.bigtable_admin_v2.types.instance.MaterializedView
Gets information about a materialized view.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.hot_tablet_path
hot_tablet_path(project: str, instance: str, cluster: str, hot_tablet: str) -> str
Returns a fully-qualified hot_tablet string.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.instance_path
instance_path(project: str, instance: str) -> str
Returns a fully-qualified instance string.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.list_app_profiles
list_app_profiles(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.ListAppProfilesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.pagers.ListAppProfilesPager
)
Lists information about app profiles in an instance.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.list_clusters
list_clusters(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.ListClustersRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.ListClustersResponse
Lists information about clusters in an instance.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.list_hot_tablets
list_hot_tablets(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.ListHotTabletsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.pagers.ListHotTabletsPager
)
Lists hot tablets in a cluster, within the time range provided.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.list_instances
list_instances(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.ListInstancesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.ListInstancesResponse
Lists information about instances in a project.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.list_logical_views
list_logical_views(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.ListLogicalViewsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.pagers.ListLogicalViewsPager
)
Lists information about logical views in an instance.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.list_materialized_views
list_materialized_views(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.ListMaterializedViewsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.pagers.ListMaterializedViewsPager
)
Lists information about materialized views in an instance.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.logical_view_path
logical_view_path(project: str, instance: str, logical_view: str) -> str
Returns a fully-qualified logical_view string.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.materialized_view_path
materialized_view_path(project: str, instance: str, materialized_view: str) -> str
Returns a fully-qualified materialized_view string.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.parse_app_profile_path
parse_app_profile_path(path: str) -> typing.Dict[str, str]
Parses a app_profile path into its component segments.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.parse_cluster_path
parse_cluster_path(path: str) -> typing.Dict[str, str]
Parses a cluster path into its component segments.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a ___location path into its component segments.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.parse_crypto_key_path
parse_crypto_key_path(path: str) -> typing.Dict[str, str]
Parses a crypto_key path into its component segments.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.parse_hot_tablet_path
parse_hot_tablet_path(path: str) -> typing.Dict[str, str]
Parses a hot_tablet path into its component segments.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.parse_instance_path
parse_instance_path(path: str) -> typing.Dict[str, str]
Parses a instance path into its component segments.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.parse_logical_view_path
parse_logical_view_path(path: str) -> typing.Dict[str, str]
Parses a logical_view path into its component segments.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.parse_materialized_view_path
parse_materialized_view_path(path: str) -> typing.Dict[str, str]
Parses a materialized_view path into its component segments.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.parse_table_path
parse_table_path(path: str) -> typing.Dict[str, str]
Parses a table path into its component segments.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.partial_update_cluster
partial_update_cluster(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.PartialUpdateClusterRequest,
dict,
]
] = None,
*,
cluster: typing.Optional[
google.cloud.bigtable_admin_v2.types.instance.Cluster
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Partially updates a cluster within a project.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.partial_update_instance
partial_update_instance(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.PartialUpdateInstanceRequest,
dict,
]
] = None,
*,
instance: typing.Optional[
google.cloud.bigtable_admin_v2.types.instance.Instance
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Partially updates an instance within a project.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.set_iam_policy
set_iam_policy(
request: typing.Optional[
typing.Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]
] = None,
*,
resource: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.iam.v1.policy_pb2.Policy
Sets the access control policy on an instance resource.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.table_path
table_path(project: str, instance: str, table: str) -> str
Returns a fully-qualified table string.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.test_iam_permissions
test_iam_permissions(
request: typing.Optional[
typing.Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]
] = None,
*,
resource: typing.Optional[str] = None,
permissions: typing.Optional[typing.MutableSequence[str]] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Returns permissions that the caller has on the specified instance resource.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.update_app_profile
update_app_profile(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.UpdateAppProfileRequest,
dict,
]
] = None,
*,
app_profile: typing.Optional[
google.cloud.bigtable_admin_v2.types.instance.AppProfile
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Updates an app profile within an instance.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.update_cluster
update_cluster(
request: typing.Optional[
typing.Union[google.cloud.bigtable_admin_v2.types.instance.Cluster, dict]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Updates a cluster within an instance.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.update_instance
update_instance(
request: typing.Optional[
typing.Union[google.cloud.bigtable_admin_v2.types.instance.Instance, dict]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.bigtable_admin_v2.types.instance.Instance
Updates an instance within a project.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.update_logical_view
update_logical_view(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.UpdateLogicalViewRequest,
dict,
]
] = None,
*,
logical_view: typing.Optional[
google.cloud.bigtable_admin_v2.types.instance.LogicalView
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Updates a logical view within an instance.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.update_materialized_view
update_materialized_view(
request: typing.Optional[
typing.Union[
google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.UpdateMaterializedViewRequest,
dict,
]
] = None,
*,
materialized_view: typing.Optional[
google.cloud.bigtable_admin_v2.types.instance.MaterializedView
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Updates a materialized view within an instance.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.pagers.ListAppProfilesAsyncPager
ListAppProfilesAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.ListAppProfilesResponse
],
],
request: google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.ListAppProfilesRequest,
response: google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.ListAppProfilesResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiates the pager.
See more: google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.pagers.ListAppProfilesAsyncPager
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.pagers.ListAppProfilesPager
ListAppProfilesPager(
method: typing.Callable[
[...],
google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.ListAppProfilesResponse,
],
request: google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.ListAppProfilesRequest,
response: google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.ListAppProfilesResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiate the pager.
See more: google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.pagers.ListAppProfilesPager
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.pagers.ListHotTabletsAsyncPager
ListHotTabletsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.ListHotTabletsResponse
],
],
request: google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.ListHotTabletsRequest,
response: google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.ListHotTabletsResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiates the pager.
See more: google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.pagers.ListHotTabletsAsyncPager
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.pagers.ListHotTabletsPager
ListHotTabletsPager(
method: typing.Callable[
[...],
google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.ListHotTabletsResponse,
],
request: google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.ListHotTabletsRequest,
response: google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.ListHotTabletsResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiate the pager.
See more: google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.pagers.ListHotTabletsPager
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.pagers.ListLogicalViewsAsyncPager
ListLogicalViewsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.ListLogicalViewsResponse
],
],
request: google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.ListLogicalViewsRequest,
response: google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.ListLogicalViewsResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiates the pager.
See more: google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.pagers.ListLogicalViewsAsyncPager
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.pagers.ListLogicalViewsPager
ListLogicalViewsPager(
method: typing.Callable[
[...],
google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.ListLogicalViewsResponse,
],
request: google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.ListLogicalViewsRequest,
response: google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.ListLogicalViewsResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiate the pager.
See more: google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.pagers.ListLogicalViewsPager
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.pagers.ListMaterializedViewsAsyncPager
ListMaterializedViewsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.ListMaterializedViewsResponse
],
],
request: google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.ListMaterializedViewsRequest,
response: google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.ListMaterializedViewsResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiates the pager.
google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.pagers.ListMaterializedViewsPager
ListMaterializedViewsPager(
method: typing.Callable[
[...],
google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.ListMaterializedViewsResponse,
],
request: google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.ListMaterializedViewsRequest,
response: google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.ListMaterializedViewsResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiate the pager.
See more: google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.pagers.ListMaterializedViewsPager
google.cloud.bigtable_admin_v2.services.bigtable_table_admin.pagers.ListAuthorizedViewsAsyncPager
ListAuthorizedViewsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.ListAuthorizedViewsResponse
],
],
request: google.cloud.bigtable_admin_v2.types.bigtable_table_admin.ListAuthorizedViewsRequest,
response: google.cloud.bigtable_admin_v2.types.bigtable_table_admin.ListAuthorizedViewsResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiates the pager.
See more: google.cloud.bigtable_admin_v2.services.bigtable_table_admin.pagers.ListAuthorizedViewsAsyncPager
google.cloud.bigtable_admin_v2.services.bigtable_table_admin.pagers.ListAuthorizedViewsPager
ListAuthorizedViewsPager(
method: typing.Callable[
[...],
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.ListAuthorizedViewsResponse,
],
request: google.cloud.bigtable_admin_v2.types.bigtable_table_admin.ListAuthorizedViewsRequest,
response: google.cloud.bigtable_admin_v2.types.bigtable_table_admin.ListAuthorizedViewsResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiate the pager.
See more: google.cloud.bigtable_admin_v2.services.bigtable_table_admin.pagers.ListAuthorizedViewsPager
google.cloud.bigtable_admin_v2.services.bigtable_table_admin.pagers.ListBackupsAsyncPager
ListBackupsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.ListBackupsResponse
],
],
request: google.cloud.bigtable_admin_v2.types.bigtable_table_admin.ListBackupsRequest,
response: google.cloud.bigtable_admin_v2.types.bigtable_table_admin.ListBackupsResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiates the pager.
See more: google.cloud.bigtable_admin_v2.services.bigtable_table_admin.pagers.ListBackupsAsyncPager
google.cloud.bigtable_admin_v2.services.bigtable_table_admin.pagers.ListBackupsPager
ListBackupsPager(
method: typing.Callable[
[...],
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.ListBackupsResponse,
],
request: google.cloud.bigtable_admin_v2.types.bigtable_table_admin.ListBackupsRequest,
response: google.cloud.bigtable_admin_v2.types.bigtable_table_admin.ListBackupsResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiate the pager.
See more: google.cloud.bigtable_admin_v2.services.bigtable_table_admin.pagers.ListBackupsPager
google.cloud.bigtable_admin_v2.services.bigtable_table_admin.pagers.ListSchemaBundlesAsyncPager
ListSchemaBundlesAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.ListSchemaBundlesResponse
],
],
request: google.cloud.bigtable_admin_v2.types.bigtable_table_admin.ListSchemaBundlesRequest,
response: google.cloud.bigtable_admin_v2.types.bigtable_table_admin.ListSchemaBundlesResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiates the pager.
See more: google.cloud.bigtable_admin_v2.services.bigtable_table_admin.pagers.ListSchemaBundlesAsyncPager
google.cloud.bigtable_admin_v2.services.bigtable_table_admin.pagers.ListSchemaBundlesPager
ListSchemaBundlesPager(
method: typing.Callable[
[...],
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.ListSchemaBundlesResponse,
],
request: google.cloud.bigtable_admin_v2.types.bigtable_table_admin.ListSchemaBundlesRequest,
response: google.cloud.bigtable_admin_v2.types.bigtable_table_admin.ListSchemaBundlesResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiate the pager.
See more: google.cloud.bigtable_admin_v2.services.bigtable_table_admin.pagers.ListSchemaBundlesPager
google.cloud.bigtable_admin_v2.services.bigtable_table_admin.pagers.ListSnapshotsAsyncPager
ListSnapshotsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.ListSnapshotsResponse
],
],
request: google.cloud.bigtable_admin_v2.types.bigtable_table_admin.ListSnapshotsRequest,
response: google.cloud.bigtable_admin_v2.types.bigtable_table_admin.ListSnapshotsResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiates the pager.
See more: google.cloud.bigtable_admin_v2.services.bigtable_table_admin.pagers.ListSnapshotsAsyncPager
google.cloud.bigtable_admin_v2.services.bigtable_table_admin.pagers.ListSnapshotsPager
ListSnapshotsPager(
method: typing.Callable[
[...],
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.ListSnapshotsResponse,
],
request: google.cloud.bigtable_admin_v2.types.bigtable_table_admin.ListSnapshotsRequest,
response: google.cloud.bigtable_admin_v2.types.bigtable_table_admin.ListSnapshotsResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiate the pager.
See more: google.cloud.bigtable_admin_v2.services.bigtable_table_admin.pagers.ListSnapshotsPager
google.cloud.bigtable_admin_v2.services.bigtable_table_admin.pagers.ListTablesAsyncPager
ListTablesAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.ListTablesResponse
],
],
request: google.cloud.bigtable_admin_v2.types.bigtable_table_admin.ListTablesRequest,
response: google.cloud.bigtable_admin_v2.types.bigtable_table_admin.ListTablesResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiates the pager.
See more: google.cloud.bigtable_admin_v2.services.bigtable_table_admin.pagers.ListTablesAsyncPager
google.cloud.bigtable_admin_v2.services.bigtable_table_admin.pagers.ListTablesPager
ListTablesPager(
method: typing.Callable[
[...],
google.cloud.bigtable_admin_v2.types.bigtable_table_admin.ListTablesResponse,
],
request: google.cloud.bigtable_admin_v2.types.bigtable_table_admin.ListTablesRequest,
response: google.cloud.bigtable_admin_v2.types.bigtable_table_admin.ListTablesResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiate the pager.
See more: google.cloud.bigtable_admin_v2.services.bigtable_table_admin.pagers.ListTablesPager