1. Packages
  2. Google Cloud Native
  3. API Docs
  4. bigtableadmin
  5. bigtableadmin/v2
  6. getTable

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>
Copy
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]
Copy
func LookupTable(ctx *Context, args *LookupTableArgs, opts ...InvokeOption) (*LookupTableResult, error)
func LookupTableOutput(ctx *Context, args *LookupTableOutputArgs, opts ...InvokeOption) LookupTableResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetTableResult> getTable(GetTableArgs args, InvokeOptions options)
public static Output<GetTableResult> getTable(GetTableArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: google-native:bigtableadmin/v2:getTable
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

InstanceId This property is required. string
TableId This property is required. string
Project string
View string
InstanceId This property is required. string
TableId This property is required. string
Project string
View string
instanceId This property is required. String
tableId This property is required. String
project String
view String
instanceId This property is required. string
tableId 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
instanceId This property is required. String
tableId This property is required. String
project String
view String

getTable Result

The following output properties are available:

ChangeStreamConfig Pulumi.GoogleNative.BigtableAdmin.V2.Outputs.ChangeStreamConfigResponse
If specified, enable the change stream on this table. Otherwise, the change stream is disabled and the change stream is not retained.
ClusterStates 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
ColumnFamilies Dictionary<string, string>
The column families configured for this table, mapped by column family ID. Views: SCHEMA_VIEW, STATS_VIEW, FULL
DeletionProtection 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 to MILLIS. 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
RestoreInfo Pulumi.GoogleNative.BigtableAdmin.V2.Outputs.RestoreInfoResponse
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.GoogleNative.BigtableAdmin.V2.Outputs.TableStatsResponse
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.
ChangeStreamConfig ChangeStreamConfigResponse
If specified, enable the change stream on this table. Otherwise, the change stream is disabled and the change stream is not retained.
ClusterStates 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
ColumnFamilies map[string]string
The column families configured for this table, mapped by column family ID. Views: SCHEMA_VIEW, STATS_VIEW, FULL
DeletionProtection 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 to MILLIS. 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
RestoreInfo RestoreInfoResponse
If this table was restored from another data source (e.g. a backup), this field will be populated with information about the restore.
Stats TableStatsResponse
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.
changeStreamConfig ChangeStreamConfigResponse
If specified, enable the change stream on this table. Otherwise, the change stream is disabled and the change stream is not retained.
clusterStates 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
columnFamilies Map<String,String>
The column families configured for this table, mapped by column family ID. Views: SCHEMA_VIEW, STATS_VIEW, FULL
deletionProtection 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 to MILLIS. 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
restoreInfo RestoreInfoResponse
If this table was restored from another data source (e.g. a backup), this field will be populated with information about the restore.
stats TableStatsResponse
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.
changeStreamConfig ChangeStreamConfigResponse
If specified, enable the change stream on this table. Otherwise, the change stream is disabled and the change stream is not retained.
clusterStates {[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
columnFamilies {[key: string]: string}
The column families configured for this table, mapped by column family ID. Views: SCHEMA_VIEW, STATS_VIEW, FULL
deletionProtection 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 to MILLIS. 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
restoreInfo RestoreInfoResponse
If this table was restored from another data source (e.g. a backup), this field will be populated with information about the restore.
stats TableStatsResponse
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_config ChangeStreamConfigResponse
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 to MILLIS. 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 RestoreInfoResponse
If this table was restored from another data source (e.g. a backup), this field will be populated with information about the restore.
stats TableStatsResponse
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.
changeStreamConfig Property Map
If specified, enable the change stream on this table. Otherwise, the change stream is disabled and the change stream is not retained.
clusterStates 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
columnFamilies Map<String>
The column families configured for this table, mapped by column family ID. Views: SCHEMA_VIEW, STATS_VIEW, FULL
deletionProtection 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 to MILLIS. 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
restoreInfo 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.
EndTime This property is required. string
This time that the backup was finished. Row data in the backup will be no newer than this timestamp.
SourceBackup 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/.
SourceTable This property is required. string
Name of the table the backup was created from.
StartTime 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.
EndTime This property is required. string
This time that the backup was finished. Row data in the backup will be no newer than this timestamp.
SourceBackup 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/.
SourceTable This property is required. string
Name of the table the backup was created from.
StartTime 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.
endTime This property is required. String
This time that the backup was finished. Row data in the backup will be no newer than this timestamp.
sourceBackup 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/.
sourceTable This property is required. String
Name of the table the backup was created from.
startTime 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.
endTime This property is required. string
This time that the backup was finished. Row data in the backup will be no newer than this timestamp.
sourceBackup 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/.
sourceTable This property is required. string
Name of the table the backup was created from.
startTime 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.
endTime This property is required. String
This time that the backup was finished. Row data in the backup will be no newer than this timestamp.
sourceBackup 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/.
sourceTable This property is required. String
Name of the table the backup was created from.
startTime 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

RetentionPeriod 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.
RetentionPeriod 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.
retentionPeriod 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.
retentionPeriod 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.
retentionPeriod 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

BackupInfo This property is required. Pulumi.GoogleNative.BigtableAdmin.V2.Inputs.BackupInfoResponse
Information about the backup used to restore the table. The backup may no longer exist.
SourceType This property is required. string
The type of the restore source.
BackupInfo This property is required. BackupInfoResponse
Information about the backup used to restore the table. The backup may no longer exist.
SourceType This property is required. string
The type of the restore source.
backupInfo This property is required. BackupInfoResponse
Information about the backup used to restore the table. The backup may no longer exist.
sourceType This property is required. String
The type of the restore source.
backupInfo This property is required. BackupInfoResponse
Information about the backup used to restore the table. The backup may no longer exist.
sourceType This property is required. string
The type of the restore source.
backup_info This property is required. BackupInfoResponse
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.
backupInfo This property is required. Property Map
Information about the backup used to restore the table. The backup may no longer exist.
sourceType This property is required. String
The type of the restore source.

TableStatsResponse

AverageCellsPerColumn 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.
AverageColumnsPerRow 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.
LogicalDataBytes 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).
RowCount This property is required. string
How many rows are in the table.
AverageCellsPerColumn 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.
AverageColumnsPerRow 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.
LogicalDataBytes 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).
RowCount This property is required. string
How many rows are in the table.
averageCellsPerColumn 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.
averageColumnsPerRow 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.
logicalDataBytes 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).
rowCount This property is required. String
How many rows are in the table.
averageCellsPerColumn 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.
averageColumnsPerRow 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.
logicalDataBytes 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).
rowCount 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.
averageCellsPerColumn 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.
averageColumnsPerRow 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.
logicalDataBytes 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).
rowCount 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