Package com.google.cloud.bigtable.admin.v2.models (2.44.0)
| GitHub Repository |
This package is not the recommended entry point to using this client library!
For this library, we recommend using com.google.cloud.bigtable for new applications.
Classes
| Class | Description |
|---|---|
| com.google.cloud.bigtable.admin.v2.models.AppProfile | An application profile, or app profile, stores settings that tell your Cloud Bigtable instance how to handle incoming requests from an application. When one of your applications connects to a Cloud Bigtable instance, it can specify an app profile, and Cloud Bigtable uses that app profile for any requests that the application sends over that connection. |
| com.google.cloud.bigtable.admin.v2.models.AppProfile.DataBoostIsolationReadOnlyPolicy | A Data Boost Read Only IsolationPolicy for running high-throughput read traffic on your Bigtable data without affecting application traffic. Data Boost App Profile needs to be created with a ComputeBillingOwner which specifies how usage should be accounted when using Data Boost. |
| com.google.cloud.bigtable.admin.v2.models.AppProfile.MultiClusterRoutingPolicy | A RoutingPolicy that tells Cloud Bigtable that it can route each request to any available cluster. |
| com.google.cloud.bigtable.admin.v2.models.AppProfile.SingleClusterRoutingPolicy | A RoutingPolicy that routes all requests to a specific cluster. |
| com.google.cloud.bigtable.admin.v2.models.AppProfile.StandardIsolationPolicy | A standard IsolationPolicy for isolating this app profile's traffic from other use cases. This accomplished by assigning different priorities to app profiles. A request that uses an app profile with a StandardIsolationPolicy with a HIGH priority will likely run before a request with a LOW priority. |
| com.google.cloud.bigtable.admin.v2.models.AuthorizedView |
A class that wraps the com.google.bigtable.admin.v2.AuthorizedView protocol buffer
object.
An AuthorizedView represents subsets of a particular table based on rules. The access to each |
| com.google.cloud.bigtable.admin.v2.models.Backup | A backup lets you save a copy of a table's schema and data and restore the backup to a new table at a later time. |
| com.google.cloud.bigtable.admin.v2.models.Cluster | A cluster represents the actual Cloud Bigtable service. Each cluster belongs to a single Cloud Bigtable instance, and an instance can have up to 2 clusters. When your application sends requests to a Cloud Bigtable instance, those requests are actually handled by one of the clusters in the instance. |
| com.google.cloud.bigtable.admin.v2.models.ClusterAutoscalingConfig | Model class to create an autoscaling config for creating or updating a cluster. When creating this config, min nodes, max nodes, and CPU utilization must all be set. |
| com.google.cloud.bigtable.admin.v2.models.ColumnFamily | Wrapper for ColumnFamily protocol buffer object |
| com.google.cloud.bigtable.admin.v2.models.ConsistencyRequest | |
| com.google.cloud.bigtable.admin.v2.models.CopyBackupRequest | Build CopyBackupRequest for com.google.bigtable.admin.v2.CopyBackupRequest. |
| com.google.cloud.bigtable.admin.v2.models.CreateAppProfileRequest |
Parameters for creating a new Cloud Bigtable app profile.
An application profile, or app profile, stores settings that tell your Cloud Bigtable instance how to handle incoming requests from an application. When one of your applications connects to a |
| com.google.cloud.bigtable.admin.v2.models.CreateAuthorizedViewRequest |
Parameters for creating a new Cloud Bigtable AuthorizedView, which represents subsets of
a particular table.
Sample code: |
| com.google.cloud.bigtable.admin.v2.models.CreateBackupRequest | Fluent wrapper for com.google.bigtable.admin.v2.CreateBackupRequest |
| com.google.cloud.bigtable.admin.v2.models.CreateClusterRequest |
Parameters for creating a new Bigtable cluster.
A cluster represents the actual Cloud Bigtable service. Each cluster belongs to a single Cloud Bigtable instance. When your application sends requests to a Cloud Bigtable instance, those |
| com.google.cloud.bigtable.admin.v2.models.CreateInstanceRequest |
Parameters for creating a new Bigtable Instance.
A Cloud Bigtable instance is mostly just a container for your clusters and nodes, which do all of the real work. Instances come in 2 flavors: |
| com.google.cloud.bigtable.admin.v2.models.CreateTableRequest |
Fluent wrapper for com.google.bigtable.admin.v2.CreateTableRequest
Allows for creating table with: |
| com.google.cloud.bigtable.admin.v2.models.EncryptionInfo |
Encryption information for a given resource.
If this resource is protected with customer managed encryption, the in-use Google Cloud Key Management Service (KMS) key versions will be specified along with their status. |
| com.google.cloud.bigtable.admin.v2.models.FamilySubsets | Represents subsets of a particular column family that are included in this authorized view. |
| com.google.cloud.bigtable.admin.v2.models.GCRules |
Wraps GcRule protocol buffer object and exposes a friendly API.
Note: Garbage collection executes opportunistically in the background, and so it's possible for reads to return a cell even if it matches the active GC expression for its family. Please use |
| com.google.cloud.bigtable.admin.v2.models.GCRules.DefaultRule | Wrapper for building a empty rule |
| com.google.cloud.bigtable.admin.v2.models.GCRules.DurationRule | Wrapper for building max duration rule |
| com.google.cloud.bigtable.admin.v2.models.GCRules.IntersectionRule | Fluent wrapper for Intersection rule. Allows far adding an hierarchy of rules with intersection as the root |
| com.google.cloud.bigtable.admin.v2.models.GCRules.UnionRule | Fluent wrapper for Union rule. Allows far adding an hierarchy of rules with union as the root |
| com.google.cloud.bigtable.admin.v2.models.GCRules.VersionRule | Wrapper for building max versions rule |
| com.google.cloud.bigtable.admin.v2.models.Instance |
Represents an existing Cloud Bigtable instance.
A Cloud Bigtable instance is mostly just a container for your clusters and nodes, which do all of the real work. |
| com.google.cloud.bigtable.admin.v2.models.ModifyColumnFamiliesRequest |
Fluent wrapper for com.google.bigtable.admin.v2.ModifyColumnFamiliesRequest
Allows for the following ColumnFamily modifications: |
| com.google.cloud.bigtable.admin.v2.models.OptimizeRestoredTableOperationToken | OptimizeRestoredTableOperationToken is a wrapper for the name of OptimizeRestoredTable operation. |
| com.google.cloud.bigtable.admin.v2.models.RestoreTableRequest | Fluent wrapper for com.google.bigtable.admin.v2.RestoreTableRequest |
| com.google.cloud.bigtable.admin.v2.models.RestoredTableResult | A RestoredTableResult holds the restored table object and the OptimizeRestoredTableOperationToken object (if any). |
| com.google.cloud.bigtable.admin.v2.models.StaticClusterSize | |
| com.google.cloud.bigtable.admin.v2.models.SubsetView |
Defines a simple authorized view that is a subset of the underlying Table.
Users can specify the rows in the form of row key prefixes, and specify the column families by adding the family id along with its familySubsets rule to the family subsets map. The subset is |
| com.google.cloud.bigtable.admin.v2.models.Table | Wrapper for Table protocol buffer object |
| com.google.cloud.bigtable.admin.v2.models.Type.Aggregate |
A value that combines incremental updates into a summarized value.
Data is never directly written or read using type |
| com.google.cloud.bigtable.admin.v2.models.Type.Aggregate.Aggregator | |
| com.google.cloud.bigtable.admin.v2.models.Type.Aggregate.Aggregator.Hll | |
| com.google.cloud.bigtable.admin.v2.models.Type.Aggregate.Aggregator.Max | |
| com.google.cloud.bigtable.admin.v2.models.Type.Aggregate.Aggregator.Min | |
| com.google.cloud.bigtable.admin.v2.models.Type.Aggregate.Aggregator.Sum | |
| com.google.cloud.bigtable.admin.v2.models.Type.Bytes | Represents a string of bytes with a specific encoding. |
| com.google.cloud.bigtable.admin.v2.models.Type.Bytes.Encoding | |
| com.google.cloud.bigtable.admin.v2.models.Type.Bytes.Encoding.Raw | |
| com.google.cloud.bigtable.admin.v2.models.Type.Int64 | Represents a 64-bit integer with a specific encoding. |
| com.google.cloud.bigtable.admin.v2.models.Type.Int64.Encoding | |
| com.google.cloud.bigtable.admin.v2.models.Type.Int64.Encoding.BigEndianBytes | |
| com.google.cloud.bigtable.admin.v2.models.Type.Raw | |
| com.google.cloud.bigtable.admin.v2.models.UpdateAppProfileRequest |
Parameters for updating an existing Cloud Bigtable app profile.
Examples |
| com.google.cloud.bigtable.admin.v2.models.UpdateAuthorizedViewRequest |
Parameters for updating an existing Cloud Bigtable AuthorizedView.
Sample code: |
| com.google.cloud.bigtable.admin.v2.models.UpdateBackupRequest | Fluent wrapper for com.google.bigtable.admin.v2.UpdateBackupRequest |
| com.google.cloud.bigtable.admin.v2.models.UpdateInstanceRequest |
Parameters for updating an existing Bigtable instance.
Existing instances maybe updated to change their superficial appearance (ie. display name) and can also be upgraded from a DEVELOPMENT instance to a PRODUCTION instance. Please note that |
| com.google.cloud.bigtable.admin.v2.models.UpdateTableRequest |
Wrapper for com.google.bigtable.admin.v2.UpdateTableRequest
Allows for updating table: |
Interfaces
| Interface | Description |
|---|---|
| com.google.cloud.bigtable.admin.v2.models.AppProfile.IsolationPolicy | Represents the options for isolating this app profile's traffic from other use cases. |
| com.google.cloud.bigtable.admin.v2.models.AppProfile.RoutingPolicy | Represents the routing for read/write requests. Please check the implementations of this interface for more details. |
| com.google.cloud.bigtable.admin.v2.models.AuthorizedView.AuthorizedViewType | Represents a subset of a Table. Please check the implementations of this interface for more details. |
| com.google.cloud.bigtable.admin.v2.models.GCRules.GCRule | interface for fluent GcRule wrappers |
| com.google.cloud.bigtable.admin.v2.models.Type | Wrapper class for the com.google.bigtable.admin.v2.Type protobuf message. See Also: com.google.bigtable.admin.v2.Type |
| com.google.cloud.bigtable.admin.v2.models.Type.HllAggregateInput | |
| com.google.cloud.bigtable.admin.v2.models.Type.MaxAggregateInput | |
| com.google.cloud.bigtable.admin.v2.models.Type.MinAggregateInput | |
| com.google.cloud.bigtable.admin.v2.models.Type.SumAggregateInput | These types are marker types that allow types to be used as the input to aggregate function. |
Enums
| Enum | Description |
|---|---|
| com.google.cloud.bigtable.admin.v2.models.AppProfile.ComputeBillingOwner | Compute Billing Owner specifies how usage should be accounted when using Data Boost. |
| com.google.cloud.bigtable.admin.v2.models.AppProfile.Priority | The possible priorities for an app profile. Note that higher priority writes can sometimes queue behind lower priority writes to the same tablet, as writes must be strictly sequenced in the durability log. |
| com.google.cloud.bigtable.admin.v2.models.Backup.BackupType | |
| com.google.cloud.bigtable.admin.v2.models.Backup.State | |
| com.google.cloud.bigtable.admin.v2.models.Cluster.State | |
| com.google.cloud.bigtable.admin.v2.models.EncryptionInfo.Type | |
| com.google.cloud.bigtable.admin.v2.models.Instance.State | |
| com.google.cloud.bigtable.admin.v2.models.Instance.Type | |
| com.google.cloud.bigtable.admin.v2.models.StorageType | Storage media types for persisting Bigtable data. |
| com.google.cloud.bigtable.admin.v2.models.Table.ReplicationState |
Exceptions
| Exception | Description |
|---|---|
| com.google.cloud.bigtable.admin.v2.models.PartialListClustersException | Exception thrown when some zones are unavailable and listClusters is unable to return a full cluster list. This exception can be inspected to get a partial list. |
| com.google.cloud.bigtable.admin.v2.models.PartialListInstancesException | Exception thrown when some zones are unavailable and listInstances is unable to return a full instance list. This exception can be inspected to get a partial list. |