bigtableadmin

package
v0.214.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 19, 2024 License: BSD-3-Clause Imports: 18 Imported by: 26

Documentation

Overview

Package bigtableadmin provides access to the Cloud Bigtable Admin API.

For product documentation, see: https://cloud.google.com/bigtable/

Library status

These client libraries are officially supported by Google. However, this library is considered complete and is in maintenance mode. This means that we will address critical bugs and security issues but will not add any new features.

When possible, we recommend using our newer [Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go) that are still actively being worked and iterated on.

Creating a client

Usage example:

import "google.golang.org/api/bigtableadmin/v2"
...
ctx := context.Background()
bigtableadminService, err := bigtableadmin.NewService(ctx)

In this example, Google Application Default Credentials are used for authentication. For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

By default, all available scopes (see "Constants") are used to authenticate. To restrict scopes, use google.golang.org/api/option.WithScopes:

bigtableadminService, err := bigtableadmin.NewService(ctx, option.WithScopes(bigtableadmin.CloudPlatformReadOnlyScope))

To use an API key for authentication (note: some APIs do not support API keys), use google.golang.org/api/option.WithAPIKey:

bigtableadminService, err := bigtableadmin.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow, use google.golang.org/api/option.WithTokenSource:

config := &oauth2.Config{...}
// ...
token, err := config.Exchange(ctx, ...)
bigtableadminService, err := bigtableadmin.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

See google.golang.org/api/option.ClientOption for details on options.

Index

Constants

View Source
const (
	// Administer your Cloud Bigtable tables and clusters
	BigtableAdminScope = "https://www.googleapis.com/auth/bigtable.admin"

	// Administer your Cloud Bigtable clusters
	BigtableAdminClusterScope = "https://www.googleapis.com/auth/bigtable.admin.cluster"

	// Administer your Cloud Bigtable clusters
	BigtableAdminInstanceScope = "https://www.googleapis.com/auth/bigtable.admin.instance"

	// Administer your Cloud Bigtable tables
	BigtableAdminTableScope = "https://www.googleapis.com/auth/bigtable.admin.table"

	// Administer your Cloud Bigtable tables and clusters
	CloudBigtableAdminScope = "https://www.googleapis.com/auth/cloud-bigtable.admin"

	// Administer your Cloud Bigtable clusters
	CloudBigtableAdminClusterScope = "https://www.googleapis.com/auth/cloud-bigtable.admin.cluster"

	// Administer your Cloud Bigtable tables
	CloudBigtableAdminTableScope = "https://www.googleapis.com/auth/cloud-bigtable.admin.table"

	// See, edit, configure, and delete your Google Cloud data and see the email
	// address for your Google Account.
	CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"

	// View your data across Google Cloud services and see the email address of
	// your Google Account
	CloudPlatformReadOnlyScope = "https://www.googleapis.com/auth/cloud-platform.read-only"
)

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

type AppProfile

type AppProfile struct {
	// DataBoostIsolationReadOnly: Specifies that this app profile is intended for
	// read-only usage via the Data Boost feature.
	DataBoostIsolationReadOnly *DataBoostIsolationReadOnly `json:"dataBoostIsolationReadOnly,omitempty"`
	// Description: Long form description of the use case for this AppProfile.
	Description string `json:"description,omitempty"`
	// Etag: 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 `json:"etag,omitempty"`
	// MultiClusterRoutingUseAny: Use a multi-cluster routing policy.
	MultiClusterRoutingUseAny *MultiClusterRoutingUseAny `json:"multiClusterRoutingUseAny,omitempty"`
	// Name: The unique name of the app profile. Values are of the form
	// `projects/{project}/instances/{instance}/appProfiles/_a-zA-Z0-9*`.
	Name string `json:"name,omitempty"`
	// Priority: 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.
	//
	// Possible values:
	//   "PRIORITY_UNSPECIFIED" - Default value. Mapped to PRIORITY_HIGH (the
	// legacy behavior) on creation.
	//   "PRIORITY_LOW"
	//   "PRIORITY_MEDIUM"
	//   "PRIORITY_HIGH"
	Priority string `json:"priority,omitempty"`
	// SingleClusterRouting: Use a single-cluster routing policy.
	SingleClusterRouting *SingleClusterRouting `json:"singleClusterRouting,omitempty"`
	// StandardIsolation: The standard options used for isolating this app
	// profile's traffic from other use cases.
	StandardIsolation *StandardIsolation `json:"standardIsolation,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "DataBoostIsolationReadOnly")
	// to unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "DataBoostIsolationReadOnly") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (AppProfile) MarshalJSON

func (s AppProfile) MarshalJSON() ([]byte, error)

type AuditConfig

type AuditConfig struct {
	// AuditLogConfigs: The configuration for logging of each type of permission.
	AuditLogConfigs []*AuditLogConfig `json:"auditLogConfigs,omitempty"`
	// Service: Specifies a service that will be enabled for audit logging. For
	// example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices`
	// is a special value that covers all services.
	Service string `json:"service,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AuditLogConfigs") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AuditLogConfigs") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

AuditConfig: Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.

func (AuditConfig) MarshalJSON

func (s AuditConfig) MarshalJSON() ([]byte, error)

type AuditLogConfig

type AuditLogConfig struct {
	// ExemptedMembers: Specifies the identities that do not cause logging for this
	// type of permission. Follows the same format of Binding.members.
	ExemptedMembers []string `json:"exemptedMembers,omitempty"`
	// LogType: The log type that this config enables.
	//
	// Possible values:
	//   "LOG_TYPE_UNSPECIFIED" - Default case. Should never be this.
	//   "ADMIN_READ" - Admin reads. Example: CloudIAM getIamPolicy
	//   "DATA_WRITE" - Data writes. Example: CloudSQL Users create
	//   "DATA_READ" - Data reads. Example: CloudSQL Users list
	LogType string `json:"logType,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ExemptedMembers") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ExemptedMembers") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

AuditLogConfig: Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

func (AuditLogConfig) MarshalJSON

func (s AuditLogConfig) MarshalJSON() ([]byte, error)

type AuthorizedView added in v0.171.0

type AuthorizedView struct {
	// DeletionProtection: 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 `json:"deletionProtection,omitempty"`
	// Etag: 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 `json:"etag,omitempty"`
	// Name: Identifier. The name of this AuthorizedView. Values are of the form
	// `projects/{project}/instances/{instance}/tables/{table}/authorizedViews/{auth
	// orized_view}`
	Name string `json:"name,omitempty"`
	// SubsetView: An AuthorizedView permitting access to an explicit subset of a
	// Table.
	SubsetView *GoogleBigtableAdminV2AuthorizedViewSubsetView `json:"subsetView,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "DeletionProtection") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "DeletionProtection") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

AuthorizedView: An Authorized View of a Cloud Bigtable Table.

func (AuthorizedView) MarshalJSON added in v0.171.0

func (s AuthorizedView) MarshalJSON() ([]byte, error)

type AutomatedBackupPolicy added in v0.170.0

type AutomatedBackupPolicy struct {
	// Frequency: How frequently automated backups should occur. The only supported
	// value at this time is 24 hours. An undefined frequency is treated as 24
	// hours.
	Frequency string `json:"frequency,omitempty"`
	// RetentionPeriod: Required. How long the automated backups should be
	// retained. Values must be at least 3 days and at most 90 days.
	RetentionPeriod string `json:"retentionPeriod,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Frequency") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Frequency") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

AutomatedBackupPolicy: Defines an automated backup policy for a table

func (AutomatedBackupPolicy) MarshalJSON added in v0.170.0

func (s AutomatedBackupPolicy) MarshalJSON() ([]byte, error)

type AutoscalingLimits added in v0.61.0

type AutoscalingLimits struct {
	// MaxServeNodes: Required. Maximum number of nodes to scale up to.
	MaxServeNodes int64 `json:"maxServeNodes,omitempty"`
	// MinServeNodes: Required. Minimum number of nodes to scale down to.
	MinServeNodes int64 `json:"minServeNodes,omitempty"`
	// ForceSendFields is a list of field names (e.g. "MaxServeNodes") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "MaxServeNodes") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (AutoscalingLimits) MarshalJSON added in v0.61.0

func (s AutoscalingLimits) MarshalJSON() ([]byte, error)

type AutoscalingTargets added in v0.61.0

type AutoscalingTargets struct {
	// CpuUtilizationPercent: 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 int64 `json:"cpuUtilizationPercent,omitempty"`
	// StorageUtilizationGibPerNode: 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 int64 `json:"storageUtilizationGibPerNode,omitempty"`
	// ForceSendFields is a list of field names (e.g. "CpuUtilizationPercent") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "CpuUtilizationPercent") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (AutoscalingTargets) MarshalJSON added in v0.61.0

func (s AutoscalingTargets) MarshalJSON() ([]byte, error)

type Backup added in v0.30.0

type Backup struct {
	// BackupType: Indicates the backup type of the backup.
	//
	// Possible values:
	//   "BACKUP_TYPE_UNSPECIFIED" - Not specified.
	//   "STANDARD" - The default type for Cloud Bigtable managed backups.
	// Supported for backups created in both HDD and SSD instances. Requires
	// optimization when restored to a table in an SSD instance.
	//   "HOT" - A backup type with faster restore to SSD performance. Only
	// supported for backups created in SSD instances. A new SSD table restored
	// from a hot backup reaches production performance more quickly than a
	// standard backup.
	BackupType string `json:"backupType,omitempty"`
	// EncryptionInfo: Output only. The encryption information for the backup.
	EncryptionInfo *EncryptionInfo `json:"encryptionInfo,omitempty"`
	// EndTime: 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 string `json:"endTime,omitempty"`
	// ExpireTime: Required. The expiration time of the backup. When creating a
	// backup or updating its `expire_time`, the value must be greater than the
	// backup creation time by: - At least 6 hours - At most 90 days Once the
	// `expire_time` has passed, Cloud Bigtable will delete the backup.
	ExpireTime string `json:"expireTime,omitempty"`
	// HotToStandardTime: The time at which the hot backup will be converted to a
	// standard backup. Once the `hot_to_standard_time` has passed, Cloud Bigtable
	// will convert the hot backup to a standard backup. This value must be greater
	// than the backup creation time by: - At least 24 hours This field only
	// applies for hot backups. When creating or updating a standard backup,
	// attempting to set this field will fail the request.
	HotToStandardTime string `json:"hotToStandardTime,omitempty"`
	// Name: 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*` 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 `json:"name,omitempty"`
	// SizeBytes: Output only. Size of the backup in bytes.
	SizeBytes int64 `json:"sizeBytes,omitempty,string"`
	// SourceBackup: 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//instances//clusters//backups/
	SourceBackup string `json:"sourceBackup,omitempty"`
	// SourceTable: 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 `json:"sourceTable,omitempty"`
	// StartTime: Output only. `start_time` is the time that the backup was started
	// (i.e. approximately the time the CreateBackup request is received). The row
	// data in this backup will be no older than this timestamp.
	StartTime string `json:"startTime,omitempty"`
	// State: Output only. The current state of the backup.
	//
	// Possible values:
	//   "STATE_UNSPECIFIED" - Not specified.
	//   "CREATING" - The pending backup is still being created. Operations on the
	// backup may fail with `FAILED_PRECONDITION` in this state.
	//   "READY" - The backup is complete and ready for use.
	State string `json:"state,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "BackupType") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "BackupType") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Backup: A backup of a Cloud Bigtable table.

func (Backup) MarshalJSON added in v0.30.0

func (s Backup) MarshalJSON() ([]byte, error)

type BackupInfo added in v0.30.0

type BackupInfo struct {
	// Backup: Output only. Name of the backup.
	Backup string `json:"backup,omitempty"`
	// EndTime: Output only. This time that the backup was finished. Row data in
	// the backup will be no newer than this timestamp.
	EndTime string `json:"endTime,omitempty"`
	// SourceBackup: 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//instances//clusters//backups/
	SourceBackup string `json:"sourceBackup,omitempty"`
	// SourceTable: Output only. Name of the table the backup was created from.
	SourceTable string `json:"sourceTable,omitempty"`
	// StartTime: Output only. The time that the backup was started. Row data in
	// the backup will be no older than this timestamp.
	StartTime string `json:"startTime,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Backup") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Backup") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

BackupInfo: Information about a backup.

func (BackupInfo) MarshalJSON added in v0.30.0

func (s BackupInfo) MarshalJSON() ([]byte, error)

type Binding

type Binding struct {
	// Condition: The condition that is associated with this binding. If the
	// condition evaluates to `true`, then this binding applies to the current
	// request. If the condition evaluates to `false`, then this binding does not
	// apply to the current request. However, a different role binding might grant
	// the same role to one or more of the principals in this binding. To learn
	// which resources support conditions in their IAM policies, see the IAM
	// documentation
	// (https://cloud.google.com/iam/help/conditions/resource-policies).
	Condition *Expr `json:"condition,omitempty"`
	// Members: Specifies the principals requesting access for a Google Cloud
	// resource. `members` can have the following values: * `allUsers`: A special
	// identifier that represents anyone who is on the internet; with or without a
	// Google account. * `allAuthenticatedUsers`: A special identifier that
	// represents anyone who is authenticated with a Google account or a service
	// account. Does not include identities that come from external identity
	// providers (IdPs) through identity federation. * `user:{emailid}`: An email
	// address that represents a specific Google account. For example,
	// `alice@example.com` . * `serviceAccount:{emailid}`: An email address that
	// represents a Google service account. For example,
	// `my-other-app@appspot.gserviceaccount.com`. *
	// `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
	// identifier for a Kubernetes service account
	// (https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
	// For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. *
	// `group:{emailid}`: An email address that represents a Google group. For
	// example, `admins@example.com`. * `domain:{domain}`: The G Suite domain
	// (primary) that represents all the users of that domain. For example,
	// `google.com` or `example.com`. *
	// `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/sub
	// ject/{subject_attribute_value}`: A single identity in a workforce identity
	// pool. *
	// `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/
	// group/{group_id}`: All workforce identities in a group. *
	// `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/
	// attribute.{attribute_name}/{attribute_value}`: All workforce identities with
	// a specific attribute value. *
	// `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/
	// *`: All identities in a workforce identity pool. *
	// `principal://iam.googleapis.com/projects/{project_number}/locations/global/wo
	// rkloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single
	// identity in a workload identity pool. *
	// `principalSet://iam.googleapis.com/projects/{project_number}/locations/global
	// /workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool
	// group. *
	// `principalSet://iam.googleapis.com/projects/{project_number}/locations/global
	// /workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}
	// `: All identities in a workload identity pool with a certain attribute. *
	// `principalSet://iam.googleapis.com/projects/{project_number}/locations/global
	// /workloadIdentityPools/{pool_id}/*`: All identities in a workload identity
	// pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus
	// unique identifier) representing a user that has been recently deleted. For
	// example, `alice@example.com?uid=123456789012345678901`. If the user is
	// recovered, this value reverts to `user:{emailid}` and the recovered user
	// retains the role in the binding. *
	// `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
	// unique identifier) representing a service account that has been recently
	// deleted. For example,
	// `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the
	// service account is undeleted, this value reverts to
	// `serviceAccount:{emailid}` and the undeleted service account retains the
	// role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email
	// address (plus unique identifier) representing a Google group that has been
	// recently deleted. For example,
	// `admins@example.com?uid=123456789012345678901`. If the group is recovered,
	// this value reverts to `group:{emailid}` and the recovered group retains the
	// role in the binding. *
	// `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool
	// _id}/subject/{subject_attribute_value}`: Deleted single identity in a
	// workforce identity pool. For example,
	// `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-po
	// ol-id/subject/my-subject-attribute-value`.
	Members []string `json:"members,omitempty"`
	// Role: Role that is assigned to the list of `members`, or principals. For
	// example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview
	// of the IAM roles and permissions, see the IAM documentation
	// (https://cloud.google.com/iam/docs/roles-overview). For a list of the
	// available pre-defined roles, see here
	// (https://cloud.google.com/iam/docs/understanding-roles).
	Role string `json:"role,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Condition") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Condition") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Binding: Associates `members`, or principals, with a `role`.

func (Binding) MarshalJSON

func (s Binding) MarshalJSON() ([]byte, error)

type ChangeStreamConfig added in v0.130.0

type ChangeStreamConfig struct {
	// RetentionPeriod: How long the change stream should be retained. Change
	// stream data older than the retention period will not be returned when
	// reading the change stream from the table. Values must be at least 1 day and
	// at most 7 days, and will be truncated to microsecond granularity.
	RetentionPeriod string `json:"retentionPeriod,omitempty"`
	// ForceSendFields is a list of field names (e.g. "RetentionPeriod") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "RetentionPeriod") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ChangeStreamConfig: Change stream configuration.

func (ChangeStreamConfig) MarshalJSON added in v0.130.0

func (s ChangeStreamConfig) MarshalJSON() ([]byte, error)

type CheckConsistencyRequest

type CheckConsistencyRequest struct {
	// ConsistencyToken: Required. The token created using GenerateConsistencyToken
	// for the Table.
	ConsistencyToken string `json:"consistencyToken,omitempty"`
	// DataBoostReadLocalWrites: 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 `json:"dataBoostReadLocalWrites,omitempty"`
	// StandardReadRemoteWrites: 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 `json:"standardReadRemoteWrites,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ConsistencyToken") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ConsistencyToken") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

CheckConsistencyRequest: Request message for google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency

func (CheckConsistencyRequest) MarshalJSON

func (s CheckConsistencyRequest) MarshalJSON() ([]byte, error)

type CheckConsistencyResponse

type CheckConsistencyResponse struct {
	// Consistent: 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 `json:"consistent,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Consistent") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Consistent") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

CheckConsistencyResponse: Response message for google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency

func (CheckConsistencyResponse) MarshalJSON

func (s CheckConsistencyResponse) MarshalJSON() ([]byte, error)

type Cluster

type Cluster struct {
	// ClusterConfig: Configuration for this cluster.
	ClusterConfig *ClusterConfig `json:"clusterConfig,omitempty"`
	// DefaultStorageType: Immutable. The type of storage used by this cluster to
	// serve its parent instance's tables, unless explicitly overridden.
	//
	// Possible values:
	//   "STORAGE_TYPE_UNSPECIFIED" - The user did not specify a storage type.
	//   "SSD" - Flash (SSD) storage should be used.
	//   "HDD" - Magnetic drive (HDD) storage should be used.
	DefaultStorageType string `json:"defaultStorageType,omitempty"`
	// EncryptionConfig: Immutable. The encryption configuration for CMEK-protected
	// clusters.
	EncryptionConfig *EncryptionConfig `json:"encryptionConfig,omitempty"`
	// Location: 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 `json:"location,omitempty"`
	// Name: The unique name of the cluster. Values are of the form
	// `projects/{project}/instances/{instance}/clusters/a-z*`.
	Name string `json:"name,omitempty"`
	// NodeScalingFactor: Immutable. The node scaling factor of this cluster.
	//
	// Possible values:
	//   "NODE_SCALING_FACTOR_UNSPECIFIED" - No node scaling specified. Defaults to
	// NODE_SCALING_FACTOR_1X.
	//   "NODE_SCALING_FACTOR_1X" - The cluster is running with a scaling factor of
	// 1.
	//   "NODE_SCALING_FACTOR_2X" - The cluster is running with a scaling factor of
	// 2. All node count values must be in increments of 2 with this scaling factor
	// enabled, otherwise an INVALID_ARGUMENT error will be returned.
	NodeScalingFactor string `json:"nodeScalingFactor,omitempty"`
	// ServeNodes: The number of nodes in the cluster. If no value is set, Cloud
	// Bigtable automatically allocates nodes based on your data footprint and
	// optimized for 50% storage utilization.
	ServeNodes int64 `json:"serveNodes,omitempty"`
	// State: Output only. The current state of the cluster.
	//
	// Possible values:
	//   "STATE_NOT_KNOWN" - The state of the cluster could not be determined.
	//   "READY" - The cluster has been successfully created and is ready to serve
	// requests.
	//   "CREATING" - 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.
	//   "RESIZING" - 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.
	//   "DISABLED" - The cluster has no backing nodes. The data (tables) still
	// exist, but no operations can be performed on the cluster.
	State string `json:"state,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "ClusterConfig") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ClusterConfig") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Cluster: A resizable group of nodes in a particular cloud location, capable of serving all Tables in the parent Instance.

func (Cluster) MarshalJSON

func (s Cluster) MarshalJSON() ([]byte, error)

type ClusterAutoscalingConfig added in v0.61.0

type ClusterAutoscalingConfig struct {
	// AutoscalingLimits: Required. Autoscaling limits for this cluster.
	AutoscalingLimits *AutoscalingLimits `json:"autoscalingLimits,omitempty"`
	// AutoscalingTargets: Required. Autoscaling targets for this cluster.
	AutoscalingTargets *AutoscalingTargets `json:"autoscalingTargets,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AutoscalingLimits") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AutoscalingLimits") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ClusterAutoscalingConfig: Autoscaling config for a cluster.

func (ClusterAutoscalingConfig) MarshalJSON added in v0.61.0

func (s ClusterAutoscalingConfig) MarshalJSON() ([]byte, error)

type ClusterConfig added in v0.61.0

type ClusterConfig struct {
	// ClusterAutoscalingConfig: Autoscaling configuration for this cluster.
	ClusterAutoscalingConfig *ClusterAutoscalingConfig `json:"clusterAutoscalingConfig,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ClusterAutoscalingConfig")
	// to unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ClusterAutoscalingConfig") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ClusterConfig: Configuration for a cluster.

func (ClusterConfig) MarshalJSON added in v0.61.0

func (s ClusterConfig) MarshalJSON() ([]byte, error)

type ClusterState

type ClusterState struct {
	// EncryptionInfo: 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 `json:"encryptionInfo,omitempty"`
	// ReplicationState: Output only. The state of replication for the table in
	// this cluster.
	//
	// Possible values:
	//   "STATE_NOT_KNOWN" - The replication state of the table is unknown in this
	// cluster.
	//   "INITIALIZING" - 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.
	//   "PLANNED_MAINTENANCE" - The table is temporarily unable to serve Data API
	// requests from this cluster due to planned internal maintenance.
	//   "UNPLANNED_MAINTENANCE" - The table is temporarily unable to serve Data
	// API requests from this cluster due to unplanned or emergency maintenance.
	//   "READY" - 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.
	//   "READY_OPTIMIZING" - 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.
	ReplicationState string `json:"replicationState,omitempty"`
	// ForceSendFields is a list of field names (e.g. "EncryptionInfo") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "EncryptionInfo") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (ClusterState) MarshalJSON

func (s ClusterState) MarshalJSON() ([]byte, error)

type ColumnFamily

type ColumnFamily struct {
	// GcRule: 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 `json:"gcRule,omitempty"`
	// Stats: Output only. Only available with STATS_VIEW, this includes summary
	// statistics about column family contents. For statistics over an entire
	// table, see TableStats above.
	Stats *ColumnFamilyStats `json:"stats,omitempty"`
	// ValueType: 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 `json:"valueType,omitempty"`
	// ForceSendFields is a list of field names (e.g. "GcRule") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "GcRule") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (ColumnFamily) MarshalJSON

func (s ColumnFamily) MarshalJSON() ([]byte, error)

type ColumnFamilyStats added in v0.103.0

type ColumnFamilyStats struct {
	// AverageCellsPerColumn: How many cells are present per column qualifier in
	// this column family, averaged over all rows containing any column in the
	// column family. e.g. For column family "family" in a table with 3 rows: * A
	// row with 3 cells in "family:col" and 1 cell in "other:col" (3 cells / 1
	// column in "family") * A row with 1 cell in "family:col", 7 cells in
	// "family:other_col", and 7 cells in "other:data" (8 cells / 2 columns in
	// "family") * A row with 3 cells in "other:col" (0 columns in "family",
	// "family" not present) would report (3 + 8 + 0)/(1 + 2 + 0) = 3.66 in this
	// field.
	AverageCellsPerColumn float64 `json:"averageCellsPerColumn,omitempty"`
	// AverageColumnsPerRow: How many column qualifiers are present in this column
	// family, averaged over all rows in the table. e.g. For column family "family"
	// in a table with 3 rows: * A row with cells in "family:col" and "other:col"
	// (1 column in "family") * A row with cells in "family:col",
	// "family:other_col", and "other:data" (2 columns in "family") * A row with
	// cells in "other:col" (0 columns in "family", "family" not present) would
	// report (1 + 2 + 0)/3 = 1.5 in this field.
	AverageColumnsPerRow float64 `json:"averageColumnsPerRow,omitempty"`
	// LogicalDataBytes: How much space the data in the column family occupies.
	// This is roughly how many bytes would be needed to read the contents of the
	// entire column family (e.g. by streaming all contents out).
	LogicalDataBytes int64 `json:"logicalDataBytes,omitempty,string"`
	// ForceSendFields is a list of field names (e.g. "AverageCellsPerColumn") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AverageCellsPerColumn") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ColumnFamilyStats: Approximate statistics related to a single column family within a table. This information may change rapidly, interpreting these values at a point in time may already preset out-of-date information. Everything below is approximate, unless otherwise specified.

func (ColumnFamilyStats) MarshalJSON added in v0.103.0

func (s ColumnFamilyStats) MarshalJSON() ([]byte, error)

func (*ColumnFamilyStats) UnmarshalJSON added in v0.103.0

func (s *ColumnFamilyStats) UnmarshalJSON(data []byte) error

type CopyBackupMetadata added in v0.101.0

type CopyBackupMetadata struct {
	// Name: The name of the backup being created through the copy operation.
	// Values are of the form `projects//instances//clusters//backups/`.
	Name string `json:"name,omitempty"`
	// Progress: The progress of the CopyBackup operation.
	Progress *OperationProgress `json:"progress,omitempty"`
	// SourceBackupInfo: Information about the source backup that is being copied
	// from.
	SourceBackupInfo *BackupInfo `json:"sourceBackupInfo,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Name") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Name") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

CopyBackupMetadata: Metadata type for the google.longrunning.Operation returned by CopyBackup.

func (CopyBackupMetadata) MarshalJSON added in v0.101.0

func (s CopyBackupMetadata) MarshalJSON() ([]byte, error)

type CopyBackupRequest added in v0.101.0

type CopyBackupRequest struct {
	// BackupId: 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_i
	// d}`. This string must be between 1 and 50 characters in length and match the
	// regex _a-zA-Z0-9*.
	BackupId string `json:"backupId,omitempty"`
	// ExpireTime: 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 string `json:"expireTime,omitempty"`
	// SourceBackup: 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//instances//clusters//backups/`.
	SourceBackup string `json:"sourceBackup,omitempty"`
	// ForceSendFields is a list of field names (e.g. "BackupId") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "BackupId") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

CopyBackupRequest: The request for CopyBackup.

func (CopyBackupRequest) MarshalJSON added in v0.101.0

func (s CopyBackupRequest) MarshalJSON() ([]byte, error)

type CreateAuthorizedViewMetadata added in v0.171.0

type CreateAuthorizedViewMetadata struct {
	// FinishTime: The time at which the operation failed or was completed
	// successfully.
	FinishTime string `json:"finishTime,omitempty"`
	// OriginalRequest: The request that prompted the initiation of this
	// CreateAuthorizedView operation.
	OriginalRequest *CreateAuthorizedViewRequest `json:"originalRequest,omitempty"`
	// RequestTime: The time at which the original request was received.
	RequestTime string `json:"requestTime,omitempty"`
	// ForceSendFields is a list of field names (e.g. "FinishTime") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "FinishTime") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

CreateAuthorizedViewMetadata: The metadata for the Operation returned by CreateAuthorizedView.

func (CreateAuthorizedViewMetadata) MarshalJSON added in v0.171.0

func (s CreateAuthorizedViewMetadata) MarshalJSON() ([]byte, error)

type CreateAuthorizedViewRequest added in v0.171.0

type CreateAuthorizedViewRequest struct {
	// AuthorizedView: Required. The AuthorizedView to create.
	AuthorizedView *AuthorizedView `json:"authorizedView,omitempty"`
	// AuthorizedViewId: 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/{autho
	// rized_view}`.
	AuthorizedViewId string `json:"authorizedViewId,omitempty"`
	// Parent: 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 `json:"parent,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AuthorizedView") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AuthorizedView") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

CreateAuthorizedViewRequest: The request for CreateAuthorizedView

func (CreateAuthorizedViewRequest) MarshalJSON added in v0.171.0

func (s CreateAuthorizedViewRequest) MarshalJSON() ([]byte, error)

type CreateBackupMetadata added in v0.30.0

type CreateBackupMetadata struct {
	// EndTime: If set, the time at which this operation finished or was cancelled.
	EndTime string `json:"endTime,omitempty"`
	// Name: The name of the backup being created.
	Name string `json:"name,omitempty"`
	// SourceTable: The name of the table the backup is created from.
	SourceTable string `json:"sourceTable,omitempty"`
	// StartTime: The time at which this operation started.
	StartTime string `json:"startTime,omitempty"`
	// ForceSendFields is a list of field names (e.g. "EndTime") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "EndTime") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

CreateBackupMetadata: Metadata type for the operation returned by CreateBackup.

func (CreateBackupMetadata) MarshalJSON added in v0.30.0

func (s CreateBackupMetadata) MarshalJSON() ([]byte, error)

type CreateClusterMetadata

type CreateClusterMetadata struct {
	// FinishTime: The time at which the operation failed or was completed
	// successfully.
	FinishTime string `json:"finishTime,omitempty"`
	// OriginalRequest: The request that prompted the initiation of this
	// CreateCluster operation.
	OriginalRequest *CreateClusterRequest `json:"originalRequest,omitempty"`
	// RequestTime: The time at which the original request was received.
	RequestTime string `json:"requestTime,omitempty"`
	// Tables: Keys: the full `name` of each table that existed in the instance
	// when CreateCluster was first called, i.e. `projects//instances//tables/`.
	// 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]TableProgress `json:"tables,omitempty"`
	// ForceSendFields is a list of field names (e.g. "FinishTime") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "FinishTime") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

CreateClusterMetadata: The metadata for the Operation returned by CreateCluster.

func (CreateClusterMetadata) MarshalJSON

func (s CreateClusterMetadata) MarshalJSON() ([]byte, error)

type CreateClusterRequest

type CreateClusterRequest struct {
	// Cluster: Required. The cluster to be created. Fields marked `OutputOnly`
	// must be left blank.
	Cluster *Cluster `json:"cluster,omitempty"`
	// ClusterId: 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 `json:"clusterId,omitempty"`
	// Parent: 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 `json:"parent,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Cluster") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Cluster") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

CreateClusterRequest: Request message for BigtableInstanceAdmin.CreateCluster.

func (CreateClusterRequest) MarshalJSON

func (s CreateClusterRequest) MarshalJSON() ([]byte, error)

type CreateInstanceMetadata

type CreateInstanceMetadata struct {
	// FinishTime: The time at which the operation failed or was completed
	// successfully.
	FinishTime string `json:"finishTime,omitempty"`
	// OriginalRequest: The request that prompted the initiation of this
	// CreateInstance operation.
	OriginalRequest *CreateInstanceRequest `json:"originalRequest,omitempty"`
	// RequestTime: The time at which the original request was received.
	RequestTime string `json:"requestTime,omitempty"`
	// ForceSendFields is a list of field names (e.g. "FinishTime") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "FinishTime") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

CreateInstanceMetadata: The metadata for the Operation returned by CreateInstance.

func (CreateInstanceMetadata) MarshalJSON

func (s CreateInstanceMetadata) MarshalJSON() ([]byte, error)

type CreateInstanceRequest

type CreateInstanceRequest struct {
	// Clusters: 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.
	Clusters map[string]Cluster `json:"clusters,omitempty"`
	// Instance: Required. The instance to create. Fields marked `OutputOnly` must
	// be left blank.
	Instance *Instance `json:"instance,omitempty"`
	// InstanceId: 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 `json:"instanceId,omitempty"`
	// Parent: Required. The unique name of the project in which to create the new
	// instance. Values are of the form `projects/{project}`.
	Parent string `json:"parent,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Clusters") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Clusters") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

CreateInstanceRequest: Request message for BigtableInstanceAdmin.CreateInstance.

func (CreateInstanceRequest) MarshalJSON

func (s CreateInstanceRequest) MarshalJSON() ([]byte, error)

type CreateTableRequest

type CreateTableRequest struct {
	// InitialSplits: 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 []*Split `json:"initialSplits,omitempty"`
	// Table: Required. The Table to create.
	Table *Table `json:"table,omitempty"`
	// TableId: 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 `json:"tableId,omitempty"`
	// ForceSendFields is a list of field names (e.g. "InitialSplits") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "InitialSplits") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

CreateTableRequest: Request message for google.bigtable.admin.v2.BigtableTableAdmin.CreateTable

func (CreateTableRequest) MarshalJSON

func (s CreateTableRequest) MarshalJSON() ([]byte, error)

type DataBoostIsolationReadOnly added in v0.172.0

type DataBoostIsolationReadOnly struct {
	// ComputeBillingOwner: The Compute Billing Owner for this Data Boost App
	// Profile.
	//
	// Possible values:
	//   "COMPUTE_BILLING_OWNER_UNSPECIFIED" - Unspecified value.
	//   "HOST_PAYS" - The host Cloud Project containing the targeted Bigtable
	// Instance / Table pays for compute.
	ComputeBillingOwner string `json:"computeBillingOwner,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ComputeBillingOwner") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ComputeBillingOwner") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

DataBoostIsolationReadOnly: Data Boost is a serverless compute capability that lets you run high-throughput read jobs and queries on your Bigtable data, without impacting the performance of the clusters that handle your application traffic. Data Boost supports read-only use cases with single-cluster routing.

func (DataBoostIsolationReadOnly) MarshalJSON added in v0.172.0

func (s DataBoostIsolationReadOnly) MarshalJSON() ([]byte, error)

type DataBoostReadLocalWrites added in v0.172.0

type DataBoostReadLocalWrites struct {
}

DataBoostReadLocalWrites: Checks that all writes before the consistency token was generated in the same cluster are readable by Databoost.

type DropRowRangeRequest

type DropRowRangeRequest struct {
	// DeleteAllDataFromTable: Delete all rows in the table. Setting this to false
	// is a no-op.
	DeleteAllDataFromTable bool `json:"deleteAllDataFromTable,omitempty"`
	// RowKeyPrefix: Delete all rows that start with this row key prefix. Prefix
	// cannot be zero length.
	RowKeyPrefix string `json:"rowKeyPrefix,omitempty"`
	// ForceSendFields is a list of field names (e.g. "DeleteAllDataFromTable") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "DeleteAllDataFromTable") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

DropRowRangeRequest: Request message for google.bigtable.admin.v2.BigtableTableAdmin.DropRowRange

func (DropRowRangeRequest) MarshalJSON

func (s DropRowRangeRequest) MarshalJSON() ([]byte, error)

type Empty

type Empty struct {
	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
}

Empty: A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

type EncryptionConfig added in v0.44.0

type EncryptionConfig struct {
	// KmsKeyName: 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. Values are of the form
	// `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}`
	KmsKeyName string `json:"kmsKeyName,omitempty"`
	// ForceSendFields is a list of field names (e.g. "KmsKeyName") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "KmsKeyName") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (EncryptionConfig) MarshalJSON added in v0.44.0

func (s EncryptionConfig) MarshalJSON() ([]byte, error)

type EncryptionInfo added in v0.44.0

type EncryptionInfo struct {
	// EncryptionStatus: 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 `json:"encryptionStatus,omitempty"`
	// EncryptionType: Output only. The type of encryption used to protect this
	// resource.
	//
	// Possible values:
	//   "ENCRYPTION_TYPE_UNSPECIFIED" - Encryption type was not specified, though
	// data at rest remains encrypted.
	//   "GOOGLE_DEFAULT_ENCRYPTION" - 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.
	//   "CUSTOMER_MANAGED_ENCRYPTION" - 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`.
	EncryptionType string `json:"encryptionType,omitempty"`
	// KmsKeyVersion: 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 `json:"kmsKeyVersion,omitempty"`
	// ForceSendFields is a list of field names (e.g. "EncryptionStatus") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "EncryptionStatus") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (EncryptionInfo) MarshalJSON added in v0.44.0

func (s EncryptionInfo) MarshalJSON() ([]byte, error)

type Expr

type Expr struct {
	// Description: Optional. Description of the expression. This is a longer text
	// which describes the expression, e.g. when hovered over it in a UI.
	Description string `json:"description,omitempty"`
	// Expression: Textual representation of an expression in Common Expression
	// Language syntax.
	Expression string `json:"expression,omitempty"`
	// Location: Optional. String indicating the location of the expression for
	// error reporting, e.g. a file name and a position in the file.
	Location string `json:"location,omitempty"`
	// Title: Optional. Title for the expression, i.e. a short string describing
	// its purpose. This can be used e.g. in UIs which allow to enter the
	// expression.
	Title string `json:"title,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Description") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Description") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Expr: Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

func (Expr) MarshalJSON

func (s Expr) MarshalJSON() ([]byte, error)

type GcRule

type GcRule struct {
	// Intersection: Delete cells that would be deleted by every nested rule.
	Intersection *Intersection `json:"intersection,omitempty"`
	// MaxAge: 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 string `json:"maxAge,omitempty"`
	// MaxNumVersions: Delete all cells in a column except the most recent N.
	MaxNumVersions int64 `json:"maxNumVersions,omitempty"`
	// Union: Delete cells that would be deleted by any nested rule.
	Union *Union `json:"union,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Intersection") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Intersection") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GcRule: Rule for determining which cells to delete during garbage collection.

func (GcRule) MarshalJSON

func (s GcRule) MarshalJSON() ([]byte, error)

type GenerateConsistencyTokenRequest

type GenerateConsistencyTokenRequest struct {
}

GenerateConsistencyTokenRequest: Request message for google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken

type GenerateConsistencyTokenResponse

type GenerateConsistencyTokenResponse struct {
	// ConsistencyToken: The generated consistency token.
	ConsistencyToken string `json:"consistencyToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "ConsistencyToken") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ConsistencyToken") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GenerateConsistencyTokenResponse: Response message for google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken

func (GenerateConsistencyTokenResponse) MarshalJSON

func (s GenerateConsistencyTokenResponse) MarshalJSON() ([]byte, error)

type GetIamPolicyRequest

type GetIamPolicyRequest struct {
	// Options: OPTIONAL: A `GetPolicyOptions` object for specifying options to
	// `GetIamPolicy`.
	Options *GetPolicyOptions `json:"options,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Options") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Options") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GetIamPolicyRequest: Request message for `GetIamPolicy` method.

func (GetIamPolicyRequest) MarshalJSON added in v0.10.0

func (s GetIamPolicyRequest) MarshalJSON() ([]byte, error)

type GetPolicyOptions added in v0.10.0

type GetPolicyOptions struct {
	// RequestedPolicyVersion: Optional. The maximum policy version that will be
	// used to format the policy. Valid values are 0, 1, and 3. Requests specifying
	// an invalid value will be rejected. Requests for policies with any
	// conditional role bindings must specify version 3. Policies with no
	// conditional role bindings may specify any valid value or leave the field
	// unset. The policy in the response might use the policy version that you
	// specified, or it might use a lower policy version. For example, if you
	// specify version 3, but the policy has no conditional role bindings, the
	// response uses version 1. To learn which resources support conditions in
	// their IAM policies, see the IAM documentation
	// (https://cloud.google.com/iam/help/conditions/resource-policies).
	RequestedPolicyVersion int64 `json:"requestedPolicyVersion,omitempty"`
	// ForceSendFields is a list of field names (e.g. "RequestedPolicyVersion") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "RequestedPolicyVersion") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GetPolicyOptions: Encapsulates settings provided to GetIamPolicy.

func (GetPolicyOptions) MarshalJSON added in v0.10.0

func (s GetPolicyOptions) MarshalJSON() ([]byte, error)

type GoogleBigtableAdminV2AuthorizedViewFamilySubsets added in v0.171.0

type GoogleBigtableAdminV2AuthorizedViewFamilySubsets struct {
	// QualifierPrefixes: 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 []string `json:"qualifierPrefixes,omitempty"`
	// Qualifiers: Individual exact column qualifiers to be included in the
	// AuthorizedView.
	Qualifiers []string `json:"qualifiers,omitempty"`
	// ForceSendFields is a list of field names (e.g. "QualifierPrefixes") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "QualifierPrefixes") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleBigtableAdminV2AuthorizedViewFamilySubsets: Subsets of a column family that are included in this AuthorizedView.

func (GoogleBigtableAdminV2AuthorizedViewFamilySubsets) MarshalJSON added in v0.171.0

type GoogleBigtableAdminV2AuthorizedViewSubsetView added in v0.171.0

type GoogleBigtableAdminV2AuthorizedViewSubsetView struct {
	// FamilySubsets: Map from column family name to the columns in this family to
	// be included in the AuthorizedView.
	FamilySubsets map[string]GoogleBigtableAdminV2AuthorizedViewFamilySubsets `json:"familySubsets,omitempty"`
	// RowPrefixes: Row prefixes to be included in the AuthorizedView. To provide
	// access to all rows, include the empty string as a prefix ("").
	RowPrefixes []string `json:"rowPrefixes,omitempty"`
	// ForceSendFields is a list of field names (e.g. "FamilySubsets") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "FamilySubsets") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleBigtableAdminV2AuthorizedViewSubsetView: Defines a simple AuthorizedView that is a subset of the underlying Table.

func (GoogleBigtableAdminV2AuthorizedViewSubsetView) MarshalJSON added in v0.171.0

type GoogleBigtableAdminV2TypeAggregate added in v0.172.0

type GoogleBigtableAdminV2TypeAggregate struct {
	// HllppUniqueCount: HyperLogLogPlusPlusUniqueCount aggregator.
	HllppUniqueCount *GoogleBigtableAdminV2TypeAggregateHyperLogLogPlusPlusUniqueCount `json:"hllppUniqueCount,omitempty"`
	// InputType: Type of the inputs that are accumulated by this `Aggregate`. Use
	// `AddInput` mutations to accumulate new inputs.
	InputType *Type `json:"inputType,omitempty"`
	// Max: Max aggregator.
	Max *GoogleBigtableAdminV2TypeAggregateMax `json:"max,omitempty"`
	// Min: Min aggregator.
	Min *GoogleBigtableAdminV2TypeAggregateMin `json:"min,omitempty"`
	// StateType: Output only. Type that holds the internal accumulator state for
	// the `Aggregate`. This is a function of the `input_type` and `aggregator`
	// chosen.
	StateType *Type `json:"stateType,omitempty"`
	// Sum: Sum aggregator.
	Sum *GoogleBigtableAdminV2TypeAggregateSum `json:"sum,omitempty"`
	// ForceSendFields is a list of field names (e.g. "HllppUniqueCount") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "HllppUniqueCount") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleBigtableAdminV2TypeAggregate: A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes provide either the `input_type` or `state_type`, and reads always return the `state_type` .

func (GoogleBigtableAdminV2TypeAggregate) MarshalJSON added in v0.172.0

func (s GoogleBigtableAdminV2TypeAggregate) MarshalJSON() ([]byte, error)

type GoogleBigtableAdminV2TypeAggregateHyperLogLogPlusPlusUniqueCount added in v0.189.0

type GoogleBigtableAdminV2TypeAggregateHyperLogLogPlusPlusUniqueCount struct {
}

GoogleBigtableAdminV2TypeAggregateHyperLogLogPlusPlusUniqueCount: Computes an approximate unique count over the input values. When using raw data as input, be careful to use a consistent encoding. Otherwise the same value encoded differently could count more than once, or two distinct values could count as identical. Input: Any, or omit for Raw State: TBD Special state conversions: `Int64` (the unique count estimate)

type GoogleBigtableAdminV2TypeAggregateMax added in v0.189.0

type GoogleBigtableAdminV2TypeAggregateMax struct {
}

GoogleBigtableAdminV2TypeAggregateMax: Computes the max of the input values. Allowed input: `Int64` State: same as input

type GoogleBigtableAdminV2TypeAggregateMin added in v0.189.0

type GoogleBigtableAdminV2TypeAggregateMin struct {
}

GoogleBigtableAdminV2TypeAggregateMin: Computes the min of the input values. Allowed input: `Int64` State: same as input

type GoogleBigtableAdminV2TypeAggregateSum added in v0.172.0

type GoogleBigtableAdminV2TypeAggregateSum struct {
}

GoogleBigtableAdminV2TypeAggregateSum: Computes the sum of the input values. Allowed input: `Int64` State: same as input

type GoogleBigtableAdminV2TypeArray added in v0.189.0

type GoogleBigtableAdminV2TypeArray struct {
	// ElementType: The type of the elements in the array. This must not be
	// `Array`.
	ElementType *Type `json:"elementType,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ElementType") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ElementType") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleBigtableAdminV2TypeArray: An ordered list of elements of a given type. Values of type `Array` are stored in `Value.array_value`.

func (GoogleBigtableAdminV2TypeArray) MarshalJSON added in v0.189.0

func (s GoogleBigtableAdminV2TypeArray) MarshalJSON() ([]byte, error)

type GoogleBigtableAdminV2TypeBool added in v0.189.0

type GoogleBigtableAdminV2TypeBool struct {
}

GoogleBigtableAdminV2TypeBool: bool Values of type `Bool` are stored in `Value.bool_value`.

type GoogleBigtableAdminV2TypeBytes added in v0.172.0

type GoogleBigtableAdminV2TypeBytes struct {
	// Encoding: The encoding to use when converting to or from lower level types.
	Encoding *GoogleBigtableAdminV2TypeBytesEncoding `json:"encoding,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Encoding") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Encoding") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleBigtableAdminV2TypeBytes: Bytes Values of type `Bytes` are stored in `Value.bytes_value`.

func (GoogleBigtableAdminV2TypeBytes) MarshalJSON added in v0.172.0

func (s GoogleBigtableAdminV2TypeBytes) MarshalJSON() ([]byte, error)

type GoogleBigtableAdminV2TypeBytesEncoding added in v0.172.0

type GoogleBigtableAdminV2TypeBytesEncoding struct {
	// Raw: Use `Raw` encoding.
	Raw *GoogleBigtableAdminV2TypeBytesEncodingRaw `json:"raw,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Raw") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Raw") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleBigtableAdminV2TypeBytesEncoding: Rules used to convert to or from lower level types.

func (GoogleBigtableAdminV2TypeBytesEncoding) MarshalJSON added in v0.172.0

func (s GoogleBigtableAdminV2TypeBytesEncoding) MarshalJSON() ([]byte, error)

type GoogleBigtableAdminV2TypeBytesEncodingRaw added in v0.172.0

type GoogleBigtableAdminV2TypeBytesEncodingRaw struct {
}

GoogleBigtableAdminV2TypeBytesEncodingRaw: Leaves the value as-is. Sorted mode: all values are supported. Distinct mode: all values are supported.

type GoogleBigtableAdminV2TypeDate added in v0.189.0

type GoogleBigtableAdminV2TypeDate struct {
}

GoogleBigtableAdminV2TypeDate: Date Values of type `Date` are stored in `Value.date_value`.

type GoogleBigtableAdminV2TypeFloat32 added in v0.189.0

type GoogleBigtableAdminV2TypeFloat32 struct {
}

GoogleBigtableAdminV2TypeFloat32: Float32 Values of type `Float32` are stored in `Value.float_value`.

type GoogleBigtableAdminV2TypeFloat64 added in v0.189.0

type GoogleBigtableAdminV2TypeFloat64 struct {
}

GoogleBigtableAdminV2TypeFloat64: Float64 Values of type `Float64` are stored in `Value.float_value`.

type GoogleBigtableAdminV2TypeInt64 added in v0.172.0

type GoogleBigtableAdminV2TypeInt64 struct {
	// Encoding: The encoding to use when converting to or from lower level types.
	Encoding *GoogleBigtableAdminV2TypeInt64Encoding `json:"encoding,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Encoding") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Encoding") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleBigtableAdminV2TypeInt64: Int64 Values of type `Int64` are stored in `Value.int_value`.

func (GoogleBigtableAdminV2TypeInt64) MarshalJSON added in v0.172.0

func (s GoogleBigtableAdminV2TypeInt64) MarshalJSON() ([]byte, error)

type GoogleBigtableAdminV2TypeInt64Encoding added in v0.172.0

type GoogleBigtableAdminV2TypeInt64Encoding struct {
	// BigEndianBytes: Use `BigEndianBytes` encoding.
	BigEndianBytes *GoogleBigtableAdminV2TypeInt64EncodingBigEndianBytes `json:"bigEndianBytes,omitempty"`
	// ForceSendFields is a list of field names (e.g. "BigEndianBytes") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "BigEndianBytes") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleBigtableAdminV2TypeInt64Encoding: Rules used to convert to or from lower level types.

func (GoogleBigtableAdminV2TypeInt64Encoding) MarshalJSON added in v0.172.0

func (s GoogleBigtableAdminV2TypeInt64Encoding) MarshalJSON() ([]byte, error)

type GoogleBigtableAdminV2TypeInt64EncodingBigEndianBytes added in v0.172.0

type GoogleBigtableAdminV2TypeInt64EncodingBigEndianBytes struct {
	// BytesType: Deprecated: ignored if set.
	BytesType *GoogleBigtableAdminV2TypeBytes `json:"bytesType,omitempty"`
	// ForceSendFields is a list of field names (e.g. "BytesType") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "BytesType") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleBigtableAdminV2TypeInt64EncodingBigEndianBytes: Encodes the value as an 8-byte big-endian two's complement value. Sorted mode: non-negative values are supported. Distinct mode: all values are supported. Compatible with: - BigQuery `BINARY` encoding - HBase `Bytes.toBytes` - Java `ByteBuffer.putLong()` with `ByteOrder.BIG_ENDIAN`

func (GoogleBigtableAdminV2TypeInt64EncodingBigEndianBytes) MarshalJSON added in v0.172.0

type GoogleBigtableAdminV2TypeMap added in v0.189.0

type GoogleBigtableAdminV2TypeMap struct {
	// KeyType: The type of a map key. Only `Bytes`, `String`, and `Int64` are
	// allowed as key types.
	KeyType *Type `json:"keyType,omitempty"`
	// ValueType: The type of the values in a map.
	ValueType *Type `json:"valueType,omitempty"`
	// ForceSendFields is a list of field names (e.g. "KeyType") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "KeyType") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleBigtableAdminV2TypeMap: A mapping of keys to values of a given type. Values of type `Map` are stored in a `Value.array_value` where each entry is another `Value.array_value` with two elements (the key and the value, in that order). Normally encoded Map values won't have repeated keys, however, clients are expected to handle the case in which they do. If the same key appears multiple times, the _last_ value takes precedence.

func (GoogleBigtableAdminV2TypeMap) MarshalJSON added in v0.189.0

func (s GoogleBigtableAdminV2TypeMap) MarshalJSON() ([]byte, error)

type GoogleBigtableAdminV2TypeString added in v0.189.0

type GoogleBigtableAdminV2TypeString struct {
	// Encoding: The encoding to use when converting to or from lower level types.
	Encoding *GoogleBigtableAdminV2TypeStringEncoding `json:"encoding,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Encoding") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Encoding") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleBigtableAdminV2TypeString: String Values of type `String` are stored in `Value.string_value`.

func (GoogleBigtableAdminV2TypeString) MarshalJSON added in v0.189.0

func (s GoogleBigtableAdminV2TypeString) MarshalJSON() ([]byte, error)

type GoogleBigtableAdminV2TypeStringEncoding added in v0.189.0

type GoogleBigtableAdminV2TypeStringEncoding struct {
	// Utf8Bytes: Use `Utf8Bytes` encoding.
	Utf8Bytes *GoogleBigtableAdminV2TypeStringEncodingUtf8Bytes `json:"utf8Bytes,omitempty"`
	// Utf8Raw: Deprecated: if set, converts to an empty `utf8_bytes`.
	Utf8Raw *GoogleBigtableAdminV2TypeStringEncodingUtf8Raw `json:"utf8Raw,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Utf8Bytes") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Utf8Bytes") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleBigtableAdminV2TypeStringEncoding: Rules used to convert to or from lower level types.

func (GoogleBigtableAdminV2TypeStringEncoding) MarshalJSON added in v0.189.0

func (s GoogleBigtableAdminV2TypeStringEncoding) MarshalJSON() ([]byte, error)

type GoogleBigtableAdminV2TypeStringEncodingUtf8Bytes added in v0.189.0

type GoogleBigtableAdminV2TypeStringEncodingUtf8Bytes struct {
}

GoogleBigtableAdminV2TypeStringEncodingUtf8Bytes: UTF-8 encoding. Sorted mode: - All values are supported. - Code point order is preserved. Distinct mode: all values are supported. Compatible with: - BigQuery `TEXT` encoding - HBase `Bytes.toBytes` - Java `String#getBytes(StandardCharsets.UTF_8)`

type GoogleBigtableAdminV2TypeStringEncodingUtf8Raw added in v0.190.0

type GoogleBigtableAdminV2TypeStringEncodingUtf8Raw struct {
}

GoogleBigtableAdminV2TypeStringEncodingUtf8Raw: Deprecated: prefer the equivalent `Utf8Bytes`.

type GoogleBigtableAdminV2TypeStruct added in v0.189.0

type GoogleBigtableAdminV2TypeStruct struct {
	// Fields: The names and types of the fields in this struct.
	Fields []*GoogleBigtableAdminV2TypeStructField `json:"fields,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Fields") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Fields") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleBigtableAdminV2TypeStruct: A structured data value, consisting of fields which map to dynamically typed values. Values of type `Struct` are stored in `Value.array_value` where entries are in the same order and number as `field_types`.

func (GoogleBigtableAdminV2TypeStruct) MarshalJSON added in v0.189.0

func (s GoogleBigtableAdminV2TypeStruct) MarshalJSON() ([]byte, error)

type GoogleBigtableAdminV2TypeStructField added in v0.189.0

type GoogleBigtableAdminV2TypeStructField struct {
	// FieldName: The field name (optional). Fields without a `field_name` are
	// considered anonymous and cannot be referenced by name.
	FieldName string `json:"fieldName,omitempty"`
	// Type: The type of values in this field.
	Type *Type `json:"type,omitempty"`
	// ForceSendFields is a list of field names (e.g. "FieldName") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "FieldName") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

GoogleBigtableAdminV2TypeStructField: A struct field and its type.

func (GoogleBigtableAdminV2TypeStructField) MarshalJSON added in v0.189.0

func (s GoogleBigtableAdminV2TypeStructField) MarshalJSON() ([]byte, error)

type GoogleBigtableAdminV2TypeTimestamp added in v0.189.0

type GoogleBigtableAdminV2TypeTimestamp struct {
}

GoogleBigtableAdminV2TypeTimestamp: Timestamp Values of type `Timestamp` are stored in `Value.timestamp_value`.

type HotTablet added in v0.75.0

type HotTablet struct {
	// EndKey: Tablet End Key (inclusive).
	EndKey string `json:"endKey,omitempty"`
	// EndTime: Output only. The end time of the hot tablet.
	EndTime string `json:"endTime,omitempty"`
	// Name: 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 `json:"name,omitempty"`
	// NodeCpuUsagePercent: 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 float64 `json:"nodeCpuUsagePercent,omitempty"`
	// StartKey: Tablet Start Key (inclusive).
	StartKey string `json:"startKey,omitempty"`
	// StartTime: Output only. The start time of the hot tablet.
	StartTime string `json:"startTime,omitempty"`
	// TableName: Name of the table that contains the tablet. Values are of the
	// form `projects/{project}/instances/{instance}/tables/_a-zA-Z0-9*`.
	TableName string `json:"tableName,omitempty"`
	// ForceSendFields is a list of field names (e.g. "EndKey") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "EndKey") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

HotTablet: 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.

func (HotTablet) MarshalJSON added in v0.75.0

func (s HotTablet) MarshalJSON() ([]byte, error)

func (*HotTablet) UnmarshalJSON added in v0.75.0

func (s *HotTablet) UnmarshalJSON(data []byte) error

type Instance

type Instance struct {
	// CreateTime: Output only. A commit 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 string `json:"createTime,omitempty"`
	// DisplayName: 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 `json:"displayName,omitempty"`
	// Labels: 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}{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 `json:"labels,omitempty"`
	// Name: The unique name of the instance. Values are of the form
	// `projects/{project}/instances/a-z+[a-z0-9]`.
	Name string `json:"name,omitempty"`
	// SatisfiesPzi: Output only. Reserved for future use.
	SatisfiesPzi bool `json:"satisfiesPzi,omitempty"`
	// SatisfiesPzs: Output only. Reserved for future use.
	SatisfiesPzs bool `json:"satisfiesPzs,omitempty"`
	// State: Output only. The current state of the instance.
	//
	// Possible values:
	//   "STATE_NOT_KNOWN" - The state of the instance could not be determined.
	//   "READY" - The instance has been successfully created and can serve
	// requests to its tables.
	//   "CREATING" - The instance is currently being created, and may be destroyed
	// if the creation process encounters an error.
	State string `json:"state,omitempty"`
	// Type: The type of the instance. Defaults to `PRODUCTION`.
	//
	// Possible values:
	//   "TYPE_UNSPECIFIED" - 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.
	//   "PRODUCTION" - An instance meant for production use. `serve_nodes` must be
	// set on the cluster.
	//   "DEVELOPMENT" - DEPRECATED: Prefer PRODUCTION for all use cases, as it no
	// longer enforces a higher minimum node count than DEVELOPMENT.
	Type string `json:"type,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "CreateTime") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "CreateTime") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Instance: A collection of Bigtable Tables and the resources that serve them. All tables in an instance are served from all Clusters in the instance.

func (Instance) MarshalJSON

func (s Instance) MarshalJSON() ([]byte, error)

type Intersection

type Intersection struct {
	// Rules: Only delete cells which would be deleted by every element of `rules`.
	Rules []*GcRule `json:"rules,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Rules") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Rules") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (Intersection) MarshalJSON

func (s Intersection) MarshalJSON() ([]byte, error)

type ListAppProfilesResponse

type ListAppProfilesResponse struct {
	// AppProfiles: The list of requested app profiles.
	AppProfiles []*AppProfile `json:"appProfiles,omitempty"`
	// FailedLocations: 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//locations/`
	FailedLocations []string `json:"failedLocations,omitempty"`
	// NextPageToken: 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 `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "AppProfiles") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AppProfiles") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListAppProfilesResponse: Response message for BigtableInstanceAdmin.ListAppProfiles.

func (ListAppProfilesResponse) MarshalJSON

func (s ListAppProfilesResponse) MarshalJSON() ([]byte, error)

type ListAuthorizedViewsResponse added in v0.171.0

type ListAuthorizedViewsResponse struct {
	// AuthorizedViews: The AuthorizedViews present in the requested table.
	AuthorizedViews []*AuthorizedView `json:"authorizedViews,omitempty"`
	// NextPageToken: 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 `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "AuthorizedViews") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AuthorizedViews") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListAuthorizedViewsResponse: Response message for google.bigtable.admin.v2.BigtableTableAdmin.ListAuthorizedViews

func (ListAuthorizedViewsResponse) MarshalJSON added in v0.171.0

func (s ListAuthorizedViewsResponse) MarshalJSON() ([]byte, error)

type ListBackupsResponse added in v0.30.0

type ListBackupsResponse struct {
	// Backups: The list of matching backups.
	Backups []*Backup `json:"backups,omitempty"`
	// NextPageToken: `next_page_token` can be sent in a subsequent ListBackups
	// call to fetch more of the matching backups.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Backups") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Backups") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListBackupsResponse: The response for ListBackups.

func (ListBackupsResponse) MarshalJSON added in v0.30.0

func (s ListBackupsResponse) MarshalJSON() ([]byte, error)

type ListClustersResponse

type ListClustersResponse struct {
	// Clusters: The list of requested clusters.
	Clusters []*Cluster `json:"clusters,omitempty"`
	// FailedLocations: 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//locations/`
	FailedLocations []string `json:"failedLocations,omitempty"`
	// NextPageToken: DEPRECATED: This field is unused and ignored.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Clusters") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Clusters") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListClustersResponse: Response message for BigtableInstanceAdmin.ListClusters.

func (ListClustersResponse) MarshalJSON

func (s ListClustersResponse) MarshalJSON() ([]byte, error)

type ListHotTabletsResponse added in v0.75.0

type ListHotTabletsResponse struct {
	// HotTablets: 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 `json:"hotTablets,omitempty"`
	// NextPageToken: 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 `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "HotTablets") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "HotTablets") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListHotTabletsResponse: Response message for BigtableInstanceAdmin.ListHotTablets.

func (ListHotTabletsResponse) MarshalJSON added in v0.75.0

func (s ListHotTabletsResponse) MarshalJSON() ([]byte, error)

type ListInstancesResponse

type ListInstancesResponse struct {
	// FailedLocations: 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//locations/`
	FailedLocations []string `json:"failedLocations,omitempty"`
	// Instances: The list of requested instances.
	Instances []*Instance `json:"instances,omitempty"`
	// NextPageToken: DEPRECATED: This field is unused and ignored.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "FailedLocations") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "FailedLocations") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListInstancesResponse: Response message for BigtableInstanceAdmin.ListInstances.

func (ListInstancesResponse) MarshalJSON

func (s ListInstancesResponse) MarshalJSON() ([]byte, error)

type ListLocationsResponse added in v0.7.0

type ListLocationsResponse struct {
	// Locations: A list of locations that matches the specified filter in the
	// request.
	Locations []*Location `json:"locations,omitempty"`
	// NextPageToken: The standard List next-page token.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Locations") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Locations") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListLocationsResponse: The response message for Locations.ListLocations.

func (ListLocationsResponse) MarshalJSON added in v0.7.0

func (s ListLocationsResponse) MarshalJSON() ([]byte, error)

type ListOperationsResponse

type ListOperationsResponse struct {
	// NextPageToken: The standard List next-page token.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// Operations: A list of operations that matches the specified filter in the
	// request.
	Operations []*Operation `json:"operations,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "NextPageToken") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "NextPageToken") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListOperationsResponse: The response message for Operations.ListOperations.

func (ListOperationsResponse) MarshalJSON

func (s ListOperationsResponse) MarshalJSON() ([]byte, error)

type ListTablesResponse

type ListTablesResponse struct {
	// NextPageToken: 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 `json:"nextPageToken,omitempty"`
	// Tables: The tables present in the requested instance.
	Tables []*Table `json:"tables,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "NextPageToken") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "NextPageToken") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListTablesResponse: Response message for google.bigtable.admin.v2.BigtableTableAdmin.ListTables

func (ListTablesResponse) MarshalJSON

func (s ListTablesResponse) MarshalJSON() ([]byte, error)

type Location added in v0.7.0

type Location struct {
	// DisplayName: The friendly name for this location, typically a nearby city
	// name. For example, "Tokyo".
	DisplayName string `json:"displayName,omitempty"`
	// Labels: Cross-service attributes for the location. For example
	// {"cloud.googleapis.com/region": "us-east1"}
	Labels map[string]string `json:"labels,omitempty"`
	// LocationId: The canonical id for this location. For example: "us-east1".
	LocationId string `json:"locationId,omitempty"`
	// Metadata: Service-specific metadata. For example the available capacity at
	// the given location.
	Metadata googleapi.RawMessage `json:"metadata,omitempty"`
	// Name: Resource name for the location, which may vary between
	// implementations. For example:
	// "projects/example-project/locations/us-east1"
	Name string `json:"name,omitempty"`
	// ForceSendFields is a list of field names (e.g. "DisplayName") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "DisplayName") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Location: A resource that represents a Google Cloud location.

func (Location) MarshalJSON added in v0.7.0

func (s Location) MarshalJSON() ([]byte, error)

type Modification

type Modification struct {
	// Create: Create a new column family with the specified schema, or fail if one
	// already exists with the given ID.
	Create *ColumnFamily `json:"create,omitempty"`
	// Drop: Drop (delete) the column family with the given ID, or fail if no such
	// family exists.
	Drop bool `json:"drop,omitempty"`
	// Id: The ID of the column family to be modified.
	Id string `json:"id,omitempty"`
	// Update: Update an existing column family to the specified schema, or fail if
	// no column family exists with the given ID.
	Update *ColumnFamily `json:"update,omitempty"`
	// UpdateMask: 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 string `json:"updateMask,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Create") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Create") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (Modification) MarshalJSON

func (s Modification) MarshalJSON() ([]byte, error)

type ModifyColumnFamiliesRequest

type ModifyColumnFamiliesRequest struct {
	// IgnoreWarnings: Optional. If true, ignore safety checks when modifying the
	// column families.
	IgnoreWarnings bool `json:"ignoreWarnings,omitempty"`
	// Modifications: 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 []*Modification `json:"modifications,omitempty"`
	// ForceSendFields is a list of field names (e.g. "IgnoreWarnings") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "IgnoreWarnings") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ModifyColumnFamiliesRequest: Request message for google.bigtable.admin.v2.BigtableTableAdmin.ModifyColumnFamilies

func (ModifyColumnFamiliesRequest) MarshalJSON

func (s ModifyColumnFamiliesRequest) MarshalJSON() ([]byte, error)

type MultiClusterRoutingUseAny

type MultiClusterRoutingUseAny struct {
	// ClusterIds: 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 `json:"clusterIds,omitempty"`
	// RowAffinity: Row affinity sticky routing based on the row key of the
	// request. Requests that span multiple rows are routed non-deterministically.
	RowAffinity *RowAffinity `json:"rowAffinity,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ClusterIds") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ClusterIds") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (MultiClusterRoutingUseAny) MarshalJSON added in v0.59.0

func (s MultiClusterRoutingUseAny) MarshalJSON() ([]byte, error)

type Operation

type Operation struct {
	// Done: If the value is `false`, it means the operation is still in progress.
	// If `true`, the operation is completed, and either `error` or `response` is
	// available.
	Done bool `json:"done,omitempty"`
	// Error: The error result of the operation in case of failure or cancellation.
	Error *Status `json:"error,omitempty"`
	// Metadata: Service-specific metadata associated with the operation. It
	// typically contains progress information and common metadata such as create
	// time. Some services might not provide such metadata. Any method that returns
	// a long-running operation should document the metadata type, if any.
	Metadata googleapi.RawMessage `json:"metadata,omitempty"`
	// Name: The server-assigned name, which is only unique within the same service
	// that originally returns it. If you use the default HTTP mapping, the `name`
	// should be a resource name ending with `operations/{unique_id}`.
	Name string `json:"name,omitempty"`
	// Response: The normal, successful response of the operation. If the original
	// method returns no data on success, such as `Delete`, the response is
	// `google.protobuf.Empty`. If the original method is standard
	// `Get`/`Create`/`Update`, the response should be the resource. For other
	// methods, the response should have the type `XxxResponse`, where `Xxx` is the
	// original method name. For example, if the original method name is
	// `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
	Response googleapi.RawMessage `json:"response,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Done") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Done") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Operation: This resource represents a long-running operation that is the result of a network API call.

func (Operation) MarshalJSON

func (s Operation) MarshalJSON() ([]byte, error)

type OperationProgress added in v0.30.0

type OperationProgress struct {
	// EndTime: If set, the time at which this operation failed or was completed
	// successfully.
	EndTime string `json:"endTime,omitempty"`
	// ProgressPercent: Percent completion of the operation. Values are between 0
	// and 100 inclusive.
	ProgressPercent int64 `json:"progressPercent,omitempty"`
	// StartTime: Time the request was received.
	StartTime string `json:"startTime,omitempty"`
	// ForceSendFields is a list of field names (e.g. "EndTime") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "EndTime") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (OperationProgress) MarshalJSON added in v0.30.0

func (s OperationProgress) MarshalJSON() ([]byte, error)

type OperationsGetCall

type OperationsGetCall struct {
	// contains filtered or unexported fields
}

func (*OperationsGetCall) Context

Context sets the context to be used in this call's Do method.

func (*OperationsGetCall) Do

Do executes the "bigtableadmin.operations.get" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*OperationsGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*OperationsGetCall) Header

func (c *OperationsGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*OperationsGetCall) IfNoneMatch

func (c *OperationsGetCall) IfNoneMatch(entityTag string) *OperationsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type OperationsProjectsOperationsListCall

type OperationsProjectsOperationsListCall struct {
	// contains filtered or unexported fields
}

func (*OperationsProjectsOperationsListCall) Context

Context sets the context to be used in this call's Do method.

func (*OperationsProjectsOperationsListCall) Do

Do executes the "bigtableadmin.operations.projects.operations.list" call. Any non-2xx status code is an error. Response headers are in either *ListOperationsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*OperationsProjectsOperationsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*OperationsProjectsOperationsListCall) Filter

Filter sets the optional parameter "filter": The standard list filter.

func (*OperationsProjectsOperationsListCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*OperationsProjectsOperationsListCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*OperationsProjectsOperationsListCall) PageSize

PageSize sets the optional parameter "pageSize": The standard list page size.

func (*OperationsProjectsOperationsListCall) PageToken

PageToken sets the optional parameter "pageToken": The standard list page token.

func (*OperationsProjectsOperationsListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type OperationsProjectsOperationsService

type OperationsProjectsOperationsService struct {
	// contains filtered or unexported fields
}

func NewOperationsProjectsOperationsService

func NewOperationsProjectsOperationsService(s *Service) *OperationsProjectsOperationsService

func (*OperationsProjectsOperationsService) List

List: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

- name: The name of the operation's parent resource.

type OperationsProjectsService

type OperationsProjectsService struct {
	Operations *OperationsProjectsOperationsService
	// contains filtered or unexported fields
}

func NewOperationsProjectsService

func NewOperationsProjectsService(s *Service) *OperationsProjectsService

type OperationsService

type OperationsService struct {
	Projects *OperationsProjectsService
	// contains filtered or unexported fields
}

func NewOperationsService

func NewOperationsService(s *Service) *OperationsService

func (*OperationsService) Get

Get: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- name: The name of the operation resource.

type OptimizeRestoredTableMetadata added in v0.30.0

type OptimizeRestoredTableMetadata struct {
	// Name: Name of the restored table being optimized.
	Name string `json:"name,omitempty"`
	// Progress: The progress of the post-restore optimizations.
	Progress *OperationProgress `json:"progress,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Name") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Name") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (OptimizeRestoredTableMetadata) MarshalJSON added in v0.30.0

func (s OptimizeRestoredTableMetadata) MarshalJSON() ([]byte, error)

type PartialUpdateClusterMetadata added in v0.61.0

type PartialUpdateClusterMetadata struct {
	// FinishTime: The time at which the operation failed or was completed
	// successfully.
	FinishTime string `json:"finishTime,omitempty"`
	// OriginalRequest: The original request for PartialUpdateCluster.
	OriginalRequest *PartialUpdateClusterRequest `json:"originalRequest,omitempty"`
	// RequestTime: The time at which the original request was received.
	RequestTime string `json:"requestTime,omitempty"`
	// ForceSendFields is a list of field names (e.g. "FinishTime") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "FinishTime") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

PartialUpdateClusterMetadata: The metadata for the Operation returned by PartialUpdateCluster.

func (PartialUpdateClusterMetadata) MarshalJSON added in v0.61.0

func (s PartialUpdateClusterMetadata) MarshalJSON() ([]byte, error)

type PartialUpdateClusterRequest added in v0.61.0

type PartialUpdateClusterRequest struct {
	// Cluster: Required. The Cluster which contains the partial updates to be
	// applied, subject to the update_mask.
	Cluster *Cluster `json:"cluster,omitempty"`
	// UpdateMask: Required. The subset of Cluster fields which should be replaced.
	UpdateMask string `json:"updateMask,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Cluster") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Cluster") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

PartialUpdateClusterRequest: Request message for BigtableInstanceAdmin.PartialUpdateCluster.

func (PartialUpdateClusterRequest) MarshalJSON added in v0.61.0

func (s PartialUpdateClusterRequest) MarshalJSON() ([]byte, error)

type PartialUpdateInstanceRequest

type PartialUpdateInstanceRequest struct {
	// Instance: Required. The Instance which will (partially) replace the current
	// value.
	Instance *Instance `json:"instance,omitempty"`
	// UpdateMask: Required. The subset of Instance fields which should be
	// replaced. Must be explicitly set.
	UpdateMask string `json:"updateMask,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Instance") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Instance") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

PartialUpdateInstanceRequest: Request message for BigtableInstanceAdmin.PartialUpdateInstance.

func (PartialUpdateInstanceRequest) MarshalJSON

func (s PartialUpdateInstanceRequest) MarshalJSON() ([]byte, error)

type Policy

type Policy struct {
	// AuditConfigs: Specifies cloud audit logging configuration for this policy.
	AuditConfigs []*AuditConfig `json:"auditConfigs,omitempty"`
	// Bindings: Associates a list of `members`, or principals, with a `role`.
	// Optionally, may specify a `condition` that determines how and when the
	// `bindings` are applied. Each of the `bindings` must contain at least one
	// principal. The `bindings` in a `Policy` can refer to up to 1,500 principals;
	// up to 250 of these principals can be Google groups. Each occurrence of a
	// principal counts towards these limits. For example, if the `bindings` grant
	// 50 different roles to `user:alice@example.com`, and not to any other
	// principal, then you can add another 1,450 principals to the `bindings` in
	// the `Policy`.
	Bindings []*Binding `json:"bindings,omitempty"`
	// Etag: `etag` is used for optimistic concurrency control as a way to help
	// prevent simultaneous updates of a policy from overwriting each other. It is
	// strongly suggested that systems make use of the `etag` in the
	// read-modify-write cycle to perform policy updates in order to avoid race
	// conditions: An `etag` is returned in the response to `getIamPolicy`, and
	// systems are expected to put that etag in the request to `setIamPolicy` to
	// ensure that their change will be applied to the same version of the policy.
	// **Important:** If you use IAM Conditions, you must include the `etag` field
	// whenever you call `setIamPolicy`. If you omit this field, then IAM allows
	// you to overwrite a version `3` policy with a version `1` policy, and all of
	// the conditions in the version `3` policy are lost.
	Etag string `json:"etag,omitempty"`
	// Version: Specifies the format of the policy. Valid values are `0`, `1`, and
	// `3`. Requests that specify an invalid value are rejected. Any operation that
	// affects conditional role bindings must specify version `3`. This requirement
	// applies to the following operations: * Getting a policy that includes a
	// conditional role binding * Adding a conditional role binding to a policy *
	// Changing a conditional role binding in a policy * Removing any role binding,
	// with or without a condition, from a policy that includes conditions
	// **Important:** If you use IAM Conditions, you must include the `etag` field
	// whenever you call `setIamPolicy`. If you omit this field, then IAM allows
	// you to overwrite a version `3` policy with a version `1` policy, and all of
	// the conditions in the version `3` policy are lost. If a policy does not
	// include any conditions, operations on that policy may specify any valid
	// version or leave the field unset. To learn which resources support
	// conditions in their IAM policies, see the IAM documentation
	// (https://cloud.google.com/iam/help/conditions/resource-policies).
	Version int64 `json:"version,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "AuditConfigs") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AuditConfigs") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Policy: An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).

func (Policy) MarshalJSON

func (s Policy) MarshalJSON() ([]byte, error)

type ProjectsInstancesAppProfilesCreateCall

type ProjectsInstancesAppProfilesCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsInstancesAppProfilesCreateCall) AppProfileId

AppProfileId sets the optional parameter "appProfileId": 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`.

func (*ProjectsInstancesAppProfilesCreateCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsInstancesAppProfilesCreateCall) Do

Do executes the "bigtableadmin.projects.instances.appProfiles.create" call. Any non-2xx status code is an error. Response headers are in either *AppProfile.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesAppProfilesCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsInstancesAppProfilesCreateCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsInstancesAppProfilesCreateCall) IgnoreWarnings

IgnoreWarnings sets the optional parameter "ignoreWarnings": If true, ignore safety checks when creating the app profile.

type ProjectsInstancesAppProfilesDeleteCall

type ProjectsInstancesAppProfilesDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsInstancesAppProfilesDeleteCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsInstancesAppProfilesDeleteCall) Do

Do executes the "bigtableadmin.projects.instances.appProfiles.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesAppProfilesDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsInstancesAppProfilesDeleteCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsInstancesAppProfilesDeleteCall) IgnoreWarnings

IgnoreWarnings sets the optional parameter "ignoreWarnings": Required. If true, ignore safety checks when deleting the app profile.

type ProjectsInstancesAppProfilesGetCall

type ProjectsInstancesAppProfilesGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsInstancesAppProfilesGetCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsInstancesAppProfilesGetCall) Do

Do executes the "bigtableadmin.projects.instances.appProfiles.get" call. Any non-2xx status code is an error. Response headers are in either *AppProfile.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesAppProfilesGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsInstancesAppProfilesGetCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsInstancesAppProfilesGetCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsInstancesAppProfilesListCall

type ProjectsInstancesAppProfilesListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsInstancesAppProfilesListCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsInstancesAppProfilesListCall) Do

Do executes the "bigtableadmin.projects.instances.appProfiles.list" call. Any non-2xx status code is an error. Response headers are in either *ListAppProfilesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesAppProfilesListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsInstancesAppProfilesListCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsInstancesAppProfilesListCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsInstancesAppProfilesListCall) PageSize

PageSize sets the optional parameter "pageSize": 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.

func (*ProjectsInstancesAppProfilesListCall) PageToken

PageToken sets the optional parameter "pageToken": The value of `next_page_token` returned by a previous call.

func (*ProjectsInstancesAppProfilesListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsInstancesAppProfilesPatchCall

type ProjectsInstancesAppProfilesPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsInstancesAppProfilesPatchCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsInstancesAppProfilesPatchCall) Do

Do executes the "bigtableadmin.projects.instances.appProfiles.patch" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesAppProfilesPatchCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsInstancesAppProfilesPatchCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsInstancesAppProfilesPatchCall) IgnoreWarnings

IgnoreWarnings sets the optional parameter "ignoreWarnings": If true, ignore safety checks when updating the app profile.

func (*ProjectsInstancesAppProfilesPatchCall) UpdateMask

UpdateMask sets the optional parameter "updateMask": Required. The subset of app profile fields which should be replaced. If unset, all fields will be replaced.

type ProjectsInstancesAppProfilesService

type ProjectsInstancesAppProfilesService struct {
	// contains filtered or unexported fields
}

func NewProjectsInstancesAppProfilesService

func NewProjectsInstancesAppProfilesService(s *Service) *ProjectsInstancesAppProfilesService

func (*ProjectsInstancesAppProfilesService) Create

Create: Creates an app profile within an instance.

  • parent: The unique name of the instance in which to create the new app profile. Values are of the form `projects/{project}/instances/{instance}`.

func (*ProjectsInstancesAppProfilesService) Delete

Delete: Deletes an app profile from an instance.

  • name: The unique name of the app profile to be deleted. Values are of the form `projects/{project}/instances/{instance}/appProfiles/{app_profile}`.

func (*ProjectsInstancesAppProfilesService) Get

Get: Gets information about an app profile.

  • name: The unique name of the requested app profile. Values are of the form `projects/{project}/instances/{instance}/appProfiles/{app_profile}`.

func (*ProjectsInstancesAppProfilesService) List

List: Lists information about app profiles in an instance.

  • parent: 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/-`.

func (*ProjectsInstancesAppProfilesService) Patch

Patch: Updates an app profile within an instance.

  • name: The unique name of the app profile. Values are of the form `projects/{project}/instances/{instance}/appProfiles/_a-zA-Z0-9*`.

type ProjectsInstancesClustersBackupsCopyCall added in v0.101.0

type ProjectsInstancesClustersBackupsCopyCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsInstancesClustersBackupsCopyCall) Context added in v0.101.0

Context sets the context to be used in this call's Do method.

func (*ProjectsInstancesClustersBackupsCopyCall) Do added in v0.101.0

Do executes the "bigtableadmin.projects.instances.clusters.backups.copy" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesClustersBackupsCopyCall) Fields added in v0.101.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsInstancesClustersBackupsCopyCall) Header added in v0.101.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsInstancesClustersBackupsCreateCall added in v0.30.0

type ProjectsInstancesClustersBackupsCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsInstancesClustersBackupsCreateCall) BackupId added in v0.30.0

BackupId sets the optional parameter "backupId": 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_i d}`. This string must be between 1 and 50 characters in length and match the regex _a-zA-Z0-9*.

func (*ProjectsInstancesClustersBackupsCreateCall) Context added in v0.30.0

Context sets the context to be used in this call's Do method.

func (*ProjectsInstancesClustersBackupsCreateCall) Do added in v0.30.0

Do executes the "bigtableadmin.projects.instances.clusters.backups.create" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesClustersBackupsCreateCall) Fields added in v0.30.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsInstancesClustersBackupsCreateCall) Header added in v0.30.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsInstancesClustersBackupsDeleteCall added in v0.30.0

type ProjectsInstancesClustersBackupsDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsInstancesClustersBackupsDeleteCall) Context added in v0.30.0

Context sets the context to be used in this call's Do method.

func (*ProjectsInstancesClustersBackupsDeleteCall) Do added in v0.30.0

Do executes the "bigtableadmin.projects.instances.clusters.backups.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesClustersBackupsDeleteCall) Fields added in v0.30.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsInstancesClustersBackupsDeleteCall) Header added in v0.30.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsInstancesClustersBackupsGetCall added in v0.30.0

type ProjectsInstancesClustersBackupsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsInstancesClustersBackupsGetCall) Context added in v0.30.0

Context sets the context to be used in this call's Do method.

func (*ProjectsInstancesClustersBackupsGetCall) Do added in v0.30.0

Do executes the "bigtableadmin.projects.instances.clusters.backups.get" call. Any non-2xx status code is an error. Response headers are in either *Backup.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesClustersBackupsGetCall) Fields added in v0.30.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsInstancesClustersBackupsGetCall) Header added in v0.30.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsInstancesClustersBackupsGetCall) IfNoneMatch added in v0.30.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsInstancesClustersBackupsGetIamPolicyCall added in v0.18.0

type ProjectsInstancesClustersBackupsGetIamPolicyCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsInstancesClustersBackupsGetIamPolicyCall) Context added in v0.18.0

Context sets the context to be used in this call's Do method.

func (*ProjectsInstancesClustersBackupsGetIamPolicyCall) Do added in v0.18.0

Do executes the "bigtableadmin.projects.instances.clusters.backups.getIamPolicy" call. Any non-2xx status code is an error. Response headers are in either *Policy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesClustersBackupsGetIamPolicyCall) Fields added in v0.18.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsInstancesClustersBackupsGetIamPolicyCall) Header added in v0.18.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsInstancesClustersBackupsListCall added in v0.30.0

type ProjectsInstancesClustersBackupsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsInstancesClustersBackupsListCall) Context added in v0.30.0

Context sets the context to be used in this call's Do method.

func (*ProjectsInstancesClustersBackupsListCall) Do added in v0.30.0

Do executes the "bigtableadmin.projects.instances.clusters.backups.list" call. Any non-2xx status code is an error. Response headers are in either *ListBackupsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesClustersBackupsListCall) Fields added in v0.30.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsInstancesClustersBackupsListCall) Filter added in v0.30.0

Filter sets the optional parameter "filter": 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

func (*ProjectsInstancesClustersBackupsListCall) Header added in v0.30.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsInstancesClustersBackupsListCall) IfNoneMatch added in v0.30.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsInstancesClustersBackupsListCall) OrderBy added in v0.30.0

OrderBy sets the optional parameter "orderBy": An expression for specifying the sort order of the results of the request. The string value should specify one or more fields in 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.

func (*ProjectsInstancesClustersBackupsListCall) PageSize added in v0.30.0

PageSize sets the optional parameter "pageSize": Number of backups to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.

func (*ProjectsInstancesClustersBackupsListCall) PageToken added in v0.30.0

PageToken sets the optional parameter "pageToken": If non-empty, `page_token` should contain a next_page_token from a previous ListBackupsResponse to the same `parent` and with the same `filter`.

func (*ProjectsInstancesClustersBackupsListCall) Pages added in v0.30.0

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsInstancesClustersBackupsPatchCall added in v0.30.0

type ProjectsInstancesClustersBackupsPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsInstancesClustersBackupsPatchCall) Context added in v0.30.0

Context sets the context to be used in this call's Do method.

func (*ProjectsInstancesClustersBackupsPatchCall) Do added in v0.30.0

Do executes the "bigtableadmin.projects.instances.clusters.backups.patch" call. Any non-2xx status code is an error. Response headers are in either *Backup.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesClustersBackupsPatchCall) Fields added in v0.30.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsInstancesClustersBackupsPatchCall) Header added in v0.30.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsInstancesClustersBackupsPatchCall) UpdateMask added in v0.30.0

UpdateMask sets the optional parameter "updateMask": 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.

type ProjectsInstancesClustersBackupsService added in v0.18.0

type ProjectsInstancesClustersBackupsService struct {
	// contains filtered or unexported fields
}

func NewProjectsInstancesClustersBackupsService added in v0.18.0

func NewProjectsInstancesClustersBackupsService(s *Service) *ProjectsInstancesClustersBackupsService

func (*ProjectsInstancesClustersBackupsService) Copy added in v0.101.0

Copy: Copy a Cloud Bigtable backup to a new backup in the destination cluster located in the destination instance and project.

  • parent: The name of the destination cluster that will contain the backup copy. The cluster must already exist. Values are of the form: `projects/{project}/instances/{instance}/clusters/{cluster}`.

func (*ProjectsInstancesClustersBackupsService) Create added in v0.30.0

Create: Starts creating a new Cloud Bigtable Backup. The returned backup long-running operation can be used to track creation of the backup. The metadata field type is CreateBackupMetadata. The response field type is Backup, if successful. Cancelling the returned operation will stop the creation and delete the backup.

  • parent: 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}`.

func (*ProjectsInstancesClustersBackupsService) Delete added in v0.30.0

Delete: Deletes a pending or completed Cloud Bigtable backup.

  • name: Name of the backup to delete. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup }`.

func (*ProjectsInstancesClustersBackupsService) Get added in v0.30.0

Get: Gets metadata on a pending or completed Cloud Bigtable Backup.

  • name: Name of the backup. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup }`.

func (*ProjectsInstancesClustersBackupsService) GetIamPolicy added in v0.18.0

GetIamPolicy: Gets the access control policy for a Bigtable resource. Returns an empty policy if the resource exists but does not have a policy set.

func (*ProjectsInstancesClustersBackupsService) List added in v0.30.0

List: Lists Cloud Bigtable backups. Returns both completed and pending backups.

  • parent: 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/-`.

func (*ProjectsInstancesClustersBackupsService) Patch added in v0.30.0

Patch: Updates a pending or completed Cloud Bigtable Backup.

  • name: 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*` 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}`.

func (*ProjectsInstancesClustersBackupsService) SetIamPolicy added in v0.18.0

SetIamPolicy: Sets the access control policy on a Bigtable resource. Replaces any existing policy.

func (*ProjectsInstancesClustersBackupsService) TestIamPermissions added in v0.21.0

TestIamPermissions: Returns permissions that the caller has on the specified Bigtable resource.

type ProjectsInstancesClustersBackupsSetIamPolicyCall added in v0.18.0

type ProjectsInstancesClustersBackupsSetIamPolicyCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsInstancesClustersBackupsSetIamPolicyCall) Context added in v0.18.0

Context sets the context to be used in this call's Do method.

func (*ProjectsInstancesClustersBackupsSetIamPolicyCall) Do added in v0.18.0

Do executes the "bigtableadmin.projects.instances.clusters.backups.setIamPolicy" call. Any non-2xx status code is an error. Response headers are in either *Policy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesClustersBackupsSetIamPolicyCall) Fields added in v0.18.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsInstancesClustersBackupsSetIamPolicyCall) Header added in v0.18.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsInstancesClustersBackupsTestIamPermissionsCall added in v0.21.0

type ProjectsInstancesClustersBackupsTestIamPermissionsCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsInstancesClustersBackupsTestIamPermissionsCall) Context added in v0.21.0

Context sets the context to be used in this call's Do method.

func (*ProjectsInstancesClustersBackupsTestIamPermissionsCall) Do added in v0.21.0

Do executes the "bigtableadmin.projects.instances.clusters.backups.testIamPermissions" call. Any non-2xx status code is an error. Response headers are in either *TestIamPermissionsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesClustersBackupsTestIamPermissionsCall) Fields added in v0.21.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsInstancesClustersBackupsTestIamPermissionsCall) Header added in v0.21.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsInstancesClustersCreateCall

type ProjectsInstancesClustersCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsInstancesClustersCreateCall) ClusterId

ClusterId sets the optional parameter "clusterId": 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`.

func (*ProjectsInstancesClustersCreateCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsInstancesClustersCreateCall) Do

Do executes the "bigtableadmin.projects.instances.clusters.create" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesClustersCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsInstancesClustersCreateCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsInstancesClustersDeleteCall

type ProjectsInstancesClustersDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsInstancesClustersDeleteCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsInstancesClustersDeleteCall) Do

Do executes the "bigtableadmin.projects.instances.clusters.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesClustersDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsInstancesClustersDeleteCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsInstancesClustersGetCall

type ProjectsInstancesClustersGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsInstancesClustersGetCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsInstancesClustersGetCall) Do

Do executes the "bigtableadmin.projects.instances.clusters.get" call. Any non-2xx status code is an error. Response headers are in either *Cluster.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesClustersGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsInstancesClustersGetCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsInstancesClustersGetCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsInstancesClustersHotTabletsListCall added in v0.75.0

type ProjectsInstancesClustersHotTabletsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsInstancesClustersHotTabletsListCall) Context added in v0.75.0

Context sets the context to be used in this call's Do method.

func (*ProjectsInstancesClustersHotTabletsListCall) Do added in v0.75.0

Do executes the "bigtableadmin.projects.instances.clusters.hotTablets.list" call. Any non-2xx status code is an error. Response headers are in either *ListHotTabletsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesClustersHotTabletsListCall) EndTime added in v0.75.0

EndTime sets the optional parameter "endTime": The end time to list hot tablets.

func (*ProjectsInstancesClustersHotTabletsListCall) Fields added in v0.75.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsInstancesClustersHotTabletsListCall) Header added in v0.75.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsInstancesClustersHotTabletsListCall) IfNoneMatch added in v0.75.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsInstancesClustersHotTabletsListCall) PageSize added in v0.75.0

PageSize sets the optional parameter "pageSize": 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.

func (*ProjectsInstancesClustersHotTabletsListCall) PageToken added in v0.75.0

PageToken sets the optional parameter "pageToken": The value of `next_page_token` returned by a previous call.

func (*ProjectsInstancesClustersHotTabletsListCall) Pages added in v0.75.0

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

func (*ProjectsInstancesClustersHotTabletsListCall) StartTime added in v0.75.0

StartTime sets the optional parameter "startTime": 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.

type ProjectsInstancesClustersHotTabletsService added in v0.75.0

type ProjectsInstancesClustersHotTabletsService struct {
	// contains filtered or unexported fields
}

func NewProjectsInstancesClustersHotTabletsService added in v0.75.0

func NewProjectsInstancesClustersHotTabletsService(s *Service) *ProjectsInstancesClustersHotTabletsService

func (*ProjectsInstancesClustersHotTabletsService) List added in v0.75.0

List: Lists hot tablets in a cluster, within the time range provided. Hot tablets are ordered based on CPU usage.

  • parent: The cluster name to list hot tablets. Value is in the following form: `projects/{project}/instances/{instance}/clusters/{cluster}`.

type ProjectsInstancesClustersListCall

type ProjectsInstancesClustersListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsInstancesClustersListCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsInstancesClustersListCall) Do

Do executes the "bigtableadmin.projects.instances.clusters.list" call. Any non-2xx status code is an error. Response headers are in either *ListClustersResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesClustersListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsInstancesClustersListCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsInstancesClustersListCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsInstancesClustersListCall) PageToken

PageToken sets the optional parameter "pageToken": DEPRECATED: This field is unused and ignored.

func (*ProjectsInstancesClustersListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsInstancesClustersPartialUpdateClusterCall added in v0.46.0

type ProjectsInstancesClustersPartialUpdateClusterCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsInstancesClustersPartialUpdateClusterCall) Context added in v0.46.0

Context sets the context to be used in this call's Do method.

func (*ProjectsInstancesClustersPartialUpdateClusterCall) Do added in v0.46.0

Do executes the "bigtableadmin.projects.instances.clusters.partialUpdateCluster" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesClustersPartialUpdateClusterCall) Fields added in v0.46.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsInstancesClustersPartialUpdateClusterCall) Header added in v0.46.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsInstancesClustersPartialUpdateClusterCall) UpdateMask added in v0.46.0

UpdateMask sets the optional parameter "updateMask": Required. The subset of Cluster fields which should be replaced.

type ProjectsInstancesClustersService

type ProjectsInstancesClustersService struct {
	Backups *ProjectsInstancesClustersBackupsService

	HotTablets *ProjectsInstancesClustersHotTabletsService
	// contains filtered or unexported fields
}

func NewProjectsInstancesClustersService

func NewProjectsInstancesClustersService(s *Service) *ProjectsInstancesClustersService

func (*ProjectsInstancesClustersService) Create

Create: 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.

  • parent: The unique name of the instance in which to create the new cluster. Values are of the form `projects/{project}/instances/{instance}`.

func (*ProjectsInstancesClustersService) Delete

Delete: Deletes a cluster from an instance.

  • name: The unique name of the cluster to be deleted. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}`.

func (*ProjectsInstancesClustersService) Get

Get: Gets information about a cluster.

  • name: The unique name of the requested cluster. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}`.

func (*ProjectsInstancesClustersService) List

List: Lists information about clusters in an instance.

  • parent: 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/-`.

func (*ProjectsInstancesClustersService) PartialUpdateCluster added in v0.46.0

PartialUpdateCluster: 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.

  • name: The unique name of the cluster. Values are of the form `projects/{project}/instances/{instance}/clusters/a-z*`.

func (*ProjectsInstancesClustersService) Update

Update: 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.

  • name: The unique name of the cluster. Values are of the form `projects/{project}/instances/{instance}/clusters/a-z*`.

type ProjectsInstancesClustersUpdateCall

type ProjectsInstancesClustersUpdateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsInstancesClustersUpdateCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsInstancesClustersUpdateCall) Do

Do executes the "bigtableadmin.projects.instances.clusters.update" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesClustersUpdateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsInstancesClustersUpdateCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsInstancesCreateCall

type ProjectsInstancesCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsInstancesCreateCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsInstancesCreateCall) Do

Do executes the "bigtableadmin.projects.instances.create" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsInstancesCreateCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsInstancesDeleteCall

type ProjectsInstancesDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsInstancesDeleteCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsInstancesDeleteCall) Do

Do executes the "bigtableadmin.projects.instances.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsInstancesDeleteCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsInstancesGetCall

type ProjectsInstancesGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsInstancesGetCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsInstancesGetCall) Do

Do executes the "bigtableadmin.projects.instances.get" call. Any non-2xx status code is an error. Response headers are in either *Instance.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsInstancesGetCall) Header

func (c *ProjectsInstancesGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsInstancesGetCall) IfNoneMatch

func (c *ProjectsInstancesGetCall) IfNoneMatch(entityTag string) *ProjectsInstancesGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsInstancesGetIamPolicyCall

type ProjectsInstancesGetIamPolicyCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsInstancesGetIamPolicyCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsInstancesGetIamPolicyCall) Do

Do executes the "bigtableadmin.projects.instances.getIamPolicy" call. Any non-2xx status code is an error. Response headers are in either *Policy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesGetIamPolicyCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsInstancesGetIamPolicyCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsInstancesListCall

type ProjectsInstancesListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsInstancesListCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsInstancesListCall) Do

Do executes the "bigtableadmin.projects.instances.list" call. Any non-2xx status code is an error. Response headers are in either *ListInstancesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsInstancesListCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsInstancesListCall) IfNoneMatch

func (c *ProjectsInstancesListCall) IfNoneMatch(entityTag string) *ProjectsInstancesListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsInstancesListCall) PageToken

PageToken sets the optional parameter "pageToken": DEPRECATED: This field is unused and ignored.

func (*ProjectsInstancesListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsInstancesPartialUpdateInstanceCall

type ProjectsInstancesPartialUpdateInstanceCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsInstancesPartialUpdateInstanceCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsInstancesPartialUpdateInstanceCall) Do

Do executes the "bigtableadmin.projects.instances.partialUpdateInstance" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesPartialUpdateInstanceCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsInstancesPartialUpdateInstanceCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsInstancesPartialUpdateInstanceCall) UpdateMask

UpdateMask sets the optional parameter "updateMask": Required. The subset of Instance fields which should be replaced. Must be explicitly set.

type ProjectsInstancesService

type ProjectsInstancesService struct {
	AppProfiles *ProjectsInstancesAppProfilesService

	Clusters *ProjectsInstancesClustersService

	Tables *ProjectsInstancesTablesService
	// contains filtered or unexported fields
}

func NewProjectsInstancesService

func NewProjectsInstancesService(s *Service) *ProjectsInstancesService

func (*ProjectsInstancesService) Create

func (r *ProjectsInstancesService) Create(parent string, createinstancerequest *CreateInstanceRequest) *ProjectsInstancesCreateCall

Create: 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.

  • parent: The unique name of the project in which to create the new instance. Values are of the form `projects/{project}`.

func (*ProjectsInstancesService) Delete

Delete: Delete an instance from a project.

  • name: The unique name of the instance to be deleted. Values are of the form `projects/{project}/instances/{instance}`.

func (*ProjectsInstancesService) Get

Get: Gets information about an instance.

  • name: The unique name of the requested instance. Values are of the form `projects/{project}/instances/{instance}`.

func (*ProjectsInstancesService) GetIamPolicy

func (r *ProjectsInstancesService) GetIamPolicy(resource string, getiampolicyrequest *GetIamPolicyRequest) *ProjectsInstancesGetIamPolicyCall

GetIamPolicy: Gets the access control policy for an instance resource. Returns an empty policy if an instance exists but does not have a policy set.

func (*ProjectsInstancesService) List

List: Lists information about instances in a project.

  • parent: The unique name of the project for which a list of instances is requested. Values are of the form `projects/{project}`.

func (*ProjectsInstancesService) PartialUpdateInstance

func (r *ProjectsInstancesService) PartialUpdateInstance(name string, instance *Instance) *ProjectsInstancesPartialUpdateInstanceCall

PartialUpdateInstance: 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.

  • name: The unique name of the instance. Values are of the form `projects/{project}/instances/a-z+[a-z0-9]`.

func (*ProjectsInstancesService) SetIamPolicy

func (r *ProjectsInstancesService) SetIamPolicy(resource string, setiampolicyrequest *SetIamPolicyRequest) *ProjectsInstancesSetIamPolicyCall

SetIamPolicy: Sets the access control policy on an instance resource. Replaces any existing policy.

func (*ProjectsInstancesService) TestIamPermissions

func (r *ProjectsInstancesService) TestIamPermissions(resource string, testiampermissionsrequest *TestIamPermissionsRequest) *ProjectsInstancesTestIamPermissionsCall

TestIamPermissions: Returns permissions that the caller has on the specified instance resource.

func (*ProjectsInstancesService) Update

Update: 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.

  • name: The unique name of the instance. Values are of the form `projects/{project}/instances/a-z+[a-z0-9]`.

type ProjectsInstancesSetIamPolicyCall

type ProjectsInstancesSetIamPolicyCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsInstancesSetIamPolicyCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsInstancesSetIamPolicyCall) Do

Do executes the "bigtableadmin.projects.instances.setIamPolicy" call. Any non-2xx status code is an error. Response headers are in either *Policy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesSetIamPolicyCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsInstancesSetIamPolicyCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsInstancesTablesAuthorizedViewsCreateCall added in v0.171.0

type ProjectsInstancesTablesAuthorizedViewsCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsInstancesTablesAuthorizedViewsCreateCall) AuthorizedViewId added in v0.171.0

AuthorizedViewId sets the optional parameter "authorizedViewId": 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/{autho rized_view}`.

func (*ProjectsInstancesTablesAuthorizedViewsCreateCall) Context added in v0.171.0

Context sets the context to be used in this call's Do method.

func (*ProjectsInstancesTablesAuthorizedViewsCreateCall) Do added in v0.171.0

Do executes the "bigtableadmin.projects.instances.tables.authorizedViews.create" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesTablesAuthorizedViewsCreateCall) Fields added in v0.171.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsInstancesTablesAuthorizedViewsCreateCall) Header added in v0.171.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsInstancesTablesAuthorizedViewsDeleteCall added in v0.171.0

type ProjectsInstancesTablesAuthorizedViewsDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsInstancesTablesAuthorizedViewsDeleteCall) Context added in v0.171.0

Context sets the context to be used in this call's Do method.

func (*ProjectsInstancesTablesAuthorizedViewsDeleteCall) Do added in v0.171.0

Do executes the "bigtableadmin.projects.instances.tables.authorizedViews.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesTablesAuthorizedViewsDeleteCall) Etag added in v0.171.0

Etag sets the optional parameter "etag": 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.

func (*ProjectsInstancesTablesAuthorizedViewsDeleteCall) Fields added in v0.171.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsInstancesTablesAuthorizedViewsDeleteCall) Header added in v0.171.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsInstancesTablesAuthorizedViewsGetCall added in v0.171.0

type ProjectsInstancesTablesAuthorizedViewsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsInstancesTablesAuthorizedViewsGetCall) Context added in v0.171.0

Context sets the context to be used in this call's Do method.

func (*ProjectsInstancesTablesAuthorizedViewsGetCall) Do added in v0.171.0

Do executes the "bigtableadmin.projects.instances.tables.authorizedViews.get" call. Any non-2xx status code is an error. Response headers are in either *AuthorizedView.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesTablesAuthorizedViewsGetCall) Fields added in v0.171.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsInstancesTablesAuthorizedViewsGetCall) Header added in v0.171.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsInstancesTablesAuthorizedViewsGetCall) IfNoneMatch added in v0.171.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsInstancesTablesAuthorizedViewsGetCall) View added in v0.171.0

View sets the optional parameter "view": The resource_view to be applied to the returned AuthorizedView's fields. Default to BASIC.

Possible values:

"RESPONSE_VIEW_UNSPECIFIED" - Uses the default view for each method as

documented in the request.

"NAME_ONLY" - Only populates `name`.
"BASIC" - Only populates the AuthorizedView's basic metadata. This

includes: name, deletion_protection, etag.

"FULL" - Populates every fields.

type ProjectsInstancesTablesAuthorizedViewsGetIamPolicyCall added in v0.173.0

type ProjectsInstancesTablesAuthorizedViewsGetIamPolicyCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsInstancesTablesAuthorizedViewsGetIamPolicyCall) Context added in v0.173.0

Context sets the context to be used in this call's Do method.

func (*ProjectsInstancesTablesAuthorizedViewsGetIamPolicyCall) Do added in v0.173.0

Do executes the "bigtableadmin.projects.instances.tables.authorizedViews.getIamPolicy" call. Any non-2xx status code is an error. Response headers are in either *Policy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesTablesAuthorizedViewsGetIamPolicyCall) Fields added in v0.173.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsInstancesTablesAuthorizedViewsGetIamPolicyCall) Header added in v0.173.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsInstancesTablesAuthorizedViewsListCall added in v0.171.0

type ProjectsInstancesTablesAuthorizedViewsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsInstancesTablesAuthorizedViewsListCall) Context added in v0.171.0

Context sets the context to be used in this call's Do method.

func (*ProjectsInstancesTablesAuthorizedViewsListCall) Do added in v0.171.0

Do executes the "bigtableadmin.projects.instances.tables.authorizedViews.list" call. Any non-2xx status code is an error. Response headers are in either *ListAuthorizedViewsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesTablesAuthorizedViewsListCall) Fields added in v0.171.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsInstancesTablesAuthorizedViewsListCall) Header added in v0.171.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsInstancesTablesAuthorizedViewsListCall) IfNoneMatch added in v0.171.0

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsInstancesTablesAuthorizedViewsListCall) PageSize added in v0.171.0

PageSize sets the optional parameter "pageSize": 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.

func (*ProjectsInstancesTablesAuthorizedViewsListCall) PageToken added in v0.171.0

PageToken sets the optional parameter "pageToken": The value of `next_page_token` returned by a previous call.

func (*ProjectsInstancesTablesAuthorizedViewsListCall) Pages added in v0.171.0

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

func (*ProjectsInstancesTablesAuthorizedViewsListCall) View added in v0.171.0

View sets the optional parameter "view": The resource_view to be applied to the returned AuthorizedViews' fields. Default to NAME_ONLY.

Possible values:

"RESPONSE_VIEW_UNSPECIFIED" - Uses the default view for each method as

documented in the request.

"NAME_ONLY" - Only populates `name`.
"BASIC" - Only populates the AuthorizedView's basic metadata. This

includes: name, deletion_protection, etag.

"FULL" - Populates every fields.

type ProjectsInstancesTablesAuthorizedViewsPatchCall added in v0.171.0

type ProjectsInstancesTablesAuthorizedViewsPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsInstancesTablesAuthorizedViewsPatchCall) Context added in v0.171.0

Context sets the context to be used in this call's Do method.

func (*ProjectsInstancesTablesAuthorizedViewsPatchCall) Do added in v0.171.0

Do executes the "bigtableadmin.projects.instances.tables.authorizedViews.patch" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesTablesAuthorizedViewsPatchCall) Fields added in v0.171.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsInstancesTablesAuthorizedViewsPatchCall) Header added in v0.171.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsInstancesTablesAuthorizedViewsPatchCall) IgnoreWarnings added in v0.171.0

IgnoreWarnings sets the optional parameter "ignoreWarnings": If true, ignore the safety checks when updating the AuthorizedView.

func (*ProjectsInstancesTablesAuthorizedViewsPatchCall) UpdateMask added in v0.171.0

UpdateMask sets the optional parameter "updateMask": 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).

type ProjectsInstancesTablesAuthorizedViewsService added in v0.171.0

type ProjectsInstancesTablesAuthorizedViewsService struct {
	// contains filtered or unexported fields
}

func NewProjectsInstancesTablesAuthorizedViewsService added in v0.171.0

func NewProjectsInstancesTablesAuthorizedViewsService(s *Service) *ProjectsInstancesTablesAuthorizedViewsService

func (*ProjectsInstancesTablesAuthorizedViewsService) Create added in v0.171.0

Create: Creates a new AuthorizedView in a table.

  • parent: This is the name of the table the AuthorizedView belongs to. Values are of the form `projects/{project}/instances/{instance}/tables/{table}`.

func (*ProjectsInstancesTablesAuthorizedViewsService) Delete added in v0.171.0

Delete: Permanently deletes a specified AuthorizedView.

  • name: The unique name of the AuthorizedView to be deleted. Values are of the form `projects/{project}/instances/{instance}/tables/{table}/authorizedViews/{au thorized_view}`.

func (*ProjectsInstancesTablesAuthorizedViewsService) Get added in v0.171.0

Get: Gets information from a specified AuthorizedView.

  • name: The unique name of the requested AuthorizedView. Values are of the form `projects/{project}/instances/{instance}/tables/{table}/authorizedViews/{au thorized_view}`.

func (*ProjectsInstancesTablesAuthorizedViewsService) GetIamPolicy added in v0.173.0

GetIamPolicy: Gets the access control policy for a Bigtable resource. Returns an empty policy if the resource exists but does not have a policy set.

func (*ProjectsInstancesTablesAuthorizedViewsService) List added in v0.171.0

List: Lists all AuthorizedViews from a specific table.

  • parent: The unique name of the table for which AuthorizedViews should be listed. Values are of the form `projects/{project}/instances/{instance}/tables/{table}`.

func (*ProjectsInstancesTablesAuthorizedViewsService) Patch added in v0.171.0

Patch: Updates an AuthorizedView in a table.

  • name: Identifier. The name of this AuthorizedView. Values are of the form `projects/{project}/instances/{instance}/tables/{table}/authorizedViews/{au thorized_view}`.

func (*ProjectsInstancesTablesAuthorizedViewsService) SetIamPolicy added in v0.173.0

SetIamPolicy: Sets the access control policy on a Bigtable resource. Replaces any existing policy.

func (*ProjectsInstancesTablesAuthorizedViewsService) TestIamPermissions added in v0.173.0

TestIamPermissions: Returns permissions that the caller has on the specified Bigtable resource.

type ProjectsInstancesTablesAuthorizedViewsSetIamPolicyCall added in v0.173.0

type ProjectsInstancesTablesAuthorizedViewsSetIamPolicyCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsInstancesTablesAuthorizedViewsSetIamPolicyCall) Context added in v0.173.0

Context sets the context to be used in this call's Do method.

func (*ProjectsInstancesTablesAuthorizedViewsSetIamPolicyCall) Do added in v0.173.0

Do executes the "bigtableadmin.projects.instances.tables.authorizedViews.setIamPolicy" call. Any non-2xx status code is an error. Response headers are in either *Policy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesTablesAuthorizedViewsSetIamPolicyCall) Fields added in v0.173.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsInstancesTablesAuthorizedViewsSetIamPolicyCall) Header added in v0.173.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsInstancesTablesAuthorizedViewsTestIamPermissionsCall added in v0.173.0

type ProjectsInstancesTablesAuthorizedViewsTestIamPermissionsCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsInstancesTablesAuthorizedViewsTestIamPermissionsCall) Context added in v0.173.0

Context sets the context to be used in this call's Do method.

func (*ProjectsInstancesTablesAuthorizedViewsTestIamPermissionsCall) Do added in v0.173.0

Do executes the "bigtableadmin.projects.instances.tables.authorizedViews.testIamPermissions" call. Any non-2xx status code is an error. Response headers are in either *TestIamPermissionsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesTablesAuthorizedViewsTestIamPermissionsCall) Fields added in v0.173.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsInstancesTablesAuthorizedViewsTestIamPermissionsCall) Header added in v0.173.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsInstancesTablesCheckConsistencyCall

type ProjectsInstancesTablesCheckConsistencyCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsInstancesTablesCheckConsistencyCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsInstancesTablesCheckConsistencyCall) Do

Do executes the "bigtableadmin.projects.instances.tables.checkConsistency" call. Any non-2xx status code is an error. Response headers are in either *CheckConsistencyResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesTablesCheckConsistencyCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsInstancesTablesCheckConsistencyCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsInstancesTablesCreateCall

type ProjectsInstancesTablesCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsInstancesTablesCreateCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsInstancesTablesCreateCall) Do

Do executes the "bigtableadmin.projects.instances.tables.create" call. Any non-2xx status code is an error. Response headers are in either *Table.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesTablesCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsInstancesTablesCreateCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsInstancesTablesDeleteCall

type ProjectsInstancesTablesDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsInstancesTablesDeleteCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsInstancesTablesDeleteCall) Do

Do executes the "bigtableadmin.projects.instances.tables.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesTablesDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsInstancesTablesDeleteCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsInstancesTablesDropRowRangeCall

type ProjectsInstancesTablesDropRowRangeCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsInstancesTablesDropRowRangeCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsInstancesTablesDropRowRangeCall) Do

Do executes the "bigtableadmin.projects.instances.tables.dropRowRange" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesTablesDropRowRangeCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsInstancesTablesDropRowRangeCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsInstancesTablesGenerateConsistencyTokenCall

type ProjectsInstancesTablesGenerateConsistencyTokenCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsInstancesTablesGenerateConsistencyTokenCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsInstancesTablesGenerateConsistencyTokenCall) Do

Do executes the "bigtableadmin.projects.instances.tables.generateConsistencyToken" call. Any non-2xx status code is an error. Response headers are in either *GenerateConsistencyTokenResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesTablesGenerateConsistencyTokenCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsInstancesTablesGenerateConsistencyTokenCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsInstancesTablesGetCall

type ProjectsInstancesTablesGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsInstancesTablesGetCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsInstancesTablesGetCall) Do

Do executes the "bigtableadmin.projects.instances.tables.get" call. Any non-2xx status code is an error. Response headers are in either *Table.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesTablesGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsInstancesTablesGetCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsInstancesTablesGetCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsInstancesTablesGetCall) View

View sets the optional parameter "view": The view to be applied to the returned table's fields. Defaults to `SCHEMA_VIEW` if unspecified.

Possible values:

"VIEW_UNSPECIFIED" - Uses the default view for each method as documented

in its request.

"NAME_ONLY" - Only populates `name`.
"SCHEMA_VIEW" - Only populates `name` and fields related to the table's

schema.

"REPLICATION_VIEW" - Only populates `name` and fields related to the

table's replication state.

"ENCRYPTION_VIEW" - Only populates `name` and fields related to the

table's encryption state.

"STATS_VIEW" - Only populates `name` and fields related to the table's

stats (e.g. TableStats and ColumnFamilyStats).

"FULL" - Populates all fields except for stats. See STATS_VIEW to request

stats.

type ProjectsInstancesTablesGetIamPolicyCall added in v0.4.0

type ProjectsInstancesTablesGetIamPolicyCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsInstancesTablesGetIamPolicyCall) Context added in v0.4.0

Context sets the context to be used in this call's Do method.

func (*ProjectsInstancesTablesGetIamPolicyCall) Do added in v0.4.0

Do executes the "bigtableadmin.projects.instances.tables.getIamPolicy" call. Any non-2xx status code is an error. Response headers are in either *Policy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesTablesGetIamPolicyCall) Fields added in v0.4.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsInstancesTablesGetIamPolicyCall) Header added in v0.4.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsInstancesTablesListCall

type ProjectsInstancesTablesListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsInstancesTablesListCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsInstancesTablesListCall) Do

Do executes the "bigtableadmin.projects.instances.tables.list" call. Any non-2xx status code is an error. Response headers are in either *ListTablesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesTablesListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsInstancesTablesListCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsInstancesTablesListCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsInstancesTablesListCall) PageSize

PageSize sets the optional parameter "pageSize": 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.

func (*ProjectsInstancesTablesListCall) PageToken

PageToken sets the optional parameter "pageToken": The value of `next_page_token` returned by a previous call.

func (*ProjectsInstancesTablesListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

func (*ProjectsInstancesTablesListCall) View

View sets the optional parameter "view": The view to be applied to the returned tables' fields. Only NAME_ONLY view (default), REPLICATION_VIEW and ENCRYPTION_VIEW are supported.

Possible values:

"VIEW_UNSPECIFIED" - Uses the default view for each method as documented

in its request.

"NAME_ONLY" - Only populates `name`.
"SCHEMA_VIEW" - Only populates `name` and fields related to the table's

schema.

"REPLICATION_VIEW" - Only populates `name` and fields related to the

table's replication state.

"ENCRYPTION_VIEW" - Only populates `name` and fields related to the

table's encryption state.

"STATS_VIEW" - Only populates `name` and fields related to the table's

stats (e.g. TableStats and ColumnFamilyStats).

"FULL" - Populates all fields except for stats. See STATS_VIEW to request

stats.

type ProjectsInstancesTablesModifyColumnFamiliesCall

type ProjectsInstancesTablesModifyColumnFamiliesCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsInstancesTablesModifyColumnFamiliesCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsInstancesTablesModifyColumnFamiliesCall) Do

Do executes the "bigtableadmin.projects.instances.tables.modifyColumnFamilies" call. Any non-2xx status code is an error. Response headers are in either *Table.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesTablesModifyColumnFamiliesCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsInstancesTablesModifyColumnFamiliesCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsInstancesTablesPatchCall added in v0.103.0

type ProjectsInstancesTablesPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsInstancesTablesPatchCall) Context added in v0.103.0

Context sets the context to be used in this call's Do method.

func (*ProjectsInstancesTablesPatchCall) Do added in v0.103.0

Do executes the "bigtableadmin.projects.instances.tables.patch" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesTablesPatchCall) Fields added in v0.103.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsInstancesTablesPatchCall) Header added in v0.103.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsInstancesTablesPatchCall) UpdateMask added in v0.103.0

UpdateMask sets the optional parameter "updateMask": 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.

type ProjectsInstancesTablesRestoreCall added in v0.30.0

type ProjectsInstancesTablesRestoreCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsInstancesTablesRestoreCall) Context added in v0.30.0

Context sets the context to be used in this call's Do method.

func (*ProjectsInstancesTablesRestoreCall) Do added in v0.30.0

Do executes the "bigtableadmin.projects.instances.tables.restore" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesTablesRestoreCall) Fields added in v0.30.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsInstancesTablesRestoreCall) Header added in v0.30.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsInstancesTablesService

type ProjectsInstancesTablesService struct {
	AuthorizedViews *ProjectsInstancesTablesAuthorizedViewsService
	// contains filtered or unexported fields
}

func NewProjectsInstancesTablesService

func NewProjectsInstancesTablesService(s *Service) *ProjectsInstancesTablesService

func (*ProjectsInstancesTablesService) CheckConsistency

CheckConsistency: 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.

  • name: The unique name of the Table for which to check replication consistency. Values are of the form `projects/{project}/instances/{instance}/tables/{table}`.

func (*ProjectsInstancesTablesService) Create

Create: 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.

  • parent: The unique name of the instance in which to create the table. Values are of the form `projects/{project}/instances/{instance}`.

func (*ProjectsInstancesTablesService) Delete

Delete: Permanently deletes a specified table and all of its data.

  • name: The unique name of the table to be deleted. Values are of the form `projects/{project}/instances/{instance}/tables/{table}`.

func (*ProjectsInstancesTablesService) DropRowRange

DropRowRange: 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. Note that row key prefixes used here are treated as service data. For more information about how service data is handled, see the Google Cloud Privacy Notice (https://cloud.google.com/terms/cloud-privacy-notice).

  • name: 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}`.

func (*ProjectsInstancesTablesService) GenerateConsistencyToken

func (r *ProjectsInstancesTablesService) GenerateConsistencyToken(name string, generateconsistencytokenrequest *GenerateConsistencyTokenRequest) *ProjectsInstancesTablesGenerateConsistencyTokenCall

GenerateConsistencyToken: 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.

  • name: The unique name of the Table for which to create a consistency token. Values are of the form `projects/{project}/instances/{instance}/tables/{table}`.

func (*ProjectsInstancesTablesService) Get

Get: Gets metadata information about the specified table.

  • name: The unique name of the requested table. Values are of the form `projects/{project}/instances/{instance}/tables/{table}`.

func (*ProjectsInstancesTablesService) GetIamPolicy added in v0.4.0

GetIamPolicy: Gets the access control policy for a Bigtable resource. Returns an empty policy if the resource exists but does not have a policy set.

func (*ProjectsInstancesTablesService) List

List: Lists all tables served from a specified instance.

  • parent: The unique name of the instance for which tables should be listed. Values are of the form `projects/{project}/instances/{instance}`.

func (*ProjectsInstancesTablesService) ModifyColumnFamilies

ModifyColumnFamilies: 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.

  • name: The unique name of the table whose families should be modified. Values are of the form `projects/{project}/instances/{instance}/tables/{table}`.

func (*ProjectsInstancesTablesService) Patch added in v0.103.0

Patch: Updates a specified table.

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

func (*ProjectsInstancesTablesService) Restore added in v0.30.0

Restore: Create a new table by restoring from a completed backup. The returned table long-running operation can be used to track the progress of the operation, and to cancel it. The metadata field type is RestoreTableMetadata. The response type is Table, if successful.

  • parent: The name of the instance in which to create the restored table. Values are of the form `projects//instances/`.

func (*ProjectsInstancesTablesService) SetIamPolicy added in v0.4.0

SetIamPolicy: Sets the access control policy on a Bigtable resource. Replaces any existing policy.

func (*ProjectsInstancesTablesService) TestIamPermissions added in v0.4.0

func (r *ProjectsInstancesTablesService) TestIamPermissions(resource string, testiampermissionsrequest *TestIamPermissionsRequest) *ProjectsInstancesTablesTestIamPermissionsCall

TestIamPermissions: Returns permissions that the caller has on the specified Bigtable resource.

func (*ProjectsInstancesTablesService) Undelete added in v0.86.0

Undelete: Restores a specified table which was accidentally deleted.

  • name: The unique name of the table to be restored. Values are of the form `projects/{project}/instances/{instance}/tables/{table}`.

type ProjectsInstancesTablesSetIamPolicyCall added in v0.4.0

type ProjectsInstancesTablesSetIamPolicyCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsInstancesTablesSetIamPolicyCall) Context added in v0.4.0

Context sets the context to be used in this call's Do method.

func (*ProjectsInstancesTablesSetIamPolicyCall) Do added in v0.4.0

Do executes the "bigtableadmin.projects.instances.tables.setIamPolicy" call. Any non-2xx status code is an error. Response headers are in either *Policy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesTablesSetIamPolicyCall) Fields added in v0.4.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsInstancesTablesSetIamPolicyCall) Header added in v0.4.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsInstancesTablesTestIamPermissionsCall added in v0.4.0

type ProjectsInstancesTablesTestIamPermissionsCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsInstancesTablesTestIamPermissionsCall) Context added in v0.4.0

Context sets the context to be used in this call's Do method.

func (*ProjectsInstancesTablesTestIamPermissionsCall) Do added in v0.4.0

Do executes the "bigtableadmin.projects.instances.tables.testIamPermissions" call. Any non-2xx status code is an error. Response headers are in either *TestIamPermissionsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesTablesTestIamPermissionsCall) Fields added in v0.4.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsInstancesTablesTestIamPermissionsCall) Header added in v0.4.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsInstancesTablesUndeleteCall added in v0.86.0

type ProjectsInstancesTablesUndeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsInstancesTablesUndeleteCall) Context added in v0.86.0

Context sets the context to be used in this call's Do method.

func (*ProjectsInstancesTablesUndeleteCall) Do added in v0.86.0

Do executes the "bigtableadmin.projects.instances.tables.undelete" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesTablesUndeleteCall) Fields added in v0.86.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsInstancesTablesUndeleteCall) Header added in v0.86.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsInstancesTestIamPermissionsCall

type ProjectsInstancesTestIamPermissionsCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsInstancesTestIamPermissionsCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsInstancesTestIamPermissionsCall) Do

Do executes the "bigtableadmin.projects.instances.testIamPermissions" call. Any non-2xx status code is an error. Response headers are in either *TestIamPermissionsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesTestIamPermissionsCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsInstancesTestIamPermissionsCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsInstancesUpdateCall

type ProjectsInstancesUpdateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsInstancesUpdateCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsInstancesUpdateCall) Do

Do executes the "bigtableadmin.projects.instances.update" call. Any non-2xx status code is an error. Response headers are in either *Instance.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsInstancesUpdateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsInstancesUpdateCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsListCall added in v0.7.0

type ProjectsLocationsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsListCall) Context added in v0.7.0

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsListCall) Do added in v0.7.0

Do executes the "bigtableadmin.projects.locations.list" call. Any non-2xx status code is an error. Response headers are in either *ListLocationsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsListCall) Fields added in v0.7.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsListCall) Filter added in v0.7.0

Filter sets the optional parameter "filter": A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160 (https://google.aip.dev/160).

func (*ProjectsLocationsListCall) Header added in v0.7.0

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsListCall) IfNoneMatch added in v0.7.0

func (c *ProjectsLocationsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsListCall) PageSize added in v0.7.0

PageSize sets the optional parameter "pageSize": The maximum number of results to return. If not set, the service selects a default.

func (*ProjectsLocationsListCall) PageToken added in v0.7.0

PageToken sets the optional parameter "pageToken": A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.

func (*ProjectsLocationsListCall) Pages added in v0.7.0

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsService added in v0.7.0

type ProjectsLocationsService struct {
	// contains filtered or unexported fields
}

func NewProjectsLocationsService added in v0.7.0

func NewProjectsLocationsService(s *Service) *ProjectsLocationsService

func (*ProjectsLocationsService) List added in v0.7.0

List: Lists information about the supported locations for this service.

- name: The resource that owns the locations collection, if applicable.

type ProjectsService

type ProjectsService struct {
	Instances *ProjectsInstancesService

	Locations *ProjectsLocationsService
	// contains filtered or unexported fields
}

func NewProjectsService

func NewProjectsService(s *Service) *ProjectsService

type RestoreInfo added in v0.30.0

type RestoreInfo struct {
	// BackupInfo: Information about the backup used to restore the table. The
	// backup may no longer exist.
	BackupInfo *BackupInfo `json:"backupInfo,omitempty"`
	// SourceType: The type of the restore source.
	//
	// Possible values:
	//   "RESTORE_SOURCE_TYPE_UNSPECIFIED" - No restore associated.
	//   "BACKUP" - A backup was used as the source of the restore.
	SourceType string `json:"sourceType,omitempty"`
	// ForceSendFields is a list of field names (e.g. "BackupInfo") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "BackupInfo") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

RestoreInfo: Information about a table restore.

func (RestoreInfo) MarshalJSON added in v0.30.0

func (s RestoreInfo) MarshalJSON() ([]byte, error)

type RestoreTableMetadata added in v0.30.0

type RestoreTableMetadata struct {
	BackupInfo *BackupInfo `json:"backupInfo,omitempty"`
	// Name: Name of the table being created and restored to.
	Name string `json:"name,omitempty"`
	// OptimizeTableOperationName: 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 OptimizeRestoredTableMetadata. The response type
	// is 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 `json:"optimizeTableOperationName,omitempty"`
	// Progress: The progress of the RestoreTable operation.
	Progress *OperationProgress `json:"progress,omitempty"`
	// SourceType: The type of the restore source.
	//
	// Possible values:
	//   "RESTORE_SOURCE_TYPE_UNSPECIFIED" - No restore associated.
	//   "BACKUP" - A backup was used as the source of the restore.
	SourceType string `json:"sourceType,omitempty"`
	// ForceSendFields is a list of field names (e.g. "BackupInfo") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "BackupInfo") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

RestoreTableMetadata: Metadata type for the long-running operation returned by RestoreTable.

func (RestoreTableMetadata) MarshalJSON added in v0.30.0

func (s RestoreTableMetadata) MarshalJSON() ([]byte, error)

type RestoreTableRequest added in v0.30.0

type RestoreTableRequest struct {
	// Backup: Name of the backup from which to restore. Values are of the form
	// `projects//instances//clusters//backups/`.
	Backup string `json:"backup,omitempty"`
	// TableId: 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//instances//tables/`.
	TableId string `json:"tableId,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Backup") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Backup") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

RestoreTableRequest: The request for RestoreTable.

func (RestoreTableRequest) MarshalJSON added in v0.30.0

func (s RestoreTableRequest) MarshalJSON() ([]byte, error)

type RowAffinity added in v0.198.0

type RowAffinity struct {
}

RowAffinity: If enabled, Bigtable will route the request based on the row key of the request, rather than randomly. Instead, each row key will be assigned to a cluster, and will stick to that cluster. If clusters are added or removed, then this may affect which row keys stick to which clusters. To avoid this, users can use a cluster group to specify which clusters are to be used. In this case, new clusters that are not a part of the cluster group will not be routed to, and routing will be unaffected by the new cluster. Moreover, clusters specified in the cluster group cannot be deleted unless removed from the cluster group.

type Service

type Service struct {
	BasePath  string // API endpoint base URL
	UserAgent string // optional additional User-Agent fragment

	Operations *OperationsService

	Projects *ProjectsService
	// contains filtered or unexported fields
}

func New deprecated

func New(client *http.Client) (*Service, error)

New creates a new Service. It uses the provided http.Client for requests.

Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.

func NewService added in v0.3.0

func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)

NewService creates a new Service.

type SetIamPolicyRequest

type SetIamPolicyRequest struct {
	// Policy: REQUIRED: The complete policy to be applied to the `resource`. The
	// size of the policy is limited to a few 10s of KB. An empty policy is a valid
	// policy but certain Google Cloud services (such as Projects) might reject
	// them.
	Policy *Policy `json:"policy,omitempty"`
	// UpdateMask: OPTIONAL: A FieldMask specifying which fields of the policy to
	// modify. Only the fields in the mask will be modified. If no mask is
	// provided, the following default mask is used: `paths: "bindings, etag"
	UpdateMask string `json:"updateMask,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Policy") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Policy") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SetIamPolicyRequest: Request message for `SetIamPolicy` method.

func (SetIamPolicyRequest) MarshalJSON

func (s SetIamPolicyRequest) MarshalJSON() ([]byte, error)

type SingleClusterRouting

type SingleClusterRouting struct {
	// AllowTransactionalWrites: 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 `json:"allowTransactionalWrites,omitempty"`
	// ClusterId: The cluster to which read/write requests should be routed.
	ClusterId string `json:"clusterId,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AllowTransactionalWrites")
	// to unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AllowTransactionalWrites") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (SingleClusterRouting) MarshalJSON

func (s SingleClusterRouting) MarshalJSON() ([]byte, error)

type Split

type Split struct {
	// Key: Row key to use as an initial tablet boundary.
	Key string `json:"key,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Key") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Key") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Split: An initial split point for a newly created table.

func (Split) MarshalJSON

func (s Split) MarshalJSON() ([]byte, error)

type StandardIsolation added in v0.149.0

type StandardIsolation struct {
	// Priority: The priority of requests sent using this app profile.
	//
	// Possible values:
	//   "PRIORITY_UNSPECIFIED" - Default value. Mapped to PRIORITY_HIGH (the
	// legacy behavior) on creation.
	//   "PRIORITY_LOW"
	//   "PRIORITY_MEDIUM"
	//   "PRIORITY_HIGH"
	Priority string `json:"priority,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Priority") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Priority") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

StandardIsolation: Standard options for isolating this app profile's traffic from other use cases.

func (StandardIsolation) MarshalJSON added in v0.149.0

func (s StandardIsolation) MarshalJSON() ([]byte, error)

type StandardReadRemoteWrites added in v0.150.0

type StandardReadRemoteWrites struct {
}

StandardReadRemoteWrites: Checks that all writes before the consistency token was generated are replicated in every cluster and readable.

type Status

type Status struct {
	// Code: The status code, which should be an enum value of google.rpc.Code.
	Code int64 `json:"code,omitempty"`
	// Details: A list of messages that carry the error details. There is a common
	// set of message types for APIs to use.
	Details []googleapi.RawMessage `json:"details,omitempty"`
	// Message: A developer-facing error message, which should be in English. Any
	// user-facing error message should be localized and sent in the
	// google.rpc.Status.details field, or localized by the client.
	Message string `json:"message,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Code") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Code") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Status: The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors).

func (Status) MarshalJSON

func (s Status) MarshalJSON() ([]byte, error)

type Table

type Table struct {
	// AutomatedBackupPolicy: If specified, automated backups are enabled for this
	// table. Otherwise, automated backups are disabled.
	AutomatedBackupPolicy *AutomatedBackupPolicy `json:"automatedBackupPolicy,omitempty"`
	// ChangeStreamConfig: If specified, enable the change stream on this table.
	// Otherwise, the change stream is disabled and the change stream is not
	// retained.
	ChangeStreamConfig *ChangeStreamConfig `json:"changeStreamConfig,omitempty"`
	// ClusterStates: 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]ClusterState `json:"clusterStates,omitempty"`
	// ColumnFamilies: The column families configured for this table, mapped by
	// column family ID. Views: `SCHEMA_VIEW`, `STATS_VIEW`, `FULL`
	ColumnFamilies map[string]ColumnFamily `json:"columnFamilies,omitempty"`
	// DeletionProtection: 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 `json:"deletionProtection,omitempty"`
	// Granularity: 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`.
	//
	// Possible values:
	//   "TIMESTAMP_GRANULARITY_UNSPECIFIED" - The user did not specify a
	// granularity. Should not be returned. When specified during table creation,
	// MILLIS will be used.
	//   "MILLIS" - The table keeps data versioned at a granularity of 1ms.
	Granularity string `json:"granularity,omitempty"`
	// Name: The unique name of the table. Values are of the form
	// `projects/{project}/instances/{instance}/tables/_a-zA-Z0-9*`. Views:
	// `NAME_ONLY`, `SCHEMA_VIEW`, `REPLICATION_VIEW`, `STATS_VIEW`, `FULL`
	Name string `json:"name,omitempty"`
	// RestoreInfo: 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 `json:"restoreInfo,omitempty"`
	// Stats: Output only. Only available with STATS_VIEW, this includes summary
	// statistics about the entire table contents. For statistics about a specific
	// column family, see ColumnFamilyStats in the mapped ColumnFamily collection
	// above.
	Stats *TableStats `json:"stats,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "AutomatedBackupPolicy") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AutomatedBackupPolicy") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (Table) MarshalJSON

func (s Table) MarshalJSON() ([]byte, error)

type TableProgress added in v0.2.0

type TableProgress struct {
	// EstimatedCopiedBytes: 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 `json:"estimatedCopiedBytes,omitempty,string"`
	// EstimatedSizeBytes: Estimate of the size of the table to be copied.
	EstimatedSizeBytes int64 `json:"estimatedSizeBytes,omitempty,string"`
	// Possible values:
	//   "STATE_UNSPECIFIED"
	//   "PENDING" - The table has not yet begun copying to the new cluster.
	//   "COPYING" - The table is actively being copied to the new cluster.
	//   "COMPLETED" - The table has been fully copied to the new cluster.
	//   "CANCELLED" - 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.
	State string `json:"state,omitempty"`
	// ForceSendFields is a list of field names (e.g. "EstimatedCopiedBytes") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "EstimatedCopiedBytes") to include
	// in API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

TableProgress: Progress info for copying a table's data to the new cluster.

func (TableProgress) MarshalJSON added in v0.2.0

func (s TableProgress) MarshalJSON() ([]byte, error)

type TableStats added in v0.103.0

type TableStats struct {
	// AverageCellsPerColumn: How many cells are present per column (column family,
	// column qualifier) combinations, averaged over all columns in all rows in the
	// table. e.g. A table with 2 rows: * A row with 3 cells in "family:col" and 1
	// cell in "other:col" (4 cells / 2 columns) * A row with 1 cell in
	// "family:col", 7 cells in "family:other_col", and 7 cells in "other:data" (15
	// cells / 3 columns) would report (4 + 15)/(2 + 3) = 3.8 in this field.
	AverageCellsPerColumn float64 `json:"averageCellsPerColumn,omitempty"`
	// AverageColumnsPerRow: How many (column family, column qualifier)
	// combinations are present per row in the table, averaged over all rows in the
	// table. e.g. A table with 2 rows: * A row with cells in "family:col" and
	// "other:col" (2 distinct columns) * A row with cells in "family:col",
	// "family:other_col", and "other:data" (3 distinct columns) would report (2 +
	// 3)/2 = 2.5 in this field.
	AverageColumnsPerRow float64 `json:"averageColumnsPerRow,omitempty"`
	// LogicalDataBytes: This is roughly how many bytes would be needed to read the
	// entire table (e.g. by streaming all contents out).
	LogicalDataBytes int64 `json:"logicalDataBytes,omitempty,string"`
	// RowCount: How many rows are in the table.
	RowCount int64 `json:"rowCount,omitempty,string"`
	// ForceSendFields is a list of field names (e.g. "AverageCellsPerColumn") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AverageCellsPerColumn") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

TableStats: Approximate statistics related to a table. These statistics are calculated infrequently, while simultaneously, data in the table can change rapidly. Thus the values reported here (e.g. row count) are very likely out-of date, even the instant they are received in this API. Thus, only treat these values as approximate. IMPORTANT: Everything below is approximate, unless otherwise specified.

func (TableStats) MarshalJSON added in v0.103.0

func (s TableStats) MarshalJSON() ([]byte, error)

func (*TableStats) UnmarshalJSON added in v0.103.0

func (s *TableStats) UnmarshalJSON(data []byte) error

type TestIamPermissionsRequest

type TestIamPermissionsRequest struct {
	// Permissions: The set of permissions to check for the `resource`. Permissions
	// with wildcards (such as `*` or `storage.*`) are not allowed. For more
	// information see IAM Overview
	// (https://cloud.google.com/iam/docs/overview#permissions).
	Permissions []string `json:"permissions,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Permissions") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Permissions") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

TestIamPermissionsRequest: Request message for `TestIamPermissions` method.

func (TestIamPermissionsRequest) MarshalJSON

func (s TestIamPermissionsRequest) MarshalJSON() ([]byte, error)

type TestIamPermissionsResponse

type TestIamPermissionsResponse struct {
	// Permissions: A subset of `TestPermissionsRequest.permissions` that the
	// caller is allowed.
	Permissions []string `json:"permissions,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Permissions") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Permissions") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

TestIamPermissionsResponse: Response message for `TestIamPermissions` method.

func (TestIamPermissionsResponse) MarshalJSON

func (s TestIamPermissionsResponse) MarshalJSON() ([]byte, error)

type Type added in v0.172.0

type Type struct {
	// AggregateType: Aggregate
	AggregateType *GoogleBigtableAdminV2TypeAggregate `json:"aggregateType,omitempty"`
	// ArrayType: Array
	ArrayType *GoogleBigtableAdminV2TypeArray `json:"arrayType,omitempty"`
	// BoolType: Bool
	BoolType *GoogleBigtableAdminV2TypeBool `json:"boolType,omitempty"`
	// BytesType: Bytes
	BytesType *GoogleBigtableAdminV2TypeBytes `json:"bytesType,omitempty"`
	// DateType: Date
	DateType *GoogleBigtableAdminV2TypeDate `json:"dateType,omitempty"`
	// Float32Type: Float32
	Float32Type *GoogleBigtableAdminV2TypeFloat32 `json:"float32Type,omitempty"`
	// Float64Type: Float64
	Float64Type *GoogleBigtableAdminV2TypeFloat64 `json:"float64Type,omitempty"`
	// Int64Type: Int64
	Int64Type *GoogleBigtableAdminV2TypeInt64 `json:"int64Type,omitempty"`
	// MapType: Map
	MapType *GoogleBigtableAdminV2TypeMap `json:"mapType,omitempty"`
	// StringType: String
	StringType *GoogleBigtableAdminV2TypeString `json:"stringType,omitempty"`
	// StructType: Struct
	StructType *GoogleBigtableAdminV2TypeStruct `json:"structType,omitempty"`
	// TimestampType: Timestamp
	TimestampType *GoogleBigtableAdminV2TypeTimestamp `json:"timestampType,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AggregateType") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AggregateType") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Type: `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 or from the underlying data. Each encoding can operate in one of two modes: - Sorted: In this mode, Bigtable guarantees that `Encode(X) <= Encode(Y)` if and only if `X <= Y`. This is useful anywhere sort order is important, for example when encoding keys. - Distinct: In this mode, Bigtable guarantees that if `X != Y` then `Encode(X) != Encode(Y)`. However, the converse is not guaranteed. For example, both "{'foo': '1', 'bar': '2'}" and "{'bar': '2', 'foo': '1'}" are valid encodings of the same JSON value. The API clearly documents which mode is used wherever an encoding can be configured. Each encoding also documents which values are supported in which modes. For example, when encoding INT64 as a numeric STRING, negative numbers cannot be encoded in sorted mode. This is because `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001")`.

func (Type) MarshalJSON added in v0.172.0

func (s Type) MarshalJSON() ([]byte, error)

type UndeleteTableMetadata added in v0.63.0

type UndeleteTableMetadata struct {
	// EndTime: If set, the time at which this operation finished or was cancelled.
	EndTime string `json:"endTime,omitempty"`
	// Name: The name of the table being restored.
	Name string `json:"name,omitempty"`
	// StartTime: The time at which this operation started.
	StartTime string `json:"startTime,omitempty"`
	// ForceSendFields is a list of field names (e.g. "EndTime") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "EndTime") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

UndeleteTableMetadata: Metadata type for the operation returned by google.bigtable.admin.v2.BigtableTableAdmin.UndeleteTable.

func (UndeleteTableMetadata) MarshalJSON added in v0.63.0

func (s UndeleteTableMetadata) MarshalJSON() ([]byte, error)

type UndeleteTableRequest added in v0.86.0

type UndeleteTableRequest struct {
}

UndeleteTableRequest: Request message for google.bigtable.admin.v2.BigtableTableAdmin.UndeleteTable

type Union

type Union struct {
	// Rules: Delete cells which would be deleted by any element of `rules`.
	Rules []*GcRule `json:"rules,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Rules") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Rules") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

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

func (Union) MarshalJSON

func (s Union) MarshalJSON() ([]byte, error)

type UpdateAppProfileMetadata

type UpdateAppProfileMetadata struct {
}

UpdateAppProfileMetadata: The metadata for the Operation returned by UpdateAppProfile.

type UpdateAuthorizedViewMetadata added in v0.171.0

type UpdateAuthorizedViewMetadata struct {
	// FinishTime: The time at which the operation failed or was completed
	// successfully.
	FinishTime string `json:"finishTime,omitempty"`
	// OriginalRequest: The request that prompted the initiation of this
	// UpdateAuthorizedView operation.
	OriginalRequest *UpdateAuthorizedViewRequest `json:"originalRequest,omitempty"`
	// RequestTime: The time at which the original request was received.
	RequestTime string `json:"requestTime,omitempty"`
	// ForceSendFields is a list of field names (e.g. "FinishTime") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "FinishTime") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

UpdateAuthorizedViewMetadata: Metadata for the google.longrunning.Operation returned by UpdateAuthorizedView.

func (UpdateAuthorizedViewMetadata) MarshalJSON added in v0.171.0

func (s UpdateAuthorizedViewMetadata) MarshalJSON() ([]byte, error)

type UpdateAuthorizedViewRequest added in v0.171.0

type UpdateAuthorizedViewRequest struct {
	// AuthorizedView: 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/{auth
	// orized_view}`.
	AuthorizedView *AuthorizedView `json:"authorizedView,omitempty"`
	// IgnoreWarnings: Optional. If true, ignore the safety checks when updating
	// the AuthorizedView.
	IgnoreWarnings bool `json:"ignoreWarnings,omitempty"`
	// UpdateMask: 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 string `json:"updateMask,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AuthorizedView") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AuthorizedView") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

UpdateAuthorizedViewRequest: The request for UpdateAuthorizedView.

func (UpdateAuthorizedViewRequest) MarshalJSON added in v0.171.0

func (s UpdateAuthorizedViewRequest) MarshalJSON() ([]byte, error)

type UpdateClusterMetadata

type UpdateClusterMetadata struct {
	// FinishTime: The time at which the operation failed or was completed
	// successfully.
	FinishTime string `json:"finishTime,omitempty"`
	// OriginalRequest: The request that prompted the initiation of this
	// UpdateCluster operation.
	OriginalRequest *Cluster `json:"originalRequest,omitempty"`
	// RequestTime: The time at which the original request was received.
	RequestTime string `json:"requestTime,omitempty"`
	// ForceSendFields is a list of field names (e.g. "FinishTime") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "FinishTime") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

UpdateClusterMetadata: The metadata for the Operation returned by UpdateCluster.

func (UpdateClusterMetadata) MarshalJSON

func (s UpdateClusterMetadata) MarshalJSON() ([]byte, error)

type UpdateInstanceMetadata

type UpdateInstanceMetadata struct {
	// FinishTime: The time at which the operation failed or was completed
	// successfully.
	FinishTime string `json:"finishTime,omitempty"`
	// OriginalRequest: The request that prompted the initiation of this
	// UpdateInstance operation.
	OriginalRequest *PartialUpdateInstanceRequest `json:"originalRequest,omitempty"`
	// RequestTime: The time at which the original request was received.
	RequestTime string `json:"requestTime,omitempty"`
	// ForceSendFields is a list of field names (e.g. "FinishTime") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "FinishTime") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

UpdateInstanceMetadata: The metadata for the Operation returned by UpdateInstance.

func (UpdateInstanceMetadata) MarshalJSON

func (s UpdateInstanceMetadata) MarshalJSON() ([]byte, error)

type UpdateTableMetadata added in v0.103.0

type UpdateTableMetadata struct {
	// EndTime: If set, the time at which this operation finished or was canceled.
	EndTime string `json:"endTime,omitempty"`
	// Name: The name of the table being updated.
	Name string `json:"name,omitempty"`
	// StartTime: The time at which this operation started.
	StartTime string `json:"startTime,omitempty"`
	// ForceSendFields is a list of field names (e.g. "EndTime") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "EndTime") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

UpdateTableMetadata: Metadata type for the operation returned by UpdateTable.

func (UpdateTableMetadata) MarshalJSON added in v0.103.0

func (s UpdateTableMetadata) MarshalJSON() ([]byte, error)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL