Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. bigtableadmin
  5. bigtableadmin/v2
  6. Table

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
pulumi/pulumi-google-native

google-native.bigtableadmin/v2.Table

Explore with Pulumi AI

google-native logo

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
pulumi/pulumi-google-native

    Creates a new table in the specified instance. The table can be created with a full set of initial column families, specified in the request.

    Create Table Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Table(name: string, args: TableArgs, opts?: CustomResourceOptions);
    @overload
def Table(resource_name: str,
          args: TableArgs,
          opts: Optional[ResourceOptions] = None)

@overload
def Table(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          instance_id: Optional[str] = None,
          table_id: Optional[str] = None,
          change_stream_config: Optional[ChangeStreamConfigArgs] = None,
          column_families: Optional[Mapping[str, str]] = None,
          deletion_protection: Optional[bool] = None,
          granularity: Optional[TableGranularity] = None,
          initial_splits: Optional[Sequence[SplitArgs]] = None,
          name: Optional[str] = None,
          project: Optional[str] = None)
    func NewTable(ctx *Context, name string, args TableArgs, opts ...ResourceOption) (*Table, error)
    public Table(string name, TableArgs args, CustomResourceOptions? opts = null)
    public Table(String name, TableArgs args)
public Table(String name, TableArgs args, CustomResourceOptions options)

    type: google-native:bigtableadmin/v2:Table
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args TableArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args TableArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args TableArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TableArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TableArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var exampletableResourceResourceFromBigtableadminv2 = new GoogleNative.BigtableAdmin.V2.Table("exampletableResourceResourceFromBigtableadminv2", new()
{
    InstanceId = "string",
    TableId = "string",
    ChangeStreamConfig = new GoogleNative.BigtableAdmin.V2.Inputs.ChangeStreamConfigArgs
    {
        RetentionPeriod = "string",
    },
    ColumnFamilies = 
    {
        { "string", "string" },
    },
    DeletionProtection = false,
    Granularity = GoogleNative.BigtableAdmin.V2.TableGranularity.TimestampGranularityUnspecified,
    InitialSplits = new[]
    {
        new GoogleNative.BigtableAdmin.V2.Inputs.SplitArgs
        {
            Key = "string",
        },
    },
    Name = "string",
    Project = "string",
});

    example, err := bigtableadmin.NewTable(ctx, "exampletableResourceResourceFromBigtableadminv2", &bigtableadmin.TableArgs{
	InstanceId: pulumi.String("string"),
	TableId:    pulumi.String("string"),
	ChangeStreamConfig: &bigtableadmin.ChangeStreamConfigArgs{
		RetentionPeriod: pulumi.String("string"),
	},
	ColumnFamilies: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	DeletionProtection: pulumi.Bool(false),
	Granularity:        bigtableadmin.TableGranularityTimestampGranularityUnspecified,
	InitialSplits: bigtableadmin.SplitArray{
		&bigtableadmin.SplitArgs{
			Key: pulumi.String("string"),
		},
	},
	Name:    pulumi.String("string"),
	Project: pulumi.String("string"),
})

    var exampletableResourceResourceFromBigtableadminv2 = new Table("exampletableResourceResourceFromBigtableadminv2", TableArgs.builder()
    .instanceId("string")
    .tableId("string")
    .changeStreamConfig(ChangeStreamConfigArgs.builder()
        .retentionPeriod("string")
        .build())
    .columnFamilies(Map.of("string", "string"))
    .deletionProtection(false)
    .granularity("TIMESTAMP_GRANULARITY_UNSPECIFIED")
    .initialSplits(SplitArgs.builder()
        .key("string")
        .build())
    .name("string")
    .project("string")
    .build());

    exampletable_resource_resource_from_bigtableadminv2 = google_native.bigtableadmin.v2.Table("exampletableResourceResourceFromBigtableadminv2",
    instance_id="string",
    table_id="string",
    change_stream_config={
        "retention_period": "string",
    },
    column_families={
        "string": "string",
    },
    deletion_protection=False,
    granularity=google_native.bigtableadmin.v2.TableGranularity.TIMESTAMP_GRANULARITY_UNSPECIFIED,
    initial_splits=[{
        "key": "string",
    }],
    name="string",
    project="string")

    const exampletableResourceResourceFromBigtableadminv2 = new google_native.bigtableadmin.v2.Table("exampletableResourceResourceFromBigtableadminv2", {
    instanceId: "string",
    tableId: "string",
    changeStreamConfig: {
        retentionPeriod: "string",
    },
    columnFamilies: {
        string: "string",
    },
    deletionProtection: false,
    granularity: google_native.bigtableadmin.v2.TableGranularity.TimestampGranularityUnspecified,
    initialSplits: [{
        key: "string",
    }],
    name: "string",
    project: "string",
});

    type: google-native:bigtableadmin/v2:Table
properties:
    changeStreamConfig:
        retentionPeriod: string
    columnFamilies:
        string: string
    deletionProtection: false
    granularity: TIMESTAMP_GRANULARITY_UNSPECIFIED
    initialSplits:
        - key: string
    instanceId: string
    name: string
    project: string
    tableId: string

    Table Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Table resource accepts the following input properties:

    InstanceId string
    TableId string
    The name by which the new table should be referred to within the parent instance, e.g., foobar rather than {parent}/tables/foobar. Maximum 50 characters.
    ChangeStreamConfig Pulumi.GoogleNative.BigtableAdmin.V2.Inputs.ChangeStreamConfig
    If specified, enable the change stream on this table. Otherwise, the change stream is disabled and the change stream is not retained.
    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 Pulumi.GoogleNative.BigtableAdmin.V2.TableGranularity
    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.
    InitialSplits List<Pulumi.GoogleNative.BigtableAdmin.V2.Inputs.Split>
    The optional list of row keys that will be used to initially split the table into several tablets (tablets are similar to HBase regions). Given two split keys, s1 and s2, three tablets will be created, spanning the key ranges: [, s1), [s1, s2), [s2, ). Example: * Row keys := ["a", "apple", "custom", "customer_1", "customer_2", "other", "zz"] * initial_split_keys := ["apple", "customer_1", "customer_2", "other"] * Key assignment: - Tablet 1 [, apple) => {"a"}. - Tablet 2 [apple, customer_1) => {"apple", "custom"}. - Tablet 3 [customer_1, customer_2) => {"customer_1"}. - Tablet 4 [customer_2, other) => {"customer_2"}. - Tablet 5 [other, ) => {"other", "zz"}.
    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
    Project string
    InstanceId string
    TableId string
    The name by which the new table should be referred to within the parent instance, e.g., foobar rather than {parent}/tables/foobar. Maximum 50 characters.
    ChangeStreamConfig ChangeStreamConfigArgs
    If specified, enable the change stream on this table. Otherwise, the change stream is disabled and the change stream is not retained.
    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 TableGranularity
    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.
    InitialSplits []SplitArgs
    The optional list of row keys that will be used to initially split the table into several tablets (tablets are similar to HBase regions). Given two split keys, s1 and s2, three tablets will be created, spanning the key ranges: [, s1), [s1, s2), [s2, ). Example: * Row keys := ["a", "apple", "custom", "customer_1", "customer_2", "other", "zz"] * initial_split_keys := ["apple", "customer_1", "customer_2", "other"] * Key assignment: - Tablet 1 [, apple) => {"a"}. - Tablet 2 [apple, customer_1) => {"apple", "custom"}. - Tablet 3 [customer_1, customer_2) => {"customer_1"}. - Tablet 4 [customer_2, other) => {"customer_2"}. - Tablet 5 [other, ) => {"other", "zz"}.
    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
    Project string
    instanceId String
    tableId String
    The name by which the new table should be referred to within the parent instance, e.g., foobar rather than {parent}/tables/foobar. Maximum 50 characters.
    changeStreamConfig ChangeStreamConfig
    If specified, enable the change stream on this table. Otherwise, the change stream is disabled and the change stream is not retained.
    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 TableGranularity
    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.
    initialSplits List<Split>
    The optional list of row keys that will be used to initially split the table into several tablets (tablets are similar to HBase regions). Given two split keys, s1 and s2, three tablets will be created, spanning the key ranges: [, s1), [s1, s2), [s2, ). Example: * Row keys := ["a", "apple", "custom", "customer_1", "customer_2", "other", "zz"] * initial_split_keys := ["apple", "customer_1", "customer_2", "other"] * Key assignment: - Tablet 1 [, apple) => {"a"}. - Tablet 2 [apple, customer_1) => {"apple", "custom"}. - Tablet 3 [customer_1, customer_2) => {"customer_1"}. - Tablet 4 [customer_2, other) => {"customer_2"}. - Tablet 5 [other, ) => {"other", "zz"}.
    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
    project String
    instanceId string
    tableId string
    The name by which the new table should be referred to within the parent instance, e.g., foobar rather than {parent}/tables/foobar. Maximum 50 characters.
    changeStreamConfig ChangeStreamConfig
    If specified, enable the change stream on this table. Otherwise, the change stream is disabled and the change stream is not retained.
    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 TableGranularity
    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.
    initialSplits Split[]
    The optional list of row keys that will be used to initially split the table into several tablets (tablets are similar to HBase regions). Given two split keys, s1 and s2, three tablets will be created, spanning the key ranges: [, s1), [s1, s2), [s2, ). Example: * Row keys := ["a", "apple", "custom", "customer_1", "customer_2", "other", "zz"] * initial_split_keys := ["apple", "customer_1", "customer_2", "other"] * Key assignment: - Tablet 1 [, apple) => {"a"}. - Tablet 2 [apple, customer_1) => {"apple", "custom"}. - Tablet 3 [customer_1, customer_2) => {"customer_1"}. - Tablet 4 [customer_2, other) => {"customer_2"}. - Tablet 5 [other, ) => {"other", "zz"}.
    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
    project string
    instance_id str
    table_id str
    The name by which the new table should be referred to within the parent instance, e.g., foobar rather than {parent}/tables/foobar. Maximum 50 characters.
    change_stream_config ChangeStreamConfigArgs
    If specified, enable the change stream on this table. Otherwise, the change stream is disabled and the change stream is not retained.
    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 TableGranularity
    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.
    initial_splits Sequence[SplitArgs]
    The optional list of row keys that will be used to initially split the table into several tablets (tablets are similar to HBase regions). Given two split keys, s1 and s2, three tablets will be created, spanning the key ranges: [, s1), [s1, s2), [s2, ). Example: * Row keys := ["a", "apple", "custom", "customer_1", "customer_2", "other", "zz"] * initial_split_keys := ["apple", "customer_1", "customer_2", "other"] * Key assignment: - Tablet 1 [, apple) => {"a"}. - Tablet 2 [apple, customer_1) => {"apple", "custom"}. - Tablet 3 [customer_1, customer_2) => {"customer_1"}. - Tablet 4 [customer_2, other) => {"customer_2"}. - Tablet 5 [other, ) => {"other", "zz"}.
    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
    project str
    instanceId String
    tableId String
    The name by which the new table should be referred to within the parent instance, e.g., foobar rather than {parent}/tables/foobar. Maximum 50 characters.
    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.
    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 "TIMESTAMP_GRANULARITY_UNSPECIFIED" | "MILLIS"
    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.
    initialSplits List<Property Map>
    The optional list of row keys that will be used to initially split the table into several tablets (tablets are similar to HBase regions). Given two split keys, s1 and s2, three tablets will be created, spanning the key ranges: [, s1), [s1, s2), [s2, ). Example: * Row keys := ["a", "apple", "custom", "customer_1", "customer_2", "other", "zz"] * initial_split_keys := ["apple", "customer_1", "customer_2", "other"] * Key assignment: - Tablet 1 [, apple) => {"a"}. - Tablet 2 [apple, customer_1) => {"apple", "custom"}. - Tablet 3 [customer_1, customer_2) => {"customer_1"}. - Tablet 4 [customer_2, other) => {"customer_2"}. - Tablet 5 [other, ) => {"other", "zz"}.
    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
    project String

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Table resource produces the following output properties:

    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
    Id string
    The provider-assigned unique ID for this managed resource.
    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.
    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
    Id string
    The provider-assigned unique ID for this managed resource.
    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.
    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
    id String
    The provider-assigned unique ID for this managed resource.
    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.
    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
    id string
    The provider-assigned unique ID for this managed resource.
    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.
    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
    id str
    The provider-assigned unique ID for this managed resource.
    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.
    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
    id String
    The provider-assigned unique ID for this managed resource.
    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, BackupInfoResponseArgs

    Backup string
    Name of the backup.
    EndTime string
    This time that the backup was finished. Row data in the backup will be no newer than this timestamp.
    SourceBackup 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 string
    Name of the table the backup was created from.
    StartTime string
    The time that the backup was started. Row data in the backup will be no older than this timestamp.
    Backup string
    Name of the backup.
    EndTime string
    This time that the backup was finished. Row data in the backup will be no newer than this timestamp.
    SourceBackup 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 string
    Name of the table the backup was created from.
    StartTime string
    The time that the backup was started. Row data in the backup will be no older than this timestamp.
    backup String
    Name of the backup.
    endTime String
    This time that the backup was finished. Row data in the backup will be no newer than this timestamp.
    sourceBackup 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 String
    Name of the table the backup was created from.
    startTime String
    The time that the backup was started. Row data in the backup will be no older than this timestamp.
    backup string
    Name of the backup.
    endTime string
    This time that the backup was finished. Row data in the backup will be no newer than this timestamp.
    sourceBackup 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 string
    Name of the table the backup was created from.
    startTime string
    The time that the backup was started. Row data in the backup will be no older than this timestamp.
    backup str
    Name of the backup.
    end_time str
    This time that the backup was finished. Row data in the backup will be no newer than this timestamp.
    source_backup 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 str
    Name of the table the backup was created from.
    start_time str
    The time that the backup was started. Row data in the backup will be no older than this timestamp.
    backup String
    Name of the backup.
    endTime String
    This time that the backup was finished. Row data in the backup will be no newer than this timestamp.
    sourceBackup 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 String
    Name of the table the backup was created from.
    startTime String
    The time that the backup was started. Row data in the backup will be no older than this timestamp.

    ChangeStreamConfig, ChangeStreamConfigArgs

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

    ChangeStreamConfigResponse, ChangeStreamConfigResponseArgs

    RetentionPeriod 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 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 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 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 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 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, RestoreInfoResponseArgs

    BackupInfo Pulumi.GoogleNative.BigtableAdmin.V2.Inputs.BackupInfoResponse
    Information about the backup used to restore the table. The backup may no longer exist.
    SourceType string
    The type of the restore source.
    BackupInfo BackupInfoResponse
    Information about the backup used to restore the table. The backup may no longer exist.
    SourceType string
    The type of the restore source.
    backupInfo BackupInfoResponse
    Information about the backup used to restore the table. The backup may no longer exist.
    sourceType String
    The type of the restore source.
    backupInfo BackupInfoResponse
    Information about the backup used to restore the table. The backup may no longer exist.
    sourceType string
    The type of the restore source.
    backup_info BackupInfoResponse
    Information about the backup used to restore the table. The backup may no longer exist.
    source_type str
    The type of the restore source.
    backupInfo Property Map
    Information about the backup used to restore the table. The backup may no longer exist.
    sourceType String
    The type of the restore source.

    Split, SplitArgs

    Key string
    Row key to use as an initial tablet boundary.
    Key string
    Row key to use as an initial tablet boundary.
    key String
    Row key to use as an initial tablet boundary.
    key string
    Row key to use as an initial tablet boundary.
    key str
    Row key to use as an initial tablet boundary.
    key String
    Row key to use as an initial tablet boundary.

    TableGranularity, TableGranularityArgs

    TimestampGranularityUnspecified
    TIMESTAMP_GRANULARITY_UNSPECIFIEDThe user did not specify a granularity. Should not be returned. When specified during table creation, MILLIS will be used.
    Millis
    MILLISThe table keeps data versioned at a granularity of 1ms.
    TableGranularityTimestampGranularityUnspecified
    TIMESTAMP_GRANULARITY_UNSPECIFIEDThe user did not specify a granularity. Should not be returned. When specified during table creation, MILLIS will be used.
    TableGranularityMillis
    MILLISThe table keeps data versioned at a granularity of 1ms.
    TimestampGranularityUnspecified
    TIMESTAMP_GRANULARITY_UNSPECIFIEDThe user did not specify a granularity. Should not be returned. When specified during table creation, MILLIS will be used.
    Millis
    MILLISThe table keeps data versioned at a granularity of 1ms.
    TimestampGranularityUnspecified
    TIMESTAMP_GRANULARITY_UNSPECIFIEDThe user did not specify a granularity. Should not be returned. When specified during table creation, MILLIS will be used.
    Millis
    MILLISThe table keeps data versioned at a granularity of 1ms.
    TIMESTAMP_GRANULARITY_UNSPECIFIED
    TIMESTAMP_GRANULARITY_UNSPECIFIEDThe user did not specify a granularity. Should not be returned. When specified during table creation, MILLIS will be used.
    MILLIS
    MILLISThe table keeps data versioned at a granularity of 1ms.
    "TIMESTAMP_GRANULARITY_UNSPECIFIED"
    TIMESTAMP_GRANULARITY_UNSPECIFIEDThe user did not specify a granularity. Should not be returned. When specified during table creation, MILLIS will be used.
    "MILLIS"
    MILLISThe table keeps data versioned at a granularity of 1ms.

    TableStatsResponse, TableStatsResponseArgs

    AverageCellsPerColumn 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 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 string
    This is roughly how many bytes would be needed to read the entire table (e.g. by streaming all contents out).
    RowCount string
    How many rows are in the table.
    AverageCellsPerColumn 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 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 string
    This is roughly how many bytes would be needed to read the entire table (e.g. by streaming all contents out).
    RowCount string
    How many rows are in the table.
    averageCellsPerColumn 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 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 String
    This is roughly how many bytes would be needed to read the entire table (e.g. by streaming all contents out).
    rowCount String
    How many rows are in the table.
    averageCellsPerColumn 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 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 string
    This is roughly how many bytes would be needed to read the entire table (e.g. by streaming all contents out).
    rowCount string
    How many rows are in the table.
    average_cells_per_column 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 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 str
    This is roughly how many bytes would be needed to read the entire table (e.g. by streaming all contents out).
    row_count str
    How many rows are in the table.
    averageCellsPerColumn 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 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 String
    This is roughly how many bytes would be needed to read the entire table (e.g. by streaming all contents out).
    rowCount String
    How many rows are in the table.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    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
    pulumi/pulumi-google-native