Namespace Google.Cloud.Bigtable.Admin.V2

Classes

AppProfile

A configuration object describing how Cloud Bigtable should treat traffic from a particular end user application.

AppProfile.Types

Container for nested types declared in the AppProfile message type.

AppProfile.Types.MultiClusterRoutingUseAny

Read/write requests are routed to the nearest cluster in the instance, and will fail over to the nearest cluster that is available in the event of transient errors or delays. Clusters in a region are considered equidistant. Choosing this option sacrifices read-your-writes consistency to improve availability.

AppProfile.Types.SingleClusterRouting

Unconditionally routes all read/write requests to a specific cluster. This option preserves read-your-writes consistency but does not improve availability.

AppProfileName

Resource name for the AppProfile resource.

AutoscalingLimits

Limits for the number of nodes a Cluster can autoscale up/down to.

AutoscalingTargets

The Autoscaling targets for a Cluster. These determine the recommended nodes.

Backup

A backup of a Cloud Bigtable table.

Backup.Types

Container for nested types declared in the Backup message type.

BackupInfo

Information about a backup.

BackupName

Resource name for the Backup resource.

BigtableInstanceAdmin

Service for creating, configuring, and deleting Cloud Bigtable Instances and Clusters. Provides access to the Instance and Cluster schemas only, not the tables' metadata or data stored in those tables.

BigtableInstanceAdmin.BigtableInstanceAdminBase

Base class for server-side implementations of BigtableInstanceAdmin

BigtableInstanceAdmin.BigtableInstanceAdminClient

Client for BigtableInstanceAdmin

BigtableInstanceAdminClient

BigtableInstanceAdmin client wrapper, for convenient use.

BigtableInstanceAdminClientBuilder

Builder class for BigtableInstanceAdminClient to provide simple configuration of credentials, endpoint etc.

BigtableInstanceAdminClientImpl

BigtableInstanceAdmin client wrapper implementation, for convenient use.

BigtableInstanceAdminSettings

Settings for BigtableInstanceAdminClient instances.

BigtableTableAdmin

Service for creating, configuring, and deleting Cloud Bigtable tables.

Provides access to the table schemas only, not the data stored within the tables.

BigtableTableAdmin.BigtableTableAdminBase

Base class for server-side implementations of BigtableTableAdmin

BigtableTableAdmin.BigtableTableAdminClient

Client for BigtableTableAdmin

BigtableTableAdminClient

BigtableTableAdmin client wrapper, for convenient use.

BigtableTableAdminClientBuilder

Builder class for BigtableTableAdminClient to provide simple configuration of credentials, endpoint etc.

BigtableTableAdminClientImpl

BigtableTableAdmin client wrapper implementation, for convenient use.

BigtableTableAdminSettings

Settings for BigtableTableAdminClient instances.

CheckConsistencyRequest

Request message for [google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency][google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency]

CheckConsistencyResponse

Response message for [google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency][google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency]

Cluster

A resizable group of nodes in a particular cloud location, capable of serving all [Tables][google.bigtable.admin.v2.Table] in the parent [Instance][google.bigtable.admin.v2.Instance].

Cluster.Types

Container for nested types declared in the Cluster message type.

Cluster.Types.ClusterAutoscalingConfig

Autoscaling config for a cluster.

Cluster.Types.ClusterConfig

Configuration for a cluster.

Cluster.Types.EncryptionConfig

Cloud Key Management Service (Cloud KMS) settings for a CMEK-protected cluster.

ClusterName

Resource name for the Cluster resource.

ColumnFamily

A set of columns within a table which share a common configuration.

CreateAppProfileRequest

Request message for BigtableInstanceAdmin.CreateAppProfile.

CreateBackupMetadata

Metadata type for the operation returned by [CreateBackup][google.bigtable.admin.v2.BigtableTableAdmin.CreateBackup].

CreateBackupRequest

The request for [CreateBackup][google.bigtable.admin.v2.BigtableTableAdmin.CreateBackup].

CreateClusterMetadata

The metadata for the Operation returned by CreateCluster.

CreateClusterRequest

Request message for BigtableInstanceAdmin.CreateCluster.

CreateInstanceMetadata

The metadata for the Operation returned by CreateInstance.

CreateInstanceRequest

Request message for BigtableInstanceAdmin.CreateInstance.

CreateTableFromSnapshotMetadata

The metadata for the Operation returned by CreateTableFromSnapshot.

Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

CreateTableFromSnapshotRequest

Request message for [google.bigtable.admin.v2.BigtableTableAdmin.CreateTableFromSnapshot][google.bigtable.admin.v2.BigtableTableAdmin.CreateTableFromSnapshot]

Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

CreateTableRequest

Request message for [google.bigtable.admin.v2.BigtableTableAdmin.CreateTable][google.bigtable.admin.v2.BigtableTableAdmin.CreateTable]

CreateTableRequest.Types

Container for nested types declared in the CreateTableRequest message type.

CreateTableRequest.Types.Split

An initial split point for a newly created table.

CryptoKeyName

Resource name for the CryptoKey resource.

CryptoKeyVersionName

Resource name for the CryptoKeyVersion resource.

DeleteAppProfileRequest

Request message for BigtableInstanceAdmin.DeleteAppProfile.

DeleteBackupRequest

The request for [DeleteBackup][google.bigtable.admin.v2.BigtableTableAdmin.DeleteBackup].

DeleteClusterRequest

Request message for BigtableInstanceAdmin.DeleteCluster.

DeleteInstanceRequest

Request message for BigtableInstanceAdmin.DeleteInstance.

DeleteSnapshotRequest

Request message for [google.bigtable.admin.v2.BigtableTableAdmin.DeleteSnapshot][google.bigtable.admin.v2.BigtableTableAdmin.DeleteSnapshot]

Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

DeleteTableRequest

Request message for [google.bigtable.admin.v2.BigtableTableAdmin.DeleteTable][google.bigtable.admin.v2.BigtableTableAdmin.DeleteTable]

DropRowRangeRequest

Request message for [google.bigtable.admin.v2.BigtableTableAdmin.DropRowRange][google.bigtable.admin.v2.BigtableTableAdmin.DropRowRange]

EncryptionInfo

Encryption information for a given resource. If this resource is protected with customer managed encryption, the in-use Cloud Key Management Service (Cloud KMS) key version is specified along with its status.

EncryptionInfo.Types

Container for nested types declared in the EncryptionInfo message type.

GcRule

Rule for determining which cells to delete during garbage collection.

GcRule.Types

Container for nested types declared in the GcRule message type.

GcRule.Types.Intersection

A GcRule which deletes cells matching all of the given rules.

GcRule.Types.Union

A GcRule which deletes cells matching any of the given rules.

GenerateConsistencyTokenRequest

Request message for [google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken][google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken]

GenerateConsistencyTokenResponse

Response message for [google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken][google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken]

GetAppProfileRequest

Request message for BigtableInstanceAdmin.GetAppProfile.

GetBackupRequest

The request for [GetBackup][google.bigtable.admin.v2.BigtableTableAdmin.GetBackup].

GetClusterRequest

Request message for BigtableInstanceAdmin.GetCluster.

GetInstanceRequest

Request message for BigtableInstanceAdmin.GetInstance.

GetSnapshotRequest

Request message for [google.bigtable.admin.v2.BigtableTableAdmin.GetSnapshot][google.bigtable.admin.v2.BigtableTableAdmin.GetSnapshot]

Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

GetTableRequest

Request message for [google.bigtable.admin.v2.BigtableTableAdmin.GetTable][google.bigtable.admin.v2.BigtableTableAdmin.GetTable]

Instance

A collection of Bigtable [Tables][google.bigtable.admin.v2.Table] and the resources that serve them. All tables in an instance are served from all [Clusters][google.bigtable.admin.v2.Cluster] in the instance.

Instance.Types

Container for nested types declared in the Instance message type.

InstanceName

Resource name for the Instance resource.

ListAppProfilesRequest

Request message for BigtableInstanceAdmin.ListAppProfiles.

ListAppProfilesResponse

Response message for BigtableInstanceAdmin.ListAppProfiles.

ListBackupsRequest

The request for [ListBackups][google.bigtable.admin.v2.BigtableTableAdmin.ListBackups].

ListBackupsResponse

The response for [ListBackups][google.bigtable.admin.v2.BigtableTableAdmin.ListBackups].

ListClustersRequest

Request message for BigtableInstanceAdmin.ListClusters.

ListClustersResponse

Response message for BigtableInstanceAdmin.ListClusters.

ListInstancesRequest

Request message for BigtableInstanceAdmin.ListInstances.

ListInstancesResponse

Response message for BigtableInstanceAdmin.ListInstances.

ListSnapshotsRequest

Request message for [google.bigtable.admin.v2.BigtableTableAdmin.ListSnapshots][google.bigtable.admin.v2.BigtableTableAdmin.ListSnapshots]

Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

ListSnapshotsResponse

Response message for [google.bigtable.admin.v2.BigtableTableAdmin.ListSnapshots][google.bigtable.admin.v2.BigtableTableAdmin.ListSnapshots]

Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

ListTablesRequest

Request message for [google.bigtable.admin.v2.BigtableTableAdmin.ListTables][google.bigtable.admin.v2.BigtableTableAdmin.ListTables]

ListTablesResponse

Response message for [google.bigtable.admin.v2.BigtableTableAdmin.ListTables][google.bigtable.admin.v2.BigtableTableAdmin.ListTables]

ModifyColumnFamiliesRequest

Request message for [google.bigtable.admin.v2.BigtableTableAdmin.ModifyColumnFamilies][google.bigtable.admin.v2.BigtableTableAdmin.ModifyColumnFamilies]

ModifyColumnFamiliesRequest.Types

Container for nested types declared in the ModifyColumnFamiliesRequest message type.

ModifyColumnFamiliesRequest.Types.Modification

A create, update, or delete of a particular column family.

OperationProgress

Encapsulates progress related information for a Cloud Bigtable long running operation.

OptimizeRestoredTableMetadata

Metadata type for the long-running operation used to track the progress of optimizations performed on a newly restored table. This long-running operation is automatically created by the system after the successful completion of a table restore, and cannot be cancelled.

PartialUpdateClusterMetadata

The metadata for the Operation returned by PartialUpdateCluster.

PartialUpdateClusterRequest

Request message for BigtableInstanceAdmin.PartialUpdateCluster.

PartialUpdateInstanceRequest

Request message for BigtableInstanceAdmin.PartialUpdateInstance.

RestoreInfo

Information about a table restore.

RestoreTableMetadata

Metadata type for the long-running operation returned by [RestoreTable][google.bigtable.admin.v2.BigtableTableAdmin.RestoreTable].

RestoreTableRequest

The request for [RestoreTable][google.bigtable.admin.v2.BigtableTableAdmin.RestoreTable].

Snapshot

A snapshot of a table at a particular time. A snapshot can be used as a checkpoint for data restoration or a data source for a new table.

Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

Snapshot.Types

Container for nested types declared in the Snapshot message type.

SnapshotName

Resource name for the Snapshot resource.

SnapshotTableMetadata

The metadata for the Operation returned by SnapshotTable.

Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

SnapshotTableRequest

Request message for [google.bigtable.admin.v2.BigtableTableAdmin.SnapshotTable][google.bigtable.admin.v2.BigtableTableAdmin.SnapshotTable]

Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

Table

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

Table.Types

Container for nested types declared in the Table message type.

Table.Types.ClusterState

The state of a table's data in a particular cluster.

Table.Types.ClusterState.Types

Container for nested types declared in the ClusterState message type.

UpdateAppProfileMetadata

The metadata for the Operation returned by UpdateAppProfile.

UpdateAppProfileRequest

Request message for BigtableInstanceAdmin.UpdateAppProfile.

UpdateBackupRequest

The request for [UpdateBackup][google.bigtable.admin.v2.BigtableTableAdmin.UpdateBackup].

UpdateClusterMetadata

The metadata for the Operation returned by UpdateCluster.

UpdateInstanceMetadata

The metadata for the Operation returned by UpdateInstance.

Enums

AppProfile.RoutingPolicyOneofCase

Enum of possible cases for the "routing_policy" oneof.

AppProfileName.ResourceNameType

The possible contents of AppProfileName.

Backup.Types.State

Indicates the current state of the backup.

BackupName.ResourceNameType

The possible contents of BackupName.

Cluster.ConfigOneofCase

Enum of possible cases for the "config" oneof.

Cluster.Types.State

Possible states of a cluster.

ClusterName.ResourceNameType

The possible contents of ClusterName.

CryptoKeyName.ResourceNameType

The possible contents of CryptoKeyName.

CryptoKeyVersionName.ResourceNameType

The possible contents of CryptoKeyVersionName.

DropRowRangeRequest.TargetOneofCase

Enum of possible cases for the "target" oneof.

EncryptionInfo.Types.EncryptionType

Possible encryption types for a resource.

GcRule.RuleOneofCase

Enum of possible cases for the "rule" oneof.

Instance.Types.State

Possible states of an instance.

Instance.Types.Type

The type of the instance.

InstanceName.ResourceNameType

The possible contents of InstanceName.

ModifyColumnFamiliesRequest.Types.Modification.ModOneofCase

Enum of possible cases for the "mod" oneof.

RestoreInfo.SourceInfoOneofCase

Enum of possible cases for the "source_info" oneof.

RestoreSourceType

Indicates the type of the restore source.

RestoreTableMetadata.SourceInfoOneofCase

Enum of possible cases for the "source_info" oneof.

RestoreTableRequest.SourceOneofCase

Enum of possible cases for the "source" oneof.

Snapshot.Types.State

Possible states of a snapshot.

SnapshotName.ResourceNameType

The possible contents of SnapshotName.

StorageType

Storage media types for persisting Bigtable data.

Table.Types.ClusterState.Types.ReplicationState

Table replication states.

Table.Types.TimestampGranularity

Possible timestamp granularities to use when keeping multiple versions of data in a table.

Table.Types.View

Defines a view over a table's fields.