Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
google-native.bigtableadmin/v2.getTable
Explore with Pulumi AI
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
Gets metadata information about the specified table.
Using getTable
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getTable(args: GetTableArgs, opts?: InvokeOptions): Promise<GetTableResult>
function getTableOutput(args: GetTableOutputArgs, opts?: InvokeOptions): Output<GetTableResult>
def get_table(instance_id: Optional[str] = None,
project: Optional[str] = None,
table_id: Optional[str] = None,
view: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetTableResult
def get_table_output(instance_id: Optional[pulumi.Input[str]] = None,
project: Optional[pulumi.Input[str]] = None,
table_id: Optional[pulumi.Input[str]] = None,
view: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetTableResult]
func LookupTable(ctx *Context, args *LookupTableArgs, opts ...InvokeOption) (*LookupTableResult, error)
func LookupTableOutput(ctx *Context, args *LookupTableOutputArgs, opts ...InvokeOption) LookupTableResultOutput
> Note: This function is named LookupTable
in the Go SDK.
public static class GetTable
{
public static Task<GetTableResult> InvokeAsync(GetTableArgs args, InvokeOptions? opts = null)
public static Output<GetTableResult> Invoke(GetTableInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetTableResult> getTable(GetTableArgs args, InvokeOptions options)
public static Output<GetTableResult> getTable(GetTableArgs args, InvokeOptions options)
fn::invoke:
function: google-native:bigtableadmin/v2:getTable
arguments:
# arguments dictionary
The following arguments are supported:
- Instance
Id This property is required. string - Table
Id This property is required. string - Project string
- View string
- Instance
Id This property is required. string - Table
Id This property is required. string - Project string
- View string
- instance
Id This property is required. String - table
Id This property is required. String - project String
- view String
- instance
Id This property is required. string - table
Id This property is required. string - project string
- view string
- instance_
id This property is required. str - table_
id This property is required. str - project str
- view str
- instance
Id This property is required. String - table
Id This property is required. String - project String
- view String
getTable Result
The following output properties are available:
- Change
Stream Pulumi.Config Google Native. Bigtable Admin. V2. Outputs. Change Stream Config Response - If specified, enable the change stream on this table. Otherwise, the change stream is disabled and the change stream is not retained.
- Cluster
States Dictionary<string, string> - Map from cluster ID to per-cluster table state. If it could not be determined whether or not the table has data in a particular cluster (for example, if its zone is unavailable), then there will be an entry for the cluster with UNKNOWN
replication_status
. Views:REPLICATION_VIEW
,ENCRYPTION_VIEW
,FULL
- Column
Families Dictionary<string, string> - The column families configured for this table, mapped by column family ID. Views:
SCHEMA_VIEW
,STATS_VIEW
,FULL
- Deletion
Protection bool - Set to true to make the table protected against data loss. i.e. deleting the following resources through Admin APIs are prohibited: * The table. * The column families in the table. * The instance containing the table. Note one can still delete the data stored in the table through Data APIs.
- Granularity string
- Immutable. The granularity (i.e.
MILLIS
) at which timestamps are stored in this table. Timestamps not matching the granularity will be rejected. If unspecified at creation time, the value will be set toMILLIS
. Views:SCHEMA_VIEW
,FULL
. - Name string
- The unique name of the table. Values are of the form
projects/{project}/instances/{instance}/tables/_a-zA-Z0-9*
. Views:NAME_ONLY
,SCHEMA_VIEW
,REPLICATION_VIEW
,STATS_VIEW
,FULL
- Restore
Info Pulumi.Google Native. Bigtable Admin. V2. Outputs. Restore Info Response - If this table was restored from another data source (e.g. a backup), this field will be populated with information about the restore.
- Stats
Pulumi.
Google Native. Bigtable Admin. V2. Outputs. Table Stats Response - Only available with STATS_VIEW, this includes summary statistics about the entire table contents. For statistics about a specific column family, see ColumnFamilyStats in the mapped ColumnFamily collection above.
- Change
Stream ChangeConfig Stream Config Response - If specified, enable the change stream on this table. Otherwise, the change stream is disabled and the change stream is not retained.
- Cluster
States map[string]string - Map from cluster ID to per-cluster table state. If it could not be determined whether or not the table has data in a particular cluster (for example, if its zone is unavailable), then there will be an entry for the cluster with UNKNOWN
replication_status
. Views:REPLICATION_VIEW
,ENCRYPTION_VIEW
,FULL
- Column
Families map[string]string - The column families configured for this table, mapped by column family ID. Views:
SCHEMA_VIEW
,STATS_VIEW
,FULL
- Deletion
Protection bool - Set to true to make the table protected against data loss. i.e. deleting the following resources through Admin APIs are prohibited: * The table. * The column families in the table. * The instance containing the table. Note one can still delete the data stored in the table through Data APIs.
- Granularity string
- Immutable. The granularity (i.e.
MILLIS
) at which timestamps are stored in this table. Timestamps not matching the granularity will be rejected. If unspecified at creation time, the value will be set toMILLIS
. Views:SCHEMA_VIEW
,FULL
. - Name string
- The unique name of the table. Values are of the form
projects/{project}/instances/{instance}/tables/_a-zA-Z0-9*
. Views:NAME_ONLY
,SCHEMA_VIEW
,REPLICATION_VIEW
,STATS_VIEW
,FULL
- Restore
Info RestoreInfo Response - If this table was restored from another data source (e.g. a backup), this field will be populated with information about the restore.
- Stats
Table
Stats Response - Only available with STATS_VIEW, this includes summary statistics about the entire table contents. For statistics about a specific column family, see ColumnFamilyStats in the mapped ColumnFamily collection above.
- change
Stream ChangeConfig Stream Config Response - If specified, enable the change stream on this table. Otherwise, the change stream is disabled and the change stream is not retained.
- cluster
States Map<String,String> - Map from cluster ID to per-cluster table state. If it could not be determined whether or not the table has data in a particular cluster (for example, if its zone is unavailable), then there will be an entry for the cluster with UNKNOWN
replication_status
. Views:REPLICATION_VIEW
,ENCRYPTION_VIEW
,FULL
- column
Families Map<String,String> - The column families configured for this table, mapped by column family ID. Views:
SCHEMA_VIEW
,STATS_VIEW
,FULL
- deletion
Protection Boolean - Set to true to make the table protected against data loss. i.e. deleting the following resources through Admin APIs are prohibited: * The table. * The column families in the table. * The instance containing the table. Note one can still delete the data stored in the table through Data APIs.
- granularity String
- Immutable. The granularity (i.e.
MILLIS
) at which timestamps are stored in this table. Timestamps not matching the granularity will be rejected. If unspecified at creation time, the value will be set toMILLIS
. Views:SCHEMA_VIEW
,FULL
. - name String
- The unique name of the table. Values are of the form
projects/{project}/instances/{instance}/tables/_a-zA-Z0-9*
. Views:NAME_ONLY
,SCHEMA_VIEW
,REPLICATION_VIEW
,STATS_VIEW
,FULL
- restore
Info RestoreInfo Response - If this table was restored from another data source (e.g. a backup), this field will be populated with information about the restore.
- stats
Table
Stats Response - Only available with STATS_VIEW, this includes summary statistics about the entire table contents. For statistics about a specific column family, see ColumnFamilyStats in the mapped ColumnFamily collection above.
- change
Stream ChangeConfig Stream Config Response - If specified, enable the change stream on this table. Otherwise, the change stream is disabled and the change stream is not retained.
- cluster
States {[key: string]: string} - Map from cluster ID to per-cluster table state. If it could not be determined whether or not the table has data in a particular cluster (for example, if its zone is unavailable), then there will be an entry for the cluster with UNKNOWN
replication_status
. Views:REPLICATION_VIEW
,ENCRYPTION_VIEW
,FULL
- column
Families {[key: string]: string} - The column families configured for this table, mapped by column family ID. Views:
SCHEMA_VIEW
,STATS_VIEW
,FULL
- deletion
Protection boolean - Set to true to make the table protected against data loss. i.e. deleting the following resources through Admin APIs are prohibited: * The table. * The column families in the table. * The instance containing the table. Note one can still delete the data stored in the table through Data APIs.
- granularity string
- Immutable. The granularity (i.e.
MILLIS
) at which timestamps are stored in this table. Timestamps not matching the granularity will be rejected. If unspecified at creation time, the value will be set toMILLIS
. Views:SCHEMA_VIEW
,FULL
. - name string
- The unique name of the table. Values are of the form
projects/{project}/instances/{instance}/tables/_a-zA-Z0-9*
. Views:NAME_ONLY
,SCHEMA_VIEW
,REPLICATION_VIEW
,STATS_VIEW
,FULL
- restore
Info RestoreInfo Response - If this table was restored from another data source (e.g. a backup), this field will be populated with information about the restore.
- stats
Table
Stats Response - Only available with STATS_VIEW, this includes summary statistics about the entire table contents. For statistics about a specific column family, see ColumnFamilyStats in the mapped ColumnFamily collection above.
- change_
stream_ Changeconfig Stream Config Response - If specified, enable the change stream on this table. Otherwise, the change stream is disabled and the change stream is not retained.
- cluster_
states Mapping[str, str] - Map from cluster ID to per-cluster table state. If it could not be determined whether or not the table has data in a particular cluster (for example, if its zone is unavailable), then there will be an entry for the cluster with UNKNOWN
replication_status
. Views:REPLICATION_VIEW
,ENCRYPTION_VIEW
,FULL
- column_
families Mapping[str, str] - The column families configured for this table, mapped by column family ID. Views:
SCHEMA_VIEW
,STATS_VIEW
,FULL
- deletion_
protection bool - Set to true to make the table protected against data loss. i.e. deleting the following resources through Admin APIs are prohibited: * The table. * The column families in the table. * The instance containing the table. Note one can still delete the data stored in the table through Data APIs.
- granularity str
- Immutable. The granularity (i.e.
MILLIS
) at which timestamps are stored in this table. Timestamps not matching the granularity will be rejected. If unspecified at creation time, the value will be set toMILLIS
. Views:SCHEMA_VIEW
,FULL
. - name str
- The unique name of the table. Values are of the form
projects/{project}/instances/{instance}/tables/_a-zA-Z0-9*
. Views:NAME_ONLY
,SCHEMA_VIEW
,REPLICATION_VIEW
,STATS_VIEW
,FULL
- restore_
info RestoreInfo Response - If this table was restored from another data source (e.g. a backup), this field will be populated with information about the restore.
- stats
Table
Stats Response - Only available with STATS_VIEW, this includes summary statistics about the entire table contents. For statistics about a specific column family, see ColumnFamilyStats in the mapped ColumnFamily collection above.
- change
Stream Property MapConfig - If specified, enable the change stream on this table. Otherwise, the change stream is disabled and the change stream is not retained.
- cluster
States Map<String> - Map from cluster ID to per-cluster table state. If it could not be determined whether or not the table has data in a particular cluster (for example, if its zone is unavailable), then there will be an entry for the cluster with UNKNOWN
replication_status
. Views:REPLICATION_VIEW
,ENCRYPTION_VIEW
,FULL
- column
Families Map<String> - The column families configured for this table, mapped by column family ID. Views:
SCHEMA_VIEW
,STATS_VIEW
,FULL
- deletion
Protection Boolean - Set to true to make the table protected against data loss. i.e. deleting the following resources through Admin APIs are prohibited: * The table. * The column families in the table. * The instance containing the table. Note one can still delete the data stored in the table through Data APIs.
- granularity String
- Immutable. The granularity (i.e.
MILLIS
) at which timestamps are stored in this table. Timestamps not matching the granularity will be rejected. If unspecified at creation time, the value will be set toMILLIS
. Views:SCHEMA_VIEW
,FULL
. - name String
- The unique name of the table. Values are of the form
projects/{project}/instances/{instance}/tables/_a-zA-Z0-9*
. Views:NAME_ONLY
,SCHEMA_VIEW
,REPLICATION_VIEW
,STATS_VIEW
,FULL
- restore
Info Property Map - If this table was restored from another data source (e.g. a backup), this field will be populated with information about the restore.
- stats Property Map
- Only available with STATS_VIEW, this includes summary statistics about the entire table contents. For statistics about a specific column family, see ColumnFamilyStats in the mapped ColumnFamily collection above.
Supporting Types
BackupInfoResponse
- Backup
This property is required. string - Name of the backup.
- End
Time This property is required. string - This time that the backup was finished. Row data in the backup will be no newer than this timestamp.
- Source
Backup This property is required. string - Name of the backup from which this backup was copied. If a backup is not created by copying a backup, this field will be empty. Values are of the form: projects//instances//backups/.
- Source
Table This property is required. string - Name of the table the backup was created from.
- Start
Time This property is required. string - The time that the backup was started. Row data in the backup will be no older than this timestamp.
- Backup
This property is required. string - Name of the backup.
- End
Time This property is required. string - This time that the backup was finished. Row data in the backup will be no newer than this timestamp.
- Source
Backup This property is required. string - Name of the backup from which this backup was copied. If a backup is not created by copying a backup, this field will be empty. Values are of the form: projects//instances//backups/.
- Source
Table This property is required. string - Name of the table the backup was created from.
- Start
Time This property is required. string - The time that the backup was started. Row data in the backup will be no older than this timestamp.
- backup
This property is required. String - Name of the backup.
- end
Time This property is required. String - This time that the backup was finished. Row data in the backup will be no newer than this timestamp.
- source
Backup This property is required. String - Name of the backup from which this backup was copied. If a backup is not created by copying a backup, this field will be empty. Values are of the form: projects//instances//backups/.
- source
Table This property is required. String - Name of the table the backup was created from.
- start
Time This property is required. String - The time that the backup was started. Row data in the backup will be no older than this timestamp.
- backup
This property is required. string - Name of the backup.
- end
Time This property is required. string - This time that the backup was finished. Row data in the backup will be no newer than this timestamp.
- source
Backup This property is required. string - Name of the backup from which this backup was copied. If a backup is not created by copying a backup, this field will be empty. Values are of the form: projects//instances//backups/.
- source
Table This property is required. string - Name of the table the backup was created from.
- start
Time This property is required. string - The time that the backup was started. Row data in the backup will be no older than this timestamp.
- backup
This property is required. str - Name of the backup.
- end_
time This property is required. str - This time that the backup was finished. Row data in the backup will be no newer than this timestamp.
- source_
backup This property is required. str - Name of the backup from which this backup was copied. If a backup is not created by copying a backup, this field will be empty. Values are of the form: projects//instances//backups/.
- source_
table This property is required. str - Name of the table the backup was created from.
- start_
time This property is required. str - The time that the backup was started. Row data in the backup will be no older than this timestamp.
- backup
This property is required. String - Name of the backup.
- end
Time This property is required. String - This time that the backup was finished. Row data in the backup will be no newer than this timestamp.
- source
Backup This property is required. String - Name of the backup from which this backup was copied. If a backup is not created by copying a backup, this field will be empty. Values are of the form: projects//instances//backups/.
- source
Table This property is required. String - Name of the table the backup was created from.
- start
Time This property is required. String - The time that the backup was started. Row data in the backup will be no older than this timestamp.
ChangeStreamConfigResponse
- Retention
Period This property is required. string - How long the change stream should be retained. Change stream data older than the retention period will not be returned when reading the change stream from the table. Values must be at least 1 day and at most 7 days, and will be truncated to microsecond granularity.
- Retention
Period This property is required. string - How long the change stream should be retained. Change stream data older than the retention period will not be returned when reading the change stream from the table. Values must be at least 1 day and at most 7 days, and will be truncated to microsecond granularity.
- retention
Period This property is required. String - How long the change stream should be retained. Change stream data older than the retention period will not be returned when reading the change stream from the table. Values must be at least 1 day and at most 7 days, and will be truncated to microsecond granularity.
- retention
Period This property is required. string - How long the change stream should be retained. Change stream data older than the retention period will not be returned when reading the change stream from the table. Values must be at least 1 day and at most 7 days, and will be truncated to microsecond granularity.
- retention_
period This property is required. str - How long the change stream should be retained. Change stream data older than the retention period will not be returned when reading the change stream from the table. Values must be at least 1 day and at most 7 days, and will be truncated to microsecond granularity.
- retention
Period This property is required. String - How long the change stream should be retained. Change stream data older than the retention period will not be returned when reading the change stream from the table. Values must be at least 1 day and at most 7 days, and will be truncated to microsecond granularity.
RestoreInfoResponse
- Backup
Info This property is required. Pulumi.Google Native. Bigtable Admin. V2. Inputs. Backup Info Response - Information about the backup used to restore the table. The backup may no longer exist.
- Source
Type This property is required. string - The type of the restore source.
- Backup
Info This property is required. BackupInfo Response - Information about the backup used to restore the table. The backup may no longer exist.
- Source
Type This property is required. string - The type of the restore source.
- backup
Info This property is required. BackupInfo Response - Information about the backup used to restore the table. The backup may no longer exist.
- source
Type This property is required. String - The type of the restore source.
- backup
Info This property is required. BackupInfo Response - Information about the backup used to restore the table. The backup may no longer exist.
- source
Type This property is required. string - The type of the restore source.
- backup_
info This property is required. BackupInfo Response - Information about the backup used to restore the table. The backup may no longer exist.
- source_
type This property is required. str - The type of the restore source.
- backup
Info This property is required. Property Map - Information about the backup used to restore the table. The backup may no longer exist.
- source
Type This property is required. String - The type of the restore source.
TableStatsResponse
- Average
Cells Per Column This property is required. double - How many cells are present per column (column family, column qualifier) combinations, averaged over all columns in all rows in the table. e.g. A table with 2 rows: * A row with 3 cells in "family:col" and 1 cell in "other:col" (4 cells / 2 columns) * A row with 1 cell in "family:col", 7 cells in "family:other_col", and 7 cells in "other:data" (15 cells / 3 columns) would report (4 + 15)/(2 + 3) = 3.8 in this field.
- Average
Columns Per Row This property is required. double - How many (column family, column qualifier) combinations are present per row in the table, averaged over all rows in the table. e.g. A table with 2 rows: * A row with cells in "family:col" and "other:col" (2 distinct columns) * A row with cells in "family:col", "family:other_col", and "other:data" (3 distinct columns) would report (2 + 3)/2 = 2.5 in this field.
- Logical
Data Bytes This property is required. string - This is roughly how many bytes would be needed to read the entire table (e.g. by streaming all contents out).
- Row
Count This property is required. string - How many rows are in the table.
- Average
Cells Per Column This property is required. float64 - How many cells are present per column (column family, column qualifier) combinations, averaged over all columns in all rows in the table. e.g. A table with 2 rows: * A row with 3 cells in "family:col" and 1 cell in "other:col" (4 cells / 2 columns) * A row with 1 cell in "family:col", 7 cells in "family:other_col", and 7 cells in "other:data" (15 cells / 3 columns) would report (4 + 15)/(2 + 3) = 3.8 in this field.
- Average
Columns Per Row This property is required. float64 - How many (column family, column qualifier) combinations are present per row in the table, averaged over all rows in the table. e.g. A table with 2 rows: * A row with cells in "family:col" and "other:col" (2 distinct columns) * A row with cells in "family:col", "family:other_col", and "other:data" (3 distinct columns) would report (2 + 3)/2 = 2.5 in this field.
- Logical
Data Bytes This property is required. string - This is roughly how many bytes would be needed to read the entire table (e.g. by streaming all contents out).
- Row
Count This property is required. string - How many rows are in the table.
- average
Cells Per Column This property is required. Double - How many cells are present per column (column family, column qualifier) combinations, averaged over all columns in all rows in the table. e.g. A table with 2 rows: * A row with 3 cells in "family:col" and 1 cell in "other:col" (4 cells / 2 columns) * A row with 1 cell in "family:col", 7 cells in "family:other_col", and 7 cells in "other:data" (15 cells / 3 columns) would report (4 + 15)/(2 + 3) = 3.8 in this field.
- average
Columns Per Row This property is required. Double - How many (column family, column qualifier) combinations are present per row in the table, averaged over all rows in the table. e.g. A table with 2 rows: * A row with cells in "family:col" and "other:col" (2 distinct columns) * A row with cells in "family:col", "family:other_col", and "other:data" (3 distinct columns) would report (2 + 3)/2 = 2.5 in this field.
- logical
Data Bytes This property is required. String - This is roughly how many bytes would be needed to read the entire table (e.g. by streaming all contents out).
- row
Count This property is required. String - How many rows are in the table.
- average
Cells Per Column This property is required. number - How many cells are present per column (column family, column qualifier) combinations, averaged over all columns in all rows in the table. e.g. A table with 2 rows: * A row with 3 cells in "family:col" and 1 cell in "other:col" (4 cells / 2 columns) * A row with 1 cell in "family:col", 7 cells in "family:other_col", and 7 cells in "other:data" (15 cells / 3 columns) would report (4 + 15)/(2 + 3) = 3.8 in this field.
- average
Columns Per Row This property is required. number - How many (column family, column qualifier) combinations are present per row in the table, averaged over all rows in the table. e.g. A table with 2 rows: * A row with cells in "family:col" and "other:col" (2 distinct columns) * A row with cells in "family:col", "family:other_col", and "other:data" (3 distinct columns) would report (2 + 3)/2 = 2.5 in this field.
- logical
Data Bytes This property is required. string - This is roughly how many bytes would be needed to read the entire table (e.g. by streaming all contents out).
- row
Count This property is required. string - How many rows are in the table.
- average_
cells_ per_ column This property is required. float - How many cells are present per column (column family, column qualifier) combinations, averaged over all columns in all rows in the table. e.g. A table with 2 rows: * A row with 3 cells in "family:col" and 1 cell in "other:col" (4 cells / 2 columns) * A row with 1 cell in "family:col", 7 cells in "family:other_col", and 7 cells in "other:data" (15 cells / 3 columns) would report (4 + 15)/(2 + 3) = 3.8 in this field.
- average_
columns_ per_ row This property is required. float - How many (column family, column qualifier) combinations are present per row in the table, averaged over all rows in the table. e.g. A table with 2 rows: * A row with cells in "family:col" and "other:col" (2 distinct columns) * A row with cells in "family:col", "family:other_col", and "other:data" (3 distinct columns) would report (2 + 3)/2 = 2.5 in this field.
- logical_
data_ bytes This property is required. str - This is roughly how many bytes would be needed to read the entire table (e.g. by streaming all contents out).
- row_
count This property is required. str - How many rows are in the table.
- average
Cells Per Column This property is required. Number - How many cells are present per column (column family, column qualifier) combinations, averaged over all columns in all rows in the table. e.g. A table with 2 rows: * A row with 3 cells in "family:col" and 1 cell in "other:col" (4 cells / 2 columns) * A row with 1 cell in "family:col", 7 cells in "family:other_col", and 7 cells in "other:data" (15 cells / 3 columns) would report (4 + 15)/(2 + 3) = 3.8 in this field.
- average
Columns Per Row This property is required. Number - How many (column family, column qualifier) combinations are present per row in the table, averaged over all rows in the table. e.g. A table with 2 rows: * A row with cells in "family:col" and "other:col" (2 distinct columns) * A row with cells in "family:col", "family:other_col", and "other:data" (3 distinct columns) would report (2 + 3)/2 = 2.5 in this field.
- logical
Data Bytes This property is required. String - This is roughly how many bytes would be needed to read the entire table (e.g. by streaming all contents out).
- row
Count This property is required. String - How many rows are in the table.
Package Details
- Repository
- Google Cloud Native pulumi/pulumi-google-native
- License
- Apache-2.0
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi