3.36.0 (latest) 3.35.0 3.34.0 3.33.0 3.32.0 3.31.0 3.30.0 3.29.0 3.28.0 3.27.0 3.26.0 3.25.0 3.24.0 3.23.0 3.22.0 3.21.0 3.20.0 3.19.0 3.18.0 3.17.0 3.16.0 3.15.0 3.14.0 3.13.0 3.12.0 3.11.0 3.10.0 3.9.0 3.8.0 3.7.0 3.6.0 3.5.0 3.4.0 3.3.0 3.2.0 3.1.0 3.0.0 2.9.0 2.8.0 2.7.0 2.6.0 2.5.0 2.4.0

    public sealed class Table : IMessage<Table>, IEquatable<Table>, IDeepCloneable<Table>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Cloud Bigtable Administration v2 API class Table.

A collection of user data indexed by row, column, and timestamp.
Each table is served using the resources of its parent cluster.

## Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) \> Table

## Implements

[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[Table](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/latest/Google.Cloud.Bigtable.Admin.V2.Table), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[Table](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/latest/Google.Cloud.Bigtable.Admin.V2.Table), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[Table](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/latest/Google.Cloud.Bigtable.Admin.V2.Table), [IBufferMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IBufferMessage.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage.html)

## Inherited Members

[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) [object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) [object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)

## Namespace

[Google.Cloud.Bigtable.Admin.V2](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/latest/Google.Cloud.Bigtable.Admin.V2)

## Assembly

Google.Cloud.Bigtable.Admin.V2.dll

## Constructors

### Table()

    public Table()

### Table(Table)

    public Table(Table other)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `other` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/latest/Google.Cloud.Bigtable.Admin.V2.Table` |

## Properties

### AutomatedBackupConfigCase

    public Table.AutomatedBackupConfigOneofCase AutomatedBackupConfigCase { get; }

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/latest/Google.Cloud.Bigtable.Admin.V2.Tablehttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/latest/Google.Cloud.Bigtable.Admin.V2.Table.AutomatedBackupConfigOneofCase` |   |

### AutomatedBackupPolicy

    public Table.Types.AutomatedBackupPolicy AutomatedBackupPolicy { get; set; }

If specified, automated backups are enabled for this table.
Otherwise, automated backups are disabled.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/latest/Google.Cloud.Bigtable.Admin.V2.Tablehttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/latest/Google.Cloud.Bigtable.Admin.V2.Table.Typeshttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/latest/Google.Cloud.Bigtable.Admin.V2.Table.Types.AutomatedBackupPolicy` |   |

### ChangeStreamConfig

    public ChangeStreamConfig ChangeStreamConfig { get; set; }

If specified, enable the change stream on this table.
Otherwise, the change stream is disabled and the change stream is not
retained.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/latest/Google.Cloud.Bigtable.Admin.V2.ChangeStreamConfig` |   |

### ClusterStates

    public MapField<string, Table.Types.ClusterState> ClusterStates { get; }

Output only. 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`

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.Collections.MapField-2.htmlhttps://learn.microsoft.com/dotnet/api/system.stringhttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/latest/Google.Cloud.Bigtable.Admin.V2.Tablehttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/latest/Google.Cloud.Bigtable.Admin.V2.Table.Typeshttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/latest/Google.Cloud.Bigtable.Admin.V2.Table.Types.ClusterState` |   |

### ColumnFamilies

    public MapField<string, ColumnFamily> ColumnFamilies { get; }

The column families configured for this table, mapped by column family ID.
Views: `SCHEMA_VIEW`, `STATS_VIEW`, `FULL`

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.Collections.MapField-2.htmlhttps://learn.microsoft.com/dotnet/api/system.stringhttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/latest/Google.Cloud.Bigtable.Admin.V2.ColumnFamily` |   |

### DeletionProtection

    public bool DeletionProtection { get; set; }

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.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.boolean` |   |

### EffectiveAutomatedBackupPolicy

    public Table.Types.AutomatedBackupPolicy EffectiveAutomatedBackupPolicy { get; set; }

Output only. The effective automated backup policy applied to the table.
This represents the policy actually in effect, which may be a
system-default policy if the user has not explicitly configured one.
Views: `SCHEMA_VIEW`, `FULL`.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/latest/Google.Cloud.Bigtable.Admin.V2.Tablehttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/latest/Google.Cloud.Bigtable.Admin.V2.Table.Typeshttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/latest/Google.Cloud.Bigtable.Admin.V2.Table.Types.AutomatedBackupPolicy` |   |

### Granularity

    public Table.Types.TimestampGranularity Granularity { get; set; }

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

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/latest/Google.Cloud.Bigtable.Admin.V2.Tablehttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/latest/Google.Cloud.Bigtable.Admin.V2.Table.Typeshttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/latest/Google.Cloud.Bigtable.Admin.V2.Table.Types.TimestampGranularity` |   |

### Name

    public string Name { get; set; }

The unique name of the table. Values are of the form
`projects/{project}/instances/{instance}/tables/[_a-zA-Z0-9][-_.a-zA-Z0-9]*`.
Views: `NAME_ONLY`, `SCHEMA_VIEW`, `REPLICATION_VIEW`, `FULL`

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### RestoreInfo

    public RestoreInfo RestoreInfo { get; set; }

Output only. If this table was restored from another data source (e.g. a
backup), this field will be populated with information about the restore.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/latest/Google.Cloud.Bigtable.Admin.V2.RestoreInfo` |   |

### RowKeySchema

    public Type.Types.Struct RowKeySchema { get; set; }

The row key schema for this table. The schema is used to decode the raw row
key bytes into a structured format. The order of field declarations in this
schema is important, as it reflects how the raw row key bytes are
structured. Currently, this only affects how the key is read via a
GoogleSQL query from the ExecuteQuery API.

For a SQL query, the _key column is still read as raw bytes. But queries
can reference the key fields by name, which will be decoded from _key using
provided type and encoding. Queries that reference key fields will fail if
they encounter an invalid row key.

For example, if _key = "some_id#2024-04-30#\\x00\\x13\\x00\\xf3" with the
following schema:
{
fields {
field_name: "id"
type { string { encoding: utf8_bytes {} } }
}
fields {
field_name: "date"
type { string { encoding: utf8_bytes {} } }
}
fields {
field_name: "product_code"
type { int64 { encoding: big_endian_bytes {} } }
}
encoding { delimited_bytes { delimiter: "#" } }
}

The decoded key parts would be:
id = "some_id", date = "2024-04-30", product_code = 1245427
The query "SELECT _key, product_code FROM table" will return two columns:
/---\\

| _key | product_code |
|---|---|
| "some_id#2024-04-30#\\x00\\x13\\x00\\xf3" | 1245427 |

---/

The schema has the following invariants:
(1) The decoded field values are order-preserved. For read, the field
values will be decoded in sorted mode from the raw bytes.
(2) Every field in the schema must specify a non-empty name.
(3) Every field must specify a type with an associated encoding. The type
is limited to scalar types only: Array, Map, Aggregate, and Struct are not
allowed.
(4) The field names must not collide with existing column family
names and reserved keywords "_key" and "_timestamp".

The following update operations are allowed for row_key_schema:

- Update from an empty schema to a new schema.
- Remove the existing schema. This operation requires setting the `ignore_warnings` flag to `true`, since it might be a backward incompatible change. Without the flag, the update request will fail with an INVALID_ARGUMENT error. Any other row key schema update operation (e.g. update existing schema columns names or types) is currently unsupported.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/latest/Google.Cloud.Bigtable.Admin.V2.Typehttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/latest/Google.Cloud.Bigtable.Admin.V2.Type.Typeshttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/latest/Google.Cloud.Bigtable.Admin.V2.Type.Types.Struct` |   |

### TableName

    public TableName TableName { get; set; }

[TableName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Bigtable.Common.V2/latest/Google.Cloud.Bigtable.Common.V2.TableName.html)-typed view over the [Name](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/latest/Google.Cloud.Bigtable.Admin.V2.Table#Google_Cloud_Bigtable_Admin_V2_Table_Name) resource name property.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Bigtable.Common.V2/latest/Google.Cloud.Bigtable.Common.V2.TableName.html` |   |

### TieredStorageConfig

    public TieredStorageConfig TieredStorageConfig { get; set; }

Rules to specify what data is stored in each storage tier.
Different tiers store data differently, providing different trade-offs
between cost and performance. Different parts of a table can be stored
separately on different tiers.
If a config is specified, tiered storage is enabled for this table.
Otherwise, tiered storage is disabled.
Only SSD instances can configure tiered storage.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Bigtable.Admin.V2/latest/Google.Cloud.Bigtable.Admin.V2.TieredStorageConfig` |   |