Enum value maps for CreateClusterMetadata_TableProgress_State.
var (
CreateClusterMetadata_TableProgress_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "PENDING",
2: "COPYING",
3: "COMPLETED",
4: "CANCELLED",
}
CreateClusterMetadata_TableProgress_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"PENDING": 1,
"COPYING": 2,
"COMPLETED": 3,
"CANCELLED": 4,
}
)
Enum value maps for StorageType.
var (
StorageType_name = map[int32]string{
0: "STORAGE_TYPE_UNSPECIFIED",
1: "SSD",
2: "HDD",
}
StorageType_value = map[string]int32{
"STORAGE_TYPE_UNSPECIFIED": 0,
"SSD": 1,
"HDD": 2,
}
)
Enum value maps for Instance_State.
var (
Instance_State_name = map[int32]string{
0: "STATE_NOT_KNOWN",
1: "READY",
2: "CREATING",
}
Instance_State_value = map[string]int32{
"STATE_NOT_KNOWN": 0,
"READY": 1,
"CREATING": 2,
}
)
Enum value maps for Instance_Type.
var (
Instance_Type_name = map[int32]string{
0: "TYPE_UNSPECIFIED",
1: "PRODUCTION",
2: "DEVELOPMENT",
}
Instance_Type_value = map[string]int32{
"TYPE_UNSPECIFIED": 0,
"PRODUCTION": 1,
"DEVELOPMENT": 2,
}
)
Enum value maps for Cluster_State.
var (
Cluster_State_name = map[int32]string{
0: "STATE_NOT_KNOWN",
1: "READY",
2: "CREATING",
3: "RESIZING",
4: "DISABLED",
}
Cluster_State_value = map[string]int32{
"STATE_NOT_KNOWN": 0,
"READY": 1,
"CREATING": 2,
"RESIZING": 3,
"DISABLED": 4,
}
)
Enum value maps for AppProfile_Priority.
var (
AppProfile_Priority_name = map[int32]string{
0: "PRIORITY_UNSPECIFIED",
1: "PRIORITY_LOW",
2: "PRIORITY_MEDIUM",
3: "PRIORITY_HIGH",
}
AppProfile_Priority_value = map[string]int32{
"PRIORITY_UNSPECIFIED": 0,
"PRIORITY_LOW": 1,
"PRIORITY_MEDIUM": 2,
"PRIORITY_HIGH": 3,
}
)
Enum value maps for AppProfile_DataBoostIsolationReadOnly_ComputeBillingOwner.
var (
AppProfile_DataBoostIsolationReadOnly_ComputeBillingOwner_name = map[int32]string{
0: "COMPUTE_BILLING_OWNER_UNSPECIFIED",
1: "HOST_PAYS",
}
AppProfile_DataBoostIsolationReadOnly_ComputeBillingOwner_value = map[string]int32{
"COMPUTE_BILLING_OWNER_UNSPECIFIED": 0,
"HOST_PAYS": 1,
}
)
Enum value maps for RestoreSourceType.
var (
RestoreSourceType_name = map[int32]string{
0: "RESTORE_SOURCE_TYPE_UNSPECIFIED",
1: "BACKUP",
}
RestoreSourceType_value = map[string]int32{
"RESTORE_SOURCE_TYPE_UNSPECIFIED": 0,
"BACKUP": 1,
}
)
Enum value maps for Table_TimestampGranularity.
var (
Table_TimestampGranularity_name = map[int32]string{
0: "TIMESTAMP_GRANULARITY_UNSPECIFIED",
1: "MILLIS",
}
Table_TimestampGranularity_value = map[string]int32{
"TIMESTAMP_GRANULARITY_UNSPECIFIED": 0,
"MILLIS": 1,
}
)
Enum value maps for Table_View.
var (
Table_View_name = map[int32]string{
0: "VIEW_UNSPECIFIED",
1: "NAME_ONLY",
2: "SCHEMA_VIEW",
3: "REPLICATION_VIEW",
5: "ENCRYPTION_VIEW",
4: "FULL",
}
Table_View_value = map[string]int32{
"VIEW_UNSPECIFIED": 0,
"NAME_ONLY": 1,
"SCHEMA_VIEW": 2,
"REPLICATION_VIEW": 3,
"ENCRYPTION_VIEW": 5,
"FULL": 4,
}
)
Enum value maps for Table_ClusterState_ReplicationState.
var (
Table_ClusterState_ReplicationState_name = map[int32]string{
0: "STATE_NOT_KNOWN",
1: "INITIALIZING",
2: "PLANNED_MAINTENANCE",
3: "UNPLANNED_MAINTENANCE",
4: "READY",
5: "READY_OPTIMIZING",
}
Table_ClusterState_ReplicationState_value = map[string]int32{
"STATE_NOT_KNOWN": 0,
"INITIALIZING": 1,
"PLANNED_MAINTENANCE": 2,
"UNPLANNED_MAINTENANCE": 3,
"READY": 4,
"READY_OPTIMIZING": 5,
}
)
Enum value maps for AuthorizedView_ResponseView.
var (
AuthorizedView_ResponseView_name = map[int32]string{
0: "RESPONSE_VIEW_UNSPECIFIED",
1: "NAME_ONLY",
2: "BASIC",
3: "FULL",
}
AuthorizedView_ResponseView_value = map[string]int32{
"RESPONSE_VIEW_UNSPECIFIED": 0,
"NAME_ONLY": 1,
"BASIC": 2,
"FULL": 3,
}
)
Enum value maps for EncryptionInfo_EncryptionType.
var (
EncryptionInfo_EncryptionType_name = map[int32]string{
0: "ENCRYPTION_TYPE_UNSPECIFIED",
1: "GOOGLE_DEFAULT_ENCRYPTION",
2: "CUSTOMER_MANAGED_ENCRYPTION",
}
EncryptionInfo_EncryptionType_value = map[string]int32{
"ENCRYPTION_TYPE_UNSPECIFIED": 0,
"GOOGLE_DEFAULT_ENCRYPTION": 1,
"CUSTOMER_MANAGED_ENCRYPTION": 2,
}
)
Enum value maps for Snapshot_State.
var (
Snapshot_State_name = map[int32]string{
0: "STATE_NOT_KNOWN",
1: "READY",
2: "CREATING",
}
Snapshot_State_value = map[string]int32{
"STATE_NOT_KNOWN": 0,
"READY": 1,
"CREATING": 2,
}
)
Enum value maps for Backup_State.
var (
Backup_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "CREATING",
2: "READY",
}
Backup_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"CREATING": 1,
"READY": 2,
}
)
var File_google_bigtable_admin_v2_bigtable_instance_admin_proto protoreflect.FileDescriptor
var File_google_bigtable_admin_v2_bigtable_table_admin_proto protoreflect.FileDescriptor
var File_google_bigtable_admin_v2_common_proto protoreflect.FileDescriptor
var File_google_bigtable_admin_v2_instance_proto protoreflect.FileDescriptor
var File_google_bigtable_admin_v2_table_proto protoreflect.FileDescriptor
var File_google_bigtable_admin_v2_types_proto protoreflect.FileDescriptor
func RegisterBigtableInstanceAdminServer(s *grpc.Server, srv BigtableInstanceAdminServer)
func RegisterBigtableTableAdminServer(s *grpc.Server, srv BigtableTableAdminServer)
A configuration object describing how Cloud Bigtable should treat traffic from a particular end user application.
type AppProfile struct {
// The unique name of the app profile. Values are of the form
// `projects/{project}/instances/{instance}/appProfiles/[_a-zA-Z0-9][-_.a-zA-Z0-9]*`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Strongly validated etag for optimistic concurrency control. Preserve the
// value returned from `GetAppProfile` when calling `UpdateAppProfile` to
// fail the request if there has been a modification in the mean time. The
// `update_mask` of the request need not include `etag` for this protection
// to apply.
// See [Wikipedia](https://en.wikipedia.org/wiki/HTTP_ETag) and
// [RFC 7232](https://tools.ietf.org/html/rfc7232#section-2.3) for more
// details.
Etag string `protobuf:"bytes,2,opt,name=etag,proto3" json:"etag,omitempty"`
// Long form description of the use case for this AppProfile.
Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
// The routing policy for all read/write requests that use this app profile.
// A value must be explicitly set.
//
// Types that are assignable to RoutingPolicy:
//
// *AppProfile_MultiClusterRoutingUseAny_
// *AppProfile_SingleClusterRouting_
RoutingPolicy isAppProfile_RoutingPolicy `protobuf_oneof:"routing_policy"`
// Options for isolating this app profile's traffic from other use cases.
//
// Types that are assignable to Isolation:
//
// *AppProfile_Priority_
// *AppProfile_StandardIsolation_
// *AppProfile_DataBoostIsolationReadOnly_
Isolation isAppProfile_Isolation `protobuf_oneof:"isolation"`
// contains filtered or unexported fields
}
func (*AppProfile) Descriptor() ([]byte, []int)
Deprecated: Use AppProfile.ProtoReflect.Descriptor instead.
func (x *AppProfile) GetDataBoostIsolationReadOnly() *AppProfile_DataBoostIsolationReadOnly
func (x *AppProfile) GetDescription() string
func (x *AppProfile) GetEtag() string
func (m *AppProfile) GetIsolation() isAppProfile_Isolation
func (x *AppProfile) GetMultiClusterRoutingUseAny() *AppProfile_MultiClusterRoutingUseAny
func (x *AppProfile) GetName() string
func (x *AppProfile) GetPriority() AppProfile_Priority
Deprecated: Do not use.
func (m *AppProfile) GetRoutingPolicy() isAppProfile_RoutingPolicy
func (x *AppProfile) GetSingleClusterRouting() *AppProfile_SingleClusterRouting
func (x *AppProfile) GetStandardIsolation() *AppProfile_StandardIsolation
func (*AppProfile) ProtoMessage()
func (x *AppProfile) ProtoReflect() protoreflect.Message
func (x *AppProfile) Reset()
func (x *AppProfile) String() string
Data Boost is a serverless compute capability that lets you run high-throughput read jobs on your Bigtable data, without impacting the performance of the clusters that handle your application traffic. Currently, Data Boost exclusively supports read-only use-cases with single-cluster routing.
Data Boost reads are only guaranteed to see the results of writes that were written at least 30 minutes ago. This means newly written values may not become visible for up to 30m, and also means that old values may remain visible for up to 30m after being deleted or overwritten. To mitigate the staleness of the data, users may either wait 30m, or use CheckConsistency.
type AppProfile_DataBoostIsolationReadOnly struct {
// The Compute Billing Owner for this Data Boost App Profile.
ComputeBillingOwner *AppProfile_DataBoostIsolationReadOnly_ComputeBillingOwner `protobuf:"varint,1,opt,name=compute_billing_owner,json=computeBillingOwner,proto3,enum=google.bigtable.admin.v2.AppProfile_DataBoostIsolationReadOnly_ComputeBillingOwner,oneof" json:"compute_billing_owner,omitempty"`
// contains filtered or unexported fields
}
func (*AppProfile_DataBoostIsolationReadOnly) Descriptor() ([]byte, []int)
Deprecated: Use AppProfile_DataBoostIsolationReadOnly.ProtoReflect.Descriptor instead.
func (x *AppProfile_DataBoostIsolationReadOnly) GetComputeBillingOwner() AppProfile_DataBoostIsolationReadOnly_ComputeBillingOwner
func (*AppProfile_DataBoostIsolationReadOnly) ProtoMessage()
func (x *AppProfile_DataBoostIsolationReadOnly) ProtoReflect() protoreflect.Message
func (x *AppProfile_DataBoostIsolationReadOnly) Reset()
func (x *AppProfile_DataBoostIsolationReadOnly) String() string
type AppProfile_DataBoostIsolationReadOnly_ struct {
// Specifies that this app profile is intended for read-only usage via the
// Data Boost feature.
DataBoostIsolationReadOnly *AppProfile_DataBoostIsolationReadOnly `protobuf:"bytes,10,opt,name=data_boost_isolation_read_only,json=dataBoostIsolationReadOnly,proto3,oneof"`
}
Compute Billing Owner specifies how usage should be accounted when using Data Boost. Compute Billing Owner also configures which Cloud Project is charged for relevant quota.
type AppProfile_DataBoostIsolationReadOnly_ComputeBillingOwner int32
const (
// Unspecified value.
AppProfile_DataBoostIsolationReadOnly_COMPUTE_BILLING_OWNER_UNSPECIFIED AppProfile_DataBoostIsolationReadOnly_ComputeBillingOwner = 0
// The host Cloud Project containing the targeted Bigtable Instance /
// Table pays for compute.
AppProfile_DataBoostIsolationReadOnly_HOST_PAYS AppProfile_DataBoostIsolationReadOnly_ComputeBillingOwner = 1
)
func (AppProfile_DataBoostIsolationReadOnly_ComputeBillingOwner) Descriptor() protoreflect.EnumDescriptor
func (x AppProfile_DataBoostIsolationReadOnly_ComputeBillingOwner) Enum() *AppProfile_DataBoostIsolationReadOnly_ComputeBillingOwner
func (AppProfile_DataBoostIsolationReadOnly_ComputeBillingOwner) EnumDescriptor() ([]byte, []int)
Deprecated: Use AppProfile_DataBoostIsolationReadOnly_ComputeBillingOwner.Descriptor instead.
func (x AppProfile_DataBoostIsolationReadOnly_ComputeBillingOwner) Number() protoreflect.EnumNumber
func (x AppProfile_DataBoostIsolationReadOnly_ComputeBillingOwner) String() string
func (AppProfile_DataBoostIsolationReadOnly_ComputeBillingOwner) Type() protoreflect.EnumType
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.
type AppProfile_MultiClusterRoutingUseAny struct {
// The set of clusters to route to. The order is ignored; clusters will be
// tried in order of distance. If left empty, all clusters are eligible.
ClusterIds []string `protobuf:"bytes,1,rep,name=cluster_ids,json=clusterIds,proto3" json:"cluster_ids,omitempty"`
// contains filtered or unexported fields
}
func (*AppProfile_MultiClusterRoutingUseAny) Descriptor() ([]byte, []int)
Deprecated: Use AppProfile_MultiClusterRoutingUseAny.ProtoReflect.Descriptor instead.
func (x *AppProfile_MultiClusterRoutingUseAny) GetClusterIds() []string
func (*AppProfile_MultiClusterRoutingUseAny) ProtoMessage()
func (x *AppProfile_MultiClusterRoutingUseAny) ProtoReflect() protoreflect.Message
func (x *AppProfile_MultiClusterRoutingUseAny) Reset()
func (x *AppProfile_MultiClusterRoutingUseAny) String() string
type AppProfile_MultiClusterRoutingUseAny_ struct {
// Use a multi-cluster routing policy.
MultiClusterRoutingUseAny *AppProfile_MultiClusterRoutingUseAny `protobuf:"bytes,5,opt,name=multi_cluster_routing_use_any,json=multiClusterRoutingUseAny,proto3,oneof"`
}
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.
type AppProfile_Priority int32
const (
// Default value. Mapped to PRIORITY_HIGH (the legacy behavior) on creation.
AppProfile_PRIORITY_UNSPECIFIED AppProfile_Priority = 0
AppProfile_PRIORITY_LOW AppProfile_Priority = 1
AppProfile_PRIORITY_MEDIUM AppProfile_Priority = 2
AppProfile_PRIORITY_HIGH AppProfile_Priority = 3
)
func (AppProfile_Priority) Descriptor() protoreflect.EnumDescriptor
func (x AppProfile_Priority) Enum() *AppProfile_Priority
func (AppProfile_Priority) EnumDescriptor() ([]byte, []int)
Deprecated: Use AppProfile_Priority.Descriptor instead.
func (x AppProfile_Priority) Number() protoreflect.EnumNumber
func (x AppProfile_Priority) String() string
func (AppProfile_Priority) Type() protoreflect.EnumType
type AppProfile_Priority_ struct {
// This field has been deprecated in favor of `standard_isolation.priority`.
// If you set this field, `standard_isolation.priority` will be set instead.
//
// The priority of requests sent using this app profile.
//
// Deprecated: Do not use.
Priority AppProfile_Priority `protobuf:"varint,7,opt,name=priority,proto3,enum=google.bigtable.admin.v2.AppProfile_Priority,oneof"`
}
Unconditionally routes all read/write requests to a specific cluster. This option preserves read-your-writes consistency but does not improve availability.
type AppProfile_SingleClusterRouting struct {
// The cluster to which read/write requests should be routed.
ClusterId string `protobuf:"bytes,1,opt,name=cluster_id,json=clusterId,proto3" json:"cluster_id,omitempty"`
// Whether or not `CheckAndMutateRow` and `ReadModifyWriteRow` requests are
// allowed by this app profile. It is unsafe to send these requests to
// the same table/row/column in multiple clusters.
AllowTransactionalWrites bool `protobuf:"varint,2,opt,name=allow_transactional_writes,json=allowTransactionalWrites,proto3" json:"allow_transactional_writes,omitempty"`
// contains filtered or unexported fields
}
func (*AppProfile_SingleClusterRouting) Descriptor() ([]byte, []int)
Deprecated: Use AppProfile_SingleClusterRouting.ProtoReflect.Descriptor instead.
func (x *AppProfile_SingleClusterRouting) GetAllowTransactionalWrites() bool
func (x *AppProfile_SingleClusterRouting) GetClusterId() string
func (*AppProfile_SingleClusterRouting) ProtoMessage()
func (x *AppProfile_SingleClusterRouting) ProtoReflect() protoreflect.Message
func (x *AppProfile_SingleClusterRouting) Reset()
func (x *AppProfile_SingleClusterRouting) String() string
type AppProfile_SingleClusterRouting_ struct {
// Use a single-cluster routing policy.
SingleClusterRouting *AppProfile_SingleClusterRouting `protobuf:"bytes,6,opt,name=single_cluster_routing,json=singleClusterRouting,proto3,oneof"`
}
Standard options for isolating this app profile's traffic from other use cases.
type AppProfile_StandardIsolation struct {
// The priority of requests sent using this app profile.
Priority AppProfile_Priority `protobuf:"varint,1,opt,name=priority,proto3,enum=google.bigtable.admin.v2.AppProfile_Priority" json:"priority,omitempty"`
// contains filtered or unexported fields
}
func (*AppProfile_StandardIsolation) Descriptor() ([]byte, []int)
Deprecated: Use AppProfile_StandardIsolation.ProtoReflect.Descriptor instead.
func (x *AppProfile_StandardIsolation) GetPriority() AppProfile_Priority
func (*AppProfile_StandardIsolation) ProtoMessage()
func (x *AppProfile_StandardIsolation) ProtoReflect() protoreflect.Message
func (x *AppProfile_StandardIsolation) Reset()
func (x *AppProfile_StandardIsolation) String() string
type AppProfile_StandardIsolation_ struct {
// The standard options used for isolating this app profile's traffic from
// other use cases.
StandardIsolation *AppProfile_StandardIsolation `protobuf:"bytes,11,opt,name=standard_isolation,json=standardIsolation,proto3,oneof"`
}
AuthorizedViews represent subsets of a particular Cloud Bigtable table. Users can configure access to each Authorized View independently from the table and use the existing Data APIs to access the subset of data.
type AuthorizedView struct {
// Identifier. The name of this AuthorizedView.
// Values are of the form
// `projects/{project}/instances/{instance}/tables/{table}/authorizedViews/{authorized_view}`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// The type of this AuthorizedView.
//
// Types that are assignable to AuthorizedView:
//
// *AuthorizedView_SubsetView_
AuthorizedView isAuthorizedView_AuthorizedView `protobuf_oneof:"authorized_view"`
// The etag for this AuthorizedView.
// If this is provided on update, it must match the server's etag. The server
// returns ABORTED error on a mismatched etag.
Etag string `protobuf:"bytes,3,opt,name=etag,proto3" json:"etag,omitempty"`
// Set to true to make the AuthorizedView protected against deletion.
// The parent Table and containing Instance cannot be deleted if an
// AuthorizedView has this bit set.
DeletionProtection bool `protobuf:"varint,4,opt,name=deletion_protection,json=deletionProtection,proto3" json:"deletion_protection,omitempty"`
// contains filtered or unexported fields
}
func (*AuthorizedView) Descriptor() ([]byte, []int)
Deprecated: Use AuthorizedView.ProtoReflect.Descriptor instead.
func (m *AuthorizedView) GetAuthorizedView() isAuthorizedView_AuthorizedView
func (x *AuthorizedView) GetDeletionProtection() bool
func (x *AuthorizedView) GetEtag() string
func (x *AuthorizedView) GetName() string
func (x *AuthorizedView) GetSubsetView() *AuthorizedView_SubsetView
func (*AuthorizedView) ProtoMessage()
func (x *AuthorizedView) ProtoReflect() protoreflect.Message
func (x *AuthorizedView) Reset()
func (x *AuthorizedView) String() string
Subsets of a column family that are included in this AuthorizedView.
type AuthorizedView_FamilySubsets struct {
// Individual exact column qualifiers to be included in the AuthorizedView.
Qualifiers [][]byte `protobuf:"bytes,1,rep,name=qualifiers,proto3" json:"qualifiers,omitempty"`
// Prefixes for qualifiers to be included in the AuthorizedView. Every
// qualifier starting with one of these prefixes is included in the
// AuthorizedView. To provide access to all qualifiers, include the empty
// string as a prefix
// ("").
QualifierPrefixes [][]byte `protobuf:"bytes,2,rep,name=qualifier_prefixes,json=qualifierPrefixes,proto3" json:"qualifier_prefixes,omitempty"`
// contains filtered or unexported fields
}
func (*AuthorizedView_FamilySubsets) Descriptor() ([]byte, []int)
Deprecated: Use AuthorizedView_FamilySubsets.ProtoReflect.Descriptor instead.
func (x *AuthorizedView_FamilySubsets) GetQualifierPrefixes() [][]byte
func (x *AuthorizedView_FamilySubsets) GetQualifiers() [][]byte
func (*AuthorizedView_FamilySubsets) ProtoMessage()
func (x *AuthorizedView_FamilySubsets) ProtoReflect() protoreflect.Message
func (x *AuthorizedView_FamilySubsets) Reset()
func (x *AuthorizedView_FamilySubsets) String() string
Defines a subset of an AuthorizedView's fields.
type AuthorizedView_ResponseView int32
const (
// Uses the default view for each method as documented in the request.
AuthorizedView_RESPONSE_VIEW_UNSPECIFIED AuthorizedView_ResponseView = 0
// Only populates `name`.
AuthorizedView_NAME_ONLY AuthorizedView_ResponseView = 1
// Only populates the AuthorizedView's basic metadata. This includes:
// name, deletion_protection, etag.
AuthorizedView_BASIC AuthorizedView_ResponseView = 2
// Populates every fields.
AuthorizedView_FULL AuthorizedView_ResponseView = 3
)
func (AuthorizedView_ResponseView) Descriptor() protoreflect.EnumDescriptor
func (x AuthorizedView_ResponseView) Enum() *AuthorizedView_ResponseView
func (AuthorizedView_ResponseView) EnumDescriptor() ([]byte, []int)
Deprecated: Use AuthorizedView_ResponseView.Descriptor instead.
func (x AuthorizedView_ResponseView) Number() protoreflect.EnumNumber
func (x AuthorizedView_ResponseView) String() string
func (AuthorizedView_ResponseView) Type() protoreflect.EnumType
Defines a simple AuthorizedView that is a subset of the underlying Table.
type AuthorizedView_SubsetView struct {
// Row prefixes to be included in the AuthorizedView.
// To provide access to all rows, include the empty string as a prefix ("").
RowPrefixes [][]byte `protobuf:"bytes,1,rep,name=row_prefixes,json=rowPrefixes,proto3" json:"row_prefixes,omitempty"`
// Map from column family name to the columns in this family to be included
// in the AuthorizedView.
FamilySubsets map[string]*AuthorizedView_FamilySubsets `protobuf:"bytes,2,rep,name=family_subsets,json=familySubsets,proto3" json:"family_subsets,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// contains filtered or unexported fields
}
func (*AuthorizedView_SubsetView) Descriptor() ([]byte, []int)
Deprecated: Use AuthorizedView_SubsetView.ProtoReflect.Descriptor instead.
func (x *AuthorizedView_SubsetView) GetFamilySubsets() map[string]*AuthorizedView_FamilySubsets
func (x *AuthorizedView_SubsetView) GetRowPrefixes() [][]byte
func (*AuthorizedView_SubsetView) ProtoMessage()
func (x *AuthorizedView_SubsetView) ProtoReflect() protoreflect.Message
func (x *AuthorizedView_SubsetView) Reset()
func (x *AuthorizedView_SubsetView) String() string
type AuthorizedView_SubsetView_ struct {
// An AuthorizedView permitting access to an explicit subset of a Table.
SubsetView *AuthorizedView_SubsetView `protobuf:"bytes,2,opt,name=subset_view,json=subsetView,proto3,oneof"`
}
Limits for the number of nodes a Cluster can autoscale up/down to.
type AutoscalingLimits struct {
// Required. Minimum number of nodes to scale down to.
MinServeNodes int32 `protobuf:"varint,1,opt,name=min_serve_nodes,json=minServeNodes,proto3" json:"min_serve_nodes,omitempty"`
// Required. Maximum number of nodes to scale up to.
MaxServeNodes int32 `protobuf:"varint,2,opt,name=max_serve_nodes,json=maxServeNodes,proto3" json:"max_serve_nodes,omitempty"`
// contains filtered or unexported fields
}
func (*AutoscalingLimits) Descriptor() ([]byte, []int)
Deprecated: Use AutoscalingLimits.ProtoReflect.Descriptor instead.
func (x *AutoscalingLimits) GetMaxServeNodes() int32
func (x *AutoscalingLimits) GetMinServeNodes() int32
func (*AutoscalingLimits) ProtoMessage()
func (x *AutoscalingLimits) ProtoReflect() protoreflect.Message
func (x *AutoscalingLimits) Reset()
func (x *AutoscalingLimits) String() string
The Autoscaling targets for a Cluster. These determine the recommended nodes.
type AutoscalingTargets struct {
// The cpu utilization that the Autoscaler should be trying to achieve.
// This number is on a scale from 0 (no utilization) to
// 100 (total utilization), and is limited between 10 and 80, otherwise it
// will return INVALID_ARGUMENT error.
CpuUtilizationPercent int32 `protobuf:"varint,2,opt,name=cpu_utilization_percent,json=cpuUtilizationPercent,proto3" json:"cpu_utilization_percent,omitempty"`
// The storage utilization that the Autoscaler should be trying to achieve.
// This number is limited between 2560 (2.5TiB) and 5120 (5TiB) for a SSD
// cluster and between 8192 (8TiB) and 16384 (16TiB) for an HDD cluster,
// otherwise it will return INVALID_ARGUMENT error. If this value is set to 0,
// it will be treated as if it were set to the default value: 2560 for SSD,
// 8192 for HDD.
StorageUtilizationGibPerNode int32 `protobuf:"varint,3,opt,name=storage_utilization_gib_per_node,json=storageUtilizationGibPerNode,proto3" json:"storage_utilization_gib_per_node,omitempty"`
// contains filtered or unexported fields
}
func (*AutoscalingTargets) Descriptor() ([]byte, []int)
Deprecated: Use AutoscalingTargets.ProtoReflect.Descriptor instead.
func (x *AutoscalingTargets) GetCpuUtilizationPercent() int32
func (x *AutoscalingTargets) GetStorageUtilizationGibPerNode() int32
func (*AutoscalingTargets) ProtoMessage()
func (x *AutoscalingTargets) ProtoReflect() protoreflect.Message
func (x *AutoscalingTargets) Reset()
func (x *AutoscalingTargets) String() string
A backup of a Cloud Bigtable table.
type Backup struct {
// A globally unique identifier for the backup which cannot be
// changed. Values are of the form
// `projects/{project}/instances/{instance}/clusters/{cluster}/
//
// backups/[_a-zA-Z0-9][-_.a-zA-Z0-9]*`
//
// The final segment of the name must be between 1 and 50 characters
// in length.
//
// The backup is stored in the cluster identified by the prefix of the backup
// name of the form
// `projects/{project}/instances/{instance}/clusters/{cluster}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. Immutable. Name of the table from which this backup was created.
// This needs to be in the same instance as the backup. Values are of the form
// `projects/{project}/instances/{instance}/tables/{source_table}`.
SourceTable string `protobuf:"bytes,2,opt,name=source_table,json=sourceTable,proto3" json:"source_table,omitempty"`
// Output only. 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/<project>/instances/<instance>/backups/<backup>.
SourceBackup string `protobuf:"bytes,10,opt,name=source_backup,json=sourceBackup,proto3" json:"source_backup,omitempty"`
// Required. The expiration time of the backup, with microseconds
// granularity that must be at least 6 hours and at most 90 days
// from the time the request is received. Once the `expire_time`
// has passed, Cloud Bigtable will delete the backup and free the
// resources used by the backup.
ExpireTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=expire_time,json=expireTime,proto3" json:"expire_time,omitempty"`
// Output only. `start_time` is the time that the backup was started
// (i.e. approximately the time the
// [CreateBackup][google.bigtable.admin.v2.BigtableTableAdmin.CreateBackup]
// request is received). The row data in this backup will be no older than
// this timestamp.
StartTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
// Output only. `end_time` is the time that the backup was finished. The row
// data in the backup will be no newer than this timestamp.
EndTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
// Output only. Size of the backup in bytes.
SizeBytes int64 `protobuf:"varint,6,opt,name=size_bytes,json=sizeBytes,proto3" json:"size_bytes,omitempty"`
// Output only. The current state of the backup.
State Backup_State `protobuf:"varint,7,opt,name=state,proto3,enum=google.bigtable.admin.v2.Backup_State" json:"state,omitempty"`
// Output only. The encryption information for the backup.
EncryptionInfo *EncryptionInfo `protobuf:"bytes,9,opt,name=encryption_info,json=encryptionInfo,proto3" json:"encryption_info,omitempty"`
// contains filtered or unexported fields
}
func (*Backup) Descriptor() ([]byte, []int)
Deprecated: Use Backup.ProtoReflect.Descriptor instead.
func (x *Backup) GetEncryptionInfo() *EncryptionInfo
func (x *Backup) GetEndTime() *timestamppb.Timestamp
func (x *Backup) GetExpireTime() *timestamppb.Timestamp
func (x *Backup) GetName() string
func (x *Backup) GetSizeBytes() int64
func (x *Backup) GetSourceBackup() string
func (x *Backup) GetSourceTable() string
func (x *Backup) GetStartTime() *timestamppb.Timestamp
func (x *Backup) GetState() Backup_State
func (*Backup) ProtoMessage()
func (x *Backup) ProtoReflect() protoreflect.Message
func (x *Backup) Reset()
func (x *Backup) String() string
Information about a backup.
type BackupInfo struct {
// Output only. Name of the backup.
Backup string `protobuf:"bytes,1,opt,name=backup,proto3" json:"backup,omitempty"`
// Output only. The time that the backup was started. Row data in the backup
// will be no older than this timestamp.
StartTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
// Output only. This time that the backup was finished. Row data in the
// backup will be no newer than this timestamp.
EndTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
// Output only. Name of the table the backup was created from.
SourceTable string `protobuf:"bytes,4,opt,name=source_table,json=sourceTable,proto3" json:"source_table,omitempty"`
// Output only. 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/<project>/instances/<instance>/backups/<backup>.
SourceBackup string `protobuf:"bytes,10,opt,name=source_backup,json=sourceBackup,proto3" json:"source_backup,omitempty"`
// contains filtered or unexported fields
}
func (*BackupInfo) Descriptor() ([]byte, []int)
Deprecated: Use BackupInfo.ProtoReflect.Descriptor instead.
func (x *BackupInfo) GetBackup() string
func (x *BackupInfo) GetEndTime() *timestamppb.Timestamp
func (x *BackupInfo) GetSourceBackup() string
func (x *BackupInfo) GetSourceTable() string
func (x *BackupInfo) GetStartTime() *timestamppb.Timestamp
func (*BackupInfo) ProtoMessage()
func (x *BackupInfo) ProtoReflect() protoreflect.Message
func (x *BackupInfo) Reset()
func (x *BackupInfo) String() string
Indicates the current state of the backup.
type Backup_State int32
const (
// Not specified.
Backup_STATE_UNSPECIFIED Backup_State = 0
// The pending backup is still being created. Operations on the
// backup may fail with `FAILED_PRECONDITION` in this state.
Backup_CREATING Backup_State = 1
// The backup is complete and ready for use.
Backup_READY Backup_State = 2
)
func (Backup_State) Descriptor() protoreflect.EnumDescriptor
func (x Backup_State) Enum() *Backup_State
func (Backup_State) EnumDescriptor() ([]byte, []int)
Deprecated: Use Backup_State.Descriptor instead.
func (x Backup_State) Number() protoreflect.EnumNumber
func (x Backup_State) String() string
func (Backup_State) Type() protoreflect.EnumType
BigtableInstanceAdminClient is the client API for BigtableInstanceAdmin service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
type BigtableInstanceAdminClient interface {
// Create an instance within a project.
//
// Note that exactly one of Cluster.serve_nodes and
// Cluster.cluster_config.cluster_autoscaling_config can be set. If
// serve_nodes is set to non-zero, then the cluster is manually scaled. If
// cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is
// enabled.
CreateInstance(ctx context.Context, in *CreateInstanceRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Gets information about an instance.
GetInstance(ctx context.Context, in *GetInstanceRequest, opts ...grpc.CallOption) (*Instance, error)
// Lists information about instances in a project.
ListInstances(ctx context.Context, in *ListInstancesRequest, opts ...grpc.CallOption) (*ListInstancesResponse, error)
// Updates an instance within a project. This method updates only the display
// name and type for an Instance. To update other Instance properties, such as
// labels, use PartialUpdateInstance.
UpdateInstance(ctx context.Context, in *Instance, opts ...grpc.CallOption) (*Instance, error)
// Partially updates an instance within a project. This method can modify all
// fields of an Instance and is the preferred way to update an Instance.
PartialUpdateInstance(ctx context.Context, in *PartialUpdateInstanceRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Delete an instance from a project.
DeleteInstance(ctx context.Context, in *DeleteInstanceRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Creates a cluster within an instance.
//
// Note that exactly one of Cluster.serve_nodes and
// Cluster.cluster_config.cluster_autoscaling_config can be set. If
// serve_nodes is set to non-zero, then the cluster is manually scaled. If
// cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is
// enabled.
CreateCluster(ctx context.Context, in *CreateClusterRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Gets information about a cluster.
GetCluster(ctx context.Context, in *GetClusterRequest, opts ...grpc.CallOption) (*Cluster, error)
// Lists information about clusters in an instance.
ListClusters(ctx context.Context, in *ListClustersRequest, opts ...grpc.CallOption) (*ListClustersResponse, error)
// Updates a cluster within an instance.
//
// Note that UpdateCluster does not support updating
// cluster_config.cluster_autoscaling_config. In order to update it, you
// must use PartialUpdateCluster.
UpdateCluster(ctx context.Context, in *Cluster, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Partially updates a cluster within a project. This method is the preferred
// way to update a Cluster.
//
// To enable and update autoscaling, set
// cluster_config.cluster_autoscaling_config. When autoscaling is enabled,
// serve_nodes is treated as an OUTPUT_ONLY field, meaning that updates to it
// are ignored. Note that an update cannot simultaneously set serve_nodes to
// non-zero and cluster_config.cluster_autoscaling_config to non-empty, and
// also specify both in the update_mask.
//
// To disable autoscaling, clear cluster_config.cluster_autoscaling_config,
// and explicitly set a serve_node count via the update_mask.
PartialUpdateCluster(ctx context.Context, in *PartialUpdateClusterRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Deletes a cluster from an instance.
DeleteCluster(ctx context.Context, in *DeleteClusterRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Creates an app profile within an instance.
CreateAppProfile(ctx context.Context, in *CreateAppProfileRequest, opts ...grpc.CallOption) (*AppProfile, error)
// Gets information about an app profile.
GetAppProfile(ctx context.Context, in *GetAppProfileRequest, opts ...grpc.CallOption) (*AppProfile, error)
// Lists information about app profiles in an instance.
ListAppProfiles(ctx context.Context, in *ListAppProfilesRequest, opts ...grpc.CallOption) (*ListAppProfilesResponse, error)
// Updates an app profile within an instance.
UpdateAppProfile(ctx context.Context, in *UpdateAppProfileRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Deletes an app profile from an instance.
DeleteAppProfile(ctx context.Context, in *DeleteAppProfileRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Gets the access control policy for an instance resource. Returns an empty
// policy if an instance exists but does not have a policy set.
GetIamPolicy(ctx context.Context, in *iampb.GetIamPolicyRequest, opts ...grpc.CallOption) (*iampb.Policy, error)
// Sets the access control policy on an instance resource. Replaces any
// existing policy.
SetIamPolicy(ctx context.Context, in *iampb.SetIamPolicyRequest, opts ...grpc.CallOption) (*iampb.Policy, error)
// Returns permissions that the caller has on the specified instance resource.
TestIamPermissions(ctx context.Context, in *iampb.TestIamPermissionsRequest, opts ...grpc.CallOption) (*iampb.TestIamPermissionsResponse, error)
// Lists hot tablets in a cluster, within the time range provided. Hot
// tablets are ordered based on CPU usage.
ListHotTablets(ctx context.Context, in *ListHotTabletsRequest, opts ...grpc.CallOption) (*ListHotTabletsResponse, error)
}
func NewBigtableInstanceAdminClient(cc grpc.ClientConnInterface) BigtableInstanceAdminClient
BigtableInstanceAdminServer is the server API for BigtableInstanceAdmin service.
type BigtableInstanceAdminServer interface {
// Create an instance within a project.
//
// Note that exactly one of Cluster.serve_nodes and
// Cluster.cluster_config.cluster_autoscaling_config can be set. If
// serve_nodes is set to non-zero, then the cluster is manually scaled. If
// cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is
// enabled.
CreateInstance(context.Context, *CreateInstanceRequest) (*longrunningpb.Operation, error)
// Gets information about an instance.
GetInstance(context.Context, *GetInstanceRequest) (*Instance, error)
// Lists information about instances in a project.
ListInstances(context.Context, *ListInstancesRequest) (*ListInstancesResponse, error)
// Updates an instance within a project. This method updates only the display
// name and type for an Instance. To update other Instance properties, such as
// labels, use PartialUpdateInstance.
UpdateInstance(context.Context, *Instance) (*Instance, error)
// Partially updates an instance within a project. This method can modify all
// fields of an Instance and is the preferred way to update an Instance.
PartialUpdateInstance(context.Context, *PartialUpdateInstanceRequest) (*longrunningpb.Operation, error)
// Delete an instance from a project.
DeleteInstance(context.Context, *DeleteInstanceRequest) (*emptypb.Empty, error)
// Creates a cluster within an instance.
//
// Note that exactly one of Cluster.serve_nodes and
// Cluster.cluster_config.cluster_autoscaling_config can be set. If
// serve_nodes is set to non-zero, then the cluster is manually scaled. If
// cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is
// enabled.
CreateCluster(context.Context, *CreateClusterRequest) (*longrunningpb.Operation, error)
// Gets information about a cluster.
GetCluster(context.Context, *GetClusterRequest) (*Cluster, error)
// Lists information about clusters in an instance.
ListClusters(context.Context, *ListClustersRequest) (*ListClustersResponse, error)
// Updates a cluster within an instance.
//
// Note that UpdateCluster does not support updating
// cluster_config.cluster_autoscaling_config. In order to update it, you
// must use PartialUpdateCluster.
UpdateCluster(context.Context, *Cluster) (*longrunningpb.Operation, error)
// Partially updates a cluster within a project. This method is the preferred
// way to update a Cluster.
//
// To enable and update autoscaling, set
// cluster_config.cluster_autoscaling_config. When autoscaling is enabled,
// serve_nodes is treated as an OUTPUT_ONLY field, meaning that updates to it
// are ignored. Note that an update cannot simultaneously set serve_nodes to
// non-zero and cluster_config.cluster_autoscaling_config to non-empty, and
// also specify both in the update_mask.
//
// To disable autoscaling, clear cluster_config.cluster_autoscaling_config,
// and explicitly set a serve_node count via the update_mask.
PartialUpdateCluster(context.Context, *PartialUpdateClusterRequest) (*longrunningpb.Operation, error)
// Deletes a cluster from an instance.
DeleteCluster(context.Context, *DeleteClusterRequest) (*emptypb.Empty, error)
// Creates an app profile within an instance.
CreateAppProfile(context.Context, *CreateAppProfileRequest) (*AppProfile, error)
// Gets information about an app profile.
GetAppProfile(context.Context, *GetAppProfileRequest) (*AppProfile, error)
// Lists information about app profiles in an instance.
ListAppProfiles(context.Context, *ListAppProfilesRequest) (*ListAppProfilesResponse, error)
// Updates an app profile within an instance.
UpdateAppProfile(context.Context, *UpdateAppProfileRequest) (*longrunningpb.Operation, error)
// Deletes an app profile from an instance.
DeleteAppProfile(context.Context, *DeleteAppProfileRequest) (*emptypb.Empty, error)
// Gets the access control policy for an instance resource. Returns an empty
// policy if an instance exists but does not have a policy set.
GetIamPolicy(context.Context, *iampb.GetIamPolicyRequest) (*iampb.Policy, error)
// Sets the access control policy on an instance resource. Replaces any
// existing policy.
SetIamPolicy(context.Context, *iampb.SetIamPolicyRequest) (*iampb.Policy, error)
// Returns permissions that the caller has on the specified instance resource.
TestIamPermissions(context.Context, *iampb.TestIamPermissionsRequest) (*iampb.TestIamPermissionsResponse, error)
// Lists hot tablets in a cluster, within the time range provided. Hot
// tablets are ordered based on CPU usage.
ListHotTablets(context.Context, *ListHotTabletsRequest) (*ListHotTabletsResponse, error)
}
BigtableTableAdminClient is the client API for BigtableTableAdmin service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
type BigtableTableAdminClient interface {
// 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.
CreateTable(ctx context.Context, in *CreateTableRequest, opts ...grpc.CallOption) (*Table, error)
// Creates a new table from the specified snapshot. The target table must
// not exist. The snapshot and the table must be in the same instance.
//
// 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.
CreateTableFromSnapshot(ctx context.Context, in *CreateTableFromSnapshotRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Lists all tables served from a specified instance.
ListTables(ctx context.Context, in *ListTablesRequest, opts ...grpc.CallOption) (*ListTablesResponse, error)
// Gets metadata information about the specified table.
GetTable(ctx context.Context, in *GetTableRequest, opts ...grpc.CallOption) (*Table, error)
// Updates a specified table.
UpdateTable(ctx context.Context, in *UpdateTableRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Permanently deletes a specified table and all of its data.
DeleteTable(ctx context.Context, in *DeleteTableRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Restores a specified table which was accidentally deleted.
UndeleteTable(ctx context.Context, in *UndeleteTableRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Creates a new AuthorizedView in a table.
CreateAuthorizedView(ctx context.Context, in *CreateAuthorizedViewRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Lists all AuthorizedViews from a specific table.
ListAuthorizedViews(ctx context.Context, in *ListAuthorizedViewsRequest, opts ...grpc.CallOption) (*ListAuthorizedViewsResponse, error)
// Gets information from a specified AuthorizedView.
GetAuthorizedView(ctx context.Context, in *GetAuthorizedViewRequest, opts ...grpc.CallOption) (*AuthorizedView, error)
// Updates an AuthorizedView in a table.
UpdateAuthorizedView(ctx context.Context, in *UpdateAuthorizedViewRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Permanently deletes a specified AuthorizedView.
DeleteAuthorizedView(ctx context.Context, in *DeleteAuthorizedViewRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Performs a series of column family modifications on the specified table.
// Either all or none of the modifications will occur before this method
// returns, but data requests received prior to that point may see a table
// where only some modifications have taken effect.
ModifyColumnFamilies(ctx context.Context, in *ModifyColumnFamiliesRequest, opts ...grpc.CallOption) (*Table, error)
// Permanently drop/delete a row range from a specified table. The request can
// specify whether to delete all rows in a table, or only those that match a
// particular prefix.
DropRowRange(ctx context.Context, in *DropRowRangeRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Generates a consistency token for a Table, which can be used in
// CheckConsistency to check whether mutations to the table that finished
// before this call started have been replicated. The tokens will be available
// for 90 days.
GenerateConsistencyToken(ctx context.Context, in *GenerateConsistencyTokenRequest, opts ...grpc.CallOption) (*GenerateConsistencyTokenResponse, error)
// Checks replication consistency based on a consistency token, that is, if
// replication has caught up based on the conditions specified in the token
// and the check request.
CheckConsistency(ctx context.Context, in *CheckConsistencyRequest, opts ...grpc.CallOption) (*CheckConsistencyResponse, error)
// Creates a new snapshot in the specified cluster from the specified
// source table. The cluster and the table must be in the same instance.
//
// 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.
SnapshotTable(ctx context.Context, in *SnapshotTableRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Gets metadata information about the specified snapshot.
//
// 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.
GetSnapshot(ctx context.Context, in *GetSnapshotRequest, opts ...grpc.CallOption) (*Snapshot, error)
// Lists all snapshots associated with the specified cluster.
//
// 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.
ListSnapshots(ctx context.Context, in *ListSnapshotsRequest, opts ...grpc.CallOption) (*ListSnapshotsResponse, error)
// Permanently deletes the specified snapshot.
//
// 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.
DeleteSnapshot(ctx context.Context, in *DeleteSnapshotRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Starts creating a new Cloud Bigtable Backup. The returned backup
// [long-running operation][google.longrunning.Operation] can be used to
// track creation of the backup. The
// [metadata][google.longrunning.Operation.metadata] field type is
// [CreateBackupMetadata][google.bigtable.admin.v2.CreateBackupMetadata]. The
// [response][google.longrunning.Operation.response] field type is
// [Backup][google.bigtable.admin.v2.Backup], if successful. Cancelling the
// returned operation will stop the creation and delete the backup.
CreateBackup(ctx context.Context, in *CreateBackupRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Gets metadata on a pending or completed Cloud Bigtable Backup.
GetBackup(ctx context.Context, in *GetBackupRequest, opts ...grpc.CallOption) (*Backup, error)
// Updates a pending or completed Cloud Bigtable Backup.
UpdateBackup(ctx context.Context, in *UpdateBackupRequest, opts ...grpc.CallOption) (*Backup, error)
// Deletes a pending or completed Cloud Bigtable backup.
DeleteBackup(ctx context.Context, in *DeleteBackupRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Lists Cloud Bigtable backups. Returns both completed and pending
// backups.
ListBackups(ctx context.Context, in *ListBackupsRequest, opts ...grpc.CallOption) (*ListBackupsResponse, error)
// Create a new table by restoring from a completed backup. The
// returned table [long-running operation][google.longrunning.Operation] can
// be used to track the progress of the operation, and to cancel it. The
// [metadata][google.longrunning.Operation.metadata] field type is
// [RestoreTableMetadata][google.bigtable.admin.RestoreTableMetadata]. The
// [response][google.longrunning.Operation.response] type is
// [Table][google.bigtable.admin.v2.Table], if successful.
RestoreTable(ctx context.Context, in *RestoreTableRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Copy a Cloud Bigtable backup to a new backup in the destination cluster
// located in the destination instance and project.
CopyBackup(ctx context.Context, in *CopyBackupRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Gets the access control policy for a Table or Backup resource.
// Returns an empty policy if the resource exists but does not have a policy
// set.
GetIamPolicy(ctx context.Context, in *iampb.GetIamPolicyRequest, opts ...grpc.CallOption) (*iampb.Policy, error)
// Sets the access control policy on a Table or Backup resource.
// Replaces any existing policy.
SetIamPolicy(ctx context.Context, in *iampb.SetIamPolicyRequest, opts ...grpc.CallOption) (*iampb.Policy, error)
// Returns permissions that the caller has on the specified Table or Backup
// resource.
TestIamPermissions(ctx context.Context, in *iampb.TestIamPermissionsRequest, opts ...grpc.CallOption) (*iampb.TestIamPermissionsResponse, error)
}
func NewBigtableTableAdminClient(cc grpc.ClientConnInterface) BigtableTableAdminClient
BigtableTableAdminServer is the server API for BigtableTableAdmin service.
type BigtableTableAdminServer interface {
// 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.
CreateTable(context.Context, *CreateTableRequest) (*Table, error)
// Creates a new table from the specified snapshot. The target table must
// not exist. The snapshot and the table must be in the same instance.
//
// 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.
CreateTableFromSnapshot(context.Context, *CreateTableFromSnapshotRequest) (*longrunningpb.Operation, error)
// Lists all tables served from a specified instance.
ListTables(context.Context, *ListTablesRequest) (*ListTablesResponse, error)
// Gets metadata information about the specified table.
GetTable(context.Context, *GetTableRequest) (*Table, error)
// Updates a specified table.
UpdateTable(context.Context, *UpdateTableRequest) (*longrunningpb.Operation, error)
// Permanently deletes a specified table and all of its data.
DeleteTable(context.Context, *DeleteTableRequest) (*emptypb.Empty, error)
// Restores a specified table which was accidentally deleted.
UndeleteTable(context.Context, *UndeleteTableRequest) (*longrunningpb.Operation, error)
// Creates a new AuthorizedView in a table.
CreateAuthorizedView(context.Context, *CreateAuthorizedViewRequest) (*longrunningpb.Operation, error)
// Lists all AuthorizedViews from a specific table.
ListAuthorizedViews(context.Context, *ListAuthorizedViewsRequest) (*ListAuthorizedViewsResponse, error)
// Gets information from a specified AuthorizedView.
GetAuthorizedView(context.Context, *GetAuthorizedViewRequest) (*AuthorizedView, error)
// Updates an AuthorizedView in a table.
UpdateAuthorizedView(context.Context, *UpdateAuthorizedViewRequest) (*longrunningpb.Operation, error)
// Permanently deletes a specified AuthorizedView.
DeleteAuthorizedView(context.Context, *DeleteAuthorizedViewRequest) (*emptypb.Empty, error)
// Performs a series of column family modifications on the specified table.
// Either all or none of the modifications will occur before this method
// returns, but data requests received prior to that point may see a table
// where only some modifications have taken effect.
ModifyColumnFamilies(context.Context, *ModifyColumnFamiliesRequest) (*Table, error)
// Permanently drop/delete a row range from a specified table. The request can
// specify whether to delete all rows in a table, or only those that match a
// particular prefix.
DropRowRange(context.Context, *DropRowRangeRequest) (*emptypb.Empty, error)
// Generates a consistency token for a Table, which can be used in
// CheckConsistency to check whether mutations to the table that finished
// before this call started have been replicated. The tokens will be available
// for 90 days.
GenerateConsistencyToken(context.Context, *GenerateConsistencyTokenRequest) (*GenerateConsistencyTokenResponse, error)
// Checks replication consistency based on a consistency token, that is, if
// replication has caught up based on the conditions specified in the token
// and the check request.
CheckConsistency(context.Context, *CheckConsistencyRequest) (*CheckConsistencyResponse, error)
// Creates a new snapshot in the specified cluster from the specified
// source table. The cluster and the table must be in the same instance.
//
// 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.
SnapshotTable(context.Context, *SnapshotTableRequest) (*longrunningpb.Operation, error)
// Gets metadata information about the specified snapshot.
//
// 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.
GetSnapshot(context.Context, *GetSnapshotRequest) (*Snapshot, error)
// Lists all snapshots associated with the specified cluster.
//
// 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.
ListSnapshots(context.Context, *ListSnapshotsRequest) (*ListSnapshotsResponse, error)
// Permanently deletes the specified snapshot.
//
// 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.
DeleteSnapshot(context.Context, *DeleteSnapshotRequest) (*emptypb.Empty, error)
// Starts creating a new Cloud Bigtable Backup. The returned backup
// [long-running operation][google.longrunning.Operation] can be used to
// track creation of the backup. The
// [metadata][google.longrunning.Operation.metadata] field type is
// [CreateBackupMetadata][google.bigtable.admin.v2.CreateBackupMetadata]. The
// [response][google.longrunning.Operation.response] field type is
// [Backup][google.bigtable.admin.v2.Backup], if successful. Cancelling the
// returned operation will stop the creation and delete the backup.
CreateBackup(context.Context, *CreateBackupRequest) (*longrunningpb.Operation, error)
// Gets metadata on a pending or completed Cloud Bigtable Backup.
GetBackup(context.Context, *GetBackupRequest) (*Backup, error)
// Updates a pending or completed Cloud Bigtable Backup.
UpdateBackup(context.Context, *UpdateBackupRequest) (*Backup, error)
// Deletes a pending or completed Cloud Bigtable backup.
DeleteBackup(context.Context, *DeleteBackupRequest) (*emptypb.Empty, error)
// Lists Cloud Bigtable backups. Returns both completed and pending
// backups.
ListBackups(context.Context, *ListBackupsRequest) (*ListBackupsResponse, error)
// Create a new table by restoring from a completed backup. The
// returned table [long-running operation][google.longrunning.Operation] can
// be used to track the progress of the operation, and to cancel it. The
// [metadata][google.longrunning.Operation.metadata] field type is
// [RestoreTableMetadata][google.bigtable.admin.RestoreTableMetadata]. The
// [response][google.longrunning.Operation.response] type is
// [Table][google.bigtable.admin.v2.Table], if successful.
RestoreTable(context.Context, *RestoreTableRequest) (*longrunningpb.Operation, error)
// Copy a Cloud Bigtable backup to a new backup in the destination cluster
// located in the destination instance and project.
CopyBackup(context.Context, *CopyBackupRequest) (*longrunningpb.Operation, error)
// Gets the access control policy for a Table or Backup resource.
// Returns an empty policy if the resource exists but does not have a policy
// set.
GetIamPolicy(context.Context, *iampb.GetIamPolicyRequest) (*iampb.Policy, error)
// Sets the access control policy on a Table or Backup resource.
// Replaces any existing policy.
SetIamPolicy(context.Context, *iampb.SetIamPolicyRequest) (*iampb.Policy, error)
// Returns permissions that the caller has on the specified Table or Backup
// resource.
TestIamPermissions(context.Context, *iampb.TestIamPermissionsRequest) (*iampb.TestIamPermissionsResponse, error)
}
Change stream configuration.
type ChangeStreamConfig struct {
// 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 *durationpb.Duration `protobuf:"bytes,1,opt,name=retention_period,json=retentionPeriod,proto3" json:"retention_period,omitempty"`
// contains filtered or unexported fields
}
func (*ChangeStreamConfig) Descriptor() ([]byte, []int)
Deprecated: Use ChangeStreamConfig.ProtoReflect.Descriptor instead.
func (x *ChangeStreamConfig) GetRetentionPeriod() *durationpb.Duration
func (*ChangeStreamConfig) ProtoMessage()
func (x *ChangeStreamConfig) ProtoReflect() protoreflect.Message
func (x *ChangeStreamConfig) Reset()
func (x *ChangeStreamConfig) String() string
Request message for [google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency][google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency]
type CheckConsistencyRequest struct {
// Required. The unique name of the Table for which to check replication
// consistency. Values are of the form
// `projects/{project}/instances/{instance}/tables/{table}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. The token created using GenerateConsistencyToken for the Table.
ConsistencyToken string `protobuf:"bytes,2,opt,name=consistency_token,json=consistencyToken,proto3" json:"consistency_token,omitempty"`
// Which type of read needs to consistently observe which type of write?
// Default: `standard_read_remote_writes`
//
// Types that are assignable to Mode:
//
// *CheckConsistencyRequest_StandardReadRemoteWrites
// *CheckConsistencyRequest_DataBoostReadLocalWrites
Mode isCheckConsistencyRequest_Mode `protobuf_oneof:"mode"`
// contains filtered or unexported fields
}
func (*CheckConsistencyRequest) Descriptor() ([]byte, []int)
Deprecated: Use CheckConsistencyRequest.ProtoReflect.Descriptor instead.
func (x *CheckConsistencyRequest) GetConsistencyToken() string
func (x *CheckConsistencyRequest) GetDataBoostReadLocalWrites() *DataBoostReadLocalWrites
func (m *CheckConsistencyRequest) GetMode() isCheckConsistencyRequest_Mode
func (x *CheckConsistencyRequest) GetName() string
func (x *CheckConsistencyRequest) GetStandardReadRemoteWrites() *StandardReadRemoteWrites
func (*CheckConsistencyRequest) ProtoMessage()
func (x *CheckConsistencyRequest) ProtoReflect() protoreflect.Message
func (x *CheckConsistencyRequest) Reset()
func (x *CheckConsistencyRequest) String() string
type CheckConsistencyRequest_DataBoostReadLocalWrites struct {
// Checks that reads using an app profile with `DataBoostIsolationReadOnly`
// can see all writes committed before the token was created, but only if
// the read and write target the same cluster.
DataBoostReadLocalWrites *DataBoostReadLocalWrites `protobuf:"bytes,4,opt,name=data_boost_read_local_writes,json=dataBoostReadLocalWrites,proto3,oneof"`
}
type CheckConsistencyRequest_StandardReadRemoteWrites struct {
// Checks that reads using an app profile with `StandardIsolation` can
// see all writes committed before the token was created, even if the
// read and write target different clusters.
StandardReadRemoteWrites *StandardReadRemoteWrites `protobuf:"bytes,3,opt,name=standard_read_remote_writes,json=standardReadRemoteWrites,proto3,oneof"`
}
Response message for [google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency][google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency]
type CheckConsistencyResponse struct {
// True only if the token is consistent. A token is consistent if replication
// has caught up with the restrictions specified in the request.
Consistent bool `protobuf:"varint,1,opt,name=consistent,proto3" json:"consistent,omitempty"`
// contains filtered or unexported fields
}
func (*CheckConsistencyResponse) Descriptor() ([]byte, []int)
Deprecated: Use CheckConsistencyResponse.ProtoReflect.Descriptor instead.
func (x *CheckConsistencyResponse) GetConsistent() bool
func (*CheckConsistencyResponse) ProtoMessage()
func (x *CheckConsistencyResponse) ProtoReflect() protoreflect.Message
func (x *CheckConsistencyResponse) Reset()
func (x *CheckConsistencyResponse) String() string
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].
type Cluster struct {
// The unique name of the cluster. Values are of the form
// `projects/{project}/instances/{instance}/clusters/[a-z][-a-z0-9]*`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Immutable. The location where this cluster's nodes and storage reside. For
// best performance, clients should be located as close as possible to this
// cluster. Currently only zones are supported, so values should be of the
// form `projects/{project}/locations/{zone}`.
Location string `protobuf:"bytes,2,opt,name=location,proto3" json:"location,omitempty"`
// Output only. The current state of the cluster.
State Cluster_State `protobuf:"varint,3,opt,name=state,proto3,enum=google.bigtable.admin.v2.Cluster_State" json:"state,omitempty"`
// The number of nodes allocated to this cluster. More nodes enable higher
// throughput and more consistent performance.
ServeNodes int32 `protobuf:"varint,4,opt,name=serve_nodes,json=serveNodes,proto3" json:"serve_nodes,omitempty"`
// Types that are assignable to Config:
//
// *Cluster_ClusterConfig_
Config isCluster_Config `protobuf_oneof:"config"`
// Immutable. The type of storage used by this cluster to serve its
// parent instance's tables, unless explicitly overridden.
DefaultStorageType StorageType `protobuf:"varint,5,opt,name=default_storage_type,json=defaultStorageType,proto3,enum=google.bigtable.admin.v2.StorageType" json:"default_storage_type,omitempty"`
// Immutable. The encryption configuration for CMEK-protected clusters.
EncryptionConfig *Cluster_EncryptionConfig `protobuf:"bytes,6,opt,name=encryption_config,json=encryptionConfig,proto3" json:"encryption_config,omitempty"`
// contains filtered or unexported fields
}
func (*Cluster) Descriptor() ([]byte, []int)
Deprecated: Use Cluster.ProtoReflect.Descriptor instead.
func (x *Cluster) GetClusterConfig() *Cluster_ClusterConfig
func (m *Cluster) GetConfig() isCluster_Config
func (x *Cluster) GetDefaultStorageType() StorageType
func (x *Cluster) GetEncryptionConfig() *Cluster_EncryptionConfig
func (x *Cluster) GetLocation() string
func (x *Cluster) GetName() string
func (x *Cluster) GetServeNodes() int32
func (x *Cluster) GetState() Cluster_State
func (*Cluster) ProtoMessage()
func (x *Cluster) ProtoReflect() protoreflect.Message
func (x *Cluster) Reset()
func (x *Cluster) String() string
Autoscaling config for a cluster.
type Cluster_ClusterAutoscalingConfig struct {
// Required. Autoscaling limits for this cluster.
AutoscalingLimits *AutoscalingLimits `protobuf:"bytes,1,opt,name=autoscaling_limits,json=autoscalingLimits,proto3" json:"autoscaling_limits,omitempty"`
// Required. Autoscaling targets for this cluster.
AutoscalingTargets *AutoscalingTargets `protobuf:"bytes,2,opt,name=autoscaling_targets,json=autoscalingTargets,proto3" json:"autoscaling_targets,omitempty"`
// contains filtered or unexported fields
}
func (*Cluster_ClusterAutoscalingConfig) Descriptor() ([]byte, []int)
Deprecated: Use Cluster_ClusterAutoscalingConfig.ProtoReflect.Descriptor instead.
func (x *Cluster_ClusterAutoscalingConfig) GetAutoscalingLimits() *AutoscalingLimits
func (x *Cluster_ClusterAutoscalingConfig) GetAutoscalingTargets() *AutoscalingTargets
func (*Cluster_ClusterAutoscalingConfig) ProtoMessage()
func (x *Cluster_ClusterAutoscalingConfig) ProtoReflect() protoreflect.Message
func (x *Cluster_ClusterAutoscalingConfig) Reset()
func (x *Cluster_ClusterAutoscalingConfig) String() string
Configuration for a cluster.
type Cluster_ClusterConfig struct {
// Autoscaling configuration for this cluster.
ClusterAutoscalingConfig *Cluster_ClusterAutoscalingConfig `protobuf:"bytes,1,opt,name=cluster_autoscaling_config,json=clusterAutoscalingConfig,proto3" json:"cluster_autoscaling_config,omitempty"`
// contains filtered or unexported fields
}
func (*Cluster_ClusterConfig) Descriptor() ([]byte, []int)
Deprecated: Use Cluster_ClusterConfig.ProtoReflect.Descriptor instead.
func (x *Cluster_ClusterConfig) GetClusterAutoscalingConfig() *Cluster_ClusterAutoscalingConfig
func (*Cluster_ClusterConfig) ProtoMessage()
func (x *Cluster_ClusterConfig) ProtoReflect() protoreflect.Message
func (x *Cluster_ClusterConfig) Reset()
func (x *Cluster_ClusterConfig) String() string
type Cluster_ClusterConfig_ struct {
// Configuration for this cluster.
ClusterConfig *Cluster_ClusterConfig `protobuf:"bytes,7,opt,name=cluster_config,json=clusterConfig,proto3,oneof"`
}
Cloud Key Management Service (Cloud KMS) settings for a CMEK-protected cluster.
type Cluster_EncryptionConfig struct {
// Describes the Cloud KMS encryption key that will be used to protect the
// destination Bigtable cluster. The requirements for this key are:
// 1. The Cloud Bigtable service account associated with the project that
// contains this cluster must be granted the
// `cloudkms.cryptoKeyEncrypterDecrypter` role on the CMEK key.
// 2. Only regional keys can be used and the region of the CMEK key must
// match the region of the cluster.
// 3. All clusters within an instance must use the same CMEK key.
//
// Values are of the form
// `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}`
KmsKeyName string `protobuf:"bytes,1,opt,name=kms_key_name,json=kmsKeyName,proto3" json:"kms_key_name,omitempty"`
// contains filtered or unexported fields
}
func (*Cluster_EncryptionConfig) Descriptor() ([]byte, []int)
Deprecated: Use Cluster_EncryptionConfig.ProtoReflect.Descriptor instead.
func (x *Cluster_EncryptionConfig) GetKmsKeyName() string
func (*Cluster_EncryptionConfig) ProtoMessage()
func (x *Cluster_EncryptionConfig) ProtoReflect() protoreflect.Message
func (x *Cluster_EncryptionConfig) Reset()
func (x *Cluster_EncryptionConfig) String() string
Possible states of a cluster.
type Cluster_State int32
const (
// The state of the cluster could not be determined.
Cluster_STATE_NOT_KNOWN Cluster_State = 0
// The cluster has been successfully created and is ready to serve requests.
Cluster_READY Cluster_State = 1
// The cluster is currently being created, and may be destroyed
// if the creation process encounters an error.
// A cluster may not be able to serve requests while being created.
Cluster_CREATING Cluster_State = 2
// The cluster is currently being resized, and may revert to its previous
// node count if the process encounters an error.
// A cluster is still capable of serving requests while being resized,
// but may exhibit performance as if its number of allocated nodes is
// between the starting and requested states.
Cluster_RESIZING Cluster_State = 3
// The cluster has no backing nodes. The data (tables) still
// exist, but no operations can be performed on the cluster.
Cluster_DISABLED Cluster_State = 4
)
func (Cluster_State) Descriptor() protoreflect.EnumDescriptor
func (x Cluster_State) Enum() *Cluster_State
func (Cluster_State) EnumDescriptor() ([]byte, []int)
Deprecated: Use Cluster_State.Descriptor instead.
func (x Cluster_State) Number() protoreflect.EnumNumber
func (x Cluster_State) String() string
func (Cluster_State) Type() protoreflect.EnumType
A set of columns within a table which share a common configuration.
type ColumnFamily struct {
// Garbage collection rule specified as a protobuf.
// Must serialize to at most 500 bytes.
//
// 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.
GcRule *GcRule `protobuf:"bytes,1,opt,name=gc_rule,json=gcRule,proto3" json:"gc_rule,omitempty"`
// The type of data stored in each of this family's cell values, including its
// full encoding. If omitted, the family only serves raw untyped bytes.
//
// For now, only the `Aggregate` type is supported.
//
// `Aggregate` can only be set at family creation and is immutable afterwards.
//
// If `value_type` is `Aggregate`, written data must be compatible with:
// - `value_type.input_type` for `AddInput` mutations
ValueType *Type `protobuf:"bytes,3,opt,name=value_type,json=valueType,proto3" json:"value_type,omitempty"`
// contains filtered or unexported fields
}
func (*ColumnFamily) Descriptor() ([]byte, []int)
Deprecated: Use ColumnFamily.ProtoReflect.Descriptor instead.
func (x *ColumnFamily) GetGcRule() *GcRule
func (x *ColumnFamily) GetValueType() *Type
func (*ColumnFamily) ProtoMessage()
func (x *ColumnFamily) ProtoReflect() protoreflect.Message
func (x *ColumnFamily) Reset()
func (x *ColumnFamily) String() string
Metadata type for the google.longrunning.Operation returned by [CopyBackup][google.bigtable.admin.v2.BigtableTableAdmin.CopyBackup].
type CopyBackupMetadata struct {
// The name of the backup being created through the copy operation.
// Values are of the form
// `projects/<project>/instances/<instance>/clusters/<cluster>/backups/<backup>`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Information about the source backup that is being copied from.
SourceBackupInfo *BackupInfo `protobuf:"bytes,2,opt,name=source_backup_info,json=sourceBackupInfo,proto3" json:"source_backup_info,omitempty"`
// The progress of the
// [CopyBackup][google.bigtable.admin.v2.BigtableTableAdmin.CopyBackup]
// operation.
Progress *OperationProgress `protobuf:"bytes,3,opt,name=progress,proto3" json:"progress,omitempty"`
// contains filtered or unexported fields
}
func (*CopyBackupMetadata) Descriptor() ([]byte, []int)
Deprecated: Use CopyBackupMetadata.ProtoReflect.Descriptor instead.
func (x *CopyBackupMetadata) GetName() string
func (x *CopyBackupMetadata) GetProgress() *OperationProgress
func (x *CopyBackupMetadata) GetSourceBackupInfo() *BackupInfo
func (*CopyBackupMetadata) ProtoMessage()
func (x *CopyBackupMetadata) ProtoReflect() protoreflect.Message
func (x *CopyBackupMetadata) Reset()
func (x *CopyBackupMetadata) String() string
The request for [CopyBackup][google.bigtable.admin.v2.BigtableTableAdmin.CopyBackup].
type CopyBackupRequest struct {
// Required. The name of the destination cluster that will contain the backup
// copy. The cluster must already exists. Values are of the form:
// `projects/{project}/instances/{instance}/clusters/{cluster}`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The id of the new backup. The `backup_id` along with `parent`
// are combined as {parent}/backups/{backup_id} to create the full backup
// name, of the form:
// `projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup_id}`.
// This string must be between 1 and 50 characters in length and match the
// regex [_a-zA-Z0-9][-_.a-zA-Z0-9]*.
BackupId string `protobuf:"bytes,2,opt,name=backup_id,json=backupId,proto3" json:"backup_id,omitempty"`
// Required. The source backup to be copied from.
// The source backup needs to be in READY state for it to be copied.
// Copying a copied backup is not allowed.
// Once CopyBackup is in progress, the source backup cannot be deleted or
// cleaned up on expiration until CopyBackup is finished.
// Values are of the form:
// `projects/<project>/instances/<instance>/clusters/<cluster>/backups/<backup>`.
SourceBackup string `protobuf:"bytes,3,opt,name=source_backup,json=sourceBackup,proto3" json:"source_backup,omitempty"`
// Required. Required. The expiration time of the copied backup with
// microsecond granularity that must be at least 6 hours and at most 30 days
// from the time the request is received. Once the `expire_time` has
// passed, Cloud Bigtable will delete the backup and free the resources used
// by the backup.
ExpireTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=expire_time,json=expireTime,proto3" json:"expire_time,omitempty"`
// contains filtered or unexported fields
}
func (*CopyBackupRequest) Descriptor() ([]byte, []int)
Deprecated: Use CopyBackupRequest.ProtoReflect.Descriptor instead.
func (x *CopyBackupRequest) GetBackupId() string
func (x *CopyBackupRequest) GetExpireTime() *timestamppb.Timestamp
func (x *CopyBackupRequest) GetParent() string
func (x *CopyBackupRequest) GetSourceBackup() string
func (*CopyBackupRequest) ProtoMessage()
func (x *CopyBackupRequest) ProtoReflect() protoreflect.Message
func (x *CopyBackupRequest) Reset()
func (x *CopyBackupRequest) String() string
Request message for BigtableInstanceAdmin.CreateAppProfile.
type CreateAppProfileRequest struct {
// Required. The unique name of the instance in which to create the new app
// profile. Values are of the form `projects/{project}/instances/{instance}`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The ID to be used when referring to the new app profile within
// its instance, e.g., just `myprofile` rather than
// `projects/myproject/instances/myinstance/appProfiles/myprofile`.
AppProfileId string `protobuf:"bytes,2,opt,name=app_profile_id,json=appProfileId,proto3" json:"app_profile_id,omitempty"`
// Required. The app profile to be created.
// Fields marked `OutputOnly` will be ignored.
AppProfile *AppProfile `protobuf:"bytes,3,opt,name=app_profile,json=appProfile,proto3" json:"app_profile,omitempty"`
// If true, ignore safety checks when creating the app profile.
IgnoreWarnings bool `protobuf:"varint,4,opt,name=ignore_warnings,json=ignoreWarnings,proto3" json:"ignore_warnings,omitempty"`
// contains filtered or unexported fields
}
func (*CreateAppProfileRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateAppProfileRequest.ProtoReflect.Descriptor instead.
func (x *CreateAppProfileRequest) GetAppProfile() *AppProfile
func (x *CreateAppProfileRequest) GetAppProfileId() string
func (x *CreateAppProfileRequest) GetIgnoreWarnings() bool
func (x *CreateAppProfileRequest) GetParent() string
func (*CreateAppProfileRequest) ProtoMessage()
func (x *CreateAppProfileRequest) ProtoReflect() protoreflect.Message
func (x *CreateAppProfileRequest) Reset()
func (x *CreateAppProfileRequest) String() string
The metadata for the Operation returned by CreateAuthorizedView.
type CreateAuthorizedViewMetadata struct {
// The request that prompted the initiation of this CreateInstance operation.
OriginalRequest *CreateAuthorizedViewRequest `protobuf:"bytes,1,opt,name=original_request,json=originalRequest,proto3" json:"original_request,omitempty"`
// The time at which the original request was received.
RequestTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=request_time,json=requestTime,proto3" json:"request_time,omitempty"`
// The time at which the operation failed or was completed successfully.
FinishTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=finish_time,json=finishTime,proto3" json:"finish_time,omitempty"`
// contains filtered or unexported fields
}
func (*CreateAuthorizedViewMetadata) Descriptor() ([]byte, []int)
Deprecated: Use CreateAuthorizedViewMetadata.ProtoReflect.Descriptor instead.
func (x *CreateAuthorizedViewMetadata) GetFinishTime() *timestamppb.Timestamp
func (x *CreateAuthorizedViewMetadata) GetOriginalRequest() *CreateAuthorizedViewRequest
func (x *CreateAuthorizedViewMetadata) GetRequestTime() *timestamppb.Timestamp
func (*CreateAuthorizedViewMetadata) ProtoMessage()
func (x *CreateAuthorizedViewMetadata) ProtoReflect() protoreflect.Message
func (x *CreateAuthorizedViewMetadata) Reset()
func (x *CreateAuthorizedViewMetadata) String() string
The request for [CreateAuthorizedView][google.bigtable.admin.v2.BigtableTableAdmin.CreateAuthorizedView]
type CreateAuthorizedViewRequest struct {
// Required. This is the name of the table the AuthorizedView belongs to.
// Values are of the form
// `projects/{project}/instances/{instance}/tables/{table}`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The id of the AuthorizedView to create. This AuthorizedView must
// not already exist. The `authorized_view_id` appended to `parent` forms the
// full AuthorizedView name of the form
// `projects/{project}/instances/{instance}/tables/{table}/authorizedView/{authorized_view}`.
AuthorizedViewId string `protobuf:"bytes,2,opt,name=authorized_view_id,json=authorizedViewId,proto3" json:"authorized_view_id,omitempty"`
// Required. The AuthorizedView to create.
AuthorizedView *AuthorizedView `protobuf:"bytes,3,opt,name=authorized_view,json=authorizedView,proto3" json:"authorized_view,omitempty"`
// contains filtered or unexported fields
}
func (*CreateAuthorizedViewRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateAuthorizedViewRequest.ProtoReflect.Descriptor instead.
func (x *CreateAuthorizedViewRequest) GetAuthorizedView() *AuthorizedView
func (x *CreateAuthorizedViewRequest) GetAuthorizedViewId() string
func (x *CreateAuthorizedViewRequest) GetParent() string
func (*CreateAuthorizedViewRequest) ProtoMessage()
func (x *CreateAuthorizedViewRequest) ProtoReflect() protoreflect.Message
func (x *CreateAuthorizedViewRequest) Reset()
func (x *CreateAuthorizedViewRequest) String() string
Metadata type for the operation returned by [CreateBackup][google.bigtable.admin.v2.BigtableTableAdmin.CreateBackup].
type CreateBackupMetadata struct {
// The name of the backup being created.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// The name of the table the backup is created from.
SourceTable string `protobuf:"bytes,2,opt,name=source_table,json=sourceTable,proto3" json:"source_table,omitempty"`
// The time at which this operation started.
StartTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
// If set, the time at which this operation finished or was cancelled.
EndTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
// contains filtered or unexported fields
}
func (*CreateBackupMetadata) Descriptor() ([]byte, []int)
Deprecated: Use CreateBackupMetadata.ProtoReflect.Descriptor instead.
func (x *CreateBackupMetadata) GetEndTime() *timestamppb.Timestamp
func (x *CreateBackupMetadata) GetName() string
func (x *CreateBackupMetadata) GetSourceTable() string
func (x *CreateBackupMetadata) GetStartTime() *timestamppb.Timestamp
func (*CreateBackupMetadata) ProtoMessage()
func (x *CreateBackupMetadata) ProtoReflect() protoreflect.Message
func (x *CreateBackupMetadata) Reset()
func (x *CreateBackupMetadata) String() string
The request for [CreateBackup][google.bigtable.admin.v2.BigtableTableAdmin.CreateBackup].
type CreateBackupRequest struct {
// Required. This must be one of the clusters in the instance in which this
// table is located. The backup will be stored in this cluster. Values are
// of the form `projects/{project}/instances/{instance}/clusters/{cluster}`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The id of the backup to be created. The `backup_id` along with
// the parent `parent` are combined as {parent}/backups/{backup_id} to create
// the full backup name, of the form:
// `projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup_id}`.
// This string must be between 1 and 50 characters in length and match the
// regex [_a-zA-Z0-9][-_.a-zA-Z0-9]*.
BackupId string `protobuf:"bytes,2,opt,name=backup_id,json=backupId,proto3" json:"backup_id,omitempty"`
// Required. The backup to create.
Backup *Backup `protobuf:"bytes,3,opt,name=backup,proto3" json:"backup,omitempty"`
// contains filtered or unexported fields
}
func (*CreateBackupRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateBackupRequest.ProtoReflect.Descriptor instead.
func (x *CreateBackupRequest) GetBackup() *Backup
func (x *CreateBackupRequest) GetBackupId() string
func (x *CreateBackupRequest) GetParent() string
func (*CreateBackupRequest) ProtoMessage()
func (x *CreateBackupRequest) ProtoReflect() protoreflect.Message
func (x *CreateBackupRequest) Reset()
func (x *CreateBackupRequest) String() string
The metadata for the Operation returned by CreateCluster.
type CreateClusterMetadata struct {
// The request that prompted the initiation of this CreateCluster operation.
OriginalRequest *CreateClusterRequest `protobuf:"bytes,1,opt,name=original_request,json=originalRequest,proto3" json:"original_request,omitempty"`
// The time at which the original request was received.
RequestTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=request_time,json=requestTime,proto3" json:"request_time,omitempty"`
// The time at which the operation failed or was completed successfully.
FinishTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=finish_time,json=finishTime,proto3" json:"finish_time,omitempty"`
// Keys: the full `name` of each table that existed in the instance when
// CreateCluster was first called, i.e.
// `projects/<project>/instances/<instance>/tables/<table>`. Any table added
// to the instance by a later API call will be created in the new cluster by
// that API call, not this one.
//
// Values: information on how much of a table's data has been copied to the
// newly-created cluster so far.
Tables map[string]*CreateClusterMetadata_TableProgress `protobuf:"bytes,4,rep,name=tables,proto3" json:"tables,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// contains filtered or unexported fields
}
func (*CreateClusterMetadata) Descriptor() ([]byte, []int)
Deprecated: Use CreateClusterMetadata.ProtoReflect.Descriptor instead.
func (x *CreateClusterMetadata) GetFinishTime() *timestamppb.Timestamp
func (x *CreateClusterMetadata) GetOriginalRequest() *CreateClusterRequest
func (x *CreateClusterMetadata) GetRequestTime() *timestamppb.Timestamp
func (x *CreateClusterMetadata) GetTables() map[string]*CreateClusterMetadata_TableProgress
func (*CreateClusterMetadata) ProtoMessage()
func (x *CreateClusterMetadata) ProtoReflect() protoreflect.Message
func (x *CreateClusterMetadata) Reset()
func (x *CreateClusterMetadata) String() string
Progress info for copying a table's data to the new cluster.
type CreateClusterMetadata_TableProgress struct {
// Estimate of the size of the table to be copied.
EstimatedSizeBytes int64 `protobuf:"varint,2,opt,name=estimated_size_bytes,json=estimatedSizeBytes,proto3" json:"estimated_size_bytes,omitempty"`
// Estimate of the number of bytes copied so far for this table.
// This will eventually reach 'estimated_size_bytes' unless the table copy
// is CANCELLED.
EstimatedCopiedBytes int64 `protobuf:"varint,3,opt,name=estimated_copied_bytes,json=estimatedCopiedBytes,proto3" json:"estimated_copied_bytes,omitempty"`
State CreateClusterMetadata_TableProgress_State `protobuf:"varint,4,opt,name=state,proto3,enum=google.bigtable.admin.v2.CreateClusterMetadata_TableProgress_State" json:"state,omitempty"`
// contains filtered or unexported fields
}
func (*CreateClusterMetadata_TableProgress) Descriptor() ([]byte, []int)
Deprecated: Use CreateClusterMetadata_TableProgress.ProtoReflect.Descriptor instead.
func (x *CreateClusterMetadata_TableProgress) GetEstimatedCopiedBytes() int64
func (x *CreateClusterMetadata_TableProgress) GetEstimatedSizeBytes() int64
func (x *CreateClusterMetadata_TableProgress) GetState() CreateClusterMetadata_TableProgress_State
func (*CreateClusterMetadata_TableProgress) ProtoMessage()
func (x *CreateClusterMetadata_TableProgress) ProtoReflect() protoreflect.Message
func (x *CreateClusterMetadata_TableProgress) Reset()
func (x *CreateClusterMetadata_TableProgress) String() string
type CreateClusterMetadata_TableProgress_State int32
const (
CreateClusterMetadata_TableProgress_STATE_UNSPECIFIED CreateClusterMetadata_TableProgress_State = 0
// The table has not yet begun copying to the new cluster.
CreateClusterMetadata_TableProgress_PENDING CreateClusterMetadata_TableProgress_State = 1
// The table is actively being copied to the new cluster.
CreateClusterMetadata_TableProgress_COPYING CreateClusterMetadata_TableProgress_State = 2
// The table has been fully copied to the new cluster.
CreateClusterMetadata_TableProgress_COMPLETED CreateClusterMetadata_TableProgress_State = 3
// The table was deleted before it finished copying to the new cluster.
// Note that tables deleted after completion will stay marked as
// COMPLETED, not CANCELLED.
CreateClusterMetadata_TableProgress_CANCELLED CreateClusterMetadata_TableProgress_State = 4
)
func (CreateClusterMetadata_TableProgress_State) Descriptor() protoreflect.EnumDescriptor
func (x CreateClusterMetadata_TableProgress_State) Enum() *CreateClusterMetadata_TableProgress_State
func (CreateClusterMetadata_TableProgress_State) EnumDescriptor() ([]byte, []int)
Deprecated: Use CreateClusterMetadata_TableProgress_State.Descriptor instead.
func (x CreateClusterMetadata_TableProgress_State) Number() protoreflect.EnumNumber
func (x CreateClusterMetadata_TableProgress_State) String() string
func (CreateClusterMetadata_TableProgress_State) Type() protoreflect.EnumType
Request message for BigtableInstanceAdmin.CreateCluster.
type CreateClusterRequest struct {
// Required. The unique name of the instance in which to create the new
// cluster. Values are of the form `projects/{project}/instances/{instance}`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The ID to be used when referring to the new cluster within its
// instance, e.g., just `mycluster` rather than
// `projects/myproject/instances/myinstance/clusters/mycluster`.
ClusterId string `protobuf:"bytes,2,opt,name=cluster_id,json=clusterId,proto3" json:"cluster_id,omitempty"`
// Required. The cluster to be created.
// Fields marked `OutputOnly` must be left blank.
Cluster *Cluster `protobuf:"bytes,3,opt,name=cluster,proto3" json:"cluster,omitempty"`
// contains filtered or unexported fields
}
func (*CreateClusterRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateClusterRequest.ProtoReflect.Descriptor instead.
func (x *CreateClusterRequest) GetCluster() *Cluster
func (x *CreateClusterRequest) GetClusterId() string
func (x *CreateClusterRequest) GetParent() string
func (*CreateClusterRequest) ProtoMessage()
func (x *CreateClusterRequest) ProtoReflect() protoreflect.Message
func (x *CreateClusterRequest) Reset()
func (x *CreateClusterRequest) String() string
The metadata for the Operation returned by CreateInstance.
type CreateInstanceMetadata struct {
// The request that prompted the initiation of this CreateInstance operation.
OriginalRequest *CreateInstanceRequest `protobuf:"bytes,1,opt,name=original_request,json=originalRequest,proto3" json:"original_request,omitempty"`
// The time at which the original request was received.
RequestTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=request_time,json=requestTime,proto3" json:"request_time,omitempty"`
// The time at which the operation failed or was completed successfully.
FinishTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=finish_time,json=finishTime,proto3" json:"finish_time,omitempty"`
// contains filtered or unexported fields
}
func (*CreateInstanceMetadata) Descriptor() ([]byte, []int)
Deprecated: Use CreateInstanceMetadata.ProtoReflect.Descriptor instead.
func (x *CreateInstanceMetadata) GetFinishTime() *timestamppb.Timestamp
func (x *CreateInstanceMetadata) GetOriginalRequest() *CreateInstanceRequest
func (x *CreateInstanceMetadata) GetRequestTime() *timestamppb.Timestamp
func (*CreateInstanceMetadata) ProtoMessage()
func (x *CreateInstanceMetadata) ProtoReflect() protoreflect.Message
func (x *CreateInstanceMetadata) Reset()
func (x *CreateInstanceMetadata) String() string
Request message for BigtableInstanceAdmin.CreateInstance.
type CreateInstanceRequest struct {
// Required. The unique name of the project in which to create the new
// instance. Values are of the form `projects/{project}`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The ID to be used when referring to the new instance within its
// project, e.g., just `myinstance` rather than
// `projects/myproject/instances/myinstance`.
InstanceId string `protobuf:"bytes,2,opt,name=instance_id,json=instanceId,proto3" json:"instance_id,omitempty"`
// Required. The instance to create.
// Fields marked `OutputOnly` must be left blank.
Instance *Instance `protobuf:"bytes,3,opt,name=instance,proto3" json:"instance,omitempty"`
// Required. The clusters to be created within the instance, mapped by desired
// cluster ID, e.g., just `mycluster` rather than
// `projects/myproject/instances/myinstance/clusters/mycluster`.
// Fields marked `OutputOnly` must be left blank.
// Currently, at most four clusters can be specified.
Clusters map[string]*Cluster `protobuf:"bytes,4,rep,name=clusters,proto3" json:"clusters,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// contains filtered or unexported fields
}
func (*CreateInstanceRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateInstanceRequest.ProtoReflect.Descriptor instead.
func (x *CreateInstanceRequest) GetClusters() map[string]*Cluster
func (x *CreateInstanceRequest) GetInstance() *Instance
func (x *CreateInstanceRequest) GetInstanceId() string
func (x *CreateInstanceRequest) GetParent() string
func (*CreateInstanceRequest) ProtoMessage()
func (x *CreateInstanceRequest) ProtoReflect() protoreflect.Message
func (x *CreateInstanceRequest) Reset()
func (x *CreateInstanceRequest) String() string
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.
type CreateTableFromSnapshotMetadata struct {
// The request that prompted the initiation of this CreateTableFromSnapshot
// operation.
OriginalRequest *CreateTableFromSnapshotRequest `protobuf:"bytes,1,opt,name=original_request,json=originalRequest,proto3" json:"original_request,omitempty"`
// The time at which the original request was received.
RequestTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=request_time,json=requestTime,proto3" json:"request_time,omitempty"`
// The time at which the operation failed or was completed successfully.
FinishTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=finish_time,json=finishTime,proto3" json:"finish_time,omitempty"`
// contains filtered or unexported fields
}
func (*CreateTableFromSnapshotMetadata) Descriptor() ([]byte, []int)
Deprecated: Use CreateTableFromSnapshotMetadata.ProtoReflect.Descriptor instead.
func (x *CreateTableFromSnapshotMetadata) GetFinishTime() *timestamppb.Timestamp
func (x *CreateTableFromSnapshotMetadata) GetOriginalRequest() *CreateTableFromSnapshotRequest
func (x *CreateTableFromSnapshotMetadata) GetRequestTime() *timestamppb.Timestamp
func (*CreateTableFromSnapshotMetadata) ProtoMessage()
func (x *CreateTableFromSnapshotMetadata) ProtoReflect() protoreflect.Message
func (x *CreateTableFromSnapshotMetadata) Reset()
func (x *CreateTableFromSnapshotMetadata) String() string
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.
type CreateTableFromSnapshotRequest struct {
// Required. The unique name of the instance in which to create the table.
// Values are of the form `projects/{project}/instances/{instance}`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The name by which the new table should be referred to within the
// parent instance, e.g., `foobar` rather than `{parent}/tables/foobar`.
TableId string `protobuf:"bytes,2,opt,name=table_id,json=tableId,proto3" json:"table_id,omitempty"`
// Required. The unique name of the snapshot from which to restore the table.
// The snapshot and the table must be in the same instance. Values are of the
// form
// `projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}`.
SourceSnapshot string `protobuf:"bytes,3,opt,name=source_snapshot,json=sourceSnapshot,proto3" json:"source_snapshot,omitempty"`
// contains filtered or unexported fields
}
func (*CreateTableFromSnapshotRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateTableFromSnapshotRequest.ProtoReflect.Descriptor instead.
func (x *CreateTableFromSnapshotRequest) GetParent() string
func (x *CreateTableFromSnapshotRequest) GetSourceSnapshot() string
func (x *CreateTableFromSnapshotRequest) GetTableId() string
func (*CreateTableFromSnapshotRequest) ProtoMessage()
func (x *CreateTableFromSnapshotRequest) ProtoReflect() protoreflect.Message
func (x *CreateTableFromSnapshotRequest) Reset()
func (x *CreateTableFromSnapshotRequest) String() string
Request message for [google.bigtable.admin.v2.BigtableTableAdmin.CreateTable][google.bigtable.admin.v2.BigtableTableAdmin.CreateTable]
type CreateTableRequest struct {
// Required. The unique name of the instance in which to create the table.
// Values are of the form `projects/{project}/instances/{instance}`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. 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.
TableId string `protobuf:"bytes,2,opt,name=table_id,json=tableId,proto3" json:"table_id,omitempty"`
// Required. The Table to create.
Table *Table `protobuf:"bytes,3,opt,name=table,proto3" json:"table,omitempty"`
// 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"}.`
InitialSplits []*CreateTableRequest_Split `protobuf:"bytes,4,rep,name=initial_splits,json=initialSplits,proto3" json:"initial_splits,omitempty"`
// contains filtered or unexported fields
}
func (*CreateTableRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateTableRequest.ProtoReflect.Descriptor instead.
func (x *CreateTableRequest) GetInitialSplits() []*CreateTableRequest_Split
func (x *CreateTableRequest) GetParent() string
func (x *CreateTableRequest) GetTable() *Table
func (x *CreateTableRequest) GetTableId() string
func (*CreateTableRequest) ProtoMessage()
func (x *CreateTableRequest) ProtoReflect() protoreflect.Message
func (x *CreateTableRequest) Reset()
func (x *CreateTableRequest) String() string
An initial split point for a newly created table.
type CreateTableRequest_Split struct {
// Row key to use as an initial tablet boundary.
Key []byte `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
// contains filtered or unexported fields
}
func (*CreateTableRequest_Split) Descriptor() ([]byte, []int)
Deprecated: Use CreateTableRequest_Split.ProtoReflect.Descriptor instead.
func (x *CreateTableRequest_Split) GetKey() []byte
func (*CreateTableRequest_Split) ProtoMessage()
func (x *CreateTableRequest_Split) ProtoReflect() protoreflect.Message
func (x *CreateTableRequest_Split) Reset()
func (x *CreateTableRequest_Split) String() string
Checks that all writes before the consistency token was generated in the same cluster are readable by Databoost.
type DataBoostReadLocalWrites struct {
// contains filtered or unexported fields
}
func (*DataBoostReadLocalWrites) Descriptor() ([]byte, []int)
Deprecated: Use DataBoostReadLocalWrites.ProtoReflect.Descriptor instead.
func (*DataBoostReadLocalWrites) ProtoMessage()
func (x *DataBoostReadLocalWrites) ProtoReflect() protoreflect.Message
func (x *DataBoostReadLocalWrites) Reset()
func (x *DataBoostReadLocalWrites) String() string
Request message for BigtableInstanceAdmin.DeleteAppProfile.
type DeleteAppProfileRequest struct {
// Required. The unique name of the app profile to be deleted. Values are of
// the form
// `projects/{project}/instances/{instance}/appProfiles/{app_profile}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. If true, ignore safety checks when deleting the app profile.
IgnoreWarnings bool `protobuf:"varint,2,opt,name=ignore_warnings,json=ignoreWarnings,proto3" json:"ignore_warnings,omitempty"`
// contains filtered or unexported fields
}
func (*DeleteAppProfileRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteAppProfileRequest.ProtoReflect.Descriptor instead.
func (x *DeleteAppProfileRequest) GetIgnoreWarnings() bool
func (x *DeleteAppProfileRequest) GetName() string
func (*DeleteAppProfileRequest) ProtoMessage()
func (x *DeleteAppProfileRequest) ProtoReflect() protoreflect.Message
func (x *DeleteAppProfileRequest) Reset()
func (x *DeleteAppProfileRequest) String() string
Request message for [google.bigtable.admin.v2.BigtableTableAdmin.DeleteAuthorizedView][google.bigtable.admin.v2.BigtableTableAdmin.DeleteAuthorizedView]
type DeleteAuthorizedViewRequest struct {
// Required. The unique name of the AuthorizedView to be deleted.
// Values are of the form
// `projects/{project}/instances/{instance}/tables/{table}/authorizedViews/{authorized_view}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Optional. The current etag of the AuthorizedView.
// If an etag is provided and does not match the current etag of the
// AuthorizedView, deletion will be blocked and an ABORTED error will be
// returned.
Etag string `protobuf:"bytes,2,opt,name=etag,proto3" json:"etag,omitempty"`
// contains filtered or unexported fields
}
func (*DeleteAuthorizedViewRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteAuthorizedViewRequest.ProtoReflect.Descriptor instead.
func (x *DeleteAuthorizedViewRequest) GetEtag() string
func (x *DeleteAuthorizedViewRequest) GetName() string
func (*DeleteAuthorizedViewRequest) ProtoMessage()
func (x *DeleteAuthorizedViewRequest) ProtoReflect() protoreflect.Message
func (x *DeleteAuthorizedViewRequest) Reset()
func (x *DeleteAuthorizedViewRequest) String() string
The request for [DeleteBackup][google.bigtable.admin.v2.BigtableTableAdmin.DeleteBackup].
type DeleteBackupRequest struct {
// Required. Name of the backup to delete.
// Values are of the form
// `projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*DeleteBackupRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteBackupRequest.ProtoReflect.Descriptor instead.
func (x *DeleteBackupRequest) GetName() string
func (*DeleteBackupRequest) ProtoMessage()
func (x *DeleteBackupRequest) ProtoReflect() protoreflect.Message
func (x *DeleteBackupRequest) Reset()
func (x *DeleteBackupRequest) String() string
Request message for BigtableInstanceAdmin.DeleteCluster.
type DeleteClusterRequest struct {
// Required. The unique name of the cluster to be deleted. Values are of the
// form `projects/{project}/instances/{instance}/clusters/{cluster}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*DeleteClusterRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteClusterRequest.ProtoReflect.Descriptor instead.
func (x *DeleteClusterRequest) GetName() string
func (*DeleteClusterRequest) ProtoMessage()
func (x *DeleteClusterRequest) ProtoReflect() protoreflect.Message
func (x *DeleteClusterRequest) Reset()
func (x *DeleteClusterRequest) String() string
Request message for BigtableInstanceAdmin.DeleteInstance.
type DeleteInstanceRequest struct {
// Required. The unique name of the instance to be deleted.
// Values are of the form `projects/{project}/instances/{instance}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*DeleteInstanceRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteInstanceRequest.ProtoReflect.Descriptor instead.
func (x *DeleteInstanceRequest) GetName() string
func (*DeleteInstanceRequest) ProtoMessage()
func (x *DeleteInstanceRequest) ProtoReflect() protoreflect.Message
func (x *DeleteInstanceRequest) Reset()
func (x *DeleteInstanceRequest) String() string
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.
type DeleteSnapshotRequest struct {
// Required. The unique name of the snapshot to be deleted.
// Values are of the form
// `projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*DeleteSnapshotRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteSnapshotRequest.ProtoReflect.Descriptor instead.
func (x *DeleteSnapshotRequest) GetName() string
func (*DeleteSnapshotRequest) ProtoMessage()
func (x *DeleteSnapshotRequest) ProtoReflect() protoreflect.Message
func (x *DeleteSnapshotRequest) Reset()
func (x *DeleteSnapshotRequest) String() string
Request message for [google.bigtable.admin.v2.BigtableTableAdmin.DeleteTable][google.bigtable.admin.v2.BigtableTableAdmin.DeleteTable]
type DeleteTableRequest struct {
// Required. The unique name of the table to be deleted.
// Values are of the form
// `projects/{project}/instances/{instance}/tables/{table}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*DeleteTableRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteTableRequest.ProtoReflect.Descriptor instead.
func (x *DeleteTableRequest) GetName() string
func (*DeleteTableRequest) ProtoMessage()
func (x *DeleteTableRequest) ProtoReflect() protoreflect.Message
func (x *DeleteTableRequest) Reset()
func (x *DeleteTableRequest) String() string
Request message for [google.bigtable.admin.v2.BigtableTableAdmin.DropRowRange][google.bigtable.admin.v2.BigtableTableAdmin.DropRowRange]
type DropRowRangeRequest struct {
// Required. The unique name of the table on which to drop a range of rows.
// Values are of the form
// `projects/{project}/instances/{instance}/tables/{table}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Delete all rows or by prefix.
//
// Types that are assignable to Target:
//
// *DropRowRangeRequest_RowKeyPrefix
// *DropRowRangeRequest_DeleteAllDataFromTable
Target isDropRowRangeRequest_Target `protobuf_oneof:"target"`
// contains filtered or unexported fields
}
func (*DropRowRangeRequest) Descriptor() ([]byte, []int)
Deprecated: Use DropRowRangeRequest.ProtoReflect.Descriptor instead.
func (x *DropRowRangeRequest) GetDeleteAllDataFromTable() bool
func (x *DropRowRangeRequest) GetName() string
func (x *DropRowRangeRequest) GetRowKeyPrefix() []byte
func (m *DropRowRangeRequest) GetTarget() isDropRowRangeRequest_Target
func (*DropRowRangeRequest) ProtoMessage()
func (x *DropRowRangeRequest) ProtoReflect() protoreflect.Message
func (x *DropRowRangeRequest) Reset()
func (x *DropRowRangeRequest) String() string
type DropRowRangeRequest_DeleteAllDataFromTable struct {
// Delete all rows in the table. Setting this to false is a no-op.
DeleteAllDataFromTable bool `protobuf:"varint,3,opt,name=delete_all_data_from_table,json=deleteAllDataFromTable,proto3,oneof"`
}
type DropRowRangeRequest_RowKeyPrefix struct {
// Delete all rows that start with this row key prefix. Prefix cannot be
// zero length.
RowKeyPrefix []byte `protobuf:"bytes,2,opt,name=row_key_prefix,json=rowKeyPrefix,proto3,oneof"`
}
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.
type EncryptionInfo struct {
// Output only. The type of encryption used to protect this resource.
EncryptionType EncryptionInfo_EncryptionType `protobuf:"varint,3,opt,name=encryption_type,json=encryptionType,proto3,enum=google.bigtable.admin.v2.EncryptionInfo_EncryptionType" json:"encryption_type,omitempty"`
// Output only. The status of encrypt/decrypt calls on underlying data for
// this resource. Regardless of status, the existing data is always encrypted
// at rest.
EncryptionStatus *status.Status `protobuf:"bytes,4,opt,name=encryption_status,json=encryptionStatus,proto3" json:"encryption_status,omitempty"`
// Output only. The version of the Cloud KMS key specified in the parent
// cluster that is in use for the data underlying this table.
KmsKeyVersion string `protobuf:"bytes,2,opt,name=kms_key_version,json=kmsKeyVersion,proto3" json:"kms_key_version,omitempty"`
// contains filtered or unexported fields
}
func (*EncryptionInfo) Descriptor() ([]byte, []int)
Deprecated: Use EncryptionInfo.ProtoReflect.Descriptor instead.
func (x *EncryptionInfo) GetEncryptionStatus() *status.Status
func (x *EncryptionInfo) GetEncryptionType() EncryptionInfo_EncryptionType
func (x *EncryptionInfo) GetKmsKeyVersion() string
func (*EncryptionInfo) ProtoMessage()
func (x *EncryptionInfo) ProtoReflect() protoreflect.Message
func (x *EncryptionInfo) Reset()
func (x *EncryptionInfo) String() string
Possible encryption types for a resource.
type EncryptionInfo_EncryptionType int32
const (
// Encryption type was not specified, though data at rest remains encrypted.
EncryptionInfo_ENCRYPTION_TYPE_UNSPECIFIED EncryptionInfo_EncryptionType = 0
// The data backing this resource is encrypted at rest with a key that is
// fully managed by Google. No key version or status will be populated.
// This is the default state.
EncryptionInfo_GOOGLE_DEFAULT_ENCRYPTION EncryptionInfo_EncryptionType = 1
// The data backing this resource is encrypted at rest with a key that is
// managed by the customer.
// The in-use version of the key and its status are populated for
// CMEK-protected tables.
// CMEK-protected backups are pinned to the key version that was in use at
// the time the backup was taken. This key version is populated but its
// status is not tracked and is reported as `UNKNOWN`.
EncryptionInfo_CUSTOMER_MANAGED_ENCRYPTION EncryptionInfo_EncryptionType = 2
)
func (EncryptionInfo_EncryptionType) Descriptor() protoreflect.EnumDescriptor
func (x EncryptionInfo_EncryptionType) Enum() *EncryptionInfo_EncryptionType
func (EncryptionInfo_EncryptionType) EnumDescriptor() ([]byte, []int)
Deprecated: Use EncryptionInfo_EncryptionType.Descriptor instead.
func (x EncryptionInfo_EncryptionType) Number() protoreflect.EnumNumber
func (x EncryptionInfo_EncryptionType) String() string
func (EncryptionInfo_EncryptionType) Type() protoreflect.EnumType
Rule for determining which cells to delete during garbage collection.
type GcRule struct {
// Garbage collection rules.
//
// Types that are assignable to Rule:
//
// *GcRule_MaxNumVersions
// *GcRule_MaxAge
// *GcRule_Intersection_
// *GcRule_Union_
Rule isGcRule_Rule `protobuf_oneof:"rule"`
// contains filtered or unexported fields
}
func (*GcRule) Descriptor() ([]byte, []int)
Deprecated: Use GcRule.ProtoReflect.Descriptor instead.
func (x *GcRule) GetIntersection() *GcRule_Intersection
func (x *GcRule) GetMaxAge() *durationpb.Duration
func (x *GcRule) GetMaxNumVersions() int32
func (m *GcRule) GetRule() isGcRule_Rule
func (x *GcRule) GetUnion() *GcRule_Union
func (*GcRule) ProtoMessage()
func (x *GcRule) ProtoReflect() protoreflect.Message
func (x *GcRule) Reset()
func (x *GcRule) String() string
A GcRule which deletes cells matching all of the given rules.
type GcRule_Intersection struct {
// Only delete cells which would be deleted by every element of `rules`.
Rules []*GcRule `protobuf:"bytes,1,rep,name=rules,proto3" json:"rules,omitempty"`
// contains filtered or unexported fields
}
func (*GcRule_Intersection) Descriptor() ([]byte, []int)
Deprecated: Use GcRule_Intersection.ProtoReflect.Descriptor instead.
func (x *GcRule_Intersection) GetRules() []*GcRule
func (*GcRule_Intersection) ProtoMessage()
func (x *GcRule_Intersection) ProtoReflect() protoreflect.Message
func (x *GcRule_Intersection) Reset()
func (x *GcRule_Intersection) String() string
type GcRule_Intersection_ struct {
// Delete cells that would be deleted by every nested rule.
Intersection *GcRule_Intersection `protobuf:"bytes,3,opt,name=intersection,proto3,oneof"`
}
type GcRule_MaxAge struct {
// Delete cells in a column older than the given age.
// Values must be at least one millisecond, and will be truncated to
// microsecond granularity.
MaxAge *durationpb.Duration `protobuf:"bytes,2,opt,name=max_age,json=maxAge,proto3,oneof"`
}
type GcRule_MaxNumVersions struct {
// Delete all cells in a column except the most recent N.
MaxNumVersions int32 `protobuf:"varint,1,opt,name=max_num_versions,json=maxNumVersions,proto3,oneof"`
}
A GcRule which deletes cells matching any of the given rules.
type GcRule_Union struct {
// Delete cells which would be deleted by any element of `rules`.
Rules []*GcRule `protobuf:"bytes,1,rep,name=rules,proto3" json:"rules,omitempty"`
// contains filtered or unexported fields
}
func (*GcRule_Union) Descriptor() ([]byte, []int)
Deprecated: Use GcRule_Union.ProtoReflect.Descriptor instead.
func (x *GcRule_Union) GetRules() []*GcRule
func (*GcRule_Union) ProtoMessage()
func (x *GcRule_Union) ProtoReflect() protoreflect.Message
func (x *GcRule_Union) Reset()
func (x *GcRule_Union) String() string
type GcRule_Union_ struct {
// Delete cells that would be deleted by any nested rule.
Union *GcRule_Union `protobuf:"bytes,4,opt,name=union,proto3,oneof"`
}
Request message for [google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken][google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken]
type GenerateConsistencyTokenRequest struct {
// Required. The unique name of the Table for which to create a consistency
// token. Values are of the form
// `projects/{project}/instances/{instance}/tables/{table}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*GenerateConsistencyTokenRequest) Descriptor() ([]byte, []int)
Deprecated: Use GenerateConsistencyTokenRequest.ProtoReflect.Descriptor instead.
func (x *GenerateConsistencyTokenRequest) GetName() string
func (*GenerateConsistencyTokenRequest) ProtoMessage()
func (x *GenerateConsistencyTokenRequest) ProtoReflect() protoreflect.Message
func (x *GenerateConsistencyTokenRequest) Reset()
func (x *GenerateConsistencyTokenRequest) String() string
Response message for [google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken][google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken]
type GenerateConsistencyTokenResponse struct {
// The generated consistency token.
ConsistencyToken string `protobuf:"bytes,1,opt,name=consistency_token,json=consistencyToken,proto3" json:"consistency_token,omitempty"`
// contains filtered or unexported fields
}
func (*GenerateConsistencyTokenResponse) Descriptor() ([]byte, []int)
Deprecated: Use GenerateConsistencyTokenResponse.ProtoReflect.Descriptor instead.
func (x *GenerateConsistencyTokenResponse) GetConsistencyToken() string
func (*GenerateConsistencyTokenResponse) ProtoMessage()
func (x *GenerateConsistencyTokenResponse) ProtoReflect() protoreflect.Message
func (x *GenerateConsistencyTokenResponse) Reset()
func (x *GenerateConsistencyTokenResponse) String() string
Request message for BigtableInstanceAdmin.GetAppProfile.
type GetAppProfileRequest struct {
// Required. The unique name of the requested app profile. Values are of the
// form `projects/{project}/instances/{instance}/appProfiles/{app_profile}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*GetAppProfileRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetAppProfileRequest.ProtoReflect.Descriptor instead.
func (x *GetAppProfileRequest) GetName() string
func (*GetAppProfileRequest) ProtoMessage()
func (x *GetAppProfileRequest) ProtoReflect() protoreflect.Message
func (x *GetAppProfileRequest) Reset()
func (x *GetAppProfileRequest) String() string
Request message for [google.bigtable.admin.v2.BigtableTableAdmin.GetAuthorizedView][google.bigtable.admin.v2.BigtableTableAdmin.GetAuthorizedView]
type GetAuthorizedViewRequest struct {
// Required. The unique name of the requested AuthorizedView.
// Values are of the form
// `projects/{project}/instances/{instance}/tables/{table}/authorizedViews/{authorized_view}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Optional. The resource_view to be applied to the returned AuthorizedView's
// fields. Default to BASIC.
View AuthorizedView_ResponseView `protobuf:"varint,2,opt,name=view,proto3,enum=google.bigtable.admin.v2.AuthorizedView_ResponseView" json:"view,omitempty"`
// contains filtered or unexported fields
}
func (*GetAuthorizedViewRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetAuthorizedViewRequest.ProtoReflect.Descriptor instead.
func (x *GetAuthorizedViewRequest) GetName() string
func (x *GetAuthorizedViewRequest) GetView() AuthorizedView_ResponseView
func (*GetAuthorizedViewRequest) ProtoMessage()
func (x *GetAuthorizedViewRequest) ProtoReflect() protoreflect.Message
func (x *GetAuthorizedViewRequest) Reset()
func (x *GetAuthorizedViewRequest) String() string
The request for [GetBackup][google.bigtable.admin.v2.BigtableTableAdmin.GetBackup].
type GetBackupRequest struct {
// Required. Name of the backup.
// Values are of the form
// `projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*GetBackupRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetBackupRequest.ProtoReflect.Descriptor instead.
func (x *GetBackupRequest) GetName() string
func (*GetBackupRequest) ProtoMessage()
func (x *GetBackupRequest) ProtoReflect() protoreflect.Message
func (x *GetBackupRequest) Reset()
func (x *GetBackupRequest) String() string
Request message for BigtableInstanceAdmin.GetCluster.
type GetClusterRequest struct {
// Required. The unique name of the requested cluster. Values are of the form
// `projects/{project}/instances/{instance}/clusters/{cluster}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*GetClusterRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetClusterRequest.ProtoReflect.Descriptor instead.
func (x *GetClusterRequest) GetName() string
func (*GetClusterRequest) ProtoMessage()
func (x *GetClusterRequest) ProtoReflect() protoreflect.Message
func (x *GetClusterRequest) Reset()
func (x *GetClusterRequest) String() string
Request message for BigtableInstanceAdmin.GetInstance.
type GetInstanceRequest struct {
// Required. The unique name of the requested instance. Values are of the form
// `projects/{project}/instances/{instance}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*GetInstanceRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetInstanceRequest.ProtoReflect.Descriptor instead.
func (x *GetInstanceRequest) GetName() string
func (*GetInstanceRequest) ProtoMessage()
func (x *GetInstanceRequest) ProtoReflect() protoreflect.Message
func (x *GetInstanceRequest) Reset()
func (x *GetInstanceRequest) String() string
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.
type GetSnapshotRequest struct {
// Required. The unique name of the requested snapshot.
// Values are of the form
// `projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*GetSnapshotRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetSnapshotRequest.ProtoReflect.Descriptor instead.
func (x *GetSnapshotRequest) GetName() string
func (*GetSnapshotRequest) ProtoMessage()
func (x *GetSnapshotRequest) ProtoReflect() protoreflect.Message
func (x *GetSnapshotRequest) Reset()
func (x *GetSnapshotRequest) String() string
Request message for [google.bigtable.admin.v2.BigtableTableAdmin.GetTable][google.bigtable.admin.v2.BigtableTableAdmin.GetTable]
type GetTableRequest struct {
// Required. The unique name of the requested table.
// Values are of the form
// `projects/{project}/instances/{instance}/tables/{table}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// The view to be applied to the returned table's fields.
// Defaults to `SCHEMA_VIEW` if unspecified.
View Table_View `protobuf:"varint,2,opt,name=view,proto3,enum=google.bigtable.admin.v2.Table_View" json:"view,omitempty"`
// contains filtered or unexported fields
}
func (*GetTableRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetTableRequest.ProtoReflect.Descriptor instead.
func (x *GetTableRequest) GetName() string
func (x *GetTableRequest) GetView() Table_View
func (*GetTableRequest) ProtoMessage()
func (x *GetTableRequest) ProtoReflect() protoreflect.Message
func (x *GetTableRequest) Reset()
func (x *GetTableRequest) String() string
A tablet is a defined by a start and end key and is explained in https://cloud.google.com/bigtable/docs/overview#architecture and https://cloud.google.com/bigtable/docs/performance#optimization. A Hot tablet is a tablet that exhibits high average cpu usage during the time interval from start time to end time.
type HotTablet struct {
// The unique name of the hot tablet. Values are of the form
// `projects/{project}/instances/{instance}/clusters/{cluster}/hotTablets/[a-zA-Z0-9_-]*`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Name of the table that contains the tablet. Values are of the form
// `projects/{project}/instances/{instance}/tables/[_a-zA-Z0-9][-_.a-zA-Z0-9]*`.
TableName string `protobuf:"bytes,2,opt,name=table_name,json=tableName,proto3" json:"table_name,omitempty"`
// Output only. The start time of the hot tablet.
StartTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
// Output only. The end time of the hot tablet.
EndTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
// Tablet Start Key (inclusive).
StartKey string `protobuf:"bytes,5,opt,name=start_key,json=startKey,proto3" json:"start_key,omitempty"`
// Tablet End Key (inclusive).
EndKey string `protobuf:"bytes,6,opt,name=end_key,json=endKey,proto3" json:"end_key,omitempty"`
// Output only. The average CPU usage spent by a node on this tablet over the
// start_time to end_time time range. The percentage is the amount of CPU used
// by the node to serve the tablet, from 0% (tablet was not interacted with)
// to 100% (the node spent all cycles serving the hot tablet).
NodeCpuUsagePercent float32 `protobuf:"fixed32,7,opt,name=node_cpu_usage_percent,json=nodeCpuUsagePercent,proto3" json:"node_cpu_usage_percent,omitempty"`
// contains filtered or unexported fields
}
func (*HotTablet) Descriptor() ([]byte, []int)
Deprecated: Use HotTablet.ProtoReflect.Descriptor instead.
func (x *HotTablet) GetEndKey() string
func (x *HotTablet) GetEndTime() *timestamppb.Timestamp
func (x *HotTablet) GetName() string
func (x *HotTablet) GetNodeCpuUsagePercent() float32
func (x *HotTablet) GetStartKey() string
func (x *HotTablet) GetStartTime() *timestamppb.Timestamp
func (x *HotTablet) GetTableName() string
func (*HotTablet) ProtoMessage()
func (x *HotTablet) ProtoReflect() protoreflect.Message
func (x *HotTablet) Reset()
func (x *HotTablet) String() string
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.
type Instance struct {
// The unique name of the instance. Values are of the form
// `projects/{project}/instances/[a-z][a-z0-9\\-]+[a-z0-9]`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. The descriptive name for this instance as it appears in UIs.
// Can be changed at any time, but should be kept globally unique
// to avoid confusion.
DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// (`OutputOnly`)
// The current state of the instance.
State Instance_State `protobuf:"varint,3,opt,name=state,proto3,enum=google.bigtable.admin.v2.Instance_State" json:"state,omitempty"`
// The type of the instance. Defaults to `PRODUCTION`.
Type Instance_Type `protobuf:"varint,4,opt,name=type,proto3,enum=google.bigtable.admin.v2.Instance_Type" json:"type,omitempty"`
// Labels are a flexible and lightweight mechanism for organizing cloud
// resources into groups that reflect a customer's organizational needs and
// deployment strategies. They can be used to filter resources and aggregate
// metrics.
//
// - Label keys must be between 1 and 63 characters long and must conform to
// the regular expression: `[\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}_-]{0,62}`.
// - Label values must be between 0 and 63 characters long and must conform to
// the regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`.
// - No more than 64 labels can be associated with a given resource.
// - Keys and values must both be under 128 bytes.
Labels map[string]string `protobuf:"bytes,5,rep,name=labels,proto3" json:"labels,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// Output only. A server-assigned timestamp representing when this Instance
// was created. For instances created before this field was added (August
// 2021), this value is `seconds: 0, nanos: 1`.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. Reserved for future use.
SatisfiesPzs *bool `protobuf:"varint,8,opt,name=satisfies_pzs,json=satisfiesPzs,proto3,oneof" json:"satisfies_pzs,omitempty"`
// contains filtered or unexported fields
}
func (*Instance) Descriptor() ([]byte, []int)
Deprecated: Use Instance.ProtoReflect.Descriptor instead.
func (x *Instance) GetCreateTime() *timestamppb.Timestamp
func (x *Instance) GetDisplayName() string
func (x *Instance) GetLabels() map[string]string
func (x *Instance) GetName() string
func (x *Instance) GetSatisfiesPzs() bool
func (x *Instance) GetState() Instance_State
func (x *Instance) GetType() Instance_Type
func (*Instance) ProtoMessage()
func (x *Instance) ProtoReflect() protoreflect.Message
func (x *Instance) Reset()
func (x *Instance) String() string
Possible states of an instance.
type Instance_State int32
const (
// The state of the instance could not be determined.
Instance_STATE_NOT_KNOWN Instance_State = 0
// The instance has been successfully created and can serve requests
// to its tables.
Instance_READY Instance_State = 1
// The instance is currently being created, and may be destroyed
// if the creation process encounters an error.
Instance_CREATING Instance_State = 2
)
func (Instance_State) Descriptor() protoreflect.EnumDescriptor
func (x Instance_State) Enum() *Instance_State
func (Instance_State) EnumDescriptor() ([]byte, []int)
Deprecated: Use Instance_State.Descriptor instead.
func (x Instance_State) Number() protoreflect.EnumNumber
func (x Instance_State) String() string
func (Instance_State) Type() protoreflect.EnumType
The type of the instance.
type Instance_Type int32
const (
// The type of the instance is unspecified. If set when creating an
// instance, a `PRODUCTION` instance will be created. If set when updating
// an instance, the type will be left unchanged.
Instance_TYPE_UNSPECIFIED Instance_Type = 0
// An instance meant for production use. `serve_nodes` must be set
// on the cluster.
Instance_PRODUCTION Instance_Type = 1
// DEPRECATED: Prefer PRODUCTION for all use cases, as it no longer enforces
// a higher minimum node count than DEVELOPMENT.
Instance_DEVELOPMENT Instance_Type = 2
)
func (Instance_Type) Descriptor() protoreflect.EnumDescriptor
func (x Instance_Type) Enum() *Instance_Type
func (Instance_Type) EnumDescriptor() ([]byte, []int)
Deprecated: Use Instance_Type.Descriptor instead.
func (x Instance_Type) Number() protoreflect.EnumNumber
func (x Instance_Type) String() string
func (Instance_Type) Type() protoreflect.EnumType
Request message for BigtableInstanceAdmin.ListAppProfiles.
type ListAppProfilesRequest struct {
// Required. The unique name of the instance for which a list of app profiles
// is requested. Values are of the form
// `projects/{project}/instances/{instance}`.
// Use `{instance} = '-'` to list AppProfiles for all Instances in a project,
// e.g., `projects/myproject/instances/-`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Maximum number of results per page.
//
// A page_size of zero lets the server choose the number of items to return.
// A page_size which is strictly positive will return at most that many items.
// A negative page_size will cause an error.
//
// Following the first request, subsequent paginated calls are not required
// to pass a page_size. If a page_size is set in subsequent calls, it must
// match the page_size given in the first request.
PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// The value of `next_page_token` returned by a previous call.
PageToken string `protobuf:"bytes,2,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListAppProfilesRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListAppProfilesRequest.ProtoReflect.Descriptor instead.
func (x *ListAppProfilesRequest) GetPageSize() int32
func (x *ListAppProfilesRequest) GetPageToken() string
func (x *ListAppProfilesRequest) GetParent() string
func (*ListAppProfilesRequest) ProtoMessage()
func (x *ListAppProfilesRequest) ProtoReflect() protoreflect.Message
func (x *ListAppProfilesRequest) Reset()
func (x *ListAppProfilesRequest) String() string
Response message for BigtableInstanceAdmin.ListAppProfiles.
type ListAppProfilesResponse struct {
// The list of requested app profiles.
AppProfiles []*AppProfile `protobuf:"bytes,1,rep,name=app_profiles,json=appProfiles,proto3" json:"app_profiles,omitempty"`
// Set if not all app profiles could be returned in a single response.
// Pass this value to `page_token` in another request to get the next
// page of results.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// Locations from which AppProfile information could not be retrieved,
// due to an outage or some other transient condition.
// AppProfiles from these locations may be missing from `app_profiles`.
// Values are of the form `projects/<project>/locations/<zone_id>`
FailedLocations []string `protobuf:"bytes,3,rep,name=failed_locations,json=failedLocations,proto3" json:"failed_locations,omitempty"`
// contains filtered or unexported fields
}
func (*ListAppProfilesResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListAppProfilesResponse.ProtoReflect.Descriptor instead.
func (x *ListAppProfilesResponse) GetAppProfiles() []*AppProfile
func (x *ListAppProfilesResponse) GetFailedLocations() []string
func (x *ListAppProfilesResponse) GetNextPageToken() string
func (*ListAppProfilesResponse) ProtoMessage()
func (x *ListAppProfilesResponse) ProtoReflect() protoreflect.Message
func (x *ListAppProfilesResponse) Reset()
func (x *ListAppProfilesResponse) String() string
Request message for [google.bigtable.admin.v2.BigtableTableAdmin.ListAuthorizedViews][google.bigtable.admin.v2.BigtableTableAdmin.ListAuthorizedViews]
type ListAuthorizedViewsRequest struct {
// Required. The unique name of the table for which AuthorizedViews should be
// listed. Values are of the form
// `projects/{project}/instances/{instance}/tables/{table}`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Optional. Maximum number of results per page.
//
// A page_size of zero lets the server choose the number of items to return.
// A page_size which is strictly positive will return at most that many items.
// A negative page_size will cause an error.
//
// Following the first request, subsequent paginated calls are not required
// to pass a page_size. If a page_size is set in subsequent calls, it must
// match the page_size given in the first request.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// Optional. The value of `next_page_token` returned by a previous call.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// Optional. The resource_view to be applied to the returned views' fields.
// Default to NAME_ONLY.
View AuthorizedView_ResponseView `protobuf:"varint,4,opt,name=view,proto3,enum=google.bigtable.admin.v2.AuthorizedView_ResponseView" json:"view,omitempty"`
// contains filtered or unexported fields
}
func (*ListAuthorizedViewsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListAuthorizedViewsRequest.ProtoReflect.Descriptor instead.
func (x *ListAuthorizedViewsRequest) GetPageSize() int32
func (x *ListAuthorizedViewsRequest) GetPageToken() string
func (x *ListAuthorizedViewsRequest) GetParent() string
func (x *ListAuthorizedViewsRequest) GetView() AuthorizedView_ResponseView
func (*ListAuthorizedViewsRequest) ProtoMessage()
func (x *ListAuthorizedViewsRequest) ProtoReflect() protoreflect.Message
func (x *ListAuthorizedViewsRequest) Reset()
func (x *ListAuthorizedViewsRequest) String() string
Response message for [google.bigtable.admin.v2.BigtableTableAdmin.ListAuthorizedViews][google.bigtable.admin.v2.BigtableTableAdmin.ListAuthorizedViews]
type ListAuthorizedViewsResponse struct {
// The AuthorizedViews present in the requested table.
AuthorizedViews []*AuthorizedView `protobuf:"bytes,1,rep,name=authorized_views,json=authorizedViews,proto3" json:"authorized_views,omitempty"`
// Set if not all tables could be returned in a single response.
// Pass this value to `page_token` in another request to get the next
// page of results.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListAuthorizedViewsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListAuthorizedViewsResponse.ProtoReflect.Descriptor instead.
func (x *ListAuthorizedViewsResponse) GetAuthorizedViews() []*AuthorizedView
func (x *ListAuthorizedViewsResponse) GetNextPageToken() string
func (*ListAuthorizedViewsResponse) ProtoMessage()
func (x *ListAuthorizedViewsResponse) ProtoReflect() protoreflect.Message
func (x *ListAuthorizedViewsResponse) Reset()
func (x *ListAuthorizedViewsResponse) String() string
The request for [ListBackups][google.bigtable.admin.v2.BigtableTableAdmin.ListBackups].
type ListBackupsRequest struct {
// Required. The cluster to list backups from. Values are of the
// form `projects/{project}/instances/{instance}/clusters/{cluster}`.
// Use `{cluster} = '-'` to list backups for all clusters in an instance,
// e.g., `projects/{project}/instances/{instance}/clusters/-`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// A filter expression that filters backups listed in the response.
// The expression must specify the field name, a comparison operator,
// and the value that you want to use for filtering. The value must be a
// string, a number, or a boolean. The comparison operator must be
// <, >, <=, >=, !=, =, or :. Colon ':' represents a HAS operator which is
// roughly synonymous with equality. Filter rules are case insensitive.
//
// The fields eligible for filtering are:
//
// * `name`
// * `source_table`
// * `state`
// * `start_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ)
// * `end_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ)
// * `expire_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ)
// * `size_bytes`
//
// To filter on multiple expressions, provide each separate expression within
// parentheses. By default, each expression is an AND expression. However,
// you can include AND, OR, and NOT expressions explicitly.
//
// Some examples of using filters are:
//
// - `name:"exact"` --> The backup's name is the string "exact".
// - `name:howl` --> The backup's name contains the string "howl".
// - `source_table:prod`
// --> The source_table's name contains the string "prod".
// - `state:CREATING` --> The backup is pending creation.
// - `state:READY` --> The backup is fully created and ready for use.
// - `(name:howl) AND (start_time < \"2018-03-28T14:50:00Z\")`
// --> The backup name contains the string "howl" and start_time
// of the backup is before 2018-03-28T14:50:00Z.
// - `size_bytes > 10000000000` --> The backup's size is greater than 10GB
Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
// An expression for specifying the sort order of the results of the request.
// The string value should specify one or more fields in
// [Backup][google.bigtable.admin.v2.Backup]. The full syntax is described at
// https://aip.dev/132#ordering.
//
// Fields supported are:
//
// * name
// * source_table
// * expire_time
// * start_time
// * end_time
// * size_bytes
// * state
//
// For example, "start_time". The default sorting order is ascending.
// To specify descending order for the field, a suffix " desc" should
// be appended to the field name. For example, "start_time desc".
// Redundant space characters in the syntax are insigificant.
//
// If order_by is empty, results will be sorted by `start_time` in descending
// order starting from the most recently created backup.
OrderBy string `protobuf:"bytes,3,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
// Number of backups to be returned in the response. If 0 or
// less, defaults to the server's maximum allowed page size.
PageSize int32 `protobuf:"varint,4,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// If non-empty, `page_token` should contain a
// [next_page_token][google.bigtable.admin.v2.ListBackupsResponse.next_page_token]
// from a previous
// [ListBackupsResponse][google.bigtable.admin.v2.ListBackupsResponse] to the
// same `parent` and with the same `filter`.
PageToken string `protobuf:"bytes,5,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListBackupsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListBackupsRequest.ProtoReflect.Descriptor instead.
func (x *ListBackupsRequest) GetFilter() string
func (x *ListBackupsRequest) GetOrderBy() string
func (x *ListBackupsRequest) GetPageSize() int32
func (x *ListBackupsRequest) GetPageToken() string
func (x *ListBackupsRequest) GetParent() string
func (*ListBackupsRequest) ProtoMessage()
func (x *ListBackupsRequest) ProtoReflect() protoreflect.Message
func (x *ListBackupsRequest) Reset()
func (x *ListBackupsRequest) String() string
The response for [ListBackups][google.bigtable.admin.v2.BigtableTableAdmin.ListBackups].
type ListBackupsResponse struct {
// The list of matching backups.
Backups []*Backup `protobuf:"bytes,1,rep,name=backups,proto3" json:"backups,omitempty"`
// `next_page_token` can be sent in a subsequent
// [ListBackups][google.bigtable.admin.v2.BigtableTableAdmin.ListBackups] call
// to fetch more of the matching backups.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListBackupsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListBackupsResponse.ProtoReflect.Descriptor instead.
func (x *ListBackupsResponse) GetBackups() []*Backup
func (x *ListBackupsResponse) GetNextPageToken() string
func (*ListBackupsResponse) ProtoMessage()
func (x *ListBackupsResponse) ProtoReflect() protoreflect.Message
func (x *ListBackupsResponse) Reset()
func (x *ListBackupsResponse) String() string
Request message for BigtableInstanceAdmin.ListClusters.
type ListClustersRequest struct {
// Required. The unique name of the instance for which a list of clusters is
// requested. Values are of the form
// `projects/{project}/instances/{instance}`. Use `{instance} = '-'` to list
// Clusters for all Instances in a project, e.g.,
// `projects/myproject/instances/-`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// DEPRECATED: This field is unused and ignored.
PageToken string `protobuf:"bytes,2,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListClustersRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListClustersRequest.ProtoReflect.Descriptor instead.
func (x *ListClustersRequest) GetPageToken() string
func (x *ListClustersRequest) GetParent() string
func (*ListClustersRequest) ProtoMessage()
func (x *ListClustersRequest) ProtoReflect() protoreflect.Message
func (x *ListClustersRequest) Reset()
func (x *ListClustersRequest) String() string
Response message for BigtableInstanceAdmin.ListClusters.
type ListClustersResponse struct {
// The list of requested clusters.
Clusters []*Cluster `protobuf:"bytes,1,rep,name=clusters,proto3" json:"clusters,omitempty"`
// Locations from which Cluster information could not be retrieved,
// due to an outage or some other transient condition.
// Clusters from these locations may be missing from `clusters`,
// or may only have partial information returned.
// Values are of the form `projects/<project>/locations/<zone_id>`
FailedLocations []string `protobuf:"bytes,2,rep,name=failed_locations,json=failedLocations,proto3" json:"failed_locations,omitempty"`
// DEPRECATED: This field is unused and ignored.
NextPageToken string `protobuf:"bytes,3,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListClustersResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListClustersResponse.ProtoReflect.Descriptor instead.
func (x *ListClustersResponse) GetClusters() []*Cluster
func (x *ListClustersResponse) GetFailedLocations() []string
func (x *ListClustersResponse) GetNextPageToken() string
func (*ListClustersResponse) ProtoMessage()
func (x *ListClustersResponse) ProtoReflect() protoreflect.Message
func (x *ListClustersResponse) Reset()
func (x *ListClustersResponse) String() string
Request message for BigtableInstanceAdmin.ListHotTablets.
type ListHotTabletsRequest struct {
// Required. The cluster name to list hot tablets.
// Value is in the following form:
// `projects/{project}/instances/{instance}/clusters/{cluster}`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// The start time to list hot tablets. The hot tablets in the response will
// have start times between the requested start time and end time. Start time
// defaults to Now if it is unset, and end time defaults to Now - 24 hours if
// it is unset. The start time should be less than the end time, and the
// maximum allowed time range between start time and end time is 48 hours.
// Start time and end time should have values between Now and Now - 14 days.
StartTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
// The end time to list hot tablets.
EndTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
// Maximum number of results per page.
//
// A page_size that is empty or zero lets the server choose the number of
// items to return. A page_size which is strictly positive will return at most
// that many items. A negative page_size will cause an error.
//
// Following the first request, subsequent paginated calls do not need a
// page_size field. If a page_size is set in subsequent calls, it must match
// the page_size given in the first request.
PageSize int32 `protobuf:"varint,4,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// The value of `next_page_token` returned by a previous call.
PageToken string `protobuf:"bytes,5,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListHotTabletsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListHotTabletsRequest.ProtoReflect.Descriptor instead.
func (x *ListHotTabletsRequest) GetEndTime() *timestamppb.Timestamp
func (x *ListHotTabletsRequest) GetPageSize() int32
func (x *ListHotTabletsRequest) GetPageToken() string
func (x *ListHotTabletsRequest) GetParent() string
func (x *ListHotTabletsRequest) GetStartTime() *timestamppb.Timestamp
func (*ListHotTabletsRequest) ProtoMessage()
func (x *ListHotTabletsRequest) ProtoReflect() protoreflect.Message
func (x *ListHotTabletsRequest) Reset()
func (x *ListHotTabletsRequest) String() string
Response message for BigtableInstanceAdmin.ListHotTablets.
type ListHotTabletsResponse struct {
// List of hot tablets in the tables of the requested cluster that fall
// within the requested time range. Hot tablets are ordered by node cpu usage
// percent. If there are multiple hot tablets that correspond to the same
// tablet within a 15-minute interval, only the hot tablet with the highest
// node cpu usage will be included in the response.
HotTablets []*HotTablet `protobuf:"bytes,1,rep,name=hot_tablets,json=hotTablets,proto3" json:"hot_tablets,omitempty"`
// Set if not all hot tablets could be returned in a single response.
// Pass this value to `page_token` in another request to get the next
// page of results.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListHotTabletsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListHotTabletsResponse.ProtoReflect.Descriptor instead.
func (x *ListHotTabletsResponse) GetHotTablets() []*HotTablet
func (x *ListHotTabletsResponse) GetNextPageToken() string
func (*ListHotTabletsResponse) ProtoMessage()
func (x *ListHotTabletsResponse) ProtoReflect() protoreflect.Message
func (x *ListHotTabletsResponse) Reset()
func (x *ListHotTabletsResponse) String() string
Request message for BigtableInstanceAdmin.ListInstances.
type ListInstancesRequest struct {
// Required. The unique name of the project for which a list of instances is
// requested. Values are of the form `projects/{project}`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// DEPRECATED: This field is unused and ignored.
PageToken string `protobuf:"bytes,2,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListInstancesRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListInstancesRequest.ProtoReflect.Descriptor instead.
func (x *ListInstancesRequest) GetPageToken() string
func (x *ListInstancesRequest) GetParent() string
func (*ListInstancesRequest) ProtoMessage()
func (x *ListInstancesRequest) ProtoReflect() protoreflect.Message
func (x *ListInstancesRequest) Reset()
func (x *ListInstancesRequest) String() string
Response message for BigtableInstanceAdmin.ListInstances.
type ListInstancesResponse struct {
// The list of requested instances.
Instances []*Instance `protobuf:"bytes,1,rep,name=instances,proto3" json:"instances,omitempty"`
// Locations from which Instance information could not be retrieved,
// due to an outage or some other transient condition.
// Instances whose Clusters are all in one of the failed locations
// may be missing from `instances`, and Instances with at least one
// Cluster in a failed location may only have partial information returned.
// Values are of the form `projects/<project>/locations/<zone_id>`
FailedLocations []string `protobuf:"bytes,2,rep,name=failed_locations,json=failedLocations,proto3" json:"failed_locations,omitempty"`
// DEPRECATED: This field is unused and ignored.
NextPageToken string `protobuf:"bytes,3,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListInstancesResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListInstancesResponse.ProtoReflect.Descriptor instead.
func (x *ListInstancesResponse) GetFailedLocations() []string
func (x *ListInstancesResponse) GetInstances() []*Instance
func (x *ListInstancesResponse) GetNextPageToken() string
func (*ListInstancesResponse) ProtoMessage()
func (x *ListInstancesResponse) ProtoReflect() protoreflect.Message
func (x *ListInstancesResponse) Reset()
func (x *ListInstancesResponse) String() string
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.
type ListSnapshotsRequest struct {
// Required. The unique name of the cluster for which snapshots should be
// listed. Values are of the form
// `projects/{project}/instances/{instance}/clusters/{cluster}`.
// Use `{cluster} = '-'` to list snapshots for all clusters in an instance,
// e.g., `projects/{project}/instances/{instance}/clusters/-`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// The maximum number of snapshots to return per page.
// CURRENTLY UNIMPLEMENTED AND IGNORED.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// The value of `next_page_token` returned by a previous call.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListSnapshotsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListSnapshotsRequest.ProtoReflect.Descriptor instead.
func (x *ListSnapshotsRequest) GetPageSize() int32
func (x *ListSnapshotsRequest) GetPageToken() string
func (x *ListSnapshotsRequest) GetParent() string
func (*ListSnapshotsRequest) ProtoMessage()
func (x *ListSnapshotsRequest) ProtoReflect() protoreflect.Message
func (x *ListSnapshotsRequest) Reset()
func (x *ListSnapshotsRequest) String() string
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.
type ListSnapshotsResponse struct {
// The snapshots present in the requested cluster.
Snapshots []*Snapshot `protobuf:"bytes,1,rep,name=snapshots,proto3" json:"snapshots,omitempty"`
// Set if not all snapshots could be returned in a single response.
// Pass this value to `page_token` in another request to get the next
// page of results.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListSnapshotsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListSnapshotsResponse.ProtoReflect.Descriptor instead.
func (x *ListSnapshotsResponse) GetNextPageToken() string
func (x *ListSnapshotsResponse) GetSnapshots() []*Snapshot
func (*ListSnapshotsResponse) ProtoMessage()
func (x *ListSnapshotsResponse) ProtoReflect() protoreflect.Message
func (x *ListSnapshotsResponse) Reset()
func (x *ListSnapshotsResponse) String() string
Request message for [google.bigtable.admin.v2.BigtableTableAdmin.ListTables][google.bigtable.admin.v2.BigtableTableAdmin.ListTables]
type ListTablesRequest struct {
// Required. The unique name of the instance for which tables should be
// listed. Values are of the form `projects/{project}/instances/{instance}`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// The view to be applied to the returned tables' fields.
// NAME_ONLY view (default) and REPLICATION_VIEW are supported.
View Table_View `protobuf:"varint,2,opt,name=view,proto3,enum=google.bigtable.admin.v2.Table_View" json:"view,omitempty"`
// Maximum number of results per page.
//
// A page_size of zero lets the server choose the number of items to return.
// A page_size which is strictly positive will return at most that many items.
// A negative page_size will cause an error.
//
// Following the first request, subsequent paginated calls are not required
// to pass a page_size. If a page_size is set in subsequent calls, it must
// match the page_size given in the first request.
PageSize int32 `protobuf:"varint,4,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// The value of `next_page_token` returned by a previous call.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListTablesRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListTablesRequest.ProtoReflect.Descriptor instead.
func (x *ListTablesRequest) GetPageSize() int32
func (x *ListTablesRequest) GetPageToken() string
func (x *ListTablesRequest) GetParent() string
func (x *ListTablesRequest) GetView() Table_View
func (*ListTablesRequest) ProtoMessage()
func (x *ListTablesRequest) ProtoReflect() protoreflect.Message
func (x *ListTablesRequest) Reset()
func (x *ListTablesRequest) String() string
Response message for [google.bigtable.admin.v2.BigtableTableAdmin.ListTables][google.bigtable.admin.v2.BigtableTableAdmin.ListTables]
type ListTablesResponse struct {
// The tables present in the requested instance.
Tables []*Table `protobuf:"bytes,1,rep,name=tables,proto3" json:"tables,omitempty"`
// Set if not all tables could be returned in a single response.
// Pass this value to `page_token` in another request to get the next
// page of results.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListTablesResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListTablesResponse.ProtoReflect.Descriptor instead.
func (x *ListTablesResponse) GetNextPageToken() string
func (x *ListTablesResponse) GetTables() []*Table
func (*ListTablesResponse) ProtoMessage()
func (x *ListTablesResponse) ProtoReflect() protoreflect.Message
func (x *ListTablesResponse) Reset()
func (x *ListTablesResponse) String() string
Request message for [google.bigtable.admin.v2.BigtableTableAdmin.ModifyColumnFamilies][google.bigtable.admin.v2.BigtableTableAdmin.ModifyColumnFamilies]
type ModifyColumnFamiliesRequest struct {
// Required. The unique name of the table whose families should be modified.
// Values are of the form
// `projects/{project}/instances/{instance}/tables/{table}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. Modifications to be atomically applied to the specified table's
// families. Entries are applied in order, meaning that earlier modifications
// can be masked by later ones (in the case of repeated updates to the same
// family, for example).
Modifications []*ModifyColumnFamiliesRequest_Modification `protobuf:"bytes,2,rep,name=modifications,proto3" json:"modifications,omitempty"`
// Optional. If true, ignore safety checks when modifying the column families.
IgnoreWarnings bool `protobuf:"varint,3,opt,name=ignore_warnings,json=ignoreWarnings,proto3" json:"ignore_warnings,omitempty"`
// contains filtered or unexported fields
}
func (*ModifyColumnFamiliesRequest) Descriptor() ([]byte, []int)
Deprecated: Use ModifyColumnFamiliesRequest.ProtoReflect.Descriptor instead.
func (x *ModifyColumnFamiliesRequest) GetIgnoreWarnings() bool
func (x *ModifyColumnFamiliesRequest) GetModifications() []*ModifyColumnFamiliesRequest_Modification
func (x *ModifyColumnFamiliesRequest) GetName() string
func (*ModifyColumnFamiliesRequest) ProtoMessage()
func (x *ModifyColumnFamiliesRequest) ProtoReflect() protoreflect.Message
func (x *ModifyColumnFamiliesRequest) Reset()
func (x *ModifyColumnFamiliesRequest) String() string
A create, update, or delete of a particular column family.
type ModifyColumnFamiliesRequest_Modification struct {
// The ID of the column family to be modified.
Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
// Column family modifications.
//
// Types that are assignable to Mod:
//
// *ModifyColumnFamiliesRequest_Modification_Create
// *ModifyColumnFamiliesRequest_Modification_Update
// *ModifyColumnFamiliesRequest_Modification_Drop
Mod isModifyColumnFamiliesRequest_Modification_Mod `protobuf_oneof:"mod"`
// Optional. A mask specifying which fields (e.g. `gc_rule`) in the `update`
// mod should be updated, ignored for other modification types. If unset or
// empty, we treat it as updating `gc_rule` to be backward compatible.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,6,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// contains filtered or unexported fields
}
func (*ModifyColumnFamiliesRequest_Modification) Descriptor() ([]byte, []int)
Deprecated: Use ModifyColumnFamiliesRequest_Modification.ProtoReflect.Descriptor instead.
func (x *ModifyColumnFamiliesRequest_Modification) GetCreate() *ColumnFamily
func (x *ModifyColumnFamiliesRequest_Modification) GetDrop() bool
func (x *ModifyColumnFamiliesRequest_Modification) GetId() string
func (m *ModifyColumnFamiliesRequest_Modification) GetMod() isModifyColumnFamiliesRequest_Modification_Mod
func (x *ModifyColumnFamiliesRequest_Modification) GetUpdate() *ColumnFamily
func (x *ModifyColumnFamiliesRequest_Modification) GetUpdateMask() *fieldmaskpb.FieldMask
func (*ModifyColumnFamiliesRequest_Modification) ProtoMessage()
func (x *ModifyColumnFamiliesRequest_Modification) ProtoReflect() protoreflect.Message
func (x *ModifyColumnFamiliesRequest_Modification) Reset()
func (x *ModifyColumnFamiliesRequest_Modification) String() string
type ModifyColumnFamiliesRequest_Modification_Create struct {
// Create a new column family with the specified schema, or fail if
// one already exists with the given ID.
Create *ColumnFamily `protobuf:"bytes,2,opt,name=create,proto3,oneof"`
}
type ModifyColumnFamiliesRequest_Modification_Drop struct {
// Drop (delete) the column family with the given ID, or fail if no such
// family exists.
Drop bool `protobuf:"varint,4,opt,name=drop,proto3,oneof"`
}
type ModifyColumnFamiliesRequest_Modification_Update struct {
// Update an existing column family to the specified schema, or fail
// if no column family exists with the given ID.
Update *ColumnFamily `protobuf:"bytes,3,opt,name=update,proto3,oneof"`
}
Encapsulates progress related information for a Cloud Bigtable long running operation.
type OperationProgress struct {
// Percent completion of the operation.
// Values are between 0 and 100 inclusive.
ProgressPercent int32 `protobuf:"varint,1,opt,name=progress_percent,json=progressPercent,proto3" json:"progress_percent,omitempty"`
// Time the request was received.
StartTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
// If set, the time at which this operation failed or was completed
// successfully.
EndTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
// contains filtered or unexported fields
}
func (*OperationProgress) Descriptor() ([]byte, []int)
Deprecated: Use OperationProgress.ProtoReflect.Descriptor instead.
func (x *OperationProgress) GetEndTime() *timestamppb.Timestamp
func (x *OperationProgress) GetProgressPercent() int32
func (x *OperationProgress) GetStartTime() *timestamppb.Timestamp
func (*OperationProgress) ProtoMessage()
func (x *OperationProgress) ProtoReflect() protoreflect.Message
func (x *OperationProgress) Reset()
func (x *OperationProgress) String() string
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.
type OptimizeRestoredTableMetadata struct {
// Name of the restored table being optimized.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// The progress of the post-restore optimizations.
Progress *OperationProgress `protobuf:"bytes,2,opt,name=progress,proto3" json:"progress,omitempty"`
// contains filtered or unexported fields
}
func (*OptimizeRestoredTableMetadata) Descriptor() ([]byte, []int)
Deprecated: Use OptimizeRestoredTableMetadata.ProtoReflect.Descriptor instead.
func (x *OptimizeRestoredTableMetadata) GetName() string
func (x *OptimizeRestoredTableMetadata) GetProgress() *OperationProgress
func (*OptimizeRestoredTableMetadata) ProtoMessage()
func (x *OptimizeRestoredTableMetadata) ProtoReflect() protoreflect.Message
func (x *OptimizeRestoredTableMetadata) Reset()
func (x *OptimizeRestoredTableMetadata) String() string
The metadata for the Operation returned by PartialUpdateCluster.
type PartialUpdateClusterMetadata struct {
// The time at which the original request was received.
RequestTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=request_time,json=requestTime,proto3" json:"request_time,omitempty"`
// The time at which the operation failed or was completed successfully.
FinishTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=finish_time,json=finishTime,proto3" json:"finish_time,omitempty"`
// The original request for PartialUpdateCluster.
OriginalRequest *PartialUpdateClusterRequest `protobuf:"bytes,3,opt,name=original_request,json=originalRequest,proto3" json:"original_request,omitempty"`
// contains filtered or unexported fields
}
func (*PartialUpdateClusterMetadata) Descriptor() ([]byte, []int)
Deprecated: Use PartialUpdateClusterMetadata.ProtoReflect.Descriptor instead.
func (x *PartialUpdateClusterMetadata) GetFinishTime() *timestamppb.Timestamp
func (x *PartialUpdateClusterMetadata) GetOriginalRequest() *PartialUpdateClusterRequest
func (x *PartialUpdateClusterMetadata) GetRequestTime() *timestamppb.Timestamp
func (*PartialUpdateClusterMetadata) ProtoMessage()
func (x *PartialUpdateClusterMetadata) ProtoReflect() protoreflect.Message
func (x *PartialUpdateClusterMetadata) Reset()
func (x *PartialUpdateClusterMetadata) String() string
Request message for BigtableInstanceAdmin.PartialUpdateCluster.
type PartialUpdateClusterRequest struct {
// Required. The Cluster which contains the partial updates to be applied,
// subject to the update_mask.
Cluster *Cluster `protobuf:"bytes,1,opt,name=cluster,proto3" json:"cluster,omitempty"`
// Required. The subset of Cluster fields which should be replaced.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// contains filtered or unexported fields
}
func (*PartialUpdateClusterRequest) Descriptor() ([]byte, []int)
Deprecated: Use PartialUpdateClusterRequest.ProtoReflect.Descriptor instead.
func (x *PartialUpdateClusterRequest) GetCluster() *Cluster
func (x *PartialUpdateClusterRequest) GetUpdateMask() *fieldmaskpb.FieldMask
func (*PartialUpdateClusterRequest) ProtoMessage()
func (x *PartialUpdateClusterRequest) ProtoReflect() protoreflect.Message
func (x *PartialUpdateClusterRequest) Reset()
func (x *PartialUpdateClusterRequest) String() string
Request message for BigtableInstanceAdmin.PartialUpdateInstance.
type PartialUpdateInstanceRequest struct {
// Required. The Instance which will (partially) replace the current value.
Instance *Instance `protobuf:"bytes,1,opt,name=instance,proto3" json:"instance,omitempty"`
// Required. The subset of Instance fields which should be replaced.
// Must be explicitly set.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// contains filtered or unexported fields
}
func (*PartialUpdateInstanceRequest) Descriptor() ([]byte, []int)
Deprecated: Use PartialUpdateInstanceRequest.ProtoReflect.Descriptor instead.
func (x *PartialUpdateInstanceRequest) GetInstance() *Instance
func (x *PartialUpdateInstanceRequest) GetUpdateMask() *fieldmaskpb.FieldMask
func (*PartialUpdateInstanceRequest) ProtoMessage()
func (x *PartialUpdateInstanceRequest) ProtoReflect() protoreflect.Message
func (x *PartialUpdateInstanceRequest) Reset()
func (x *PartialUpdateInstanceRequest) String() string
Information about a table restore.
type RestoreInfo struct {
// The type of the restore source.
SourceType RestoreSourceType `protobuf:"varint,1,opt,name=source_type,json=sourceType,proto3,enum=google.bigtable.admin.v2.RestoreSourceType" json:"source_type,omitempty"`
// Information about the source used to restore the table.
//
// Types that are assignable to SourceInfo:
//
// *RestoreInfo_BackupInfo
SourceInfo isRestoreInfo_SourceInfo `protobuf_oneof:"source_info"`
// contains filtered or unexported fields
}
func (*RestoreInfo) Descriptor() ([]byte, []int)
Deprecated: Use RestoreInfo.ProtoReflect.Descriptor instead.
func (x *RestoreInfo) GetBackupInfo() *BackupInfo
func (m *RestoreInfo) GetSourceInfo() isRestoreInfo_SourceInfo
func (x *RestoreInfo) GetSourceType() RestoreSourceType
func (*RestoreInfo) ProtoMessage()
func (x *RestoreInfo) ProtoReflect() protoreflect.Message
func (x *RestoreInfo) Reset()
func (x *RestoreInfo) String() string
type RestoreInfo_BackupInfo struct {
// Information about the backup used to restore the table. The backup
// may no longer exist.
BackupInfo *BackupInfo `protobuf:"bytes,2,opt,name=backup_info,json=backupInfo,proto3,oneof"`
}
Indicates the type of the restore source.
type RestoreSourceType int32
const (
// No restore associated.
RestoreSourceType_RESTORE_SOURCE_TYPE_UNSPECIFIED RestoreSourceType = 0
// A backup was used as the source of the restore.
RestoreSourceType_BACKUP RestoreSourceType = 1
)
func (RestoreSourceType) Descriptor() protoreflect.EnumDescriptor
func (x RestoreSourceType) Enum() *RestoreSourceType
func (RestoreSourceType) EnumDescriptor() ([]byte, []int)
Deprecated: Use RestoreSourceType.Descriptor instead.
func (x RestoreSourceType) Number() protoreflect.EnumNumber
func (x RestoreSourceType) String() string
func (RestoreSourceType) Type() protoreflect.EnumType
Metadata type for the long-running operation returned by [RestoreTable][google.bigtable.admin.v2.BigtableTableAdmin.RestoreTable].
type RestoreTableMetadata struct {
// Name of the table being created and restored to.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// The type of the restore source.
SourceType RestoreSourceType `protobuf:"varint,2,opt,name=source_type,json=sourceType,proto3,enum=google.bigtable.admin.v2.RestoreSourceType" json:"source_type,omitempty"`
// Information about the source used to restore the table, as specified by
// `source` in
// [RestoreTableRequest][google.bigtable.admin.v2.RestoreTableRequest].
//
// Types that are assignable to SourceInfo:
//
// *RestoreTableMetadata_BackupInfo
SourceInfo isRestoreTableMetadata_SourceInfo `protobuf_oneof:"source_info"`
// If exists, the name of the long-running operation that will be used to
// track the post-restore optimization process to optimize the performance of
// the restored table. The metadata type of the long-running operation is
// [OptimizeRestoreTableMetadata][]. The response type is
// [Empty][google.protobuf.Empty]. This long-running operation may be
// automatically created by the system if applicable after the
// RestoreTable long-running operation completes successfully. This operation
// may not be created if the table is already optimized or the restore was
// not successful.
OptimizeTableOperationName string `protobuf:"bytes,4,opt,name=optimize_table_operation_name,json=optimizeTableOperationName,proto3" json:"optimize_table_operation_name,omitempty"`
// The progress of the
// [RestoreTable][google.bigtable.admin.v2.BigtableTableAdmin.RestoreTable]
// operation.
Progress *OperationProgress `protobuf:"bytes,5,opt,name=progress,proto3" json:"progress,omitempty"`
// contains filtered or unexported fields
}
func (*RestoreTableMetadata) Descriptor() ([]byte, []int)
Deprecated: Use RestoreTableMetadata.ProtoReflect.Descriptor instead.
func (x *RestoreTableMetadata) GetBackupInfo() *BackupInfo
func (x *RestoreTableMetadata) GetName() string
func (x *RestoreTableMetadata) GetOptimizeTableOperationName() string
func (x *RestoreTableMetadata) GetProgress() *OperationProgress
func (m *RestoreTableMetadata) GetSourceInfo() isRestoreTableMetadata_SourceInfo
func (x *RestoreTableMetadata) GetSourceType() RestoreSourceType
func (*RestoreTableMetadata) ProtoMessage()
func (x *RestoreTableMetadata) ProtoReflect() protoreflect.Message
func (x *RestoreTableMetadata) Reset()
func (x *RestoreTableMetadata) String() string
type RestoreTableMetadata_BackupInfo struct {
BackupInfo *BackupInfo `protobuf:"bytes,3,opt,name=backup_info,json=backupInfo,proto3,oneof"`
}
The request for [RestoreTable][google.bigtable.admin.v2.BigtableTableAdmin.RestoreTable].
type RestoreTableRequest struct {
// Required. The name of the instance in which to create the restored
// table. Values are of the form `projects/<project>/instances/<instance>`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The id of the table to create and restore to. This
// table must not already exist. The `table_id` appended to
// `parent` forms the full table name of the form
// `projects/<project>/instances/<instance>/tables/<table_id>`.
TableId string `protobuf:"bytes,2,opt,name=table_id,json=tableId,proto3" json:"table_id,omitempty"`
// Required. The source from which to restore.
//
// Types that are assignable to Source:
//
// *RestoreTableRequest_Backup
Source isRestoreTableRequest_Source `protobuf_oneof:"source"`
// contains filtered or unexported fields
}
func (*RestoreTableRequest) Descriptor() ([]byte, []int)
Deprecated: Use RestoreTableRequest.ProtoReflect.Descriptor instead.
func (x *RestoreTableRequest) GetBackup() string
func (x *RestoreTableRequest) GetParent() string
func (m *RestoreTableRequest) GetSource() isRestoreTableRequest_Source
func (x *RestoreTableRequest) GetTableId() string
func (*RestoreTableRequest) ProtoMessage()
func (x *RestoreTableRequest) ProtoReflect() protoreflect.Message
func (x *RestoreTableRequest) Reset()
func (x *RestoreTableRequest) String() string
type RestoreTableRequest_Backup struct {
// Name of the backup from which to restore. Values are of the form
// `projects/<project>/instances/<instance>/clusters/<cluster>/backups/<backup>`.
Backup string `protobuf:"bytes,3,opt,name=backup,proto3,oneof"`
}
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.
type Snapshot struct {
// The unique name of the snapshot.
// Values are of the form
// `projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Output only. The source table at the time the snapshot was taken.
SourceTable *Table `protobuf:"bytes,2,opt,name=source_table,json=sourceTable,proto3" json:"source_table,omitempty"`
// Output only. The size of the data in the source table at the time the
// snapshot was taken. In some cases, this value may be computed
// asynchronously via a background process and a placeholder of 0 will be used
// in the meantime.
DataSizeBytes int64 `protobuf:"varint,3,opt,name=data_size_bytes,json=dataSizeBytes,proto3" json:"data_size_bytes,omitempty"`
// Output only. The time when the snapshot is created.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// The time when the snapshot will be deleted. The maximum amount of time a
// snapshot can stay active is 365 days. If 'ttl' is not specified,
// the default maximum of 365 days will be used.
DeleteTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=delete_time,json=deleteTime,proto3" json:"delete_time,omitempty"`
// Output only. The current state of the snapshot.
State Snapshot_State `protobuf:"varint,6,opt,name=state,proto3,enum=google.bigtable.admin.v2.Snapshot_State" json:"state,omitempty"`
// Description of the snapshot.
Description string `protobuf:"bytes,7,opt,name=description,proto3" json:"description,omitempty"`
// contains filtered or unexported fields
}
func (*Snapshot) Descriptor() ([]byte, []int)
Deprecated: Use Snapshot.ProtoReflect.Descriptor instead.
func (x *Snapshot) GetCreateTime() *timestamppb.Timestamp
func (x *Snapshot) GetDataSizeBytes() int64
func (x *Snapshot) GetDeleteTime() *timestamppb.Timestamp
func (x *Snapshot) GetDescription() string
func (x *Snapshot) GetName() string
func (x *Snapshot) GetSourceTable() *Table
func (x *Snapshot) GetState() Snapshot_State
func (*Snapshot) ProtoMessage()
func (x *Snapshot) ProtoReflect() protoreflect.Message
func (x *Snapshot) Reset()
func (x *Snapshot) String() string
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.
type SnapshotTableMetadata struct {
// The request that prompted the initiation of this SnapshotTable operation.
OriginalRequest *SnapshotTableRequest `protobuf:"bytes,1,opt,name=original_request,json=originalRequest,proto3" json:"original_request,omitempty"`
// The time at which the original request was received.
RequestTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=request_time,json=requestTime,proto3" json:"request_time,omitempty"`
// The time at which the operation failed or was completed successfully.
FinishTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=finish_time,json=finishTime,proto3" json:"finish_time,omitempty"`
// contains filtered or unexported fields
}
func (*SnapshotTableMetadata) Descriptor() ([]byte, []int)
Deprecated: Use SnapshotTableMetadata.ProtoReflect.Descriptor instead.
func (x *SnapshotTableMetadata) GetFinishTime() *timestamppb.Timestamp
func (x *SnapshotTableMetadata) GetOriginalRequest() *SnapshotTableRequest
func (x *SnapshotTableMetadata) GetRequestTime() *timestamppb.Timestamp
func (*SnapshotTableMetadata) ProtoMessage()
func (x *SnapshotTableMetadata) ProtoReflect() protoreflect.Message
func (x *SnapshotTableMetadata) Reset()
func (x *SnapshotTableMetadata) String() string
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.
type SnapshotTableRequest struct {
// Required. The unique name of the table to have the snapshot taken.
// Values are of the form
// `projects/{project}/instances/{instance}/tables/{table}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. The name of the cluster where the snapshot will be created in.
// Values are of the form
// `projects/{project}/instances/{instance}/clusters/{cluster}`.
Cluster string `protobuf:"bytes,2,opt,name=cluster,proto3" json:"cluster,omitempty"`
// Required. The ID by which the new snapshot should be referred to within the
// parent cluster, e.g., `mysnapshot` of the form:
// `[_a-zA-Z0-9][-_.a-zA-Z0-9]*` rather than
// `projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/mysnapshot`.
SnapshotId string `protobuf:"bytes,3,opt,name=snapshot_id,json=snapshotId,proto3" json:"snapshot_id,omitempty"`
// The amount of time that the new snapshot can stay active after it is
// created. Once 'ttl' expires, the snapshot will get deleted. The maximum
// amount of time a snapshot can stay active is 7 days. If 'ttl' is not
// specified, the default value of 24 hours will be used.
Ttl *durationpb.Duration `protobuf:"bytes,4,opt,name=ttl,proto3" json:"ttl,omitempty"`
// Description of the snapshot.
Description string `protobuf:"bytes,5,opt,name=description,proto3" json:"description,omitempty"`
// contains filtered or unexported fields
}
func (*SnapshotTableRequest) Descriptor() ([]byte, []int)
Deprecated: Use SnapshotTableRequest.ProtoReflect.Descriptor instead.
func (x *SnapshotTableRequest) GetCluster() string
func (x *SnapshotTableRequest) GetDescription() string
func (x *SnapshotTableRequest) GetName() string
func (x *SnapshotTableRequest) GetSnapshotId() string
func (x *SnapshotTableRequest) GetTtl() *durationpb.Duration
func (*SnapshotTableRequest) ProtoMessage()
func (x *SnapshotTableRequest) ProtoReflect() protoreflect.Message
func (x *SnapshotTableRequest) Reset()
func (x *SnapshotTableRequest) String() string
Possible states of a snapshot.
type Snapshot_State int32
const (
// The state of the snapshot could not be determined.
Snapshot_STATE_NOT_KNOWN Snapshot_State = 0
// The snapshot has been successfully created and can serve all requests.
Snapshot_READY Snapshot_State = 1
// The snapshot is currently being created, and may be destroyed if the
// creation process encounters an error. A snapshot may not be restored to a
// table while it is being created.
Snapshot_CREATING Snapshot_State = 2
)
func (Snapshot_State) Descriptor() protoreflect.EnumDescriptor
func (x Snapshot_State) Enum() *Snapshot_State
func (Snapshot_State) EnumDescriptor() ([]byte, []int)
Deprecated: Use Snapshot_State.Descriptor instead.
func (x Snapshot_State) Number() protoreflect.EnumNumber
func (x Snapshot_State) String() string
func (Snapshot_State) Type() protoreflect.EnumType
Checks that all writes before the consistency token was generated are replicated in every cluster and readable.
type StandardReadRemoteWrites struct {
// contains filtered or unexported fields
}
func (*StandardReadRemoteWrites) Descriptor() ([]byte, []int)
Deprecated: Use StandardReadRemoteWrites.ProtoReflect.Descriptor instead.
func (*StandardReadRemoteWrites) ProtoMessage()
func (x *StandardReadRemoteWrites) ProtoReflect() protoreflect.Message
func (x *StandardReadRemoteWrites) Reset()
func (x *StandardReadRemoteWrites) String() string
Storage media types for persisting Bigtable data.
type StorageType int32
const (
// The user did not specify a storage type.
StorageType_STORAGE_TYPE_UNSPECIFIED StorageType = 0
// Flash (SSD) storage should be used.
StorageType_SSD StorageType = 1
// Magnetic drive (HDD) storage should be used.
StorageType_HDD StorageType = 2
)
func (StorageType) Descriptor() protoreflect.EnumDescriptor
func (x StorageType) Enum() *StorageType
func (StorageType) EnumDescriptor() ([]byte, []int)
Deprecated: Use StorageType.Descriptor instead.
func (x StorageType) Number() protoreflect.EnumNumber
func (x StorageType) String() string
func (StorageType) Type() protoreflect.EnumType
A collection of user data indexed by row, column, and timestamp. Each table is served using the resources of its parent cluster.
type Table struct {
// 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`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// 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`
ClusterStates map[string]*Table_ClusterState `protobuf:"bytes,2,rep,name=cluster_states,json=clusterStates,proto3" json:"cluster_states,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// The column families configured for this table, mapped by column family ID.
// Views: `SCHEMA_VIEW`, `STATS_VIEW`, `FULL`
ColumnFamilies map[string]*ColumnFamily `protobuf:"bytes,3,rep,name=column_families,json=columnFamilies,proto3" json:"column_families,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// 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`.
Granularity Table_TimestampGranularity `protobuf:"varint,4,opt,name=granularity,proto3,enum=google.bigtable.admin.v2.Table_TimestampGranularity" json:"granularity,omitempty"`
// 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.
RestoreInfo *RestoreInfo `protobuf:"bytes,6,opt,name=restore_info,json=restoreInfo,proto3" json:"restore_info,omitempty"`
// If specified, enable the change stream on this table.
// Otherwise, the change stream is disabled and the change stream is not
// retained.
ChangeStreamConfig *ChangeStreamConfig `protobuf:"bytes,8,opt,name=change_stream_config,json=changeStreamConfig,proto3" json:"change_stream_config,omitempty"`
// 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.
DeletionProtection bool `protobuf:"varint,9,opt,name=deletion_protection,json=deletionProtection,proto3" json:"deletion_protection,omitempty"`
// Types that are assignable to AutomatedBackupConfig:
//
// *Table_AutomatedBackupPolicy_
AutomatedBackupConfig isTable_AutomatedBackupConfig `protobuf_oneof:"automated_backup_config"`
// contains filtered or unexported fields
}
func (*Table) Descriptor() ([]byte, []int)
Deprecated: Use Table.ProtoReflect.Descriptor instead.
func (m *Table) GetAutomatedBackupConfig() isTable_AutomatedBackupConfig
func (x *Table) GetAutomatedBackupPolicy() *Table_AutomatedBackupPolicy
func (x *Table) GetChangeStreamConfig() *ChangeStreamConfig
func (x *Table) GetClusterStates() map[string]*Table_ClusterState
func (x *Table) GetColumnFamilies() map[string]*ColumnFamily
func (x *Table) GetDeletionProtection() bool
func (x *Table) GetGranularity() Table_TimestampGranularity
func (x *Table) GetName() string
func (x *Table) GetRestoreInfo() *RestoreInfo
func (*Table) ProtoMessage()
func (x *Table) ProtoReflect() protoreflect.Message
func (x *Table) Reset()
func (x *Table) String() string
Defines an automated backup policy for a table
type Table_AutomatedBackupPolicy struct {
// Required. How long the automated backups should be retained. The only
// supported value at this time is 3 days.
RetentionPeriod *durationpb.Duration `protobuf:"bytes,1,opt,name=retention_period,json=retentionPeriod,proto3" json:"retention_period,omitempty"`
// Required. How frequently automated backups should occur. The only
// supported value at this time is 24 hours.
Frequency *durationpb.Duration `protobuf:"bytes,2,opt,name=frequency,proto3" json:"frequency,omitempty"`
// contains filtered or unexported fields
}
func (*Table_AutomatedBackupPolicy) Descriptor() ([]byte, []int)
Deprecated: Use Table_AutomatedBackupPolicy.ProtoReflect.Descriptor instead.
func (x *Table_AutomatedBackupPolicy) GetFrequency() *durationpb.Duration
func (x *Table_AutomatedBackupPolicy) GetRetentionPeriod() *durationpb.Duration
func (*Table_AutomatedBackupPolicy) ProtoMessage()
func (x *Table_AutomatedBackupPolicy) ProtoReflect() protoreflect.Message
func (x *Table_AutomatedBackupPolicy) Reset()
func (x *Table_AutomatedBackupPolicy) String() string
type Table_AutomatedBackupPolicy_ struct {
// If specified, automated backups are enabled for this table.
// Otherwise, automated backups are disabled.
AutomatedBackupPolicy *Table_AutomatedBackupPolicy `protobuf:"bytes,13,opt,name=automated_backup_policy,json=automatedBackupPolicy,proto3,oneof"`
}
The state of a table's data in a particular cluster.
type Table_ClusterState struct {
// Output only. The state of replication for the table in this cluster.
ReplicationState Table_ClusterState_ReplicationState `protobuf:"varint,1,opt,name=replication_state,json=replicationState,proto3,enum=google.bigtable.admin.v2.Table_ClusterState_ReplicationState" json:"replication_state,omitempty"`
// Output only. The encryption information for the table in this cluster.
// If the encryption key protecting this resource is customer managed, then
// its version can be rotated in Cloud Key Management Service (Cloud KMS).
// The primary version of the key and its status will be reflected here when
// changes propagate from Cloud KMS.
EncryptionInfo []*EncryptionInfo `protobuf:"bytes,2,rep,name=encryption_info,json=encryptionInfo,proto3" json:"encryption_info,omitempty"`
// contains filtered or unexported fields
}
func (*Table_ClusterState) Descriptor() ([]byte, []int)
Deprecated: Use Table_ClusterState.ProtoReflect.Descriptor instead.
func (x *Table_ClusterState) GetEncryptionInfo() []*EncryptionInfo
func (x *Table_ClusterState) GetReplicationState() Table_ClusterState_ReplicationState
func (*Table_ClusterState) ProtoMessage()
func (x *Table_ClusterState) ProtoReflect() protoreflect.Message
func (x *Table_ClusterState) Reset()
func (x *Table_ClusterState) String() string
Table replication states.
type Table_ClusterState_ReplicationState int32
const (
// The replication state of the table is unknown in this cluster.
Table_ClusterState_STATE_NOT_KNOWN Table_ClusterState_ReplicationState = 0
// The cluster was recently created, and the table must finish copying
// over pre-existing data from other clusters before it can begin
// receiving live replication updates and serving Data API requests.
Table_ClusterState_INITIALIZING Table_ClusterState_ReplicationState = 1
// The table is temporarily unable to serve Data API requests from this
// cluster due to planned internal maintenance.
Table_ClusterState_PLANNED_MAINTENANCE Table_ClusterState_ReplicationState = 2
// The table is temporarily unable to serve Data API requests from this
// cluster due to unplanned or emergency maintenance.
Table_ClusterState_UNPLANNED_MAINTENANCE Table_ClusterState_ReplicationState = 3
// The table can serve Data API requests from this cluster. Depending on
// replication delay, reads may not immediately reflect the state of the
// table in other clusters.
Table_ClusterState_READY Table_ClusterState_ReplicationState = 4
// The table is fully created and ready for use after a restore, and is
// being optimized for performance. When optimizations are complete, the
// table will transition to `READY` state.
Table_ClusterState_READY_OPTIMIZING Table_ClusterState_ReplicationState = 5
)
func (Table_ClusterState_ReplicationState) Descriptor() protoreflect.EnumDescriptor
func (x Table_ClusterState_ReplicationState) Enum() *Table_ClusterState_ReplicationState
func (Table_ClusterState_ReplicationState) EnumDescriptor() ([]byte, []int)
Deprecated: Use Table_ClusterState_ReplicationState.Descriptor instead.
func (x Table_ClusterState_ReplicationState) Number() protoreflect.EnumNumber
func (x Table_ClusterState_ReplicationState) String() string
func (Table_ClusterState_ReplicationState) Type() protoreflect.EnumType
Possible timestamp granularities to use when keeping multiple versions of data in a table.
type Table_TimestampGranularity int32
const (
// The user did not specify a granularity. Should not be returned.
// When specified during table creation, MILLIS will be used.
Table_TIMESTAMP_GRANULARITY_UNSPECIFIED Table_TimestampGranularity = 0
// The table keeps data versioned at a granularity of 1ms.
Table_MILLIS Table_TimestampGranularity = 1
)
func (Table_TimestampGranularity) Descriptor() protoreflect.EnumDescriptor
func (x Table_TimestampGranularity) Enum() *Table_TimestampGranularity
func (Table_TimestampGranularity) EnumDescriptor() ([]byte, []int)
Deprecated: Use Table_TimestampGranularity.Descriptor instead.
func (x Table_TimestampGranularity) Number() protoreflect.EnumNumber
func (x Table_TimestampGranularity) String() string
func (Table_TimestampGranularity) Type() protoreflect.EnumType
Defines a view over a table's fields.
type Table_View int32
const (
// Uses the default view for each method as documented in its request.
Table_VIEW_UNSPECIFIED Table_View = 0
// Only populates `name`.
Table_NAME_ONLY Table_View = 1
// Only populates `name` and fields related to the table's schema.
Table_SCHEMA_VIEW Table_View = 2
// Only populates `name` and fields related to the table's replication
// state.
Table_REPLICATION_VIEW Table_View = 3
// Only populates `name` and fields related to the table's encryption state.
Table_ENCRYPTION_VIEW Table_View = 5
// Populates all fields.
Table_FULL Table_View = 4
)
func (Table_View) Descriptor() protoreflect.EnumDescriptor
func (x Table_View) Enum() *Table_View
func (Table_View) EnumDescriptor() ([]byte, []int)
Deprecated: Use Table_View.Descriptor instead.
func (x Table_View) Number() protoreflect.EnumNumber
func (x Table_View) String() string
func (Table_View) Type() protoreflect.EnumType
`Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features.
For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. This might involve composing a series of steps into an "encoding chain," for example to convert from INT64 -> STRING -> raw bytes. In most cases, a "link" in the encoding chain will be based an on existing GoogleSQL conversion function like `CAST`.
Each link in the encoding chain also defines the following properties:
type Type struct {
// The kind of type that this represents.
//
// Types that are assignable to Kind:
//
// *Type_BytesType
// *Type_Int64Type
// *Type_AggregateType
Kind isType_Kind `protobuf_oneof:"kind"`
// contains filtered or unexported fields
}
func (*Type) Descriptor() ([]byte, []int)
Deprecated: Use Type.ProtoReflect.Descriptor instead.
func (x *Type) GetAggregateType() *Type_Aggregate
func (x *Type) GetBytesType() *Type_Bytes
func (x *Type) GetInt64Type() *Type_Int64
func (m *Type) GetKind() isType_Kind
func (*Type) ProtoMessage()
func (x *Type) ProtoReflect() protoreflect.Message
func (x *Type) Reset()
func (x *Type) String() string
A value that combines incremental updates into a summarized value.
Data is never directly written or read using type `Aggregate`. Writes will provide either the `input_type` or `state_type`, and reads will always return the `state_type` .
type Type_Aggregate struct {
// Type of the inputs that are accumulated by this `Aggregate`, which must
// specify a full encoding.
// Use `AddInput` mutations to accumulate new inputs.
InputType *Type `protobuf:"bytes,1,opt,name=input_type,json=inputType,proto3" json:"input_type,omitempty"`
// Output only. Type that holds the internal accumulator state for the
// `Aggregate`. This is a function of the `input_type` and `aggregator`
// chosen, and will always specify a full encoding.
StateType *Type `protobuf:"bytes,2,opt,name=state_type,json=stateType,proto3" json:"state_type,omitempty"`
// Which aggregator function to use. The configured types must match.
//
// Types that are assignable to Aggregator:
//
// *Type_Aggregate_Sum_
Aggregator isType_Aggregate_Aggregator `protobuf_oneof:"aggregator"`
// contains filtered or unexported fields
}
func (*Type_Aggregate) Descriptor() ([]byte, []int)
Deprecated: Use Type_Aggregate.ProtoReflect.Descriptor instead.
func (m *Type_Aggregate) GetAggregator() isType_Aggregate_Aggregator
func (x *Type_Aggregate) GetInputType() *Type
func (x *Type_Aggregate) GetStateType() *Type
func (x *Type_Aggregate) GetSum() *Type_Aggregate_Sum
func (*Type_Aggregate) ProtoMessage()
func (x *Type_Aggregate) ProtoReflect() protoreflect.Message
func (x *Type_Aggregate) Reset()
func (x *Type_Aggregate) String() string
type Type_AggregateType struct {
// Aggregate
AggregateType *Type_Aggregate `protobuf:"bytes,6,opt,name=aggregate_type,json=aggregateType,proto3,oneof"`
}
Computes the sum of the input values. Allowed input: `Int64` State: same as input
type Type_Aggregate_Sum struct {
// contains filtered or unexported fields
}
func (*Type_Aggregate_Sum) Descriptor() ([]byte, []int)
Deprecated: Use Type_Aggregate_Sum.ProtoReflect.Descriptor instead.
func (*Type_Aggregate_Sum) ProtoMessage()
func (x *Type_Aggregate_Sum) ProtoReflect() protoreflect.Message
func (x *Type_Aggregate_Sum) Reset()
func (x *Type_Aggregate_Sum) String() string
type Type_Aggregate_Sum_ struct {
// Sum aggregator.
Sum *Type_Aggregate_Sum `protobuf:"bytes,4,opt,name=sum,proto3,oneof"`
}
Bytes Values of type `Bytes` are stored in `Value.bytes_value`.
type Type_Bytes struct {
// The encoding to use when converting to/from lower level types.
Encoding *Type_Bytes_Encoding `protobuf:"bytes,1,opt,name=encoding,proto3" json:"encoding,omitempty"`
// contains filtered or unexported fields
}
func (*Type_Bytes) Descriptor() ([]byte, []int)
Deprecated: Use Type_Bytes.ProtoReflect.Descriptor instead.
func (x *Type_Bytes) GetEncoding() *Type_Bytes_Encoding
func (*Type_Bytes) ProtoMessage()
func (x *Type_Bytes) ProtoReflect() protoreflect.Message
func (x *Type_Bytes) Reset()
func (x *Type_Bytes) String() string
type Type_BytesType struct {
// Bytes
BytesType *Type_Bytes `protobuf:"bytes,1,opt,name=bytes_type,json=bytesType,proto3,oneof"`
}
Rules used to convert to/from lower level types.
type Type_Bytes_Encoding struct {
// Which encoding to use.
//
// Types that are assignable to Encoding:
//
// *Type_Bytes_Encoding_Raw_
Encoding isType_Bytes_Encoding_Encoding `protobuf_oneof:"encoding"`
// contains filtered or unexported fields
}
func (*Type_Bytes_Encoding) Descriptor() ([]byte, []int)
Deprecated: Use Type_Bytes_Encoding.ProtoReflect.Descriptor instead.
func (m *Type_Bytes_Encoding) GetEncoding() isType_Bytes_Encoding_Encoding
func (x *Type_Bytes_Encoding) GetRaw() *Type_Bytes_Encoding_Raw
func (*Type_Bytes_Encoding) ProtoMessage()
func (x *Type_Bytes_Encoding) ProtoReflect() protoreflect.Message
func (x *Type_Bytes_Encoding) Reset()
func (x *Type_Bytes_Encoding) String() string
Leaves the value "as-is" * Natural sort? Yes * Self-delimiting? No * Compatibility? N/A
type Type_Bytes_Encoding_Raw struct {
// contains filtered or unexported fields
}
func (*Type_Bytes_Encoding_Raw) Descriptor() ([]byte, []int)
Deprecated: Use Type_Bytes_Encoding_Raw.ProtoReflect.Descriptor instead.
func (*Type_Bytes_Encoding_Raw) ProtoMessage()
func (x *Type_Bytes_Encoding_Raw) ProtoReflect() protoreflect.Message
func (x *Type_Bytes_Encoding_Raw) Reset()
func (x *Type_Bytes_Encoding_Raw) String() string
type Type_Bytes_Encoding_Raw_ struct {
// Use `Raw` encoding.
Raw *Type_Bytes_Encoding_Raw `protobuf:"bytes,1,opt,name=raw,proto3,oneof"`
}
Int64 Values of type `Int64` are stored in `Value.int_value`.
type Type_Int64 struct {
// The encoding to use when converting to/from lower level types.
Encoding *Type_Int64_Encoding `protobuf:"bytes,1,opt,name=encoding,proto3" json:"encoding,omitempty"`
// contains filtered or unexported fields
}
func (*Type_Int64) Descriptor() ([]byte, []int)
Deprecated: Use Type_Int64.ProtoReflect.Descriptor instead.
func (x *Type_Int64) GetEncoding() *Type_Int64_Encoding
func (*Type_Int64) ProtoMessage()
func (x *Type_Int64) ProtoReflect() protoreflect.Message
func (x *Type_Int64) Reset()
func (x *Type_Int64) String() string
type Type_Int64Type struct {
// Int64
Int64Type *Type_Int64 `protobuf:"bytes,5,opt,name=int64_type,json=int64Type,proto3,oneof"`
}
Rules used to convert to/from lower level types.
type Type_Int64_Encoding struct {
// Which encoding to use.
//
// Types that are assignable to Encoding:
//
// *Type_Int64_Encoding_BigEndianBytes_
Encoding isType_Int64_Encoding_Encoding `protobuf_oneof:"encoding"`
// contains filtered or unexported fields
}
func (*Type_Int64_Encoding) Descriptor() ([]byte, []int)
Deprecated: Use Type_Int64_Encoding.ProtoReflect.Descriptor instead.
func (x *Type_Int64_Encoding) GetBigEndianBytes() *Type_Int64_Encoding_BigEndianBytes
func (m *Type_Int64_Encoding) GetEncoding() isType_Int64_Encoding_Encoding
func (*Type_Int64_Encoding) ProtoMessage()
func (x *Type_Int64_Encoding) ProtoReflect() protoreflect.Message
func (x *Type_Int64_Encoding) Reset()
func (x *Type_Int64_Encoding) String() string
Encodes the value as an 8-byte big endian twos complement `Bytes` value. * Natural sort? No (positive values only) * Self-delimiting? Yes * Compatibility?
type Type_Int64_Encoding_BigEndianBytes struct {
// The underlying `Bytes` type, which may be able to encode further.
BytesType *Type_Bytes `protobuf:"bytes,1,opt,name=bytes_type,json=bytesType,proto3" json:"bytes_type,omitempty"`
// contains filtered or unexported fields
}
func (*Type_Int64_Encoding_BigEndianBytes) Descriptor() ([]byte, []int)
Deprecated: Use Type_Int64_Encoding_BigEndianBytes.ProtoReflect.Descriptor instead.
func (x *Type_Int64_Encoding_BigEndianBytes) GetBytesType() *Type_Bytes
func (*Type_Int64_Encoding_BigEndianBytes) ProtoMessage()
func (x *Type_Int64_Encoding_BigEndianBytes) ProtoReflect() protoreflect.Message
func (x *Type_Int64_Encoding_BigEndianBytes) Reset()
func (x *Type_Int64_Encoding_BigEndianBytes) String() string
type Type_Int64_Encoding_BigEndianBytes_ struct {
// Use `BigEndianBytes` encoding.
BigEndianBytes *Type_Int64_Encoding_BigEndianBytes `protobuf:"bytes,1,opt,name=big_endian_bytes,json=bigEndianBytes,proto3,oneof"`
}
Metadata type for the operation returned by [google.bigtable.admin.v2.BigtableTableAdmin.UndeleteTable][google.bigtable.admin.v2.BigtableTableAdmin.UndeleteTable].
type UndeleteTableMetadata struct {
// The name of the table being restored.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// The time at which this operation started.
StartTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
// If set, the time at which this operation finished or was cancelled.
EndTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
// contains filtered or unexported fields
}
func (*UndeleteTableMetadata) Descriptor() ([]byte, []int)
Deprecated: Use UndeleteTableMetadata.ProtoReflect.Descriptor instead.
func (x *UndeleteTableMetadata) GetEndTime() *timestamppb.Timestamp
func (x *UndeleteTableMetadata) GetName() string
func (x *UndeleteTableMetadata) GetStartTime() *timestamppb.Timestamp
func (*UndeleteTableMetadata) ProtoMessage()
func (x *UndeleteTableMetadata) ProtoReflect() protoreflect.Message
func (x *UndeleteTableMetadata) Reset()
func (x *UndeleteTableMetadata) String() string
Request message for [google.bigtable.admin.v2.BigtableTableAdmin.UndeleteTable][google.bigtable.admin.v2.BigtableTableAdmin.UndeleteTable]
type UndeleteTableRequest struct {
// Required. The unique name of the table to be restored.
// Values are of the form
// `projects/{project}/instances/{instance}/tables/{table}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*UndeleteTableRequest) Descriptor() ([]byte, []int)
Deprecated: Use UndeleteTableRequest.ProtoReflect.Descriptor instead.
func (x *UndeleteTableRequest) GetName() string
func (*UndeleteTableRequest) ProtoMessage()
func (x *UndeleteTableRequest) ProtoReflect() protoreflect.Message
func (x *UndeleteTableRequest) Reset()
func (x *UndeleteTableRequest) String() string
UnimplementedBigtableInstanceAdminServer can be embedded to have forward compatible implementations.
type UnimplementedBigtableInstanceAdminServer struct {
}
func (*UnimplementedBigtableInstanceAdminServer) CreateAppProfile(context.Context, *CreateAppProfileRequest) (*AppProfile, error)
func (*UnimplementedBigtableInstanceAdminServer) CreateCluster(context.Context, *CreateClusterRequest) (*longrunningpb.Operation, error)
func (*UnimplementedBigtableInstanceAdminServer) CreateInstance(context.Context, *CreateInstanceRequest) (*longrunningpb.Operation, error)
func (*UnimplementedBigtableInstanceAdminServer) DeleteAppProfile(context.Context, *DeleteAppProfileRequest) (*emptypb.Empty, error)
func (*UnimplementedBigtableInstanceAdminServer) DeleteCluster(context.Context, *DeleteClusterRequest) (*emptypb.Empty, error)
func (*UnimplementedBigtableInstanceAdminServer) DeleteInstance(context.Context, *DeleteInstanceRequest) (*emptypb.Empty, error)
func (*UnimplementedBigtableInstanceAdminServer) GetAppProfile(context.Context, *GetAppProfileRequest) (*AppProfile, error)
func (*UnimplementedBigtableInstanceAdminServer) GetCluster(context.Context, *GetClusterRequest) (*Cluster, error)
func (*UnimplementedBigtableInstanceAdminServer) GetIamPolicy(context.Context, *iampb.GetIamPolicyRequest) (*iampb.Policy, error)
func (*UnimplementedBigtableInstanceAdminServer) GetInstance(context.Context, *GetInstanceRequest) (*Instance, error)
func (*UnimplementedBigtableInstanceAdminServer) ListAppProfiles(context.Context, *ListAppProfilesRequest) (*ListAppProfilesResponse, error)
func (*UnimplementedBigtableInstanceAdminServer) ListClusters(context.Context, *ListClustersRequest) (*ListClustersResponse, error)
func (*UnimplementedBigtableInstanceAdminServer) ListHotTablets(context.Context, *ListHotTabletsRequest) (*ListHotTabletsResponse, error)
func (*UnimplementedBigtableInstanceAdminServer) ListInstances(context.Context, *ListInstancesRequest) (*ListInstancesResponse, error)
func (*UnimplementedBigtableInstanceAdminServer) PartialUpdateCluster(context.Context, *PartialUpdateClusterRequest) (*longrunningpb.Operation, error)
func (*UnimplementedBigtableInstanceAdminServer) PartialUpdateInstance(context.Context, *PartialUpdateInstanceRequest) (*longrunningpb.Operation, error)
func (*UnimplementedBigtableInstanceAdminServer) SetIamPolicy(context.Context, *iampb.SetIamPolicyRequest) (*iampb.Policy, error)
func (*UnimplementedBigtableInstanceAdminServer) TestIamPermissions(context.Context, *iampb.TestIamPermissionsRequest) (*iampb.TestIamPermissionsResponse, error)
func (*UnimplementedBigtableInstanceAdminServer) UpdateAppProfile(context.Context, *UpdateAppProfileRequest) (*longrunningpb.Operation, error)
func (*UnimplementedBigtableInstanceAdminServer) UpdateCluster(context.Context, *Cluster) (*longrunningpb.Operation, error)
func (*UnimplementedBigtableInstanceAdminServer) UpdateInstance(context.Context, *Instance) (*Instance, error)
UnimplementedBigtableTableAdminServer can be embedded to have forward compatible implementations.
type UnimplementedBigtableTableAdminServer struct {
}
func (*UnimplementedBigtableTableAdminServer) CheckConsistency(context.Context, *CheckConsistencyRequest) (*CheckConsistencyResponse, error)
func (*UnimplementedBigtableTableAdminServer) CopyBackup(context.Context, *CopyBackupRequest) (*longrunningpb.Operation, error)
func (*UnimplementedBigtableTableAdminServer) CreateAuthorizedView(context.Context, *CreateAuthorizedViewRequest) (*longrunningpb.Operation, error)
func (*UnimplementedBigtableTableAdminServer) CreateBackup(context.Context, *CreateBackupRequest) (*longrunningpb.Operation, error)
func (*UnimplementedBigtableTableAdminServer) CreateTable(context.Context, *CreateTableRequest) (*Table, error)
func (*UnimplementedBigtableTableAdminServer) CreateTableFromSnapshot(context.Context, *CreateTableFromSnapshotRequest) (*longrunningpb.Operation, error)
func (*UnimplementedBigtableTableAdminServer) DeleteAuthorizedView(context.Context, *DeleteAuthorizedViewRequest) (*emptypb.Empty, error)
func (*UnimplementedBigtableTableAdminServer) DeleteBackup(context.Context, *DeleteBackupRequest) (*emptypb.Empty, error)
func (*UnimplementedBigtableTableAdminServer) DeleteSnapshot(context.Context, *DeleteSnapshotRequest) (*emptypb.Empty, error)
func (*UnimplementedBigtableTableAdminServer) DeleteTable(context.Context, *DeleteTableRequest) (*emptypb.Empty, error)
func (*UnimplementedBigtableTableAdminServer) DropRowRange(context.Context, *DropRowRangeRequest) (*emptypb.Empty, error)
func (*UnimplementedBigtableTableAdminServer) GenerateConsistencyToken(context.Context, *GenerateConsistencyTokenRequest) (*GenerateConsistencyTokenResponse, error)
func (*UnimplementedBigtableTableAdminServer) GetAuthorizedView(context.Context, *GetAuthorizedViewRequest) (*AuthorizedView, error)
func (*UnimplementedBigtableTableAdminServer) GetBackup(context.Context, *GetBackupRequest) (*Backup, error)
func (*UnimplementedBigtableTableAdminServer) GetIamPolicy(context.Context, *iampb.GetIamPolicyRequest) (*iampb.Policy, error)
func (*UnimplementedBigtableTableAdminServer) GetSnapshot(context.Context, *GetSnapshotRequest) (*Snapshot, error)
func (*UnimplementedBigtableTableAdminServer) GetTable(context.Context, *GetTableRequest) (*Table, error)
func (*UnimplementedBigtableTableAdminServer) ListAuthorizedViews(context.Context, *ListAuthorizedViewsRequest) (*ListAuthorizedViewsResponse, error)
func (*UnimplementedBigtableTableAdminServer) ListBackups(context.Context, *ListBackupsRequest) (*ListBackupsResponse, error)
func (*UnimplementedBigtableTableAdminServer) ListSnapshots(context.Context, *ListSnapshotsRequest) (*ListSnapshotsResponse, error)
func (*UnimplementedBigtableTableAdminServer) ListTables(context.Context, *ListTablesRequest) (*ListTablesResponse, error)
func (*UnimplementedBigtableTableAdminServer) ModifyColumnFamilies(context.Context, *ModifyColumnFamiliesRequest) (*Table, error)
func (*UnimplementedBigtableTableAdminServer) RestoreTable(context.Context, *RestoreTableRequest) (*longrunningpb.Operation, error)
func (*UnimplementedBigtableTableAdminServer) SetIamPolicy(context.Context, *iampb.SetIamPolicyRequest) (*iampb.Policy, error)
func (*UnimplementedBigtableTableAdminServer) SnapshotTable(context.Context, *SnapshotTableRequest) (*longrunningpb.Operation, error)
func (*UnimplementedBigtableTableAdminServer) TestIamPermissions(context.Context, *iampb.TestIamPermissionsRequest) (*iampb.TestIamPermissionsResponse, error)
func (*UnimplementedBigtableTableAdminServer) UndeleteTable(context.Context, *UndeleteTableRequest) (*longrunningpb.Operation, error)
func (*UnimplementedBigtableTableAdminServer) UpdateAuthorizedView(context.Context, *UpdateAuthorizedViewRequest) (*longrunningpb.Operation, error)
func (*UnimplementedBigtableTableAdminServer) UpdateBackup(context.Context, *UpdateBackupRequest) (*Backup, error)
func (*UnimplementedBigtableTableAdminServer) UpdateTable(context.Context, *UpdateTableRequest) (*longrunningpb.Operation, error)
The metadata for the Operation returned by UpdateAppProfile.
type UpdateAppProfileMetadata struct {
// contains filtered or unexported fields
}
func (*UpdateAppProfileMetadata) Descriptor() ([]byte, []int)
Deprecated: Use UpdateAppProfileMetadata.ProtoReflect.Descriptor instead.
func (*UpdateAppProfileMetadata) ProtoMessage()
func (x *UpdateAppProfileMetadata) ProtoReflect() protoreflect.Message
func (x *UpdateAppProfileMetadata) Reset()
func (x *UpdateAppProfileMetadata) String() string
Request message for BigtableInstanceAdmin.UpdateAppProfile.
type UpdateAppProfileRequest struct {
// Required. The app profile which will (partially) replace the current value.
AppProfile *AppProfile `protobuf:"bytes,1,opt,name=app_profile,json=appProfile,proto3" json:"app_profile,omitempty"`
// Required. The subset of app profile fields which should be replaced.
// If unset, all fields will be replaced.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// If true, ignore safety checks when updating the app profile.
IgnoreWarnings bool `protobuf:"varint,3,opt,name=ignore_warnings,json=ignoreWarnings,proto3" json:"ignore_warnings,omitempty"`
// contains filtered or unexported fields
}
func (*UpdateAppProfileRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateAppProfileRequest.ProtoReflect.Descriptor instead.
func (x *UpdateAppProfileRequest) GetAppProfile() *AppProfile
func (x *UpdateAppProfileRequest) GetIgnoreWarnings() bool
func (x *UpdateAppProfileRequest) GetUpdateMask() *fieldmaskpb.FieldMask
func (*UpdateAppProfileRequest) ProtoMessage()
func (x *UpdateAppProfileRequest) ProtoReflect() protoreflect.Message
func (x *UpdateAppProfileRequest) Reset()
func (x *UpdateAppProfileRequest) String() string
Metadata for the google.longrunning.Operation returned by [UpdateAuthorizedView][google.bigtable.admin.v2.BigtableTableAdmin.UpdateAuthorizedView].
type UpdateAuthorizedViewMetadata struct {
// The request that prompted the initiation of this UpdateAuthorizedView
// operation.
OriginalRequest *UpdateAuthorizedViewRequest `protobuf:"bytes,1,opt,name=original_request,json=originalRequest,proto3" json:"original_request,omitempty"`
// The time at which the original request was received.
RequestTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=request_time,json=requestTime,proto3" json:"request_time,omitempty"`
// The time at which the operation failed or was completed successfully.
FinishTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=finish_time,json=finishTime,proto3" json:"finish_time,omitempty"`
// contains filtered or unexported fields
}
func (*UpdateAuthorizedViewMetadata) Descriptor() ([]byte, []int)
Deprecated: Use UpdateAuthorizedViewMetadata.ProtoReflect.Descriptor instead.
func (x *UpdateAuthorizedViewMetadata) GetFinishTime() *timestamppb.Timestamp
func (x *UpdateAuthorizedViewMetadata) GetOriginalRequest() *UpdateAuthorizedViewRequest
func (x *UpdateAuthorizedViewMetadata) GetRequestTime() *timestamppb.Timestamp
func (*UpdateAuthorizedViewMetadata) ProtoMessage()
func (x *UpdateAuthorizedViewMetadata) ProtoReflect() protoreflect.Message
func (x *UpdateAuthorizedViewMetadata) Reset()
func (x *UpdateAuthorizedViewMetadata) String() string
The request for [UpdateAuthorizedView][google.bigtable.admin.v2.BigtableTableAdmin.UpdateAuthorizedView].
type UpdateAuthorizedViewRequest struct {
// Required. The AuthorizedView to update. The `name` in `authorized_view` is
// used to identify the AuthorizedView. AuthorizedView name must in this
// format
// projects/<project>/instances/<instance>/tables/<table>/authorizedViews/<authorized_view>
AuthorizedView *AuthorizedView `protobuf:"bytes,1,opt,name=authorized_view,json=authorizedView,proto3" json:"authorized_view,omitempty"`
// Optional. The list of fields to update.
// A mask specifying which fields in the AuthorizedView resource should be
// updated. This mask is relative to the AuthorizedView resource, not to the
// request message. A field will be overwritten if it is in the mask. If
// empty, all fields set in the request will be overwritten. A special value
// `*` means to overwrite all fields (including fields not set in the
// request).
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// Optional. If true, ignore the safety checks when updating the
// AuthorizedView.
IgnoreWarnings bool `protobuf:"varint,3,opt,name=ignore_warnings,json=ignoreWarnings,proto3" json:"ignore_warnings,omitempty"`
// contains filtered or unexported fields
}
func (*UpdateAuthorizedViewRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateAuthorizedViewRequest.ProtoReflect.Descriptor instead.
func (x *UpdateAuthorizedViewRequest) GetAuthorizedView() *AuthorizedView
func (x *UpdateAuthorizedViewRequest) GetIgnoreWarnings() bool
func (x *UpdateAuthorizedViewRequest) GetUpdateMask() *fieldmaskpb.FieldMask
func (*UpdateAuthorizedViewRequest) ProtoMessage()
func (x *UpdateAuthorizedViewRequest) ProtoReflect() protoreflect.Message
func (x *UpdateAuthorizedViewRequest) Reset()
func (x *UpdateAuthorizedViewRequest) String() string
The request for [UpdateBackup][google.bigtable.admin.v2.BigtableTableAdmin.UpdateBackup].
type UpdateBackupRequest struct {
// Required. The backup to update. `backup.name`, and the fields to be updated
// as specified by `update_mask` are required. Other fields are ignored.
// Update is only supported for the following fields:
//
// - `backup.expire_time`.
Backup *Backup `protobuf:"bytes,1,opt,name=backup,proto3" json:"backup,omitempty"`
// Required. A mask specifying which fields (e.g. `expire_time`) in the
// Backup resource should be updated. This mask is relative to the Backup
// resource, not to the request message. The field mask must always be
// specified; this prevents any future fields from being erased accidentally
// by clients that do not know about them.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// contains filtered or unexported fields
}
func (*UpdateBackupRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateBackupRequest.ProtoReflect.Descriptor instead.
func (x *UpdateBackupRequest) GetBackup() *Backup
func (x *UpdateBackupRequest) GetUpdateMask() *fieldmaskpb.FieldMask
func (*UpdateBackupRequest) ProtoMessage()
func (x *UpdateBackupRequest) ProtoReflect() protoreflect.Message
func (x *UpdateBackupRequest) Reset()
func (x *UpdateBackupRequest) String() string
The metadata for the Operation returned by UpdateCluster.
type UpdateClusterMetadata struct {
// The request that prompted the initiation of this UpdateCluster operation.
OriginalRequest *Cluster `protobuf:"bytes,1,opt,name=original_request,json=originalRequest,proto3" json:"original_request,omitempty"`
// The time at which the original request was received.
RequestTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=request_time,json=requestTime,proto3" json:"request_time,omitempty"`
// The time at which the operation failed or was completed successfully.
FinishTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=finish_time,json=finishTime,proto3" json:"finish_time,omitempty"`
// contains filtered or unexported fields
}
func (*UpdateClusterMetadata) Descriptor() ([]byte, []int)
Deprecated: Use UpdateClusterMetadata.ProtoReflect.Descriptor instead.
func (x *UpdateClusterMetadata) GetFinishTime() *timestamppb.Timestamp
func (x *UpdateClusterMetadata) GetOriginalRequest() *Cluster
func (x *UpdateClusterMetadata) GetRequestTime() *timestamppb.Timestamp
func (*UpdateClusterMetadata) ProtoMessage()
func (x *UpdateClusterMetadata) ProtoReflect() protoreflect.Message
func (x *UpdateClusterMetadata) Reset()
func (x *UpdateClusterMetadata) String() string
The metadata for the Operation returned by UpdateInstance.
type UpdateInstanceMetadata struct {
// The request that prompted the initiation of this UpdateInstance operation.
OriginalRequest *PartialUpdateInstanceRequest `protobuf:"bytes,1,opt,name=original_request,json=originalRequest,proto3" json:"original_request,omitempty"`
// The time at which the original request was received.
RequestTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=request_time,json=requestTime,proto3" json:"request_time,omitempty"`
// The time at which the operation failed or was completed successfully.
FinishTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=finish_time,json=finishTime,proto3" json:"finish_time,omitempty"`
// contains filtered or unexported fields
}
func (*UpdateInstanceMetadata) Descriptor() ([]byte, []int)
Deprecated: Use UpdateInstanceMetadata.ProtoReflect.Descriptor instead.
func (x *UpdateInstanceMetadata) GetFinishTime() *timestamppb.Timestamp
func (x *UpdateInstanceMetadata) GetOriginalRequest() *PartialUpdateInstanceRequest
func (x *UpdateInstanceMetadata) GetRequestTime() *timestamppb.Timestamp
func (*UpdateInstanceMetadata) ProtoMessage()
func (x *UpdateInstanceMetadata) ProtoReflect() protoreflect.Message
func (x *UpdateInstanceMetadata) Reset()
func (x *UpdateInstanceMetadata) String() string
Metadata type for the operation returned by [UpdateTable][google.bigtable.admin.v2.BigtableTableAdmin.UpdateTable].
type UpdateTableMetadata struct {
// The name of the table being updated.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// The time at which this operation started.
StartTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
// If set, the time at which this operation finished or was canceled.
EndTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
// contains filtered or unexported fields
}
func (*UpdateTableMetadata) Descriptor() ([]byte, []int)
Deprecated: Use UpdateTableMetadata.ProtoReflect.Descriptor instead.
func (x *UpdateTableMetadata) GetEndTime() *timestamppb.Timestamp
func (x *UpdateTableMetadata) GetName() string
func (x *UpdateTableMetadata) GetStartTime() *timestamppb.Timestamp
func (*UpdateTableMetadata) ProtoMessage()
func (x *UpdateTableMetadata) ProtoReflect() protoreflect.Message
func (x *UpdateTableMetadata) Reset()
func (x *UpdateTableMetadata) String() string
The request for [UpdateTable][google.bigtable.admin.v2.BigtableTableAdmin.UpdateTable].
type UpdateTableRequest struct {
// Required. The table to update.
// The table's `name` field is used to identify the table to update.
Table *Table `protobuf:"bytes,1,opt,name=table,proto3" json:"table,omitempty"`
// Required. The list of fields to update.
// A mask specifying which fields (e.g. `change_stream_config`) in the `table`
// field should be updated. This mask is relative to the `table` field, not to
// the request message. The wildcard (*) path is currently not supported.
// Currently UpdateTable is only supported for the following fields:
//
// * `change_stream_config`
// * `change_stream_config.retention_period`
// * `deletion_protection`
//
// If `column_families` is set in `update_mask`, it will return an
// UNIMPLEMENTED error.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// contains filtered or unexported fields
}
func (*UpdateTableRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateTableRequest.ProtoReflect.Descriptor instead.
func (x *UpdateTableRequest) GetTable() *Table
func (x *UpdateTableRequest) GetUpdateMask() *fieldmaskpb.FieldMask
func (*UpdateTableRequest) ProtoMessage()
func (x *UpdateTableRequest) ProtoReflect() protoreflect.Message
func (x *UpdateTableRequest) Reset()
func (x *UpdateTableRequest) String() string