spanner

package
v0.0.0-...-ff3b5ee Latest Latest
Warning

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

Go to latest
Published: Mar 12, 2024 License: BSD-3-Clause Imports: 16 Imported by: 0

Documentation

Overview

Package spanner provides access to the Cloud Spanner API.

This package is DEPRECATED. Use package cloud.google.com/go/spanner instead.

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

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/spanner/v1"
...
ctx := context.Background()
spannerService, err := spanner.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:

spannerService, err := spanner.NewService(ctx, option.WithScopes(spanner.SpannerDataScope))

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

spannerService, err := spanner.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, ...)
spannerService, err := spanner.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

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

Index

Constants

View Source
const (
	// 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"

	// Administer your Spanner databases
	SpannerAdminScope = "https://www.googleapis.com/auth/spanner.admin"

	// View and manage the contents of your Spanner databases
	SpannerDataScope = "https://www.googleapis.com/auth/spanner.data"
)

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

type AutoscalingConfig

type AutoscalingConfig struct {
	// AutoscalingLimits: Required. Autoscaling limits for an instance.
	AutoscalingLimits *AutoscalingLimits `json:"autoscalingLimits,omitempty"`

	// AutoscalingTargets: Required. The autoscaling targets for an
	// instance.
	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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

AutoscalingConfig: Autoscaling config for an instance.

func (*AutoscalingConfig) MarshalJSON

func (s *AutoscalingConfig) MarshalJSON() ([]byte, error)

type AutoscalingLimits

type AutoscalingLimits struct {
	// MaxNodes: Maximum number of nodes allocated to the instance. If set,
	// this number should be greater than or equal to min_nodes.
	MaxNodes int64 `json:"maxNodes,omitempty"`

	// MaxProcessingUnits: Maximum number of processing units allocated to
	// the instance. If set, this number should be multiples of 1000 and be
	// greater than or equal to min_processing_units.
	MaxProcessingUnits int64 `json:"maxProcessingUnits,omitempty"`

	// MinNodes: Minimum number of nodes allocated to the instance. If set,
	// this number should be greater than or equal to 1.
	MinNodes int64 `json:"minNodes,omitempty"`

	// MinProcessingUnits: Minimum number of processing units allocated to
	// the instance. If set, this number should be multiples of 1000.
	MinProcessingUnits int64 `json:"minProcessingUnits,omitempty"`

	// ForceSendFields is a list of field names (e.g. "MaxNodes") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "MaxNodes") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

AutoscalingLimits: The autoscaling limits for the instance. Users can define the minimum and maximum compute capacity allocated to the instance, and the autoscaler will only scale within that range. Users can either use nodes or processing units to specify the limits, but should use the same unit to set both the min_limit and max_limit.

func (*AutoscalingLimits) MarshalJSON

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

type AutoscalingTargets

type AutoscalingTargets struct {
	// HighPriorityCpuUtilizationPercent: Required. The target high priority
	// cpu utilization percentage that the autoscaler should be trying to
	// achieve for the instance. This number is on a scale from 0 (no
	// utilization) to 100 (full utilization). The valid range is [10, 90]
	// inclusive.
	HighPriorityCpuUtilizationPercent int64 `json:"highPriorityCpuUtilizationPercent,omitempty"`

	// StorageUtilizationPercent: Required. The target storage utilization
	// percentage that the autoscaler should be trying to achieve for the
	// instance. This number is on a scale from 0 (no utilization) to 100
	// (full utilization). The valid range is [10, 99] inclusive.
	StorageUtilizationPercent int64 `json:"storageUtilizationPercent,omitempty"`

	// ForceSendFields is a list of field names (e.g.
	// "HighPriorityCpuUtilizationPercent") to unconditionally include in
	// API requests. By default, fields with empty or default values are
	// omitted from API requests. However, any non-pointer, non-interface
	// field appearing in ForceSendFields will be sent to the server
	// regardless of whether the field is empty or not. This may be used to
	// include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g.
	// "HighPriorityCpuUtilizationPercent") to include in API requests with
	// the JSON null value. By default, fields with empty values are omitted
	// from API requests. However, any field with an empty value appearing
	// in NullFields will be sent to the server as null. It is an error if a
	// field in this list has a non-empty value. This may be used to include
	// null fields in Patch requests.
	NullFields []string `json:"-"`
}

AutoscalingTargets: The autoscaling targets for an instance.

func (*AutoscalingTargets) MarshalJSON

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

type Backup

type Backup struct {
	// CreateTime: Output only. The time the CreateBackup request is
	// received. If the request does not specify `version_time`, the
	// `version_time` of the backup will be equivalent to the `create_time`.
	CreateTime string `json:"createTime,omitempty"`

	// Database: Required for the CreateBackup operation. Name of the
	// database from which this backup was created. This needs to be in the
	// same instance as the backup. Values are of the form
	// `projects//instances//databases/`.
	Database string `json:"database,omitempty"`

	// DatabaseDialect: Output only. The database dialect information for
	// the backup.
	//
	// Possible values:
	//   "DATABASE_DIALECT_UNSPECIFIED" - Default value. This value will
	// create a database with the GOOGLE_STANDARD_SQL dialect.
	//   "GOOGLE_STANDARD_SQL" - GoogleSQL supported SQL.
	//   "POSTGRESQL" - PostgreSQL supported SQL.
	DatabaseDialect string `json:"databaseDialect,omitempty"`

	// EncryptionInfo: Output only. The encryption information for the
	// backup.
	EncryptionInfo *EncryptionInfo `json:"encryptionInfo,omitempty"`

	// ExpireTime: Required for the CreateBackup operation. The expiration
	// time of the backup, with microseconds granularity that must be at
	// least 6 hours and at most 366 days from the time the CreateBackup
	// request is processed. Once the `expire_time` has passed, the backup
	// is eligible to be automatically deleted by Cloud Spanner to free the
	// resources used by the backup.
	ExpireTime string `json:"expireTime,omitempty"`

	// MaxExpireTime: Output only. The max allowed expiration time of the
	// backup, with microseconds granularity. A backup's expiration time can
	// be configured in multiple APIs: CreateBackup, UpdateBackup,
	// CopyBackup. When updating or copying an existing backup, the
	// expiration time specified must be less than `Backup.max_expire_time`.
	MaxExpireTime string `json:"maxExpireTime,omitempty"`

	// Name: Output only for the CreateBackup operation. Required for the
	// UpdateBackup operation. A globally unique identifier for the backup
	// which cannot be changed. Values are of the form
	// `projects//instances//backups/a-z*[a-z0-9]` The final segment of the
	// name must be between 2 and 60 characters in length. The backup is
	// stored in the location(s) specified in the instance configuration of
	// the instance containing the backup, identified by the prefix of the
	// backup name of the form `projects//instances/`.
	Name string `json:"name,omitempty"`

	// ReferencingBackups: Output only. The names of the destination backups
	// being created by copying this source backup. The backup names are of
	// the form `projects//instances//backups/`. Referencing backups may
	// exist in different instances. The existence of any referencing backup
	// prevents the backup from being deleted. When the copy operation is
	// done (either successfully completed or cancelled or the destination
	// backup is deleted), the reference to the backup is removed.
	ReferencingBackups []string `json:"referencingBackups,omitempty"`

	// ReferencingDatabases: Output only. The names of the restored
	// databases that reference the backup. The database names are of the
	// form `projects//instances//databases/`. Referencing databases may
	// exist in different instances. The existence of any referencing
	// database prevents the backup from being deleted. When a restored
	// database from the backup enters the `READY` state, the reference to
	// the backup is removed.
	ReferencingDatabases []string `json:"referencingDatabases,omitempty"`

	// SizeBytes: Output only. Size of the backup in bytes.
	SizeBytes int64 `json:"sizeBytes,omitempty,string"`

	// 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"`

	// VersionTime: The backup will contain an externally consistent copy of
	// the database at the timestamp specified by `version_time`. If
	// `version_time` is not specified, the system will set `version_time`
	// to the `create_time` of the backup.
	VersionTime string `json:"versionTime,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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Backup: A backup of a Cloud Spanner database.

func (*Backup) MarshalJSON

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

type BackupInfo

type BackupInfo struct {
	// Backup: Name of the backup.
	Backup string `json:"backup,omitempty"`

	// CreateTime: The time the CreateBackup request was received.
	CreateTime string `json:"createTime,omitempty"`

	// SourceDatabase: Name of the database the backup was created from.
	SourceDatabase string `json:"sourceDatabase,omitempty"`

	// VersionTime: The backup contains an externally consistent copy of
	// `source_database` at the timestamp specified by `version_time`. If
	// the CreateBackup request did not specify `version_time`, the
	// `version_time` of the backup is equivalent to the `create_time`.
	VersionTime string `json:"versionTime,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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

BackupInfo: Information about a backup.

func (*BackupInfo) MarshalJSON

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

type BatchCreateSessionsRequest

type BatchCreateSessionsRequest struct {
	// SessionCount: Required. The number of sessions to be created in this
	// batch call. The API may return fewer than the requested number of
	// sessions. If a specific number of sessions are desired, the client
	// can make additional calls to BatchCreateSessions (adjusting
	// session_count as necessary).
	SessionCount int64 `json:"sessionCount,omitempty"`

	// SessionTemplate: Parameters to be applied to each created session.
	SessionTemplate *Session `json:"sessionTemplate,omitempty"`

	// ForceSendFields is a list of field names (e.g. "SessionCount") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "SessionCount") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

BatchCreateSessionsRequest: The request for BatchCreateSessions.

func (*BatchCreateSessionsRequest) MarshalJSON

func (s *BatchCreateSessionsRequest) MarshalJSON() ([]byte, error)

type BatchCreateSessionsResponse

type BatchCreateSessionsResponse struct {
	// Session: The freshly created sessions.
	Session []*Session `json:"session,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Session") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Session") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

BatchCreateSessionsResponse: The response for BatchCreateSessions.

func (*BatchCreateSessionsResponse) MarshalJSON

func (s *BatchCreateSessionsResponse) MarshalJSON() ([]byte, error)

type BatchWriteRequest

type BatchWriteRequest struct {
	// MutationGroups: Required. The groups of mutations to be applied.
	MutationGroups []*MutationGroup `json:"mutationGroups,omitempty"`

	// RequestOptions: Common options for this request.
	RequestOptions *RequestOptions `json:"requestOptions,omitempty"`

	// ForceSendFields is a list of field names (e.g. "MutationGroups") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "MutationGroups") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

BatchWriteRequest: The request for BatchWrite.

func (*BatchWriteRequest) MarshalJSON

func (s *BatchWriteRequest) MarshalJSON() ([]byte, error)

type BatchWriteResponse

type BatchWriteResponse struct {
	// CommitTimestamp: The commit timestamp of the transaction that applied
	// this batch. Present if `status` is `OK`, absent otherwise.
	CommitTimestamp string `json:"commitTimestamp,omitempty"`

	// Indexes: The mutation groups applied in this batch. The values index
	// into the `mutation_groups` field in the corresponding
	// `BatchWriteRequest`.
	Indexes []int64 `json:"indexes,omitempty"`

	// Status: An `OK` status indicates success. Any other status indicates
	// a failure.
	Status *Status `json:"status,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "CommitTimestamp") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "CommitTimestamp") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

BatchWriteResponse: The result of applying a batch of mutations.

func (*BatchWriteResponse) MarshalJSON

func (s *BatchWriteResponse) MarshalJSON() ([]byte, error)

type BeginTransactionRequest

type BeginTransactionRequest struct {
	// Options: Required. Options for the new transaction.
	Options *TransactionOptions `json:"options,omitempty"`

	// RequestOptions: Common options for this request. Priority is ignored
	// for this request. Setting the priority in this request_options struct
	// will not do anything. To set the priority for a transaction, set it
	// on the reads and writes that are part of this transaction instead.
	RequestOptions *RequestOptions `json:"requestOptions,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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

BeginTransactionRequest: The request for BeginTransaction.

func (*BeginTransactionRequest) MarshalJSON

func (s *BeginTransactionRequest) 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}/subject/{subject_attribute_value}`: A single identity in a
	// workforce identity pool. *
	// `principalSet://iam.googleapis.com/locations/global/workforcePools/{po
	// ol_id}/group/{group_id}`: All workforce identities in a group. *
	// `principalSet://iam.googleapis.com/locations/global/workforcePools/{po
	// ol_id}/attribute.{attribute_name}/{attribute_value}`: All workforce
	// identities with a specific attribute value. *
	// `principalSet://iam.googleapis.com/locations/global/workforcePools/{po
	// ol_id}/*`: All identities in a workforce identity pool. *
	// `principal://iam.googleapis.com/projects/{project_number}/locations/gl
	// obal/workloadIdentityPools/{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}/{at
	// tribute_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/workforcePool
	// s/{pool_id}/subject/{subject_attribute_value}`: Deleted single
	// identity in a workforce identity pool. For example,
	// `deleted:principal://iam.googleapis.com/locations/global/workforcePool
	// s/my-pool-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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

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

func (*Binding) MarshalJSON

func (s *Binding) MarshalJSON() ([]byte, error)
type ChildLink struct {
	// ChildIndex: The node to which the link points.
	ChildIndex int64 `json:"childIndex,omitempty"`

	// Type: The type of the link. For example, in Hash Joins this could be
	// used to distinguish between the build child and the probe child, or
	// in the case of the child being an output variable, to represent the
	// tag associated with the output variable.
	Type string `json:"type,omitempty"`

	// Variable: Only present if the child node is SCALAR and corresponds to
	// an output variable of the parent node. The field carries the name of
	// the output variable. For example, a `TableScan` operator that reads
	// rows from a table will have child links to the `SCALAR` nodes
	// representing the output variables created for each column that is
	// read by the operator. The corresponding `variable` fields will be set
	// to the variable names assigned to the columns.
	Variable string `json:"variable,omitempty"`

	// ForceSendFields is a list of field names (e.g. "ChildIndex") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ChildIndex") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ChildLink: Metadata associated with a parent-child relationship appearing in a PlanNode.

func (*ChildLink) MarshalJSON

func (s *ChildLink) MarshalJSON() ([]byte, error)

type CommitRequest

type CommitRequest struct {
	// MaxCommitDelay: Optional. The amount of latency this request is
	// willing to incur in order to improve throughput. If this field is not
	// set, Spanner assumes requests are relatively latency sensitive and
	// automatically determines an appropriate delay time. You can specify a
	// batching delay value between 0 and 500 ms.
	MaxCommitDelay string `json:"maxCommitDelay,omitempty"`

	// Mutations: The mutations to be executed when this transaction
	// commits. All mutations are applied atomically, in the order they
	// appear in this list.
	Mutations []*Mutation `json:"mutations,omitempty"`

	// RequestOptions: Common options for this request.
	RequestOptions *RequestOptions `json:"requestOptions,omitempty"`

	// ReturnCommitStats: If `true`, then statistics related to the
	// transaction will be included in the CommitResponse. Default value is
	// `false`.
	ReturnCommitStats bool `json:"returnCommitStats,omitempty"`

	// SingleUseTransaction: Execute mutations in a temporary transaction.
	// Note that unlike commit of a previously-started transaction, commit
	// with a temporary transaction is non-idempotent. That is, if the
	// `CommitRequest` is sent to Cloud Spanner more than once (for
	// instance, due to retries in the application, or in the transport
	// library), it is possible that the mutations are executed more than
	// once. If this is undesirable, use BeginTransaction and Commit
	// instead.
	SingleUseTransaction *TransactionOptions `json:"singleUseTransaction,omitempty"`

	// TransactionId: Commit a previously-started transaction.
	TransactionId string `json:"transactionId,omitempty"`

	// ForceSendFields is a list of field names (e.g. "MaxCommitDelay") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "MaxCommitDelay") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

CommitRequest: The request for Commit.

func (*CommitRequest) MarshalJSON

func (s *CommitRequest) MarshalJSON() ([]byte, error)

type CommitResponse

type CommitResponse struct {
	// CommitStats: The statistics about this Commit. Not returned by
	// default. For more information, see CommitRequest.return_commit_stats.
	CommitStats *CommitStats `json:"commitStats,omitempty"`

	// CommitTimestamp: The Cloud Spanner timestamp at which the transaction
	// committed.
	CommitTimestamp string `json:"commitTimestamp,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "CommitStats") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "CommitStats") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

CommitResponse: The response for Commit.

func (*CommitResponse) MarshalJSON

func (s *CommitResponse) MarshalJSON() ([]byte, error)

type CommitStats

type CommitStats struct {
	// MutationCount: The total number of mutations for the transaction.
	// Knowing the `mutation_count` value can help you maximize the number
	// of mutations in a transaction and minimize the number of API round
	// trips. You can also monitor this value to prevent transactions from
	// exceeding the system limit
	// (https://cloud.google.com/spanner/quotas#limits_for_creating_reading_updating_and_deleting_data).
	// If the number of mutations exceeds the limit, the server returns
	// INVALID_ARGUMENT
	// (https://cloud.google.com/spanner/docs/reference/rest/v1/Code#ENUM_VALUES.INVALID_ARGUMENT).
	MutationCount int64 `json:"mutationCount,omitempty,string"`

	// ForceSendFields is a list of field names (e.g. "MutationCount") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "MutationCount") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

CommitStats: Additional statistics about a commit.

func (*CommitStats) MarshalJSON

func (s *CommitStats) MarshalJSON() ([]byte, error)

type ContextValue

type ContextValue struct {
	// Label: The label for the context value. e.g. "latency".
	Label *LocalizedString `json:"label,omitempty"`

	// Severity: The severity of this context.
	//
	// Possible values:
	//   "SEVERITY_UNSPECIFIED" - Required default value.
	//   "INFO" - Lowest severity level "Info".
	//   "WARNING" - Middle severity level "Warning".
	//   "ERROR" - Severity level signaling an error "Error"
	//   "FATAL" - Severity level signaling a non recoverable error "Fatal"
	Severity string `json:"severity,omitempty"`

	// Unit: The unit of the context value.
	Unit string `json:"unit,omitempty"`

	// Value: The value for the context.
	Value float64 `json:"value,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Label") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Label") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ContextValue: A message representing context for a KeyRangeInfo, including a label, value, unit, and severity.

func (*ContextValue) MarshalJSON

func (s *ContextValue) MarshalJSON() ([]byte, error)

func (*ContextValue) UnmarshalJSON

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

type CopyBackupEncryptionConfig

type CopyBackupEncryptionConfig struct {
	// EncryptionType: Required. The encryption type of the backup.
	//
	// Possible values:
	//   "ENCRYPTION_TYPE_UNSPECIFIED" - Unspecified. Do not use.
	//   "USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION" - This is the default
	// option for CopyBackup when encryption_config is not specified. For
	// example, if the source backup is using `Customer_Managed_Encryption`,
	// the backup will be using the same Cloud KMS key as the source backup.
	//   "GOOGLE_DEFAULT_ENCRYPTION" - Use Google default encryption.
	//   "CUSTOMER_MANAGED_ENCRYPTION" - Use customer managed encryption. If
	// specified, either `kms_key_name` or `kms_key_names` must contain
	// valid Cloud KMS key(s).
	EncryptionType string `json:"encryptionType,omitempty"`

	// KmsKeyName: Optional. The Cloud KMS key that will be used to protect
	// the backup. This field should be set only when encryption_type is
	// `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form
	// `projects//locations//keyRings//cryptoKeys/`.
	KmsKeyName string `json:"kmsKeyName,omitempty"`

	// ForceSendFields is a list of field names (e.g. "EncryptionType") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "EncryptionType") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

CopyBackupEncryptionConfig: Encryption configuration for the copied backup.

func (*CopyBackupEncryptionConfig) MarshalJSON

func (s *CopyBackupEncryptionConfig) MarshalJSON() ([]byte, error)

type CopyBackupMetadata

type CopyBackupMetadata struct {
	// CancelTime: The time at which cancellation of CopyBackup operation
	// was received. Operations.CancelOperation starts asynchronous
	// cancellation on a long-running operation. The server makes a best
	// effort to cancel the operation, but success is not guaranteed.
	// Clients can use Operations.GetOperation or other methods to check
	// whether the cancellation succeeded or whether the operation completed
	// despite cancellation. On successful cancellation, the operation is
	// not deleted; instead, it becomes an operation with an Operation.error
	// value with a google.rpc.Status.code of 1, corresponding to
	// `Code.CANCELLED`.
	CancelTime string `json:"cancelTime,omitempty"`

	// Name: The name of the backup being created through the copy
	// operation. Values are of the form `projects//instances//backups/`.
	Name string `json:"name,omitempty"`

	// Progress: The progress of the CopyBackup operation.
	Progress *OperationProgress `json:"progress,omitempty"`

	// SourceBackup: The name of the source backup that is being copied.
	// Values are of the form `projects//instances//backups/`.
	SourceBackup string `json:"sourceBackup,omitempty"`

	// ForceSendFields is a list of field names (e.g. "CancelTime") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "CancelTime") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

CopyBackupMetadata: Metadata type for the operation returned by CopyBackup.

func (*CopyBackupMetadata) MarshalJSON

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

type CopyBackupRequest

type CopyBackupRequest struct {
	// BackupId: Required. The id of the backup copy. The `backup_id`
	// appended to `parent` forms the full backup_uri of the form
	// `projects//instances//backups/`.
	BackupId string `json:"backupId,omitempty"`

	// EncryptionConfig: Optional. The encryption configuration used to
	// encrypt the backup. If this field is not specified, the backup will
	// use the same encryption configuration as the source backup by
	// default, namely encryption_type =
	// `USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION`.
	EncryptionConfig *CopyBackupEncryptionConfig `json:"encryptionConfig,omitempty"`

	// ExpireTime: Required. The expiration time of the backup in
	// microsecond granularity. The expiration time must be at least 6 hours
	// and at most 366 days from the `create_time` of the source backup.
	// Once the `expire_time` has passed, the backup is eligible to be
	// automatically deleted by Cloud Spanner to free the resources used by
	// the backup.
	ExpireTime string `json:"expireTime,omitempty"`

	// SourceBackup: Required. The source backup to be copied. The source
	// backup needs to be in READY state for it to be copied. 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//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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

CopyBackupRequest: The request for CopyBackup.

func (*CopyBackupRequest) MarshalJSON

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

type CreateBackupMetadata

type CreateBackupMetadata struct {
	// CancelTime: The time at which cancellation of this operation was
	// received. Operations.CancelOperation starts asynchronous cancellation
	// on a long-running operation. The server makes a best effort to cancel
	// the operation, but success is not guaranteed. Clients can use
	// Operations.GetOperation or other methods to check whether the
	// cancellation succeeded or whether the operation completed despite
	// cancellation. On successful cancellation, the operation is not
	// deleted; instead, it becomes an operation with an Operation.error
	// value with a google.rpc.Status.code of 1, corresponding to
	// `Code.CANCELLED`.
	CancelTime string `json:"cancelTime,omitempty"`

	// Database: The name of the database the backup is created from.
	Database string `json:"database,omitempty"`

	// Name: The name of the backup being created.
	Name string `json:"name,omitempty"`

	// Progress: The progress of the CreateBackup operation.
	Progress *OperationProgress `json:"progress,omitempty"`

	// ForceSendFields is a list of field names (e.g. "CancelTime") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "CancelTime") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

CreateBackupMetadata: Metadata type for the operation returned by CreateBackup.

func (*CreateBackupMetadata) MarshalJSON

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

type CreateDatabaseMetadata

type CreateDatabaseMetadata struct {
	// Database: The database being created.
	Database string `json:"database,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Database") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Database") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

CreateDatabaseMetadata: Metadata type for the operation returned by CreateDatabase.

func (*CreateDatabaseMetadata) MarshalJSON

func (s *CreateDatabaseMetadata) MarshalJSON() ([]byte, error)

type CreateDatabaseRequest

type CreateDatabaseRequest struct {
	// CreateStatement: Required. A `CREATE DATABASE` statement, which
	// specifies the ID of the new database. The database ID must conform to
	// the regular expression `a-z*[a-z0-9]` and be between 2 and 30
	// characters in length. If the database ID is a reserved word or if it
	// contains a hyphen, the database ID must be enclosed in backticks (“
	// ` “).
	CreateStatement string `json:"createStatement,omitempty"`

	// DatabaseDialect: Optional. The dialect of the Cloud Spanner Database.
	//
	// Possible values:
	//   "DATABASE_DIALECT_UNSPECIFIED" - Default value. This value will
	// create a database with the GOOGLE_STANDARD_SQL dialect.
	//   "GOOGLE_STANDARD_SQL" - GoogleSQL supported SQL.
	//   "POSTGRESQL" - PostgreSQL supported SQL.
	DatabaseDialect string `json:"databaseDialect,omitempty"`

	// EncryptionConfig: Optional. The encryption configuration for the
	// database. If this field is not specified, Cloud Spanner will
	// encrypt/decrypt all data at rest using Google default encryption.
	EncryptionConfig *EncryptionConfig `json:"encryptionConfig,omitempty"`

	// ExtraStatements: Optional. A list of DDL statements to run inside the
	// newly created database. Statements can create tables, indexes, etc.
	// These statements execute atomically with the creation of the
	// database: if there is an error in any statement, the database is not
	// created.
	ExtraStatements []string `json:"extraStatements,omitempty"`

	// ProtoDescriptors: Optional. Proto descriptors used by CREATE/ALTER
	// PROTO BUNDLE statements in 'extra_statements' above. Contains a
	// protobuf-serialized google.protobuf.FileDescriptorSet
	// (https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/descriptor.proto).
	// To generate it, install (https://grpc.io/docs/protoc-installation/)
	// and run `protoc` with --include_imports and --descriptor_set_out. For
	// example, to generate for moon/shot/app.proto, run “` $protoc
	// --proto_path=/app_path --proto_path=/lib_path \ --include_imports \
	// --descriptor_set_out=descriptors.data \ moon/shot/app.proto “` For
	// more details, see protobuffer self description
	// (https://developers.google.com/protocol-buffers/docs/techniques#self-description).
	ProtoDescriptors string `json:"protoDescriptors,omitempty"`

	// ForceSendFields is a list of field names (e.g. "CreateStatement") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "CreateStatement") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

CreateDatabaseRequest: The request for CreateDatabase.

func (*CreateDatabaseRequest) MarshalJSON

func (s *CreateDatabaseRequest) MarshalJSON() ([]byte, error)

type CreateInstanceConfigMetadata

type CreateInstanceConfigMetadata struct {
	// CancelTime: The time at which this operation was cancelled.
	CancelTime string `json:"cancelTime,omitempty"`

	// InstanceConfig: The target instance config end state.
	InstanceConfig *InstanceConfig `json:"instanceConfig,omitempty"`

	// Progress: The progress of the CreateInstanceConfig operation.
	Progress *InstanceOperationProgress `json:"progress,omitempty"`

	// ForceSendFields is a list of field names (e.g. "CancelTime") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "CancelTime") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

CreateInstanceConfigMetadata: Metadata type for the operation returned by CreateInstanceConfig.

func (*CreateInstanceConfigMetadata) MarshalJSON

func (s *CreateInstanceConfigMetadata) MarshalJSON() ([]byte, error)

type CreateInstanceConfigRequest

type CreateInstanceConfigRequest struct {
	// InstanceConfig: Required. The InstanceConfig proto of the
	// configuration to create. instance_config.name must be
	// `/instanceConfigs/`. instance_config.base_config must be a Google
	// managed configuration name, e.g. /instanceConfigs/us-east1,
	// /instanceConfigs/nam3.
	InstanceConfig *InstanceConfig `json:"instanceConfig,omitempty"`

	// InstanceConfigId: Required. The ID of the instance config to create.
	// Valid identifiers are of the form `custom-[-a-z0-9]*[a-z0-9]` and
	// must be between 2 and 64 characters in length. The `custom-` prefix
	// is required to avoid name conflicts with Google managed
	// configurations.
	InstanceConfigId string `json:"instanceConfigId,omitempty"`

	// ValidateOnly: An option to validate, but not actually execute, a
	// request, and provide the same response.
	ValidateOnly bool `json:"validateOnly,omitempty"`

	// ForceSendFields is a list of field names (e.g. "InstanceConfig") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "InstanceConfig") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

CreateInstanceConfigRequest: The request for CreateInstanceConfigRequest.

func (*CreateInstanceConfigRequest) MarshalJSON

func (s *CreateInstanceConfigRequest) MarshalJSON() ([]byte, error)

type CreateInstanceMetadata

type CreateInstanceMetadata struct {
	// CancelTime: The time at which this operation was cancelled. If set,
	// this operation is in the process of undoing itself (which is
	// guaranteed to succeed) and cannot be cancelled again.
	CancelTime string `json:"cancelTime,omitempty"`

	// EndTime: The time at which this operation failed or was completed
	// successfully.
	EndTime string `json:"endTime,omitempty"`

	// ExpectedFulfillmentPeriod: The expected fulfillment period of this
	// create operation.
	//
	// Possible values:
	//   "FULFILLMENT_PERIOD_UNSPECIFIED" - Not specified.
	//   "FULFILLMENT_PERIOD_NORMAL" - Normal fulfillment period. The
	// operation is expected to complete within minutes.
	//   "FULFILLMENT_PERIOD_EXTENDED" - Extended fulfillment period. It can
	// take up to an hour for the operation to complete.
	ExpectedFulfillmentPeriod string `json:"expectedFulfillmentPeriod,omitempty"`

	// Instance: The instance being created.
	Instance *Instance `json:"instance,omitempty"`

	// StartTime: The time at which the CreateInstance request was received.
	StartTime string `json:"startTime,omitempty"`

	// ForceSendFields is a list of field names (e.g. "CancelTime") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "CancelTime") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

CreateInstanceMetadata: Metadata type for the operation returned by CreateInstance.

func (*CreateInstanceMetadata) MarshalJSON

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

type CreateInstanceRequest

type CreateInstanceRequest struct {
	// Instance: Required. The instance to create. The name may be omitted,
	// but if specified must be `/instances/`.
	Instance *Instance `json:"instance,omitempty"`

	// InstanceId: Required. The ID of the instance to create. Valid
	// identifiers are of the form `a-z*[a-z0-9]` and must be between 2 and
	// 64 characters in length.
	InstanceId string `json:"instanceId,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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

CreateInstanceRequest: The request for CreateInstance.

func (*CreateInstanceRequest) MarshalJSON

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

type CreateSessionRequest

type CreateSessionRequest struct {
	// Session: Required. The session to create.
	Session *Session `json:"session,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Session") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Session") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

CreateSessionRequest: The request for CreateSession.

func (*CreateSessionRequest) MarshalJSON

func (s *CreateSessionRequest) MarshalJSON() ([]byte, error)

type Database

type Database struct {
	// CreateTime: Output only. If exists, the time at which the database
	// creation started.
	CreateTime string `json:"createTime,omitempty"`

	// DatabaseDialect: Output only. The dialect of the Cloud Spanner
	// Database.
	//
	// Possible values:
	//   "DATABASE_DIALECT_UNSPECIFIED" - Default value. This value will
	// create a database with the GOOGLE_STANDARD_SQL dialect.
	//   "GOOGLE_STANDARD_SQL" - GoogleSQL supported SQL.
	//   "POSTGRESQL" - PostgreSQL supported SQL.
	DatabaseDialect string `json:"databaseDialect,omitempty"`

	// DefaultLeader: Output only. The read-write region which contains the
	// database's leader replicas. This is the same as the value of
	// default_leader database option set using DatabaseAdmin.CreateDatabase
	// or DatabaseAdmin.UpdateDatabaseDdl. If not explicitly set, this is
	// empty.
	DefaultLeader string `json:"defaultLeader,omitempty"`

	// EarliestVersionTime: Output only. Earliest timestamp at which older
	// versions of the data can be read. This value is continuously updated
	// by Cloud Spanner and becomes stale the moment it is queried. If you
	// are using this value to recover data, make sure to account for the
	// time from the moment when the value is queried to the moment when you
	// initiate the recovery.
	EarliestVersionTime string `json:"earliestVersionTime,omitempty"`

	// EnableDropProtection: Whether drop protection is enabled for this
	// database. Defaults to false, if not set. For more details, please see
	// how to prevent accidental database deletion
	// (https://cloud.google.com/spanner/docs/prevent-database-deletion).
	EnableDropProtection bool `json:"enableDropProtection,omitempty"`

	// EncryptionConfig: Output only. For databases that are using customer
	// managed encryption, this field contains the encryption configuration
	// for the database. For databases that are using Google default or
	// other types of encryption, this field is empty.
	EncryptionConfig *EncryptionConfig `json:"encryptionConfig,omitempty"`

	// EncryptionInfo: Output only. For databases that are using customer
	// managed encryption, this field contains the encryption information
	// for the database, such as all Cloud KMS key versions that are in use.
	// The `encryption_status' field inside of each `EncryptionInfo` is not
	// populated. For databases that are using Google default or other types
	// of encryption, this field is empty. This field is propagated lazily
	// from the backend. There might be a delay from when a key version is
	// being used and when it appears in this field.
	EncryptionInfo []*EncryptionInfo `json:"encryptionInfo,omitempty"`

	// Name: Required. The name of the database. Values are of the form
	// `projects//instances//databases/`, where “ is as specified in the
	// `CREATE DATABASE` statement. This name can be passed to other API
	// methods to identify the database.
	Name string `json:"name,omitempty"`

	// Reconciling: Output only. If true, the database is being updated. If
	// false, there are no ongoing update operations for the database.
	Reconciling bool `json:"reconciling,omitempty"`

	// RestoreInfo: Output only. Applicable only for restored databases.
	// Contains information about the restore source.
	RestoreInfo *RestoreInfo `json:"restoreInfo,omitempty"`

	// State: Output only. The current database state.
	//
	// Possible values:
	//   "STATE_UNSPECIFIED" - Not specified.
	//   "CREATING" - The database is still being created. Operations on the
	// database may fail with `FAILED_PRECONDITION` in this state.
	//   "READY" - The database is fully created and ready for use.
	//   "READY_OPTIMIZING" - The database is fully created and ready for
	// use, but is still being optimized for performance and cannot handle
	// full load. In this state, the database still references the backup it
	// was restore from, preventing the backup from being deleted. When
	// optimizations are complete, the full performance of the database will
	// be restored, and the database will transition to `READY` state.
	State string `json:"state,omitempty"`

	// VersionRetentionPeriod: Output only. The period in which Cloud
	// Spanner retains all versions of data for the database. This is the
	// same as the value of version_retention_period database option set
	// using UpdateDatabaseDdl. Defaults to 1 hour, if not set.
	VersionRetentionPeriod string `json:"versionRetentionPeriod,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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Database: A Cloud Spanner database.

func (*Database) MarshalJSON

func (s *Database) MarshalJSON() ([]byte, error)

type DatabaseRole

type DatabaseRole struct {
	// Name: Required. The name of the database role. Values are of the form
	// `projects//instances//databases//databaseRoles/` where “ is as
	// specified in the `CREATE ROLE` DDL statement.
	Name string `json:"name,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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

DatabaseRole: A Cloud Spanner database role.

func (*DatabaseRole) MarshalJSON

func (s *DatabaseRole) MarshalJSON() ([]byte, error)

type DdlStatementActionInfo

type DdlStatementActionInfo struct {
	// Action: The action for the DDL statement, e.g. CREATE, ALTER, DROP,
	// GRANT, etc. This field is a non-empty string.
	Action string `json:"action,omitempty"`

	// EntityNames: The entity name(s) being operated on the DDL statement.
	// E.g. 1. For statement "CREATE TABLE t1(...)", `entity_names` =
	// ["t1"]. 2. For statement "GRANT ROLE r1, r2 ...", `entity_names` =
	// ["r1", "r2"]. 3. For statement "ANALYZE", `entity_names` = [].
	EntityNames []string `json:"entityNames,omitempty"`

	// EntityType: The entity type for the DDL statement, e.g. TABLE, INDEX,
	// VIEW, etc. This field can be empty string for some DDL statement,
	// e.g. for statement "ANALYZE", `entity_type` = "".
	EntityType string `json:"entityType,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Action") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Action") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

DdlStatementActionInfo: Action information extracted from a DDL statement. This proto is used to display the brief info of the DDL statement for the operation UpdateDatabaseDdl.

func (*DdlStatementActionInfo) MarshalJSON

func (s *DdlStatementActionInfo) MarshalJSON() ([]byte, error)

type Delete

type Delete struct {
	// KeySet: Required. The primary keys of the rows within table to
	// delete. The primary keys must be specified in the order in which they
	// appear in the `PRIMARY KEY()` clause of the table's equivalent DDL
	// statement (the DDL statement used to create the table). Delete is
	// idempotent. The transaction will succeed even if some or all rows do
	// not exist.
	KeySet *KeySet `json:"keySet,omitempty"`

	// Table: Required. The table whose rows will be deleted.
	Table string `json:"table,omitempty"`

	// ForceSendFields is a list of field names (e.g. "KeySet") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "KeySet") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Delete: Arguments to delete operations.

func (*Delete) MarshalJSON

func (s *Delete) MarshalJSON() ([]byte, error)

type DerivedMetric

type DerivedMetric struct {
	// Denominator: The name of the denominator metric. e.g. "rows".
	Denominator *LocalizedString `json:"denominator,omitempty"`

	// Numerator: The name of the numerator metric. e.g. "latency".
	Numerator *LocalizedString `json:"numerator,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Denominator") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Denominator") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

DerivedMetric: A message representing a derived metric.

func (*DerivedMetric) MarshalJSON

func (s *DerivedMetric) MarshalJSON() ([]byte, error)

type DiagnosticMessage

type DiagnosticMessage struct {
	// Info: Information about this diagnostic information.
	Info *LocalizedString `json:"info,omitempty"`

	// Metric: The metric.
	Metric *LocalizedString `json:"metric,omitempty"`

	// MetricSpecific: Whether this message is specific only for the current
	// metric. By default Diagnostics are shown for all metrics, regardless
	// which metric is the currently selected metric in the UI. However
	// occasionally a metric will generate so many messages that the
	// resulting visual clutter becomes overwhelming. In this case setting
	// this to true, will show the diagnostic messages for that metric only
	// if it is the currently selected metric.
	MetricSpecific bool `json:"metricSpecific,omitempty"`

	// Severity: The severity of the diagnostic message.
	//
	// Possible values:
	//   "SEVERITY_UNSPECIFIED" - Required default value.
	//   "INFO" - Lowest severity level "Info".
	//   "WARNING" - Middle severity level "Warning".
	//   "ERROR" - Severity level signaling an error "Error"
	//   "FATAL" - Severity level signaling a non recoverable error "Fatal"
	Severity string `json:"severity,omitempty"`

	// ShortMessage: The short message.
	ShortMessage *LocalizedString `json:"shortMessage,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Info") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Info") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

DiagnosticMessage: A message representing the key visualizer diagnostic messages.

func (*DiagnosticMessage) MarshalJSON

func (s *DiagnosticMessage) MarshalJSON() ([]byte, error)

type DirectedReadOptions

type DirectedReadOptions struct {
	// ExcludeReplicas: Exclude_replicas indicates that specified replicas
	// should be excluded from serving requests. Spanner will not route
	// requests to the replicas in this list.
	ExcludeReplicas *ExcludeReplicas `json:"excludeReplicas,omitempty"`

	// IncludeReplicas: Include_replicas indicates the order of replicas (as
	// they appear in this list) to process the request. If
	// auto_failover_disabled is set to true and all replicas are exhausted
	// without finding a healthy replica, Spanner will wait for a replica in
	// the list to become available, requests may fail due to
	// `DEADLINE_EXCEEDED` errors.
	IncludeReplicas *IncludeReplicas `json:"includeReplicas,omitempty"`

	// ForceSendFields is a list of field names (e.g. "ExcludeReplicas") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ExcludeReplicas") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

DirectedReadOptions: The DirectedReadOptions can be used to indicate which replicas or regions should be used for non-transactional reads or queries. DirectedReadOptions may only be specified for a read-only transaction, otherwise the API will return an `INVALID_ARGUMENT` error.

func (*DirectedReadOptions) MarshalJSON

func (s *DirectedReadOptions) 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

type EncryptionConfig struct {
	// KmsKeyName: The Cloud KMS key to be used for encrypting and
	// decrypting the database. Values are of the form
	// `projects//locations//keyRings//cryptoKeys/`.
	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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

EncryptionConfig: Encryption configuration for a Cloud Spanner database.

func (*EncryptionConfig) MarshalJSON

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

type EncryptionInfo

type EncryptionInfo struct {
	// EncryptionStatus: Output only. If present, the status of a recent
	// encrypt/decrypt call on underlying data for this database or backup.
	// Regardless of status, data is always encrypted at rest.
	EncryptionStatus *Status `json:"encryptionStatus,omitempty"`

	// EncryptionType: Output only. The type of encryption.
	//
	// Possible values:
	//   "TYPE_UNSPECIFIED" - Encryption type was not specified, though data
	// at rest remains encrypted.
	//   "GOOGLE_DEFAULT_ENCRYPTION" - The data 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 is encrypted at rest with
	// a key that is managed by the customer. The active version of the key.
	// `kms_key_version` will be populated, and `encryption_status` may be
	// populated.
	EncryptionType string `json:"encryptionType,omitempty"`

	// KmsKeyVersion: Output only. A Cloud KMS key version that is being
	// used to protect the database or backup.
	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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

EncryptionInfo: Encryption information for a Cloud Spanner database or backup.

func (*EncryptionInfo) MarshalJSON

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

type ExcludeReplicas

type ExcludeReplicas struct {
	// ReplicaSelections: The directed read replica selector.
	ReplicaSelections []*ReplicaSelection `json:"replicaSelections,omitempty"`

	// ForceSendFields is a list of field names (e.g. "ReplicaSelections")
	// to unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ReplicaSelections") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

ExcludeReplicas: An ExcludeReplicas contains a repeated set of ReplicaSelection that should be excluded from serving requests.

func (*ExcludeReplicas) MarshalJSON

func (s *ExcludeReplicas) MarshalJSON() ([]byte, error)

type ExecuteBatchDmlRequest

type ExecuteBatchDmlRequest struct {
	// RequestOptions: Common options for this request.
	RequestOptions *RequestOptions `json:"requestOptions,omitempty"`

	// Seqno: Required. A per-transaction sequence number used to identify
	// this request. This field makes each request idempotent such that if
	// the request is received multiple times, at most one will succeed. The
	// sequence number must be monotonically increasing within the
	// transaction. If a request arrives for the first time with an
	// out-of-order sequence number, the transaction may be aborted. Replays
	// of previously handled requests will yield the same response as the
	// first execution.
	Seqno int64 `json:"seqno,omitempty,string"`

	// Statements: Required. The list of statements to execute in this
	// batch. Statements are executed serially, such that the effects of
	// statement `i` are visible to statement `i+1`. Each statement must be
	// a DML statement. Execution stops at the first failed statement; the
	// remaining statements are not executed. Callers must provide at least
	// one statement.
	Statements []*Statement `json:"statements,omitempty"`

	// Transaction: Required. The transaction to use. Must be a read-write
	// transaction. To protect against replays, single-use transactions are
	// not supported. The caller must either supply an existing transaction
	// ID or begin a new transaction.
	Transaction *TransactionSelector `json:"transaction,omitempty"`

	// ForceSendFields is a list of field names (e.g. "RequestOptions") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "RequestOptions") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

ExecuteBatchDmlRequest: The request for ExecuteBatchDml.

func (*ExecuteBatchDmlRequest) MarshalJSON

func (s *ExecuteBatchDmlRequest) MarshalJSON() ([]byte, error)

type ExecuteBatchDmlResponse

type ExecuteBatchDmlResponse struct {
	// ResultSets: One ResultSet for each statement in the request that ran
	// successfully, in the same order as the statements in the request.
	// Each ResultSet does not contain any rows. The ResultSetStats in each
	// ResultSet contain the number of rows modified by the statement. Only
	// the first ResultSet in the response contains valid ResultSetMetadata.
	ResultSets []*ResultSet `json:"resultSets,omitempty"`

	// Status: If all DML statements are executed successfully, the status
	// is `OK`. Otherwise, the error status of the first failed statement.
	Status *Status `json:"status,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "ResultSets") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ResultSets") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ExecuteBatchDmlResponse: The response for ExecuteBatchDml. Contains a list of ResultSet messages, one for each DML statement that has successfully executed, in the same order as the statements in the request. If a statement fails, the status in the response body identifies the cause of the failure. To check for DML statements that failed, use the following approach: 1. Check the status in the response message. The google.rpc.Code enum value `OK` indicates that all statements were executed successfully. 2. If the status was not `OK`, check the number of result sets in the response. If the response contains `N` ResultSet messages, then statement `N+1` in the request failed. Example 1: * Request: 5 DML statements, all executed successfully. * Response: 5 ResultSet messages, with the status `OK`. Example 2: * Request: 5 DML statements. The third statement has a syntax error. * Response: 2 ResultSet messages, and a syntax error (`INVALID_ARGUMENT`) status. The number of ResultSet messages indicates that the third statement failed, and the fourth and fifth statements were not executed.

func (*ExecuteBatchDmlResponse) MarshalJSON

func (s *ExecuteBatchDmlResponse) MarshalJSON() ([]byte, error)

type ExecuteSqlRequest

type ExecuteSqlRequest struct {
	// DataBoostEnabled: If this is for a partitioned query and this field
	// is set to `true`, the request is executed with Spanner Data Boost
	// independent compute resources. If the field is set to `true` but the
	// request does not set `partition_token`, the API returns an
	// `INVALID_ARGUMENT` error.
	DataBoostEnabled bool `json:"dataBoostEnabled,omitempty"`

	// DirectedReadOptions: Directed read options for this request.
	DirectedReadOptions *DirectedReadOptions `json:"directedReadOptions,omitempty"`

	// ParamTypes: It is not always possible for Cloud Spanner to infer the
	// right SQL type from a JSON value. For example, values of type `BYTES`
	// and values of type `STRING` both appear in params as JSON strings. In
	// these cases, `param_types` can be used to specify the exact SQL type
	// for some or all of the SQL statement parameters. See the definition
	// of Type for more information about SQL types.
	ParamTypes map[string]Type `json:"paramTypes,omitempty"`

	// Params: Parameter names and values that bind to placeholders in the
	// SQL string. A parameter placeholder consists of the `@` character
	// followed by the parameter name (for example, `@firstName`). Parameter
	// names must conform to the naming requirements of identifiers as
	// specified at
	// https://cloud.google.com/spanner/docs/lexical#identifiers. Parameters
	// can appear anywhere that a literal value is expected. The same
	// parameter name can be used more than once, for example: "WHERE id >
	// @msg_id AND id < @msg_id + 100" It is an error to execute a SQL
	// statement with unbound parameters.
	Params googleapi.RawMessage `json:"params,omitempty"`

	// PartitionToken: If present, results will be restricted to the
	// specified partition previously created using PartitionQuery(). There
	// must be an exact match for the values of fields common to this
	// message and the PartitionQueryRequest message used to create this
	// partition_token.
	PartitionToken string `json:"partitionToken,omitempty"`

	// QueryMode: Used to control the amount of debugging information
	// returned in ResultSetStats. If partition_token is set, query_mode can
	// only be set to QueryMode.NORMAL.
	//
	// Possible values:
	//   "NORMAL" - The default mode. Only the statement results are
	// returned.
	//   "PLAN" - This mode returns only the query plan, without any results
	// or execution statistics information.
	//   "PROFILE" - This mode returns both the query plan and the execution
	// statistics along with the results.
	QueryMode string `json:"queryMode,omitempty"`

	// QueryOptions: Query optimizer configuration to use for the given
	// query.
	QueryOptions *QueryOptions `json:"queryOptions,omitempty"`

	// RequestOptions: Common options for this request.
	RequestOptions *RequestOptions `json:"requestOptions,omitempty"`

	// ResumeToken: If this request is resuming a previously interrupted SQL
	// statement execution, `resume_token` should be copied from the last
	// PartialResultSet yielded before the interruption. Doing this enables
	// the new SQL statement execution to resume where the last one left
	// off. The rest of the request parameters must exactly match the
	// request that yielded this token.
	ResumeToken string `json:"resumeToken,omitempty"`

	// Seqno: A per-transaction sequence number used to identify this
	// request. This field makes each request idempotent such that if the
	// request is received multiple times, at most one will succeed. The
	// sequence number must be monotonically increasing within the
	// transaction. If a request arrives for the first time with an
	// out-of-order sequence number, the transaction may be aborted. Replays
	// of previously handled requests will yield the same response as the
	// first execution. Required for DML statements. Ignored for queries.
	Seqno int64 `json:"seqno,omitempty,string"`

	// Sql: Required. The SQL string.
	Sql string `json:"sql,omitempty"`

	// Transaction: The transaction to use. For queries, if none is
	// provided, the default is a temporary read-only transaction with
	// strong concurrency. Standard DML statements require a read-write
	// transaction. To protect against replays, single-use transactions are
	// not supported. The caller must either supply an existing transaction
	// ID or begin a new transaction. Partitioned DML requires an existing
	// Partitioned DML transaction ID.
	Transaction *TransactionSelector `json:"transaction,omitempty"`

	// ForceSendFields is a list of field names (e.g. "DataBoostEnabled") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "DataBoostEnabled") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

ExecuteSqlRequest: The request for ExecuteSql and ExecuteStreamingSql.

func (*ExecuteSqlRequest) MarshalJSON

func (s *ExecuteSqlRequest) 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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	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 Field

type Field struct {
	// Name: The name of the field. For reads, this is the column name. For
	// SQL queries, it is the column alias (e.g., "Word" in the query
	// "SELECT 'hello' AS Word"), or the column name (e.g., "ColName" in
	// the query "SELECT ColName FROM Table"). Some columns might have an
	// empty name (e.g., "SELECT UPPER(ColName)"). Note that a query
	// result can contain multiple fields with the same name.
	Name string `json:"name,omitempty"`

	// Type: The type of the field.
	Type *Type `json:"type,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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Field: Message representing a single field of a struct.

func (*Field) MarshalJSON

func (s *Field) MarshalJSON() ([]byte, error)

type FreeInstanceMetadata

type FreeInstanceMetadata struct {
	// ExpireBehavior: Specifies the expiration behavior of a free instance.
	// The default of ExpireBehavior is `REMOVE_AFTER_GRACE_PERIOD`. This
	// can be modified during or after creation, and before expiration.
	//
	// Possible values:
	//   "EXPIRE_BEHAVIOR_UNSPECIFIED" - Not specified.
	//   "FREE_TO_PROVISIONED" - When the free instance expires, upgrade the
	// instance to a provisioned instance.
	//   "REMOVE_AFTER_GRACE_PERIOD" - When the free instance expires,
	// disable the instance, and delete it after the grace period passes if
	// it has not been upgraded.
	ExpireBehavior string `json:"expireBehavior,omitempty"`

	// ExpireTime: Output only. Timestamp after which the instance will
	// either be upgraded or scheduled for deletion after a grace period.
	// ExpireBehavior is used to choose between upgrading or scheduling the
	// free instance for deletion. This timestamp is set during the creation
	// of a free instance.
	ExpireTime string `json:"expireTime,omitempty"`

	// UpgradeTime: Output only. If present, the timestamp at which the free
	// instance was upgraded to a provisioned instance.
	UpgradeTime string `json:"upgradeTime,omitempty"`

	// ForceSendFields is a list of field names (e.g. "ExpireBehavior") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ExpireBehavior") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

FreeInstanceMetadata: Free instance specific metadata that is kept even after an instance has been upgraded for tracking purposes.

func (*FreeInstanceMetadata) MarshalJSON

func (s *FreeInstanceMetadata) MarshalJSON() ([]byte, error)

type GetDatabaseDdlResponse

type GetDatabaseDdlResponse struct {
	// ProtoDescriptors: Proto descriptors stored in the database. Contains
	// a protobuf-serialized google.protobuf.FileDescriptorSet
	// (https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/descriptor.proto).
	// For more details, see protobuffer self description
	// (https://developers.google.com/protocol-buffers/docs/techniques#self-description).
	ProtoDescriptors string `json:"protoDescriptors,omitempty"`

	// Statements: A list of formatted DDL statements defining the schema of
	// the database specified in the request.
	Statements []string `json:"statements,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "ProtoDescriptors") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ProtoDescriptors") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

GetDatabaseDdlResponse: The response for GetDatabaseDdl.

func (*GetDatabaseDdlResponse) MarshalJSON

func (s *GetDatabaseDdlResponse) 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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GetIamPolicyRequest: Request message for `GetIamPolicy` method.

func (*GetIamPolicyRequest) MarshalJSON

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

type GetPolicyOptions

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. However, any non-pointer, non-interface field appearing in
	// ForceSendFields will be sent to the server regardless of whether the
	// field is empty or not. This may be used to include empty fields in
	// Patch requests.
	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. However, any
	// field with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

GetPolicyOptions: Encapsulates settings provided to GetIamPolicy.

func (*GetPolicyOptions) MarshalJSON

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

type IncludeReplicas

type IncludeReplicas struct {
	// AutoFailoverDisabled: If true, Spanner will not route requests to a
	// replica outside the include_replicas list when all of the specified
	// replicas are unavailable or unhealthy. Default value is `false`.
	AutoFailoverDisabled bool `json:"autoFailoverDisabled,omitempty"`

	// ReplicaSelections: The directed read replica selector.
	ReplicaSelections []*ReplicaSelection `json:"replicaSelections,omitempty"`

	// ForceSendFields is a list of field names (e.g.
	// "AutoFailoverDisabled") to unconditionally include in API requests.
	// By default, fields with empty or default values are omitted from API
	// requests. However, any non-pointer, non-interface field appearing in
	// ForceSendFields will be sent to the server regardless of whether the
	// field is empty or not. This may be used to include empty fields in
	// Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AutoFailoverDisabled") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

IncludeReplicas: An IncludeReplicas contains a repeated set of ReplicaSelection which indicates the order in which replicas should be considered.

func (*IncludeReplicas) MarshalJSON

func (s *IncludeReplicas) MarshalJSON() ([]byte, error)

type IndexAdvice

type IndexAdvice struct {
	// Ddl: Optional. DDL statements to add new indexes that will improve
	// the query.
	Ddl []string `json:"ddl,omitempty"`

	// ImprovementFactor: Optional. Estimated latency improvement factor.
	// For example if the query currently takes 500 ms to run and the
	// estimated latency with new indexes is 100 ms this field will be 5.
	ImprovementFactor float64 `json:"improvementFactor,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Ddl") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Ddl") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

IndexAdvice: Recommendation to add new indexes to run queries more efficiently.

func (*IndexAdvice) MarshalJSON

func (s *IndexAdvice) MarshalJSON() ([]byte, error)

func (*IndexAdvice) UnmarshalJSON

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

type IndexedHotKey

type IndexedHotKey struct {
	// SparseHotKeys: A (sparse) mapping from key bucket index to the index
	// of the specific hot row key for that key bucket. The index of the hot
	// row key can be translated to the actual row key via the
	// ScanData.VisualizationData.indexed_keys repeated field.
	SparseHotKeys map[string]int64 `json:"sparseHotKeys,omitempty"`

	// ForceSendFields is a list of field names (e.g. "SparseHotKeys") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "SparseHotKeys") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

IndexedHotKey: A message representing a (sparse) collection of hot keys for specific key buckets.

func (*IndexedHotKey) MarshalJSON

func (s *IndexedHotKey) MarshalJSON() ([]byte, error)

type IndexedKeyRangeInfos

type IndexedKeyRangeInfos struct {
	// KeyRangeInfos: A (sparse) mapping from key bucket index to the
	// KeyRangeInfos for that key bucket.
	KeyRangeInfos map[string]KeyRangeInfos `json:"keyRangeInfos,omitempty"`

	// ForceSendFields is a list of field names (e.g. "KeyRangeInfos") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "KeyRangeInfos") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

IndexedKeyRangeInfos: A message representing a (sparse) collection of KeyRangeInfos for specific key buckets.

func (*IndexedKeyRangeInfos) MarshalJSON

func (s *IndexedKeyRangeInfos) MarshalJSON() ([]byte, error)

type Instance

type Instance struct {
	// AutoscalingConfig: Optional. The autoscaling configuration.
	// Autoscaling is enabled if this field is set. When autoscaling is
	// enabled, node_count and processing_units are treated as OUTPUT_ONLY
	// fields and reflect the current compute capacity allocated to the
	// instance.
	AutoscalingConfig *AutoscalingConfig `json:"autoscalingConfig,omitempty"`

	// Config: Required. The name of the instance's configuration. Values
	// are of the form `projects//instanceConfigs/`. See also InstanceConfig
	// and ListInstanceConfigs.
	Config string `json:"config,omitempty"`

	// CreateTime: Output only. The time at which the instance was created.
	CreateTime string `json:"createTime,omitempty"`

	// DisplayName: Required. The descriptive name for this instance as it
	// appears in UIs. Must be unique per project and between 4 and 30
	// characters in length.
	DisplayName string `json:"displayName,omitempty"`

	// EndpointUris: Deprecated. This field is not populated.
	EndpointUris []string `json:"endpointUris,omitempty"`

	// FreeInstanceMetadata: Free instance metadata. Only populated for free
	// instances.
	FreeInstanceMetadata *FreeInstanceMetadata `json:"freeInstanceMetadata,omitempty"`

	// InstanceType: The `InstanceType` of the current instance.
	//
	// Possible values:
	//   "INSTANCE_TYPE_UNSPECIFIED" - Not specified.
	//   "PROVISIONED" - Provisioned instances have dedicated resources,
	// standard usage limits and support.
	//   "FREE_INSTANCE" - Free instances provide no guarantee for dedicated
	// resources, [node_count, processing_units] should be 0. They come with
	// stricter usage limits and limited support.
	InstanceType string `json:"instanceType,omitempty"`

	// Labels: Cloud Labels are a flexible and lightweight mechanism for
	// organizing cloud resources into groups that reflect a customer's
	// organizational needs and deployment strategies. Cloud Labels can be
	// used to filter collections of resources. They can be used to control
	// how resource metrics are aggregated. And they can be used as
	// arguments to policy management rules (e.g. route, firewall, load
	// balancing, etc.). * Label keys must be between 1 and 63 characters
	// long and must conform to the following regular expression:
	// `a-z{0,62}`. * Label values must be between 0 and 63 characters long
	// and must conform to the regular expression `[a-z0-9_-]{0,63}`. * No
	// more than 64 labels can be associated with a given resource. See
	// https://goo.gl/xmQnxf for more information on and examples of labels.
	// If you plan to use labels in your own code, please note that
	// additional characters may be allowed in the future. And so you are
	// advised to use an internal label representation, such as JSON, which
	// doesn't rely upon specific characters being disallowed. For example,
	// representing labels as the string: name + "_" + value would prove
	// problematic if we were to allow "_" in a future release.
	Labels map[string]string `json:"labels,omitempty"`

	// Name: Required. A unique identifier for the instance, which cannot be
	// changed after the instance is created. Values are of the form
	// `projects//instances/a-z*[a-z0-9]`. The final segment of the name
	// must be between 2 and 64 characters in length.
	Name string `json:"name,omitempty"`

	// NodeCount: The number of nodes allocated to this instance. At most
	// one of either node_count or processing_units should be present in the
	// message. Users can set the node_count field to specify the target
	// number of nodes allocated to the instance. This may be zero in API
	// responses for instances that are not yet in state `READY`. See the
	// documentation
	// (https://cloud.google.com/spanner/docs/compute-capacity) for more
	// information about nodes and processing units.
	NodeCount int64 `json:"nodeCount,omitempty"`

	// ProcessingUnits: The number of processing units allocated to this
	// instance. At most one of processing_units or node_count should be
	// present in the message. Users can set the processing_units field to
	// specify the target number of processing units allocated to the
	// instance. This may be zero in API responses for instances that are
	// not yet in state `READY`. See the documentation
	// (https://cloud.google.com/spanner/docs/compute-capacity) for more
	// information about nodes and processing units.
	ProcessingUnits int64 `json:"processingUnits,omitempty"`

	// State: Output only. The current instance state. For CreateInstance,
	// the state must be either omitted or set to `CREATING`. For
	// UpdateInstance, the state must be either omitted or set to `READY`.
	//
	// Possible values:
	//   "STATE_UNSPECIFIED" - Not specified.
	//   "CREATING" - The instance is still being created. Resources may not
	// be available yet, and operations such as database creation may not
	// work.
	//   "READY" - The instance is fully created and ready to do work such
	// as creating databases.
	State string `json:"state,omitempty"`

	// UpdateTime: Output only. The time at which the instance was most
	// recently updated.
	UpdateTime string `json:"updateTime,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "AutoscalingConfig")
	// to unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AutoscalingConfig") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

Instance: An isolated set of Cloud Spanner resources on which databases can be hosted.

func (*Instance) MarshalJSON

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

type InstanceConfig

type InstanceConfig struct {
	// BaseConfig: Base configuration name, e.g.
	// projects//instanceConfigs/nam3, based on which this configuration is
	// created. Only set for user managed configurations. `base_config` must
	// refer to a configuration of type GOOGLE_MANAGED in the same project
	// as this configuration.
	BaseConfig string `json:"baseConfig,omitempty"`

	// ConfigType: Output only. Whether this instance config is a Google or
	// User Managed Configuration.
	//
	// Possible values:
	//   "TYPE_UNSPECIFIED" - Unspecified.
	//   "GOOGLE_MANAGED" - Google managed configuration.
	//   "USER_MANAGED" - User managed configuration.
	ConfigType string `json:"configType,omitempty"`

	// DisplayName: The name of this instance configuration as it appears in
	// UIs.
	DisplayName string `json:"displayName,omitempty"`

	// Etag: etag is used for optimistic concurrency control as a way to
	// help prevent simultaneous updates of a instance config from
	// overwriting each other. It is strongly suggested that systems make
	// use of the etag in the read-modify-write cycle to perform instance
	// config updates in order to avoid race conditions: An etag is returned
	// in the response which contains instance configs, and systems are
	// expected to put that etag in the request to update instance config to
	// ensure that their change will be applied to the same version of the
	// instance config. If no etag is provided in the call to update
	// instance config, then the existing instance config is overwritten
	// blindly.
	Etag string `json:"etag,omitempty"`

	// FreeInstanceAvailability: Output only. Describes whether free
	// instances are available to be created in this instance config.
	//
	// Possible values:
	//   "FREE_INSTANCE_AVAILABILITY_UNSPECIFIED" - Not specified.
	//   "AVAILABLE" - Indicates that free instances are available to be
	// created in this instance config.
	//   "UNSUPPORTED" - Indicates that free instances are not supported in
	// this instance config.
	//   "DISABLED" - Indicates that free instances are currently not
	// available to be created in this instance config.
	//   "QUOTA_EXCEEDED" - Indicates that additional free instances cannot
	// be created in this instance config because the project has reached
	// its limit of free instances.
	FreeInstanceAvailability string `json:"freeInstanceAvailability,omitempty"`

	// Labels: Cloud Labels are a flexible and lightweight mechanism for
	// organizing cloud resources into groups that reflect a customer's
	// organizational needs and deployment strategies. Cloud Labels can be
	// used to filter collections of resources. They can be used to control
	// how resource metrics are aggregated. And they can be used as
	// arguments to policy management rules (e.g. route, firewall, load
	// balancing, etc.). * Label keys must be between 1 and 63 characters
	// long and must conform to the following regular expression:
	// `a-z{0,62}`. * Label values must be between 0 and 63 characters long
	// and must conform to the regular expression `[a-z0-9_-]{0,63}`. * No
	// more than 64 labels can be associated with a given resource. See
	// https://goo.gl/xmQnxf for more information on and examples of labels.
	// If you plan to use labels in your own code, please note that
	// additional characters may be allowed in the future. Therefore, you
	// are advised to use an internal label representation, such as JSON,
	// which doesn't rely upon specific characters being disallowed. For
	// example, representing labels as the string: name + "_" + value would
	// prove problematic if we were to allow "_" in a future release.
	Labels map[string]string `json:"labels,omitempty"`

	// LeaderOptions: Allowed values of the "default_leader" schema option
	// for databases in instances that use this instance configuration.
	LeaderOptions []string `json:"leaderOptions,omitempty"`

	// Name: A unique identifier for the instance configuration. Values are
	// of the form `projects//instanceConfigs/a-z*`.
	Name string `json:"name,omitempty"`

	// OptionalReplicas: Output only. The available optional replicas to
	// choose from for user managed configurations. Populated for Google
	// managed configurations.
	OptionalReplicas []*ReplicaInfo `json:"optionalReplicas,omitempty"`

	// Reconciling: Output only. If true, the instance config is being
	// created or updated. If false, there are no ongoing operations for the
	// instance config.
	Reconciling bool `json:"reconciling,omitempty"`

	// Replicas: The geographic placement of nodes in this instance
	// configuration and their replication properties.
	Replicas []*ReplicaInfo `json:"replicas,omitempty"`

	// State: Output only. The current instance config state. Applicable
	// only for USER_MANAGED configs.
	//
	// Possible values:
	//   "STATE_UNSPECIFIED" - Not specified.
	//   "CREATING" - The instance config is still being created.
	//   "READY" - The instance config is fully created and ready to be used
	// to create instances.
	State string `json:"state,omitempty"`

	// StorageLimitPerProcessingUnit: Output only. The storage limit in
	// bytes per processing unit.
	StorageLimitPerProcessingUnit int64 `json:"storageLimitPerProcessingUnit,omitempty,string"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "BaseConfig") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "BaseConfig") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

InstanceConfig: A possible configuration for a Cloud Spanner instance. Configurations define the geographic placement of nodes and their replication.

func (*InstanceConfig) MarshalJSON

func (s *InstanceConfig) MarshalJSON() ([]byte, error)

type InstanceOperationProgress

type InstanceOperationProgress 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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

InstanceOperationProgress: Encapsulates progress related information for a Cloud Spanner long running instance operations.

func (*InstanceOperationProgress) MarshalJSON

func (s *InstanceOperationProgress) MarshalJSON() ([]byte, error)

type KeyRange

type KeyRange struct {
	// EndClosed: If the end is closed, then the range includes all rows
	// whose first `len(end_closed)` key columns exactly match `end_closed`.
	EndClosed []interface{} `json:"endClosed,omitempty"`

	// EndOpen: If the end is open, then the range excludes rows whose first
	// `len(end_open)` key columns exactly match `end_open`.
	EndOpen []interface{} `json:"endOpen,omitempty"`

	// StartClosed: If the start is closed, then the range includes all rows
	// whose first `len(start_closed)` key columns exactly match
	// `start_closed`.
	StartClosed []interface{} `json:"startClosed,omitempty"`

	// StartOpen: If the start is open, then the range excludes rows whose
	// first `len(start_open)` key columns exactly match `start_open`.
	StartOpen []interface{} `json:"startOpen,omitempty"`

	// ForceSendFields is a list of field names (e.g. "EndClosed") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "EndClosed") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

KeyRange: KeyRange represents a range of rows in a table or index. A range has a start key and an end key. These keys can be open or closed, indicating if the range includes rows with that key. Keys are represented by lists, where the ith value in the list corresponds to the ith component of the table or index primary key. Individual values are encoded as described here. For example, consider the following table definition: CREATE TABLE UserEvents ( UserName STRING(MAX), EventDate STRING(10) ) PRIMARY KEY(UserName, EventDate); The following keys name rows in this table: "Bob", "2014-09-23" Since the `UserEvents` table's `PRIMARY KEY` clause names two columns, each `UserEvents` key has two elements; the first is the `UserName`, and the second is the `EventDate`. Key ranges with multiple components are interpreted lexicographically by component using the table or index key's declared sort order. For example, the following range returns all events for user "Bob" that occurred in the year 2015: "start_closed": ["Bob", "2015-01-01"] "end_closed": ["Bob", "2015-12-31"] Start and end keys can omit trailing key components. This affects the inclusion and exclusion of rows that exactly match the provided key components: if the key is closed, then rows that exactly match the provided components are included; if the key is open, then rows that exactly match are not included. For example, the following range includes all events for "Bob" that occurred during and after the year 2000: "start_closed": ["Bob", "2000-01-01"] "end_closed": ["Bob"] The next example retrieves all events for "Bob": "start_closed": ["Bob"] "end_closed": ["Bob"] To retrieve events before the year 2000: "start_closed": ["Bob"] "end_open": ["Bob", "2000-01-01"] The following range includes all rows in the table: "start_closed": [] "end_closed": [] This range returns all users whose `UserName` begins with any character from A to C: "start_closed": ["A"] "end_open": ["D"] This range returns all users whose `UserName` begins with B: "start_closed": ["B"] "end_open": ["C"] Key ranges honor column sort order. For example, suppose a table is defined as follows: CREATE TABLE DescendingSortedTable { Key INT64, ... ) PRIMARY KEY(Key DESC); The following range retrieves all rows with key values between 1 and 100 inclusive: "start_closed": ["100"] "end_closed": ["1"] Note that 100 is passed as the start, and 1 is passed as the end, because `Key` is a descending column in the schema.

func (*KeyRange) MarshalJSON

func (s *KeyRange) MarshalJSON() ([]byte, error)

type KeyRangeInfo

type KeyRangeInfo struct {
	// ContextValues: The list of context values for this key range.
	ContextValues []*ContextValue `json:"contextValues,omitempty"`

	// EndKeyIndex: The index of the end key in indexed_keys.
	EndKeyIndex int64 `json:"endKeyIndex,omitempty"`

	// Info: Information about this key range, for all metrics.
	Info *LocalizedString `json:"info,omitempty"`

	// KeysCount: The number of keys this range covers.
	KeysCount int64 `json:"keysCount,omitempty,string"`

	// Metric: The name of the metric. e.g. "latency".
	Metric *LocalizedString `json:"metric,omitempty"`

	// StartKeyIndex: The index of the start key in indexed_keys.
	StartKeyIndex int64 `json:"startKeyIndex,omitempty"`

	// TimeOffset: The time offset. This is the time since the start of the
	// time interval.
	TimeOffset string `json:"timeOffset,omitempty"`

	// Unit: The unit of the metric. This is an unstructured field and will
	// be mapped as is to the user.
	Unit *LocalizedString `json:"unit,omitempty"`

	// Value: The value of the metric.
	Value float64 `json:"value,omitempty"`

	// ForceSendFields is a list of field names (e.g. "ContextValues") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ContextValues") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

KeyRangeInfo: A message representing information for a key range (possibly one key).

func (*KeyRangeInfo) MarshalJSON

func (s *KeyRangeInfo) MarshalJSON() ([]byte, error)

func (*KeyRangeInfo) UnmarshalJSON

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

type KeyRangeInfos

type KeyRangeInfos struct {
	// Infos: The list individual KeyRangeInfos.
	Infos []*KeyRangeInfo `json:"infos,omitempty"`

	// TotalSize: The total size of the list of all KeyRangeInfos. This may
	// be larger than the number of repeated messages above. If that is the
	// case, this number may be used to determine how many are not being
	// shown.
	TotalSize int64 `json:"totalSize,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Infos") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Infos") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

KeyRangeInfos: A message representing a list of specific information for multiple key ranges.

func (*KeyRangeInfos) MarshalJSON

func (s *KeyRangeInfos) MarshalJSON() ([]byte, error)

type KeySet

type KeySet struct {
	// All: For convenience `all` can be set to `true` to indicate that this
	// `KeySet` matches all keys in the table or index. Note that any keys
	// specified in `keys` or `ranges` are only yielded once.
	All bool `json:"all,omitempty"`

	// Keys: A list of specific keys. Entries in `keys` should have exactly
	// as many elements as there are columns in the primary or index key
	// with which this `KeySet` is used. Individual key values are encoded
	// as described here.
	Keys [][]interface{} `json:"keys,omitempty"`

	// Ranges: A list of key ranges. See KeyRange for more information about
	// key range specifications.
	Ranges []*KeyRange `json:"ranges,omitempty"`

	// ForceSendFields is a list of field names (e.g. "All") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "All") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

KeySet: `KeySet` defines a collection of Cloud Spanner keys and/or key ranges. All the keys are expected to be in the same table or index. The keys need not be sorted in any particular way. If the same key is specified multiple times in the set (for example if two ranges, two keys, or a key and a range overlap), Cloud Spanner behaves as if the key were only specified once.

func (*KeySet) MarshalJSON

func (s *KeySet) MarshalJSON() ([]byte, error)

type ListBackupOperationsResponse

type ListBackupOperationsResponse struct {
	// NextPageToken: `next_page_token` can be sent in a subsequent
	// ListBackupOperations call to fetch more of the matching metadata.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// Operations: The list of matching backup long-running operations. Each
	// operation's name will be prefixed by the backup's name. The
	// operation's metadata field type `metadata.type_url` describes the
	// type of the metadata. Operations returned include those that are
	// pending or have completed/failed/canceled within the last 7 days.
	// Operations returned are ordered by
	// `operation.metadata.value.progress.start_time` in descending order
	// starting from the most recently started operation.
	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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ListBackupOperationsResponse: The response for ListBackupOperations.

func (*ListBackupOperationsResponse) MarshalJSON

func (s *ListBackupOperationsResponse) MarshalJSON() ([]byte, error)

type ListBackupsResponse

type ListBackupsResponse struct {
	// Backups: The list of matching backups. Backups returned are ordered
	// by `create_time` in descending order, starting from the most recent
	// `create_time`.
	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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ListBackupsResponse: The response for ListBackups.

func (*ListBackupsResponse) MarshalJSON

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

type ListDatabaseOperationsResponse

type ListDatabaseOperationsResponse struct {
	// NextPageToken: `next_page_token` can be sent in a subsequent
	// ListDatabaseOperations call to fetch more of the matching metadata.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// Operations: The list of matching database long-running operations.
	// Each operation's name will be prefixed by the database's name. The
	// operation's metadata field type `metadata.type_url` describes the
	// type of the metadata.
	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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ListDatabaseOperationsResponse: The response for ListDatabaseOperations.

func (*ListDatabaseOperationsResponse) MarshalJSON

func (s *ListDatabaseOperationsResponse) MarshalJSON() ([]byte, error)

type ListDatabaseRolesResponse

type ListDatabaseRolesResponse struct {
	// DatabaseRoles: Database roles that matched the request.
	DatabaseRoles []*DatabaseRole `json:"databaseRoles,omitempty"`

	// NextPageToken: `next_page_token` can be sent in a subsequent
	// ListDatabaseRoles call to fetch more of the matching roles.
	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. "DatabaseRoles") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "DatabaseRoles") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ListDatabaseRolesResponse: The response for ListDatabaseRoles.

func (*ListDatabaseRolesResponse) MarshalJSON

func (s *ListDatabaseRolesResponse) MarshalJSON() ([]byte, error)

type ListDatabasesResponse

type ListDatabasesResponse struct {
	// Databases: Databases that matched the request.
	Databases []*Database `json:"databases,omitempty"`

	// NextPageToken: `next_page_token` can be sent in a subsequent
	// ListDatabases call to fetch more of the matching databases.
	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. "Databases") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Databases") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ListDatabasesResponse: The response for ListDatabases.

func (*ListDatabasesResponse) MarshalJSON

func (s *ListDatabasesResponse) MarshalJSON() ([]byte, error)

type ListInstanceConfigOperationsResponse

type ListInstanceConfigOperationsResponse struct {
	// NextPageToken: `next_page_token` can be sent in a subsequent
	// ListInstanceConfigOperations call to fetch more of the matching
	// metadata.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// Operations: The list of matching instance config long-running
	// operations. Each operation's name will be prefixed by the instance
	// config's name. The operation's metadata field type
	// `metadata.type_url` describes the type of the metadata.
	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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ListInstanceConfigOperationsResponse: The response for ListInstanceConfigOperations.

func (*ListInstanceConfigOperationsResponse) MarshalJSON

func (s *ListInstanceConfigOperationsResponse) MarshalJSON() ([]byte, error)

type ListInstanceConfigsResponse

type ListInstanceConfigsResponse struct {
	// InstanceConfigs: The list of requested instance configurations.
	InstanceConfigs []*InstanceConfig `json:"instanceConfigs,omitempty"`

	// NextPageToken: `next_page_token` can be sent in a subsequent
	// ListInstanceConfigs call to fetch more of the matching instance
	// configurations.
	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. "InstanceConfigs") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "InstanceConfigs") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

ListInstanceConfigsResponse: The response for ListInstanceConfigs.

func (*ListInstanceConfigsResponse) MarshalJSON

func (s *ListInstanceConfigsResponse) MarshalJSON() ([]byte, error)

type ListInstancesResponse

type ListInstancesResponse struct {
	// Instances: The list of requested instances.
	Instances []*Instance `json:"instances,omitempty"`

	// NextPageToken: `next_page_token` can be sent in a subsequent
	// ListInstances call to fetch more of the matching instances.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// Unreachable: The list of unreachable instances. It includes the names
	// of instances whose metadata could not be retrieved within
	// instance_deadline.
	Unreachable []string `json:"unreachable,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Instances") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Instances") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ListInstancesResponse: The response for ListInstances.

func (*ListInstancesResponse) MarshalJSON

func (s *ListInstancesResponse) 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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ListOperationsResponse: The response message for Operations.ListOperations.

func (*ListOperationsResponse) MarshalJSON

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

type ListScansResponse

type ListScansResponse struct {
	// NextPageToken: Token to retrieve the next page of results, or empty
	// if there are no more results in the list.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// Scans: Available scans based on the list query parameters.
	Scans []*Scan `json:"scans,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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ListScansResponse: Response method from the ListScans method.

func (*ListScansResponse) MarshalJSON

func (s *ListScansResponse) MarshalJSON() ([]byte, error)

type ListSessionsResponse

type ListSessionsResponse struct {
	// NextPageToken: `next_page_token` can be sent in a subsequent
	// ListSessions call to fetch more of the matching sessions.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// Sessions: The list of requested sessions.
	Sessions []*Session `json:"sessions,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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ListSessionsResponse: The response for ListSessions.

func (*ListSessionsResponse) MarshalJSON

func (s *ListSessionsResponse) MarshalJSON() ([]byte, error)

type LocalizedString

type LocalizedString struct {
	// Args: A map of arguments used when creating the localized message.
	// Keys represent parameter names which may be used by the localized
	// version when substituting dynamic values.
	Args map[string]string `json:"args,omitempty"`

	// Message: The canonical English version of this message. If no token
	// is provided or the front-end has no message associated with the
	// token, this text will be displayed as-is.
	Message string `json:"message,omitempty"`

	// Token: The token identifying the message, e.g. 'METRIC_READ_CPU'.
	// This should be unique within the service.
	Token string `json:"token,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Args") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Args") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

LocalizedString: A message representing a user-facing string whose value may need to be translated before being displayed.

func (*LocalizedString) MarshalJSON

func (s *LocalizedString) MarshalJSON() ([]byte, error)

type Metric

type Metric struct {
	// Aggregation: The aggregation function used to aggregate each key
	// bucket
	//
	// Possible values:
	//   "AGGREGATION_UNSPECIFIED" - Required default value.
	//   "MAX" - Use the maximum of all values.
	//   "SUM" - Use the sum of all values.
	Aggregation string `json:"aggregation,omitempty"`

	// Category: The category of the metric, e.g. "Activity", "Alerts",
	// "Reads", etc.
	Category *LocalizedString `json:"category,omitempty"`

	// Derived: The references to numerator and denominator metrics for a
	// derived metric.
	Derived *DerivedMetric `json:"derived,omitempty"`

	// DisplayLabel: The displayed label of the metric.
	DisplayLabel *LocalizedString `json:"displayLabel,omitempty"`

	// HasNonzeroData: Whether the metric has any non-zero data.
	HasNonzeroData bool `json:"hasNonzeroData,omitempty"`

	// HotValue: The value that is considered hot for the metric. On a per
	// metric basis hotness signals high utilization and something that
	// might potentially be a cause for concern by the end user. hot_value
	// is used to calibrate and scale visual color scales.
	HotValue float64 `json:"hotValue,omitempty"`

	// IndexedHotKeys: The (sparse) mapping from time index to an
	// IndexedHotKey message, representing those time intervals for which
	// there are hot keys.
	IndexedHotKeys map[string]IndexedHotKey `json:"indexedHotKeys,omitempty"`

	// IndexedKeyRangeInfos: The (sparse) mapping from time interval index
	// to an IndexedKeyRangeInfos message, representing those time intervals
	// for which there are informational messages concerning key ranges.
	IndexedKeyRangeInfos map[string]IndexedKeyRangeInfos `json:"indexedKeyRangeInfos,omitempty"`

	// Info: Information about the metric.
	Info *LocalizedString `json:"info,omitempty"`

	// Matrix: The data for the metric as a matrix.
	Matrix *MetricMatrix `json:"matrix,omitempty"`

	// Unit: The unit of the metric.
	Unit *LocalizedString `json:"unit,omitempty"`

	// Visible: Whether the metric is visible to the end user.
	Visible bool `json:"visible,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Aggregation") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Aggregation") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Metric: A message representing the actual monitoring data, values for each key bucket over time, of a metric.

func (*Metric) MarshalJSON

func (s *Metric) MarshalJSON() ([]byte, error)

func (*Metric) UnmarshalJSON

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

type MetricMatrix

type MetricMatrix struct {
	// Rows: The rows of the matrix.
	Rows []*MetricMatrixRow `json:"rows,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Rows") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Rows") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

MetricMatrix: A message representing a matrix of floats.

func (*MetricMatrix) MarshalJSON

func (s *MetricMatrix) MarshalJSON() ([]byte, error)

type MetricMatrixRow

type MetricMatrixRow struct {
	// Cols: The columns of the row.
	Cols []float64 `json:"cols,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Cols") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Cols") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

MetricMatrixRow: A message representing a row of a matrix of floats.

func (*MetricMatrixRow) MarshalJSON

func (s *MetricMatrixRow) MarshalJSON() ([]byte, error)

func (*MetricMatrixRow) UnmarshalJSON

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

type Mutation

type Mutation struct {
	// Delete: Delete rows from a table. Succeeds whether or not the named
	// rows were present.
	Delete *Delete `json:"delete,omitempty"`

	// Insert: Insert new rows in a table. If any of the rows already exist,
	// the write or transaction fails with error `ALREADY_EXISTS`.
	Insert *Write `json:"insert,omitempty"`

	// InsertOrUpdate: Like insert, except that if the row already exists,
	// then its column values are overwritten with the ones provided. Any
	// column values not explicitly written are preserved. When using
	// insert_or_update, just as when using insert, all `NOT NULL` columns
	// in the table must be given a value. This holds true even when the row
	// already exists and will therefore actually be updated.
	InsertOrUpdate *Write `json:"insertOrUpdate,omitempty"`

	// Replace: Like insert, except that if the row already exists, it is
	// deleted, and the column values provided are inserted instead. Unlike
	// insert_or_update, this means any values not explicitly written become
	// `NULL`. In an interleaved table, if you create the child table with
	// the `ON DELETE CASCADE` annotation, then replacing a parent row also
	// deletes the child rows. Otherwise, you must delete the child rows
	// before you replace the parent row.
	Replace *Write `json:"replace,omitempty"`

	// Update: Update existing rows in a table. If any of the rows does not
	// already exist, the transaction fails with error `NOT_FOUND`.
	Update *Write `json:"update,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Delete") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Delete") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Mutation: A modification to one or more Cloud Spanner rows. Mutations can be applied to a Cloud Spanner database by sending them in a Commit call.

func (*Mutation) MarshalJSON

func (s *Mutation) MarshalJSON() ([]byte, error)

type MutationGroup

type MutationGroup struct {
	// Mutations: Required. The mutations in this group.
	Mutations []*Mutation `json:"mutations,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Mutations") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Mutations") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

MutationGroup: A group of mutations to be committed together. Related mutations should be placed in a group. For example, two mutations inserting rows with the same primary key prefix in both parent and child tables are related.

func (*MutationGroup) MarshalJSON

func (s *MutationGroup) 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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	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

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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

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

func (*OperationProgress) MarshalJSON

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

type OptimizeRestoredDatabaseMetadata

type OptimizeRestoredDatabaseMetadata struct {
	// Name: Name of the restored database 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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

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

func (*OptimizeRestoredDatabaseMetadata) MarshalJSON

func (s *OptimizeRestoredDatabaseMetadata) MarshalJSON() ([]byte, error)

type PartialResultSet

type PartialResultSet struct {
	// ChunkedValue: If true, then the final value in values is chunked, and
	// must be combined with more values from subsequent `PartialResultSet`s
	// to obtain a complete field value.
	ChunkedValue bool `json:"chunkedValue,omitempty"`

	// Metadata: Metadata about the result set, such as row type
	// information. Only present in the first response.
	Metadata *ResultSetMetadata `json:"metadata,omitempty"`

	// ResumeToken: Streaming calls might be interrupted for a variety of
	// reasons, such as TCP connection loss. If this occurs, the stream of
	// results can be resumed by re-sending the original request and
	// including `resume_token`. Note that executing any other transaction
	// in the same session invalidates the token.
	ResumeToken string `json:"resumeToken,omitempty"`

	// Stats: Query plan and execution statistics for the statement that
	// produced this streaming result set. These can be requested by setting
	// ExecuteSqlRequest.query_mode and are sent only once with the last
	// response in the stream. This field will also be present in the last
	// response for DML statements.
	Stats *ResultSetStats `json:"stats,omitempty"`

	// Values: A streamed result set consists of a stream of values, which
	// might be split into many `PartialResultSet` messages to accommodate
	// large rows and/or large values. Every N complete values defines a
	// row, where N is equal to the number of entries in
	// metadata.row_type.fields. Most values are encoded based on type as
	// described here. It is possible that the last value in values is
	// "chunked", meaning that the rest of the value is sent in subsequent
	// `PartialResultSet`(s). This is denoted by the chunked_value field.
	// Two or more chunked values can be merged to form a complete value as
	// follows: * `bool/number/null`: cannot be chunked * `string`:
	// concatenate the strings * `list`: concatenate the lists. If the last
	// element in a list is a `string`, `list`, or `object`, merge it with
	// the first element in the next list by applying these rules
	// recursively. * `object`: concatenate the (field name, field value)
	// pairs. If a field name is duplicated, then apply these rules
	// recursively to merge the field values. Some examples of merging: #
	// Strings are concatenated. "foo", "bar" => "foobar" # Lists of
	// non-strings are concatenated. [2, 3], [4] => [2, 3, 4] # Lists are
	// concatenated, but the last and first elements are merged # because
	// they are strings. ["a", "b"], ["c", "d"] => ["a", "bc", "d"] # Lists
	// are concatenated, but the last and first elements are merged #
	// because they are lists. Recursively, the last and first elements # of
	// the inner lists are merged because they are strings. ["a", ["b",
	// "c"]], [["d"], "e"] => ["a", ["b", "cd"], "e"] # Non-overlapping
	// object fields are combined. {"a": "1"}, {"b": "2"} => {"a": "1", "b":
	// 2"} # Overlapping object fields are merged. {"a": "1"}, {"a": "2"} =>
	// {"a": "12"} # Examples of merging objects containing lists of
	// strings. {"a": ["1"]}, {"a": ["2"]} => {"a": ["12"]} For a more
	// complete example, suppose a streaming SQL query is yielding a result
	// set whose rows contain a single string field. The following
	// `PartialResultSet`s might be yielded: { "metadata": { ... } "values":
	// ["Hello", "W"] "chunked_value": true "resume_token": "Af65..." } {
	// "values": ["orl"] "chunked_value": true } { "values": ["d"]
	// "resume_token": "Zx1B..." } This sequence of `PartialResultSet`s
	// encodes two rows, one containing the field value "Hello", and a
	// second containing the field value "World" = "W" + "orl" + "d". Not
	// all `PartialResultSet`s contain a `resume_token`. Execution can only
	// be resumed from a previously yielded `resume_token`. For the above
	// sequence of `PartialResultSet`s, resuming the query with
	// "resume_token": "Af65..." will yield results from the
	// `PartialResultSet` with value `["orl"]`.
	Values []interface{} `json:"values,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "ChunkedValue") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ChunkedValue") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

PartialResultSet: Partial results from a streaming read or SQL query. Streaming reads and SQL queries better tolerate large result sets, large rows, and large values, but are a little trickier to consume.

func (*PartialResultSet) MarshalJSON

func (s *PartialResultSet) MarshalJSON() ([]byte, error)

type Partition

type Partition struct {
	// PartitionToken: This token can be passed to Read, StreamingRead,
	// ExecuteSql, or ExecuteStreamingSql requests to restrict the results
	// to those identified by this partition token.
	PartitionToken string `json:"partitionToken,omitempty"`

	// ForceSendFields is a list of field names (e.g. "PartitionToken") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "PartitionToken") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

Partition: Information returned for each partition returned in a PartitionResponse.

func (*Partition) MarshalJSON

func (s *Partition) MarshalJSON() ([]byte, error)

type PartitionOptions

type PartitionOptions struct {
	// MaxPartitions: **Note:** This hint is currently ignored by
	// PartitionQuery and PartitionRead requests. The desired maximum number
	// of partitions to return. For example, this may be set to the number
	// of workers available. The default for this option is currently
	// 10,000. The maximum value is currently 200,000. This is only a hint.
	// The actual number of partitions returned may be smaller or larger
	// than this maximum count request.
	MaxPartitions int64 `json:"maxPartitions,omitempty,string"`

	// PartitionSizeBytes: **Note:** This hint is currently ignored by
	// PartitionQuery and PartitionRead requests. The desired data size for
	// each partition generated. The default for this option is currently 1
	// GiB. This is only a hint. The actual size of each partition may be
	// smaller or larger than this size request.
	PartitionSizeBytes int64 `json:"partitionSizeBytes,omitempty,string"`

	// ForceSendFields is a list of field names (e.g. "MaxPartitions") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "MaxPartitions") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

PartitionOptions: Options for a PartitionQueryRequest and PartitionReadRequest.

func (*PartitionOptions) MarshalJSON

func (s *PartitionOptions) MarshalJSON() ([]byte, error)

type PartitionQueryRequest

type PartitionQueryRequest struct {
	// ParamTypes: It is not always possible for Cloud Spanner to infer the
	// right SQL type from a JSON value. For example, values of type `BYTES`
	// and values of type `STRING` both appear in params as JSON strings. In
	// these cases, `param_types` can be used to specify the exact SQL type
	// for some or all of the SQL query parameters. See the definition of
	// Type for more information about SQL types.
	ParamTypes map[string]Type `json:"paramTypes,omitempty"`

	// Params: Parameter names and values that bind to placeholders in the
	// SQL string. A parameter placeholder consists of the `@` character
	// followed by the parameter name (for example, `@firstName`). Parameter
	// names can contain letters, numbers, and underscores. Parameters can
	// appear anywhere that a literal value is expected. The same parameter
	// name can be used more than once, for example: "WHERE id > @msg_id
	// AND id < @msg_id + 100" It is an error to execute a SQL statement
	// with unbound parameters.
	Params googleapi.RawMessage `json:"params,omitempty"`

	// PartitionOptions: Additional options that affect how many partitions
	// are created.
	PartitionOptions *PartitionOptions `json:"partitionOptions,omitempty"`

	// Sql: Required. The query request to generate partitions for. The
	// request will fail if the query is not root partitionable. For a query
	// to be root partitionable, it needs to satisfy a few conditions. For
	// example, if the query execution plan contains a distributed union
	// operator, then it must be the first operator in the plan. For more
	// information about other conditions, see Read data in parallel
	// (https://cloud.google.com/spanner/docs/reads#read_data_in_parallel).
	// The query request must not contain DML commands, such as INSERT,
	// UPDATE, or DELETE. Use ExecuteStreamingSql with a PartitionedDml
	// transaction for large, partition-friendly DML operations.
	Sql string `json:"sql,omitempty"`

	// Transaction: Read only snapshot transactions are supported,
	// read/write and single use transactions are not.
	Transaction *TransactionSelector `json:"transaction,omitempty"`

	// ForceSendFields is a list of field names (e.g. "ParamTypes") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ParamTypes") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

PartitionQueryRequest: The request for PartitionQuery

func (*PartitionQueryRequest) MarshalJSON

func (s *PartitionQueryRequest) MarshalJSON() ([]byte, error)

type PartitionReadRequest

type PartitionReadRequest struct {
	// Columns: The columns of table to be returned for each row matching
	// this request.
	Columns []string `json:"columns,omitempty"`

	// Index: If non-empty, the name of an index on table. This index is
	// used instead of the table primary key when interpreting key_set and
	// sorting result rows. See key_set for further information.
	Index string `json:"index,omitempty"`

	// KeySet: Required. `key_set` identifies the rows to be yielded.
	// `key_set` names the primary keys of the rows in table to be yielded,
	// unless index is present. If index is present, then key_set instead
	// names index keys in index. It is not an error for the `key_set` to
	// name rows that do not exist in the database. Read yields nothing for
	// nonexistent rows.
	KeySet *KeySet `json:"keySet,omitempty"`

	// PartitionOptions: Additional options that affect how many partitions
	// are created.
	PartitionOptions *PartitionOptions `json:"partitionOptions,omitempty"`

	// Table: Required. The name of the table in the database to be read.
	Table string `json:"table,omitempty"`

	// Transaction: Read only snapshot transactions are supported,
	// read/write and single use transactions are not.
	Transaction *TransactionSelector `json:"transaction,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Columns") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Columns") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

PartitionReadRequest: The request for PartitionRead

func (*PartitionReadRequest) MarshalJSON

func (s *PartitionReadRequest) MarshalJSON() ([]byte, error)

type PartitionResponse

type PartitionResponse struct {
	// Partitions: Partitions created by this request.
	Partitions []*Partition `json:"partitions,omitempty"`

	// Transaction: Transaction created by this request.
	Transaction *Transaction `json:"transaction,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Partitions") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Partitions") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

PartitionResponse: The response for PartitionQuery or PartitionRead

func (*PartitionResponse) MarshalJSON

func (s *PartitionResponse) MarshalJSON() ([]byte, error)

type PartitionedDml

type PartitionedDml struct {
}

PartitionedDml: Message type to initiate a Partitioned DML transaction.

type PlanNode

type PlanNode struct {
	// ChildLinks: List of child node `index`es and their relationship to
	// this parent.
	ChildLinks []*ChildLink `json:"childLinks,omitempty"`

	// DisplayName: The display name for the node.
	DisplayName string `json:"displayName,omitempty"`

	// ExecutionStats: The execution statistics associated with the node,
	// contained in a group of key-value pairs. Only present if the plan was
	// returned as a result of a profile query. For example, number of
	// executions, number of rows/time per execution etc.
	ExecutionStats googleapi.RawMessage `json:"executionStats,omitempty"`

	// Index: The `PlanNode`'s index in node list.
	Index int64 `json:"index,omitempty"`

	// Kind: Used to determine the type of node. May be needed for
	// visualizing different kinds of nodes differently. For example, If the
	// node is a SCALAR node, it will have a condensed representation which
	// can be used to directly embed a description of the node in its
	// parent.
	//
	// Possible values:
	//   "KIND_UNSPECIFIED" - Not specified.
	//   "RELATIONAL" - Denotes a Relational operator node in the expression
	// tree. Relational operators represent iterative processing of rows
	// during query execution. For example, a `TableScan` operation that
	// reads rows from a table.
	//   "SCALAR" - Denotes a Scalar node in the expression tree. Scalar
	// nodes represent non-iterable entities in the query plan. For example,
	// constants or arithmetic operators appearing inside predicate
	// expressions or references to column names.
	Kind string `json:"kind,omitempty"`

	// Metadata: Attributes relevant to the node contained in a group of
	// key-value pairs. For example, a Parameter Reference node could have
	// the following information in its metadata: { "parameter_reference":
	// "param1", "parameter_type": "array" }
	Metadata googleapi.RawMessage `json:"metadata,omitempty"`

	// ShortRepresentation: Condensed representation for SCALAR nodes.
	ShortRepresentation *ShortRepresentation `json:"shortRepresentation,omitempty"`

	// ForceSendFields is a list of field names (e.g. "ChildLinks") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ChildLinks") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

PlanNode: Node information for nodes appearing in a QueryPlan.plan_nodes.

func (*PlanNode) MarshalJSON

func (s *PlanNode) MarshalJSON() ([]byte, error)

type Policy

type Policy struct {
	// 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. "Bindings") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Bindings") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	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 PrefixNode

type PrefixNode struct {
	// DataSourceNode: Whether this corresponds to a data_source name.
	DataSourceNode bool `json:"dataSourceNode,omitempty"`

	// Depth: The depth in the prefix hierarchy.
	Depth int64 `json:"depth,omitempty"`

	// EndIndex: The index of the end key bucket of the range that this node
	// spans.
	EndIndex int64 `json:"endIndex,omitempty"`

	// StartIndex: The index of the start key bucket of the range that this
	// node spans.
	StartIndex int64 `json:"startIndex,omitempty"`

	// Word: The string represented by the prefix node.
	Word string `json:"word,omitempty"`

	// ForceSendFields is a list of field names (e.g. "DataSourceNode") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "DataSourceNode") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

PrefixNode: A message representing a key prefix node in the key prefix hierarchy. for eg. Bigtable keyspaces are lexicographically ordered mappings of keys to values. Keys often have a shared prefix structure where users use the keys to organize data. Eg ///employee In this case Keysight will possibly use one node for a company and reuse it for all employees that fall under the company. Doing so improves legibility in the UI.

func (*PrefixNode) MarshalJSON

func (s *PrefixNode) MarshalJSON() ([]byte, error)

type ProjectsInstanceConfigOperationsListCall

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

func (*ProjectsInstanceConfigOperationsListCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstanceConfigOperationsListCall) Do

Do executes the "spanner.projects.instanceConfigOperations.list" call. Exactly one of *ListInstanceConfigOperationsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListInstanceConfigOperationsResponse.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 (*ProjectsInstanceConfigOperationsListCall) Fields

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

func (*ProjectsInstanceConfigOperationsListCall) Filter

Filter sets the optional parameter "filter": An expression that filters the list of returned operations. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`. Colon `:` is the contains operator. Filter rules are not case sensitive. The following fields in the Operation are eligible for filtering: * `name` - The name of the long-running operation * `done` - False if the operation is in progress, else true. * `metadata.@type` - the type of metadata. For example, the type string for CreateInstanceConfigMetadata is `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstanceCo nfigMetadata`. * `metadata.` - any field in metadata.value. `metadata.@type` must be specified first, if filtering on metadata fields. * `error` - Error associated with the long-running operation. * `response.@type` - the type of response. * `response.` - any field in response.value. You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic. However, you can specify AND, OR, and NOT logic explicitly. Here are a few examples: * `done:true` - The operation is complete. * `(metadata.@type=` \ `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstanceCo nfigMetadata) AND` \ `(metadata.instance_config.name:custom-config) AND` \ `(metadata.progress.start_time < \"2021-03-28T14:50:00Z\") AND` \ `(error:*)` - Return operations where: * The operation's metadata type is CreateInstanceConfigMetadata. * The instance config name contains "custom-config". * The operation started before 2021-03-28T14:50:00Z. * The operation resulted in an error.

func (*ProjectsInstanceConfigOperationsListCall) Header

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

func (*ProjectsInstanceConfigOperationsListCall) IfNoneMatch

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsInstanceConfigOperationsListCall) PageSize

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

func (*ProjectsInstanceConfigOperationsListCall) PageToken

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

func (*ProjectsInstanceConfigOperationsListCall) 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 ProjectsInstanceConfigOperationsService

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

func NewProjectsInstanceConfigOperationsService

func NewProjectsInstanceConfigOperationsService(s *Service) *ProjectsInstanceConfigOperationsService

func (*ProjectsInstanceConfigOperationsService) List

List: Lists the user-managed instance config long-running operations in the given project. An instance config operation has a name of the form `projects//instanceConfigs//operations/`. The long-running operation metadata field type `metadata.type_url` describes the type of the metadata. Operations returned include those that have completed/failed/canceled within the last 7 days, and pending operations. Operations returned are ordered by `operation.metadata.value.start_time` in descending order starting from the most recently started operation.

  • parent: The project of the instance config operations. Values are of the form `projects/`.

type ProjectsInstanceConfigsCreateCall

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

func (*ProjectsInstanceConfigsCreateCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstanceConfigsCreateCall) Do

Do executes the "spanner.projects.instanceConfigs.create" call. Exactly one of *Operation or error will be non-nil. 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 (*ProjectsInstanceConfigsCreateCall) Fields

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

func (*ProjectsInstanceConfigsCreateCall) Header

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

type ProjectsInstanceConfigsDeleteCall

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

func (*ProjectsInstanceConfigsDeleteCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstanceConfigsDeleteCall) Do

Do executes the "spanner.projects.instanceConfigs.delete" call. Exactly one of *Empty or error will be non-nil. 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 (*ProjectsInstanceConfigsDeleteCall) Etag

Etag sets the optional parameter "etag": Used for optimistic concurrency control as a way to help prevent simultaneous deletes of an instance config from overwriting each other. If not empty, the API only deletes the instance config when the etag provided matches the current status of the requested instance config. Otherwise, deletes the instance config without checking the current status of the requested instance config.

func (*ProjectsInstanceConfigsDeleteCall) Fields

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

func (*ProjectsInstanceConfigsDeleteCall) Header

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

func (*ProjectsInstanceConfigsDeleteCall) ValidateOnly

ValidateOnly sets the optional parameter "validateOnly": An option to validate, but not actually execute, a request, and provide the same response.

type ProjectsInstanceConfigsGetCall

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

func (*ProjectsInstanceConfigsGetCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstanceConfigsGetCall) Do

Do executes the "spanner.projects.instanceConfigs.get" call. Exactly one of *InstanceConfig or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *InstanceConfig.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 (*ProjectsInstanceConfigsGetCall) Fields

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

func (*ProjectsInstanceConfigsGetCall) Header

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

func (*ProjectsInstanceConfigsGetCall) IfNoneMatch

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsInstanceConfigsListCall

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

func (*ProjectsInstanceConfigsListCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstanceConfigsListCall) Do

Do executes the "spanner.projects.instanceConfigs.list" call. Exactly one of *ListInstanceConfigsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListInstanceConfigsResponse.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 (*ProjectsInstanceConfigsListCall) Fields

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

func (*ProjectsInstanceConfigsListCall) Header

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

func (*ProjectsInstanceConfigsListCall) IfNoneMatch

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsInstanceConfigsListCall) PageSize

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

func (*ProjectsInstanceConfigsListCall) PageToken

PageToken sets the optional parameter "pageToken": If non-empty, `page_token` should contain a next_page_token from a previous ListInstanceConfigsResponse.

func (*ProjectsInstanceConfigsListCall) 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 ProjectsInstanceConfigsOperationsCancelCall

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

func (*ProjectsInstanceConfigsOperationsCancelCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstanceConfigsOperationsCancelCall) Do

Do executes the "spanner.projects.instanceConfigs.operations.cancel" call. Exactly one of *Empty or error will be non-nil. 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 (*ProjectsInstanceConfigsOperationsCancelCall) Fields

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

func (*ProjectsInstanceConfigsOperationsCancelCall) Header

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

type ProjectsInstanceConfigsOperationsDeleteCall

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

func (*ProjectsInstanceConfigsOperationsDeleteCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstanceConfigsOperationsDeleteCall) Do

Do executes the "spanner.projects.instanceConfigs.operations.delete" call. Exactly one of *Empty or error will be non-nil. 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 (*ProjectsInstanceConfigsOperationsDeleteCall) Fields

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

func (*ProjectsInstanceConfigsOperationsDeleteCall) Header

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

type ProjectsInstanceConfigsOperationsGetCall

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

func (*ProjectsInstanceConfigsOperationsGetCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstanceConfigsOperationsGetCall) Do

Do executes the "spanner.projects.instanceConfigs.operations.get" call. Exactly one of *Operation or error will be non-nil. 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 (*ProjectsInstanceConfigsOperationsGetCall) Fields

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

func (*ProjectsInstanceConfigsOperationsGetCall) Header

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

func (*ProjectsInstanceConfigsOperationsGetCall) IfNoneMatch

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsInstanceConfigsOperationsListCall

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

func (*ProjectsInstanceConfigsOperationsListCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstanceConfigsOperationsListCall) Do

Do executes the "spanner.projects.instanceConfigs.operations.list" call. Exactly one of *ListOperationsResponse or error will be non-nil. 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 (*ProjectsInstanceConfigsOperationsListCall) Fields

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

func (*ProjectsInstanceConfigsOperationsListCall) Filter

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

func (*ProjectsInstanceConfigsOperationsListCall) Header

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

func (*ProjectsInstanceConfigsOperationsListCall) IfNoneMatch

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsInstanceConfigsOperationsListCall) PageSize

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

func (*ProjectsInstanceConfigsOperationsListCall) PageToken

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

func (*ProjectsInstanceConfigsOperationsListCall) 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 ProjectsInstanceConfigsOperationsService

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

func NewProjectsInstanceConfigsOperationsService

func NewProjectsInstanceConfigsOperationsService(s *Service) *ProjectsInstanceConfigsOperationsService

func (*ProjectsInstanceConfigsOperationsService) Cancel

Cancel: Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.

- name: The name of the operation resource to be cancelled.

func (*ProjectsInstanceConfigsOperationsService) Delete

Delete: Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.

- name: The name of the operation resource to be deleted.

func (*ProjectsInstanceConfigsOperationsService) 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.

func (*ProjectsInstanceConfigsOperationsService) 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 ProjectsInstanceConfigsPatchCall

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

func (*ProjectsInstanceConfigsPatchCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstanceConfigsPatchCall) Do

Do executes the "spanner.projects.instanceConfigs.patch" call. Exactly one of *Operation or error will be non-nil. 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 (*ProjectsInstanceConfigsPatchCall) Fields

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

func (*ProjectsInstanceConfigsPatchCall) Header

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

type ProjectsInstanceConfigsService

type ProjectsInstanceConfigsService struct {
	Operations *ProjectsInstanceConfigsOperationsService

	SsdCaches *ProjectsInstanceConfigsSsdCachesService
	// contains filtered or unexported fields
}

func NewProjectsInstanceConfigsService

func NewProjectsInstanceConfigsService(s *Service) *ProjectsInstanceConfigsService

func (*ProjectsInstanceConfigsService) Create

Create: Creates an instance config and begins preparing it to be used. The returned long-running operation can be used to track the progress of preparing the new instance config. The instance config name is assigned by the caller. If the named instance config already exists, `CreateInstanceConfig` returns `ALREADY_EXISTS`. Immediately after the request returns: * The instance config is readable via the API, with all requested attributes. The instance config's reconciling field is set to true. Its state is `CREATING`. While the operation is pending: * Cancelling the operation renders the instance config immediately unreadable via the API. * Except for deleting the creating resource, all other attempts to modify the instance config are rejected. Upon completion of the returned operation: * Instances can be created using the instance configuration. * The instance config's reconciling field becomes false. Its state becomes `READY`. The returned long-running operation will have a name of the format `/operations/` and can be used to track creation of the instance config. The metadata field type is CreateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires `spanner.instanceConfigs.create` permission on the resource parent.

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

func (*ProjectsInstanceConfigsService) Delete

Delete: Deletes the instance config. Deletion is only allowed when no instances are using the configuration. If any instances are using the config, returns `FAILED_PRECONDITION`. Only user managed configurations can be deleted. Authorization requires `spanner.instanceConfigs.delete` permission on the resource name.

  • name: The name of the instance configuration to be deleted. Values are of the form `projects//instanceConfigs/`.

func (*ProjectsInstanceConfigsService) Get

Get: Gets information about a particular instance configuration.

  • name: The name of the requested instance configuration. Values are of the form `projects//instanceConfigs/`.

func (*ProjectsInstanceConfigsService) List

List: Lists the supported instance configurations for a given project.

  • parent: The name of the project for which a list of supported instance configurations is requested. Values are of the form `projects/`.

func (*ProjectsInstanceConfigsService) Patch

Patch: Updates an instance config. The returned long-running operation can be used to track the progress of updating the instance. If the named instance config does not exist, returns `NOT_FOUND`. Only user managed configurations can be updated. Immediately after the request returns: * The instance config's reconciling field is set to true. While the operation is pending: * Cancelling the operation sets its metadata's cancel_time. The operation is guaranteed to succeed at undoing all changes, after which point it terminates with a `CANCELLED` status. * All other attempts to modify the instance config are rejected. * Reading the instance config via the API continues to give the pre-request values. Upon completion of the returned operation: * Creating instances using the instance configuration uses the new values. * The instance config's new values are readable via the API. * The instance config's reconciling field becomes false. The returned long-running operation will have a name of the format `/operations/` and can be used to track the instance config modification. The metadata field type is UpdateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires `spanner.instanceConfigs.update` permission on the resource name.

  • name: A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`.

type ProjectsInstanceConfigsSsdCachesOperationsCancelCall

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

func (*ProjectsInstanceConfigsSsdCachesOperationsCancelCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstanceConfigsSsdCachesOperationsCancelCall) Do

Do executes the "spanner.projects.instanceConfigs.ssdCaches.operations.cancel" call. Exactly one of *Empty or error will be non-nil. 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 (*ProjectsInstanceConfigsSsdCachesOperationsCancelCall) Fields

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

func (*ProjectsInstanceConfigsSsdCachesOperationsCancelCall) Header

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

type ProjectsInstanceConfigsSsdCachesOperationsDeleteCall

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

func (*ProjectsInstanceConfigsSsdCachesOperationsDeleteCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstanceConfigsSsdCachesOperationsDeleteCall) Do

Do executes the "spanner.projects.instanceConfigs.ssdCaches.operations.delete" call. Exactly one of *Empty or error will be non-nil. 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 (*ProjectsInstanceConfigsSsdCachesOperationsDeleteCall) Fields

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

func (*ProjectsInstanceConfigsSsdCachesOperationsDeleteCall) Header

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

type ProjectsInstanceConfigsSsdCachesOperationsGetCall

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

func (*ProjectsInstanceConfigsSsdCachesOperationsGetCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstanceConfigsSsdCachesOperationsGetCall) Do

Do executes the "spanner.projects.instanceConfigs.ssdCaches.operations.get" call. Exactly one of *Operation or error will be non-nil. 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 (*ProjectsInstanceConfigsSsdCachesOperationsGetCall) Fields

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

func (*ProjectsInstanceConfigsSsdCachesOperationsGetCall) Header

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

func (*ProjectsInstanceConfigsSsdCachesOperationsGetCall) IfNoneMatch

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsInstanceConfigsSsdCachesOperationsListCall

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

func (*ProjectsInstanceConfigsSsdCachesOperationsListCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstanceConfigsSsdCachesOperationsListCall) Do

Do executes the "spanner.projects.instanceConfigs.ssdCaches.operations.list" call. Exactly one of *ListOperationsResponse or error will be non-nil. 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 (*ProjectsInstanceConfigsSsdCachesOperationsListCall) Fields

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

func (*ProjectsInstanceConfigsSsdCachesOperationsListCall) Filter

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

func (*ProjectsInstanceConfigsSsdCachesOperationsListCall) Header

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

func (*ProjectsInstanceConfigsSsdCachesOperationsListCall) IfNoneMatch

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsInstanceConfigsSsdCachesOperationsListCall) PageSize

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

func (*ProjectsInstanceConfigsSsdCachesOperationsListCall) PageToken

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

func (*ProjectsInstanceConfigsSsdCachesOperationsListCall) 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 ProjectsInstanceConfigsSsdCachesOperationsService

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

func (*ProjectsInstanceConfigsSsdCachesOperationsService) Cancel

Cancel: Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.

- name: The name of the operation resource to be cancelled.

func (*ProjectsInstanceConfigsSsdCachesOperationsService) Delete

Delete: Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.

- name: The name of the operation resource to be deleted.

func (*ProjectsInstanceConfigsSsdCachesOperationsService) 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.

func (*ProjectsInstanceConfigsSsdCachesOperationsService) 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 ProjectsInstanceConfigsSsdCachesService

type ProjectsInstanceConfigsSsdCachesService struct {
	Operations *ProjectsInstanceConfigsSsdCachesOperationsService
	// contains filtered or unexported fields
}

func NewProjectsInstanceConfigsSsdCachesService

func NewProjectsInstanceConfigsSsdCachesService(s *Service) *ProjectsInstanceConfigsSsdCachesService

type ProjectsInstancesBackupOperationsListCall

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

func (*ProjectsInstancesBackupOperationsListCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesBackupOperationsListCall) Do

Do executes the "spanner.projects.instances.backupOperations.list" call. Exactly one of *ListBackupOperationsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListBackupOperationsResponse.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 (*ProjectsInstancesBackupOperationsListCall) Fields

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

func (*ProjectsInstancesBackupOperationsListCall) Filter

Filter sets the optional parameter "filter": An expression that filters the list of returned backup operations. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`. Colon `:` is the contains operator. Filter rules are not case sensitive. The following fields in the operation are eligible for filtering: * `name` - The name of the long-running operation * `done` - False if the operation is in progress, else true. * `metadata.@type` - the type of metadata. For example, the type string for CreateBackupMetadata is `type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMeta data`. * `metadata.` - any field in metadata.value. `metadata.@type` must be specified first if filtering on metadata fields. * `error` - Error associated with the long-running operation. * `response.@type` - the type of response. * `response.` - any field in response.value. You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic, but you can specify AND, OR, and NOT logic explicitly. Here are a few examples: * `done:true` - The operation is complete. * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1. CreateBackupMetadata) AND` \ `metadata.database:prod` - Returns operations where: * The operation's metadata type is CreateBackupMetadata. * The source database name of backup contains the string "prod". * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1. CreateBackupMetadata) AND` \ `(metadata.name:howl) AND` \ `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` \ `(error:*)` - Returns operations where: * The operation's metadata type is CreateBackupMetadata. * The backup name contains the string "howl". * The operation started before 2018-03-28T14:50:00Z. * The operation resulted in an error. * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1. CopyBackupMetadata) AND` \ `(metadata.source_backup:test) AND` \ `(metadata.progress.start_time < \"2022-01-18T14:50:00Z\") AND` \ `(error:*)` - Returns operations where: * The operation's metadata type is CopyBackupMetadata. * The source backup name contains the string "test". * The operation started before 2022-01-18T14:50:00Z. * The operation resulted in an error. * `((metadata.@type=type.googleapis.com/google.spanner.admin.database.v1 .CreateBackupMetadata) AND` \ `(metadata.database:test_db)) OR` \ `((metadata.@type=type.googleapis.com/google.spanner.admin.database.v1 .CopyBackupMetadata) AND` \ `(metadata.source_backup:test_bkp)) AND` \ `(error:*)` - Returns operations where: * The operation's metadata matches either of criteria: * The operation's metadata type is CreateBackupMetadata AND the source database name of the backup contains the string "test_db" * The operation's metadata type is CopyBackupMetadata AND the source backup name contains the string "test_bkp" * The operation resulted in an error.

func (*ProjectsInstancesBackupOperationsListCall) Header

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

func (*ProjectsInstancesBackupOperationsListCall) IfNoneMatch

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsInstancesBackupOperationsListCall) PageSize

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

func (*ProjectsInstancesBackupOperationsListCall) PageToken

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

func (*ProjectsInstancesBackupOperationsListCall) 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 ProjectsInstancesBackupOperationsService

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

func NewProjectsInstancesBackupOperationsService

func NewProjectsInstancesBackupOperationsService(s *Service) *ProjectsInstancesBackupOperationsService

func (*ProjectsInstancesBackupOperationsService) List

List: Lists the backup long-running operations in the given instance. A backup operation has a name of the form `projects//instances//backups//operations/`. The long-running operation metadata field type `metadata.type_url` describes the type of the metadata. Operations returned include those that have completed/failed/canceled within the last 7 days, and pending operations. Operations returned are ordered by `operation.metadata.value.progress.start_time` in descending order starting from the most recently started operation.

  • parent: The instance of the backup operations. Values are of the form `projects//instances/`.

type ProjectsInstancesBackupsCopyCall

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

func (*ProjectsInstancesBackupsCopyCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesBackupsCopyCall) Do

Do executes the "spanner.projects.instances.backups.copy" call. Exactly one of *Operation or error will be non-nil. 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 (*ProjectsInstancesBackupsCopyCall) Fields

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

func (*ProjectsInstancesBackupsCopyCall) Header

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

type ProjectsInstancesBackupsCreateCall

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

func (*ProjectsInstancesBackupsCreateCall) BackupId

BackupId sets the optional parameter "backupId": Required. The id of the backup to be created. The `backup_id` appended to `parent` forms the full backup name of the form `projects//instances//backups/`.

func (*ProjectsInstancesBackupsCreateCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesBackupsCreateCall) Do

Do executes the "spanner.projects.instances.backups.create" call. Exactly one of *Operation or error will be non-nil. 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 (*ProjectsInstancesBackupsCreateCall) EncryptionConfigEncryptionType

func (c *ProjectsInstancesBackupsCreateCall) EncryptionConfigEncryptionType(encryptionConfigEncryptionType string) *ProjectsInstancesBackupsCreateCall

EncryptionConfigEncryptionType sets the optional parameter "encryptionConfig.encryptionType": Required. The encryption type of the backup.

Possible values:

"ENCRYPTION_TYPE_UNSPECIFIED" - Unspecified. Do not use.
"USE_DATABASE_ENCRYPTION" - Use the same encryption configuration

as the database. This is the default option when encryption_config is empty. For example, if the database is using `Customer_Managed_Encryption`, the backup will be using the same Cloud KMS key as the database.

"GOOGLE_DEFAULT_ENCRYPTION" - Use Google default encryption.
"CUSTOMER_MANAGED_ENCRYPTION" - Use customer managed encryption. If

specified, `kms_key_name` must contain a valid Cloud KMS key.

func (*ProjectsInstancesBackupsCreateCall) EncryptionConfigKmsKeyName

func (c *ProjectsInstancesBackupsCreateCall) EncryptionConfigKmsKeyName(encryptionConfigKmsKeyName string) *ProjectsInstancesBackupsCreateCall

EncryptionConfigKmsKeyName sets the optional parameter "encryptionConfig.kmsKeyName": The Cloud KMS key that will be used to protect the backup. This field should be set only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`.

func (*ProjectsInstancesBackupsCreateCall) Fields

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

func (*ProjectsInstancesBackupsCreateCall) Header

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

type ProjectsInstancesBackupsDeleteCall

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

func (*ProjectsInstancesBackupsDeleteCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesBackupsDeleteCall) Do

Do executes the "spanner.projects.instances.backups.delete" call. Exactly one of *Empty or error will be non-nil. 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 (*ProjectsInstancesBackupsDeleteCall) Fields

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

func (*ProjectsInstancesBackupsDeleteCall) Header

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

type ProjectsInstancesBackupsGetCall

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

func (*ProjectsInstancesBackupsGetCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesBackupsGetCall) Do

Do executes the "spanner.projects.instances.backups.get" call. Exactly one of *Backup or error will be non-nil. 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 (*ProjectsInstancesBackupsGetCall) Fields

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

func (*ProjectsInstancesBackupsGetCall) Header

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

func (*ProjectsInstancesBackupsGetCall) IfNoneMatch

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsInstancesBackupsGetIamPolicyCall

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

func (*ProjectsInstancesBackupsGetIamPolicyCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesBackupsGetIamPolicyCall) Do

Do executes the "spanner.projects.instances.backups.getIamPolicy" call. Exactly one of *Policy or error will be non-nil. 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 (*ProjectsInstancesBackupsGetIamPolicyCall) Fields

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

func (*ProjectsInstancesBackupsGetIamPolicyCall) Header

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

type ProjectsInstancesBackupsListCall

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

func (*ProjectsInstancesBackupsListCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesBackupsListCall) Do

Do executes the "spanner.projects.instances.backups.list" call. Exactly one of *ListBackupsResponse or error will be non-nil. 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 (*ProjectsInstancesBackupsListCall) Fields

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

func (*ProjectsInstancesBackupsListCall) Filter

Filter sets the optional parameter "filter": An expression that filters the list of returned backups. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`. Colon `:` is the contains operator. Filter rules are not case sensitive. The following fields in the Backup are eligible for filtering: * `name` * `database` * `state` * `create_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) * `version_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ) * `size_bytes` You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic, but you can specify AND, OR, and NOT logic explicitly. Here are a few examples: * `name:Howl` - The backup's name contains the string "howl". * `database:prod` - The database'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 (create_time < \"2018-03-28T14:50:00Z\")` - The backup name contains the string "howl" and `create_time` of the backup is before 2018-03-28T14:50:00Z. * `expire_time < \"2018-03-28T14:50:00Z\" - The backup `expire_time` is before 2018-03-28T14:50:00Z. * `size_bytes > 10000000000` - The backup's size is greater than 10GB

func (*ProjectsInstancesBackupsListCall) Header

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

func (*ProjectsInstancesBackupsListCall) IfNoneMatch

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsInstancesBackupsListCall) PageSize

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 (*ProjectsInstancesBackupsListCall) PageToken

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 (*ProjectsInstancesBackupsListCall) 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 ProjectsInstancesBackupsOperationsCancelCall

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

func (*ProjectsInstancesBackupsOperationsCancelCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesBackupsOperationsCancelCall) Do

Do executes the "spanner.projects.instances.backups.operations.cancel" call. Exactly one of *Empty or error will be non-nil. 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 (*ProjectsInstancesBackupsOperationsCancelCall) Fields

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

func (*ProjectsInstancesBackupsOperationsCancelCall) Header

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

type ProjectsInstancesBackupsOperationsDeleteCall

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

func (*ProjectsInstancesBackupsOperationsDeleteCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesBackupsOperationsDeleteCall) Do

Do executes the "spanner.projects.instances.backups.operations.delete" call. Exactly one of *Empty or error will be non-nil. 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 (*ProjectsInstancesBackupsOperationsDeleteCall) Fields

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

func (*ProjectsInstancesBackupsOperationsDeleteCall) Header

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

type ProjectsInstancesBackupsOperationsGetCall

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

func (*ProjectsInstancesBackupsOperationsGetCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesBackupsOperationsGetCall) Do

Do executes the "spanner.projects.instances.backups.operations.get" call. Exactly one of *Operation or error will be non-nil. 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 (*ProjectsInstancesBackupsOperationsGetCall) Fields

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

func (*ProjectsInstancesBackupsOperationsGetCall) Header

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

func (*ProjectsInstancesBackupsOperationsGetCall) IfNoneMatch

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsInstancesBackupsOperationsListCall

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

func (*ProjectsInstancesBackupsOperationsListCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesBackupsOperationsListCall) Do

Do executes the "spanner.projects.instances.backups.operations.list" call. Exactly one of *ListOperationsResponse or error will be non-nil. 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 (*ProjectsInstancesBackupsOperationsListCall) Fields

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

func (*ProjectsInstancesBackupsOperationsListCall) Filter

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

func (*ProjectsInstancesBackupsOperationsListCall) Header

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

func (*ProjectsInstancesBackupsOperationsListCall) IfNoneMatch

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsInstancesBackupsOperationsListCall) PageSize

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

func (*ProjectsInstancesBackupsOperationsListCall) PageToken

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

func (*ProjectsInstancesBackupsOperationsListCall) 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 ProjectsInstancesBackupsOperationsService

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

func NewProjectsInstancesBackupsOperationsService

func NewProjectsInstancesBackupsOperationsService(s *Service) *ProjectsInstancesBackupsOperationsService

func (*ProjectsInstancesBackupsOperationsService) Cancel

Cancel: Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.

- name: The name of the operation resource to be cancelled.

func (*ProjectsInstancesBackupsOperationsService) Delete

Delete: Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.

- name: The name of the operation resource to be deleted.

func (*ProjectsInstancesBackupsOperationsService) 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.

func (*ProjectsInstancesBackupsOperationsService) 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 ProjectsInstancesBackupsPatchCall

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

func (*ProjectsInstancesBackupsPatchCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesBackupsPatchCall) Do

Do executes the "spanner.projects.instances.backups.patch" call. Exactly one of *Backup or error will be non-nil. 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 (*ProjectsInstancesBackupsPatchCall) Fields

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

func (*ProjectsInstancesBackupsPatchCall) Header

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

func (*ProjectsInstancesBackupsPatchCall) UpdateMask

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 ProjectsInstancesBackupsService

type ProjectsInstancesBackupsService struct {
	Operations *ProjectsInstancesBackupsOperationsService
	// contains filtered or unexported fields
}

func NewProjectsInstancesBackupsService

func NewProjectsInstancesBackupsService(s *Service) *ProjectsInstancesBackupsService

func (*ProjectsInstancesBackupsService) Copy

Copy: Starts copying a Cloud Spanner Backup. The returned backup long-running operation will have a name of the format `projects//instances//backups//operations/` and can be used to track copying of the backup. The operation is associated with the destination backup. The metadata field type is CopyBackupMetadata. The response field type is Backup, if successful. Cancelling the returned operation will stop the copying and delete the destination backup. Concurrent CopyBackup requests can run on the same source backup.

  • parent: The name of the destination instance that will contain the backup copy. Values are of the form: `projects//instances/`.

func (*ProjectsInstancesBackupsService) Create

Create: Starts creating a new Cloud Spanner Backup. The returned backup long-running operation will have a name of the format `projects//instances//backups//operations/` and 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. There can be only one pending backup creation per database. Backup creation of different databases can run concurrently.

  • parent: The name of the instance in which the backup will be created. This must be the same instance that contains the database the backup will be created from. The backup will be stored in the location(s) specified in the instance configuration of this instance. Values are of the form `projects//instances/`.

func (*ProjectsInstancesBackupsService) Delete

Delete: Deletes a pending or completed Backup.

  • name: Name of the backup to delete. Values are of the form `projects//instances//backups/`.

func (*ProjectsInstancesBackupsService) Get

Get: Gets metadata on a pending or completed Backup.

  • name: Name of the backup. Values are of the form `projects//instances//backups/`.

func (*ProjectsInstancesBackupsService) GetIamPolicy

GetIamPolicy: Gets the access control policy for a database or backup resource. Returns an empty policy if a database or backup exists but does not have a policy set. Authorization requires `spanner.databases.getIamPolicy` permission on resource. For backups, authorization requires `spanner.backups.getIamPolicy` permission on resource.

  • resource: REQUIRED: The Cloud Spanner resource for which the policy is being retrieved. The format is `projects//instances/` for instance resources and `projects//instances//databases/` for database resources.

func (*ProjectsInstancesBackupsService) List

List: Lists completed and pending backups. Backups returned are ordered by `create_time` in descending order, starting from the most recent `create_time`.

  • parent: The instance to list backups from. Values are of the form `projects//instances/`.

func (*ProjectsInstancesBackupsService) Patch

Patch: Updates a pending or completed Backup.

  • name: Output only for the CreateBackup operation. Required for the UpdateBackup operation. A globally unique identifier for the backup which cannot be changed. Values are of the form `projects//instances//backups/a-z*[a-z0-9]` The final segment of the name must be between 2 and 60 characters in length. The backup is stored in the location(s) specified in the instance configuration of the instance containing the backup, identified by the prefix of the backup name of the form `projects//instances/`.

func (*ProjectsInstancesBackupsService) SetIamPolicy

SetIamPolicy: Sets the access control policy on a database or backup resource. Replaces any existing policy. Authorization requires `spanner.databases.setIamPolicy` permission on resource. For backups, authorization requires `spanner.backups.setIamPolicy` permission on resource.

  • resource: REQUIRED: The Cloud Spanner resource for which the policy is being set. The format is `projects//instances/` for instance resources and `projects//instances//databases/` for databases resources.

func (*ProjectsInstancesBackupsService) TestIamPermissions

func (r *ProjectsInstancesBackupsService) TestIamPermissions(resource string, testiampermissionsrequest *TestIamPermissionsRequest) *ProjectsInstancesBackupsTestIamPermissionsCall

TestIamPermissions: Returns permissions that the caller has on the specified database or backup resource. Attempting this RPC on a non-existent Cloud Spanner database will result in a NOT_FOUND error if the user has `spanner.databases.list` permission on the containing Cloud Spanner instance. Otherwise returns an empty set of permissions. Calling this method on a backup that does not exist will result in a NOT_FOUND error if the user has `spanner.backups.list` permission on the containing instance.

  • resource: REQUIRED: The Cloud Spanner resource for which permissions are being tested. The format is `projects//instances/` for instance resources and `projects//instances//databases/` for database resources.

type ProjectsInstancesBackupsSetIamPolicyCall

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

func (*ProjectsInstancesBackupsSetIamPolicyCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesBackupsSetIamPolicyCall) Do

Do executes the "spanner.projects.instances.backups.setIamPolicy" call. Exactly one of *Policy or error will be non-nil. 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 (*ProjectsInstancesBackupsSetIamPolicyCall) Fields

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

func (*ProjectsInstancesBackupsSetIamPolicyCall) Header

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

type ProjectsInstancesBackupsTestIamPermissionsCall

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

func (*ProjectsInstancesBackupsTestIamPermissionsCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesBackupsTestIamPermissionsCall) Do

Do executes the "spanner.projects.instances.backups.testIamPermissions" call. Exactly one of *TestIamPermissionsResponse or error will be non-nil. 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 (*ProjectsInstancesBackupsTestIamPermissionsCall) Fields

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

func (*ProjectsInstancesBackupsTestIamPermissionsCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP 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. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesCreateCall) Do

Do executes the "spanner.projects.instances.create" call. Exactly one of *Operation or error will be non-nil. 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 information.

func (*ProjectsInstancesCreateCall) Header

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

type ProjectsInstancesDatabaseOperationsListCall

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

func (*ProjectsInstancesDatabaseOperationsListCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesDatabaseOperationsListCall) Do

Do executes the "spanner.projects.instances.databaseOperations.list" call. Exactly one of *ListDatabaseOperationsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListDatabaseOperationsResponse.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 (*ProjectsInstancesDatabaseOperationsListCall) Fields

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

func (*ProjectsInstancesDatabaseOperationsListCall) Filter

Filter sets the optional parameter "filter": An expression that filters the list of returned operations. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`. Colon `:` is the contains operator. Filter rules are not case sensitive. The following fields in the Operation are eligible for filtering: * `name` - The name of the long-running operation * `done` - False if the operation is in progress, else true. * `metadata.@type` - the type of metadata. For example, the type string for RestoreDatabaseMetadata is `type.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseM etadata`. * `metadata.` - any field in metadata.value. `metadata.@type` must be specified first, if filtering on metadata fields. * `error` - Error associated with the long-running operation. * `response.@type` - the type of response. * `response.` - any field in response.value. You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic. However, you can specify AND, OR, and NOT logic explicitly. Here are a few examples: * `done:true` - The operation is complete. * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1. RestoreDatabaseMetadata) AND` \ `(metadata.source_type:BACKUP) AND` \ `(metadata.backup_info.backup:backup_howl) AND` \ `(metadata.name:restored_howl) AND` \ `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` \ `(error:*)` - Return operations where: * The operation's metadata type is RestoreDatabaseMetadata. * The database is restored from a backup. * The backup name contains "backup_howl". * The restored database's name contains "restored_howl". * The operation started before 2018-03-28T14:50:00Z. * The operation resulted in an error.

func (*ProjectsInstancesDatabaseOperationsListCall) Header

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

func (*ProjectsInstancesDatabaseOperationsListCall) IfNoneMatch

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsInstancesDatabaseOperationsListCall) PageSize

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

func (*ProjectsInstancesDatabaseOperationsListCall) PageToken

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

func (*ProjectsInstancesDatabaseOperationsListCall) 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 ProjectsInstancesDatabaseOperationsService

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

func NewProjectsInstancesDatabaseOperationsService

func NewProjectsInstancesDatabaseOperationsService(s *Service) *ProjectsInstancesDatabaseOperationsService

func (*ProjectsInstancesDatabaseOperationsService) List

List: Lists database longrunning-operations. A database operation has a name of the form `projects//instances//databases//operations/`. The long-running operation metadata field type `metadata.type_url` describes the type of the metadata. Operations returned include those that have completed/failed/canceled within the last 7 days, and pending operations.

  • parent: The instance of the database operations. Values are of the form `projects//instances/`.

type ProjectsInstancesDatabasesCreateCall

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

func (*ProjectsInstancesDatabasesCreateCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesDatabasesCreateCall) Do

Do executes the "spanner.projects.instances.databases.create" call. Exactly one of *Operation or error will be non-nil. 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 (*ProjectsInstancesDatabasesCreateCall) Fields

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

func (*ProjectsInstancesDatabasesCreateCall) Header

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

type ProjectsInstancesDatabasesDatabaseRolesListCall

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

func (*ProjectsInstancesDatabasesDatabaseRolesListCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesDatabasesDatabaseRolesListCall) Do

Do executes the "spanner.projects.instances.databases.databaseRoles.list" call. Exactly one of *ListDatabaseRolesResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListDatabaseRolesResponse.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 (*ProjectsInstancesDatabasesDatabaseRolesListCall) Fields

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

func (*ProjectsInstancesDatabasesDatabaseRolesListCall) Header

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

func (*ProjectsInstancesDatabasesDatabaseRolesListCall) IfNoneMatch

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsInstancesDatabasesDatabaseRolesListCall) PageSize

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

func (*ProjectsInstancesDatabasesDatabaseRolesListCall) PageToken

PageToken sets the optional parameter "pageToken": If non-empty, `page_token` should contain a next_page_token from a previous ListDatabaseRolesResponse.

func (*ProjectsInstancesDatabasesDatabaseRolesListCall) 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 ProjectsInstancesDatabasesDatabaseRolesService

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

func NewProjectsInstancesDatabasesDatabaseRolesService

func NewProjectsInstancesDatabasesDatabaseRolesService(s *Service) *ProjectsInstancesDatabasesDatabaseRolesService

func (*ProjectsInstancesDatabasesDatabaseRolesService) List

List: Lists Cloud Spanner database roles.

  • parent: The database whose roles should be listed. Values are of the form `projects//instances//databases/`.

func (*ProjectsInstancesDatabasesDatabaseRolesService) TestIamPermissions

TestIamPermissions: Returns permissions that the caller has on the specified database or backup resource. Attempting this RPC on a non-existent Cloud Spanner database will result in a NOT_FOUND error if the user has `spanner.databases.list` permission on the containing Cloud Spanner instance. Otherwise returns an empty set of permissions. Calling this method on a backup that does not exist will result in a NOT_FOUND error if the user has `spanner.backups.list` permission on the containing instance.

  • resource: REQUIRED: The Cloud Spanner resource for which permissions are being tested. The format is `projects//instances/` for instance resources and `projects//instances//databases/` for database resources.

type ProjectsInstancesDatabasesDatabaseRolesTestIamPermissionsCall

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

func (*ProjectsInstancesDatabasesDatabaseRolesTestIamPermissionsCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesDatabasesDatabaseRolesTestIamPermissionsCall) Do

Do executes the "spanner.projects.instances.databases.databaseRoles.testIamPermissions" call. Exactly one of *TestIamPermissionsResponse or error will be non-nil. 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 (*ProjectsInstancesDatabasesDatabaseRolesTestIamPermissionsCall) Fields

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

func (*ProjectsInstancesDatabasesDatabaseRolesTestIamPermissionsCall) Header

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

type ProjectsInstancesDatabasesDropDatabaseCall

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

func (*ProjectsInstancesDatabasesDropDatabaseCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesDatabasesDropDatabaseCall) Do

Do executes the "spanner.projects.instances.databases.dropDatabase" call. Exactly one of *Empty or error will be non-nil. 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 (*ProjectsInstancesDatabasesDropDatabaseCall) Fields

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

func (*ProjectsInstancesDatabasesDropDatabaseCall) Header

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

type ProjectsInstancesDatabasesGetCall

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

func (*ProjectsInstancesDatabasesGetCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesDatabasesGetCall) Do

Do executes the "spanner.projects.instances.databases.get" call. Exactly one of *Database or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Database.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 (*ProjectsInstancesDatabasesGetCall) Fields

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

func (*ProjectsInstancesDatabasesGetCall) Header

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

func (*ProjectsInstancesDatabasesGetCall) IfNoneMatch

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsInstancesDatabasesGetDdlCall

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

func (*ProjectsInstancesDatabasesGetDdlCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesDatabasesGetDdlCall) Do

Do executes the "spanner.projects.instances.databases.getDdl" call. Exactly one of *GetDatabaseDdlResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GetDatabaseDdlResponse.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 (*ProjectsInstancesDatabasesGetDdlCall) Fields

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

func (*ProjectsInstancesDatabasesGetDdlCall) Header

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

func (*ProjectsInstancesDatabasesGetDdlCall) IfNoneMatch

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsInstancesDatabasesGetIamPolicyCall

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

func (*ProjectsInstancesDatabasesGetIamPolicyCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesDatabasesGetIamPolicyCall) Do

Do executes the "spanner.projects.instances.databases.getIamPolicy" call. Exactly one of *Policy or error will be non-nil. 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 (*ProjectsInstancesDatabasesGetIamPolicyCall) Fields

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

func (*ProjectsInstancesDatabasesGetIamPolicyCall) Header

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

type ProjectsInstancesDatabasesGetScansCall

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

func (*ProjectsInstancesDatabasesGetScansCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesDatabasesGetScansCall) Do

Do executes the "spanner.projects.instances.databases.getScans" call. Exactly one of *Scan or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Scan.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 (*ProjectsInstancesDatabasesGetScansCall) EndTime

EndTime sets the optional parameter "endTime": The upper bound for the time range to retrieve Scan data for.

func (*ProjectsInstancesDatabasesGetScansCall) Fields

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

func (*ProjectsInstancesDatabasesGetScansCall) Header

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

func (*ProjectsInstancesDatabasesGetScansCall) IfNoneMatch

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsInstancesDatabasesGetScansCall) StartTime

StartTime sets the optional parameter "startTime": These fields restrict the Database-specific information returned in the `Scan.data` field. If a `View` is provided that does not include the `Scan.data` field, these are ignored. This range of time must be entirely contained within the defined time range of the targeted scan. The lower bound for the time range to retrieve Scan data for.

func (*ProjectsInstancesDatabasesGetScansCall) View

View sets the optional parameter "view": Specifies which parts of the Scan should be returned in the response. Note, if left unspecified, the FULL view is assumed.

Possible values:

"VIEW_UNSPECIFIED" - Not specified, equivalent to SUMMARY.
"SUMMARY" - Server responses only include `name`, `details`,

`start_time` and `end_time`. The default value. Note, the ListScans method may only use this view type, others view types are not supported.

"FULL" - Full representation of the scan is returned in the server

response, including `data`.

type ProjectsInstancesDatabasesListCall

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

func (*ProjectsInstancesDatabasesListCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesDatabasesListCall) Do

Do executes the "spanner.projects.instances.databases.list" call. Exactly one of *ListDatabasesResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListDatabasesResponse.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 (*ProjectsInstancesDatabasesListCall) Fields

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

func (*ProjectsInstancesDatabasesListCall) Header

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

func (*ProjectsInstancesDatabasesListCall) IfNoneMatch

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsInstancesDatabasesListCall) PageSize

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

func (*ProjectsInstancesDatabasesListCall) PageToken

PageToken sets the optional parameter "pageToken": If non-empty, `page_token` should contain a next_page_token from a previous ListDatabasesResponse.

func (*ProjectsInstancesDatabasesListCall) 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 ProjectsInstancesDatabasesOperationsCancelCall

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

func (*ProjectsInstancesDatabasesOperationsCancelCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesDatabasesOperationsCancelCall) Do

Do executes the "spanner.projects.instances.databases.operations.cancel" call. Exactly one of *Empty or error will be non-nil. 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 (*ProjectsInstancesDatabasesOperationsCancelCall) Fields

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

func (*ProjectsInstancesDatabasesOperationsCancelCall) Header

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

type ProjectsInstancesDatabasesOperationsDeleteCall

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

func (*ProjectsInstancesDatabasesOperationsDeleteCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesDatabasesOperationsDeleteCall) Do

Do executes the "spanner.projects.instances.databases.operations.delete" call. Exactly one of *Empty or error will be non-nil. 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 (*ProjectsInstancesDatabasesOperationsDeleteCall) Fields

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

func (*ProjectsInstancesDatabasesOperationsDeleteCall) Header

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

type ProjectsInstancesDatabasesOperationsGetCall

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

func (*ProjectsInstancesDatabasesOperationsGetCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesDatabasesOperationsGetCall) Do

Do executes the "spanner.projects.instances.databases.operations.get" call. Exactly one of *Operation or error will be non-nil. 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 (*ProjectsInstancesDatabasesOperationsGetCall) Fields

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

func (*ProjectsInstancesDatabasesOperationsGetCall) Header

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

func (*ProjectsInstancesDatabasesOperationsGetCall) IfNoneMatch

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsInstancesDatabasesOperationsListCall

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

func (*ProjectsInstancesDatabasesOperationsListCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesDatabasesOperationsListCall) Do

Do executes the "spanner.projects.instances.databases.operations.list" call. Exactly one of *ListOperationsResponse or error will be non-nil. 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 (*ProjectsInstancesDatabasesOperationsListCall) Fields

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

func (*ProjectsInstancesDatabasesOperationsListCall) Filter

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

func (*ProjectsInstancesDatabasesOperationsListCall) Header

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

func (*ProjectsInstancesDatabasesOperationsListCall) IfNoneMatch

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsInstancesDatabasesOperationsListCall) PageSize

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

func (*ProjectsInstancesDatabasesOperationsListCall) PageToken

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

func (*ProjectsInstancesDatabasesOperationsListCall) 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 ProjectsInstancesDatabasesOperationsService

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

func NewProjectsInstancesDatabasesOperationsService

func NewProjectsInstancesDatabasesOperationsService(s *Service) *ProjectsInstancesDatabasesOperationsService

func (*ProjectsInstancesDatabasesOperationsService) Cancel

Cancel: Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.

- name: The name of the operation resource to be cancelled.

func (*ProjectsInstancesDatabasesOperationsService) Delete

Delete: Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.

- name: The name of the operation resource to be deleted.

func (*ProjectsInstancesDatabasesOperationsService) 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.

func (*ProjectsInstancesDatabasesOperationsService) 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 ProjectsInstancesDatabasesPatchCall

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

func (*ProjectsInstancesDatabasesPatchCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesDatabasesPatchCall) Do

Do executes the "spanner.projects.instances.databases.patch" call. Exactly one of *Operation or error will be non-nil. 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 (*ProjectsInstancesDatabasesPatchCall) Fields

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

func (*ProjectsInstancesDatabasesPatchCall) Header

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

func (*ProjectsInstancesDatabasesPatchCall) UpdateMask

UpdateMask sets the optional parameter "updateMask": Required. The list of fields to update. Currently, only `enable_drop_protection` field can be updated.

type ProjectsInstancesDatabasesRestoreCall

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

func (*ProjectsInstancesDatabasesRestoreCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesDatabasesRestoreCall) Do

Do executes the "spanner.projects.instances.databases.restore" call. Exactly one of *Operation or error will be non-nil. 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 (*ProjectsInstancesDatabasesRestoreCall) Fields

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

func (*ProjectsInstancesDatabasesRestoreCall) Header

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

type ProjectsInstancesDatabasesService

type ProjectsInstancesDatabasesService struct {
	DatabaseRoles *ProjectsInstancesDatabasesDatabaseRolesService

	Operations *ProjectsInstancesDatabasesOperationsService

	Sessions *ProjectsInstancesDatabasesSessionsService
	// contains filtered or unexported fields
}

func NewProjectsInstancesDatabasesService

func NewProjectsInstancesDatabasesService(s *Service) *ProjectsInstancesDatabasesService

func (*ProjectsInstancesDatabasesService) Create

Create: Creates a new Cloud Spanner database and starts to prepare it for serving. The returned long-running operation will have a name of the format `/operations/` and can be used to track preparation of the database. The metadata field type is CreateDatabaseMetadata. The response field type is Database, if successful.

  • parent: The name of the instance that will serve the new database. Values are of the form `projects//instances/`.

func (*ProjectsInstancesDatabasesService) DropDatabase

DropDatabase: Drops (aka deletes) a Cloud Spanner database. Completed backups for the database will be retained according to their `expire_time`. Note: Cloud Spanner might continue to accept requests for a few seconds after the database has been deleted.

- database: The database to be dropped.

func (*ProjectsInstancesDatabasesService) Get

Get: Gets the state of a Cloud Spanner database.

  • name: The name of the requested database. Values are of the form `projects//instances//databases/`.

func (*ProjectsInstancesDatabasesService) GetDdl

GetDdl: Returns the schema of a Cloud Spanner database as a list of formatted DDL statements. This method does not show pending schema updates, those may be queried using the Operations API.

  • database: The database whose schema we wish to get. Values are of the form `projects//instances//databases/`.

func (*ProjectsInstancesDatabasesService) GetIamPolicy

GetIamPolicy: Gets the access control policy for a database or backup resource. Returns an empty policy if a database or backup exists but does not have a policy set. Authorization requires `spanner.databases.getIamPolicy` permission on resource. For backups, authorization requires `spanner.backups.getIamPolicy` permission on resource.

  • resource: REQUIRED: The Cloud Spanner resource for which the policy is being retrieved. The format is `projects//instances/` for instance resources and `projects//instances//databases/` for database resources.

func (*ProjectsInstancesDatabasesService) GetScans

GetScans: Request a specific scan with Database-specific data for Cloud Key Visualizer.

  • name: The unique name of the scan containing the requested information, specific to the Database service implementing this interface.

func (*ProjectsInstancesDatabasesService) List

List: Lists Cloud Spanner databases.

  • parent: The instance whose databases should be listed. Values are of the form `projects//instances/`.

func (*ProjectsInstancesDatabasesService) Patch

Patch: Updates a Cloud Spanner database. The returned long-running operation can be used to track the progress of updating the database. If the named database does not exist, returns `NOT_FOUND`. While the operation is pending: * The database's reconciling field is set to true. * Cancelling the operation is best-effort. If the cancellation succeeds, the operation metadata's cancel_time is set, the updates are reverted, and the operation terminates with a `CANCELLED` status. * New UpdateDatabase requests will return a `FAILED_PRECONDITION` error until the pending operation is done (returns successfully or with error). * Reading the database via the API continues to give the pre-request values. Upon completion of the returned operation: * The new values are in effect and readable via the API. * The database's reconciling field becomes false. The returned long-running operation will have a name of the format `projects//instances//databases//operations/` and can be used to track the database modification. The metadata field type is UpdateDatabaseMetadata. The response field type is Database, if successful.

  • name: The name of the database. Values are of the form `projects//instances//databases/`, where “ is as specified in the `CREATE DATABASE` statement. This name can be passed to other API methods to identify the database.

func (*ProjectsInstancesDatabasesService) Restore

Restore: Create a new database by restoring from a completed backup. The new database must be in the same project and in an instance with the same instance configuration as the instance containing the backup. The returned database long-running operation has a name of the format `projects//instances//databases//operations/`, and can be used to track the progress of the operation, and to cancel it. The metadata field type is RestoreDatabaseMetadata. The response type is Database, if successful. Cancelling the returned operation will stop the restore and delete the database. There can be only one database being restored into an instance at a time. Once the restore operation completes, a new restore operation can be initiated, without waiting for the optimize operation associated with the first restore to complete.

  • parent: The name of the instance in which to create the restored database. This instance must be in the same project and have the same instance configuration as the instance containing the source backup. Values are of the form `projects//instances/`.

func (*ProjectsInstancesDatabasesService) SetIamPolicy

SetIamPolicy: Sets the access control policy on a database or backup resource. Replaces any existing policy. Authorization requires `spanner.databases.setIamPolicy` permission on resource. For backups, authorization requires `spanner.backups.setIamPolicy` permission on resource.

  • resource: REQUIRED: The Cloud Spanner resource for which the policy is being set. The format is `projects//instances/` for instance resources and `projects//instances//databases/` for databases resources.

func (*ProjectsInstancesDatabasesService) TestIamPermissions

TestIamPermissions: Returns permissions that the caller has on the specified database or backup resource. Attempting this RPC on a non-existent Cloud Spanner database will result in a NOT_FOUND error if the user has `spanner.databases.list` permission on the containing Cloud Spanner instance. Otherwise returns an empty set of permissions. Calling this method on a backup that does not exist will result in a NOT_FOUND error if the user has `spanner.backups.list` permission on the containing instance.

  • resource: REQUIRED: The Cloud Spanner resource for which permissions are being tested. The format is `projects//instances/` for instance resources and `projects//instances//databases/` for database resources.

func (*ProjectsInstancesDatabasesService) UpdateDdl

UpdateDdl: Updates the schema of a Cloud Spanner database by creating/altering/dropping tables, columns, indexes, etc. The returned long-running operation will have a name of the format `/operations/` and can be used to track execution of the schema change(s). The metadata field type is UpdateDatabaseDdlMetadata. The operation has no response.

- database: The database to update.

type ProjectsInstancesDatabasesSessionsBatchCreateCall

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

func (*ProjectsInstancesDatabasesSessionsBatchCreateCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesDatabasesSessionsBatchCreateCall) Do

Do executes the "spanner.projects.instances.databases.sessions.batchCreate" call. Exactly one of *BatchCreateSessionsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *BatchCreateSessionsResponse.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 (*ProjectsInstancesDatabasesSessionsBatchCreateCall) Fields

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

func (*ProjectsInstancesDatabasesSessionsBatchCreateCall) Header

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

type ProjectsInstancesDatabasesSessionsBatchWriteCall

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

func (*ProjectsInstancesDatabasesSessionsBatchWriteCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesDatabasesSessionsBatchWriteCall) Do

Do executes the "spanner.projects.instances.databases.sessions.batchWrite" call. Exactly one of *BatchWriteResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *BatchWriteResponse.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 (*ProjectsInstancesDatabasesSessionsBatchWriteCall) Fields

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

func (*ProjectsInstancesDatabasesSessionsBatchWriteCall) Header

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

type ProjectsInstancesDatabasesSessionsBeginTransactionCall

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

func (*ProjectsInstancesDatabasesSessionsBeginTransactionCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesDatabasesSessionsBeginTransactionCall) Do

Do executes the "spanner.projects.instances.databases.sessions.beginTransaction" call. Exactly one of *Transaction or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Transaction.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 (*ProjectsInstancesDatabasesSessionsBeginTransactionCall) Fields

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

func (*ProjectsInstancesDatabasesSessionsBeginTransactionCall) Header

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

type ProjectsInstancesDatabasesSessionsCommitCall

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

func (*ProjectsInstancesDatabasesSessionsCommitCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesDatabasesSessionsCommitCall) Do

Do executes the "spanner.projects.instances.databases.sessions.commit" call. Exactly one of *CommitResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *CommitResponse.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 (*ProjectsInstancesDatabasesSessionsCommitCall) Fields

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

func (*ProjectsInstancesDatabasesSessionsCommitCall) Header

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

type ProjectsInstancesDatabasesSessionsCreateCall

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

func (*ProjectsInstancesDatabasesSessionsCreateCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesDatabasesSessionsCreateCall) Do

Do executes the "spanner.projects.instances.databases.sessions.create" call. Exactly one of *Session or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Session.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 (*ProjectsInstancesDatabasesSessionsCreateCall) Fields

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

func (*ProjectsInstancesDatabasesSessionsCreateCall) Header

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

type ProjectsInstancesDatabasesSessionsDeleteCall

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

func (*ProjectsInstancesDatabasesSessionsDeleteCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesDatabasesSessionsDeleteCall) Do

Do executes the "spanner.projects.instances.databases.sessions.delete" call. Exactly one of *Empty or error will be non-nil. 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 (*ProjectsInstancesDatabasesSessionsDeleteCall) Fields

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

func (*ProjectsInstancesDatabasesSessionsDeleteCall) Header

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

type ProjectsInstancesDatabasesSessionsExecuteBatchDmlCall

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

func (*ProjectsInstancesDatabasesSessionsExecuteBatchDmlCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesDatabasesSessionsExecuteBatchDmlCall) Do

Do executes the "spanner.projects.instances.databases.sessions.executeBatchDml" call. Exactly one of *ExecuteBatchDmlResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ExecuteBatchDmlResponse.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 (*ProjectsInstancesDatabasesSessionsExecuteBatchDmlCall) Fields

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

func (*ProjectsInstancesDatabasesSessionsExecuteBatchDmlCall) Header

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

type ProjectsInstancesDatabasesSessionsExecuteSqlCall

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

func (*ProjectsInstancesDatabasesSessionsExecuteSqlCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesDatabasesSessionsExecuteSqlCall) Do

Do executes the "spanner.projects.instances.databases.sessions.executeSql" call. Exactly one of *ResultSet or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ResultSet.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 (*ProjectsInstancesDatabasesSessionsExecuteSqlCall) Fields

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

func (*ProjectsInstancesDatabasesSessionsExecuteSqlCall) Header

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

type ProjectsInstancesDatabasesSessionsExecuteStreamingSqlCall

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

func (*ProjectsInstancesDatabasesSessionsExecuteStreamingSqlCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesDatabasesSessionsExecuteStreamingSqlCall) Do

Do executes the "spanner.projects.instances.databases.sessions.executeStreamingSql" call. Exactly one of *PartialResultSet or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *PartialResultSet.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 (*ProjectsInstancesDatabasesSessionsExecuteStreamingSqlCall) Fields

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

func (*ProjectsInstancesDatabasesSessionsExecuteStreamingSqlCall) Header

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

type ProjectsInstancesDatabasesSessionsGetCall

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

func (*ProjectsInstancesDatabasesSessionsGetCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesDatabasesSessionsGetCall) Do

Do executes the "spanner.projects.instances.databases.sessions.get" call. Exactly one of *Session or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Session.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 (*ProjectsInstancesDatabasesSessionsGetCall) Fields

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

func (*ProjectsInstancesDatabasesSessionsGetCall) Header

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

func (*ProjectsInstancesDatabasesSessionsGetCall) IfNoneMatch

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsInstancesDatabasesSessionsListCall

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

func (*ProjectsInstancesDatabasesSessionsListCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesDatabasesSessionsListCall) Do

Do executes the "spanner.projects.instances.databases.sessions.list" call. Exactly one of *ListSessionsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListSessionsResponse.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 (*ProjectsInstancesDatabasesSessionsListCall) Fields

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

func (*ProjectsInstancesDatabasesSessionsListCall) Filter

Filter sets the optional parameter "filter": An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `labels.key` where key is the name of a label Some examples of using filters are: * `labels.env:*` --> The session has the label "env". * `labels.env:dev` --> The session has the label "env" and the value of the label contains the string "dev".

func (*ProjectsInstancesDatabasesSessionsListCall) Header

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

func (*ProjectsInstancesDatabasesSessionsListCall) IfNoneMatch

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsInstancesDatabasesSessionsListCall) PageSize

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

func (*ProjectsInstancesDatabasesSessionsListCall) PageToken

PageToken sets the optional parameter "pageToken": If non-empty, `page_token` should contain a next_page_token from a previous ListSessionsResponse.

func (*ProjectsInstancesDatabasesSessionsListCall) 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 ProjectsInstancesDatabasesSessionsPartitionQueryCall

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

func (*ProjectsInstancesDatabasesSessionsPartitionQueryCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesDatabasesSessionsPartitionQueryCall) Do

Do executes the "spanner.projects.instances.databases.sessions.partitionQuery" call. Exactly one of *PartitionResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *PartitionResponse.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 (*ProjectsInstancesDatabasesSessionsPartitionQueryCall) Fields

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

func (*ProjectsInstancesDatabasesSessionsPartitionQueryCall) Header

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

type ProjectsInstancesDatabasesSessionsPartitionReadCall

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

func (*ProjectsInstancesDatabasesSessionsPartitionReadCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesDatabasesSessionsPartitionReadCall) Do

Do executes the "spanner.projects.instances.databases.sessions.partitionRead" call. Exactly one of *PartitionResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *PartitionResponse.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 (*ProjectsInstancesDatabasesSessionsPartitionReadCall) Fields

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

func (*ProjectsInstancesDatabasesSessionsPartitionReadCall) Header

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

type ProjectsInstancesDatabasesSessionsReadCall

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

func (*ProjectsInstancesDatabasesSessionsReadCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesDatabasesSessionsReadCall) Do

Do executes the "spanner.projects.instances.databases.sessions.read" call. Exactly one of *ResultSet or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ResultSet.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 (*ProjectsInstancesDatabasesSessionsReadCall) Fields

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

func (*ProjectsInstancesDatabasesSessionsReadCall) Header

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

type ProjectsInstancesDatabasesSessionsRollbackCall

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

func (*ProjectsInstancesDatabasesSessionsRollbackCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesDatabasesSessionsRollbackCall) Do

Do executes the "spanner.projects.instances.databases.sessions.rollback" call. Exactly one of *Empty or error will be non-nil. 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 (*ProjectsInstancesDatabasesSessionsRollbackCall) Fields

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

func (*ProjectsInstancesDatabasesSessionsRollbackCall) Header

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

type ProjectsInstancesDatabasesSessionsService

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

func NewProjectsInstancesDatabasesSessionsService

func NewProjectsInstancesDatabasesSessionsService(s *Service) *ProjectsInstancesDatabasesSessionsService

func (*ProjectsInstancesDatabasesSessionsService) BatchCreate

BatchCreate: Creates multiple new sessions. This API can be used to initialize a session cache on the clients. See https://goo.gl/TgSFN2 for best practices on session cache management.

- database: The database in which the new sessions are created.

func (*ProjectsInstancesDatabasesSessionsService) BatchWrite

BatchWrite: Batches the supplied mutation groups in a collection of efficient transactions. All mutations in a group are committed atomically. However, mutations across groups can be committed non-atomically in an unspecified order and thus, they must be independent of each other. Partial failure is possible, i.e., some groups may have been committed successfully, while some may have failed. The results of individual batches are streamed into the response as the batches are applied. BatchWrite requests are not replay protected, meaning that each mutation group may be applied more than once. Replays of non-idempotent mutations may have undesirable effects. For example, replays of an insert mutation may produce an already exists error or if you use generated or commit timestamp-based keys, it may result in additional rows being added to the mutation's table. We recommend structuring your mutation groups to be idempotent to avoid this issue.

- session: The session in which the batch request is to be run.

func (*ProjectsInstancesDatabasesSessionsService) BeginTransaction

BeginTransaction: Begins a new transaction. This step can often be skipped: Read, ExecuteSql and Commit can begin a new transaction as a side-effect.

- session: The session in which the transaction runs.

func (*ProjectsInstancesDatabasesSessionsService) Commit

Commit: Commits a transaction. The request includes the mutations to be applied to rows in the database. `Commit` might return an `ABORTED` error. This can occur at any time; commonly, the cause is conflicts with concurrent transactions. However, it can also happen for a variety of other reasons. If `Commit` returns `ABORTED`, the caller should re-attempt the transaction from the beginning, re-using the same session. On very rare occasions, `Commit` might return `UNKNOWN`. This can happen, for example, if the client job experiences a 1+ hour networking failure. At that point, Cloud Spanner has lost track of the transaction outcome and we recommend that you perform another read from the database to see the state of things as they are now.

  • session: The session in which the transaction to be committed is running.

func (*ProjectsInstancesDatabasesSessionsService) Create

Create: Creates a new session. A session can be used to perform transactions that read and/or modify data in a Cloud Spanner database. Sessions are meant to be reused for many consecutive transactions. Sessions can only execute one transaction at a time. To execute multiple concurrent read-write/write-only transactions, create multiple sessions. Note that standalone reads and queries use a transaction internally, and count toward the one transaction limit. Active sessions use additional server resources, so it is a good idea to delete idle and unneeded sessions. Aside from explicit deletes, Cloud Spanner may delete sessions for which no operations are sent for more than an hour. If a session is deleted, requests to it return `NOT_FOUND`. Idle sessions can be kept alive by sending a trivial SQL query periodically, e.g., "SELECT 1".

- database: The database in which the new session is created.

func (*ProjectsInstancesDatabasesSessionsService) Delete

Delete: Ends a session, releasing server resources associated with it. This will asynchronously trigger cancellation of any operations that are running with this session.

- name: The name of the session to delete.

func (*ProjectsInstancesDatabasesSessionsService) ExecuteBatchDml

ExecuteBatchDml: Executes a batch of SQL DML statements. This method allows many statements to be run with lower latency than submitting them sequentially with ExecuteSql. Statements are executed in sequential order. A request can succeed even if a statement fails. The ExecuteBatchDmlResponse.status field in the response provides information about the statement that failed. Clients must inspect this field to determine whether an error occurred. Execution stops after the first failed statement; the remaining statements are not executed.

  • session: The session in which the DML statements should be performed.

func (*ProjectsInstancesDatabasesSessionsService) ExecuteSql

ExecuteSql: Executes an SQL statement, returning all results in a single reply. This method cannot be used to return a result set larger than 10 MiB; if the query yields more data than that, the query fails with a `FAILED_PRECONDITION` error. Operations inside read-write transactions might return `ABORTED`. If this occurs, the application should restart the transaction from the beginning. See Transaction for more details. Larger result sets can be fetched in streaming fashion by calling ExecuteStreamingSql instead.

- session: The session in which the SQL query should be performed.

func (*ProjectsInstancesDatabasesSessionsService) ExecuteStreamingSql

ExecuteStreamingSql: Like ExecuteSql, except returns the result set as a stream. Unlike ExecuteSql, there is no limit on the size of the returned result set. However, no individual row in the result set can exceed 100 MiB, and no column value can exceed 10 MiB.

- session: The session in which the SQL query should be performed.

func (*ProjectsInstancesDatabasesSessionsService) Get

Get: Gets a session. Returns `NOT_FOUND` if the session does not exist. This is mainly useful for determining whether a session is still alive.

- name: The name of the session to retrieve.

func (*ProjectsInstancesDatabasesSessionsService) List

List: Lists all sessions in a given database.

- database: The database in which to list sessions.

func (*ProjectsInstancesDatabasesSessionsService) PartitionQuery

PartitionQuery: Creates a set of partition tokens that can be used to execute a query operation in parallel. Each of the returned partition tokens can be used by ExecuteStreamingSql to specify a subset of the query result to read. The same session and read-only transaction must be used by the PartitionQueryRequest used to create the partition tokens and the ExecuteSqlRequests that use the partition tokens. Partition tokens become invalid when the session used to create them is deleted, is idle for too long, begins a new transaction, or becomes too old. When any of these happen, it is not possible to resume the query, and the whole operation must be restarted from the beginning.

- session: The session used to create the partitions.

func (*ProjectsInstancesDatabasesSessionsService) PartitionRead

PartitionRead: Creates a set of partition tokens that can be used to execute a read operation in parallel. Each of the returned partition tokens can be used by StreamingRead to specify a subset of the read result to read. The same session and read-only transaction must be used by the PartitionReadRequest used to create the partition tokens and the ReadRequests that use the partition tokens. There are no ordering guarantees on rows returned among the returned partition tokens, or even within each individual StreamingRead call issued with a partition_token. Partition tokens become invalid when the session used to create them is deleted, is idle for too long, begins a new transaction, or becomes too old. When any of these happen, it is not possible to resume the read, and the whole operation must be restarted from the beginning.

- session: The session used to create the partitions.

func (*ProjectsInstancesDatabasesSessionsService) Read

Read: Reads rows from the database using key lookups and scans, as a simple key/value style alternative to ExecuteSql. This method cannot be used to return a result set larger than 10 MiB; if the read matches more data than that, the read fails with a `FAILED_PRECONDITION` error. Reads inside read-write transactions might return `ABORTED`. If this occurs, the application should restart the transaction from the beginning. See Transaction for more details. Larger result sets can be yielded in streaming fashion by calling StreamingRead instead.

- session: The session in which the read should be performed.

func (*ProjectsInstancesDatabasesSessionsService) Rollback

Rollback: Rolls back a transaction, releasing any locks it holds. It is a good idea to call this for any transaction that includes one or more Read or ExecuteSql requests and ultimately decides not to commit. `Rollback` returns `OK` if it successfully aborts the transaction, the transaction was already aborted, or the transaction is not found. `Rollback` never returns `ABORTED`.

  • session: The session in which the transaction to roll back is running.

func (*ProjectsInstancesDatabasesSessionsService) StreamingRead

StreamingRead: Like Read, except returns the result set as a stream. Unlike Read, there is no limit on the size of the returned result set. However, no individual row in the result set can exceed 100 MiB, and no column value can exceed 10 MiB.

- session: The session in which the read should be performed.

type ProjectsInstancesDatabasesSessionsStreamingReadCall

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

func (*ProjectsInstancesDatabasesSessionsStreamingReadCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesDatabasesSessionsStreamingReadCall) Do

Do executes the "spanner.projects.instances.databases.sessions.streamingRead" call. Exactly one of *PartialResultSet or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *PartialResultSet.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 (*ProjectsInstancesDatabasesSessionsStreamingReadCall) Fields

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

func (*ProjectsInstancesDatabasesSessionsStreamingReadCall) Header

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

type ProjectsInstancesDatabasesSetIamPolicyCall

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

func (*ProjectsInstancesDatabasesSetIamPolicyCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesDatabasesSetIamPolicyCall) Do

Do executes the "spanner.projects.instances.databases.setIamPolicy" call. Exactly one of *Policy or error will be non-nil. 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 (*ProjectsInstancesDatabasesSetIamPolicyCall) Fields

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

func (*ProjectsInstancesDatabasesSetIamPolicyCall) Header

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

type ProjectsInstancesDatabasesTestIamPermissionsCall

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

func (*ProjectsInstancesDatabasesTestIamPermissionsCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesDatabasesTestIamPermissionsCall) Do

Do executes the "spanner.projects.instances.databases.testIamPermissions" call. Exactly one of *TestIamPermissionsResponse or error will be non-nil. 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 (*ProjectsInstancesDatabasesTestIamPermissionsCall) Fields

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

func (*ProjectsInstancesDatabasesTestIamPermissionsCall) Header

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

type ProjectsInstancesDatabasesUpdateDdlCall

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

func (*ProjectsInstancesDatabasesUpdateDdlCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesDatabasesUpdateDdlCall) Do

Do executes the "spanner.projects.instances.databases.updateDdl" call. Exactly one of *Operation or error will be non-nil. 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 (*ProjectsInstancesDatabasesUpdateDdlCall) Fields

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

func (*ProjectsInstancesDatabasesUpdateDdlCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP 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. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesDeleteCall) Do

Do executes the "spanner.projects.instances.delete" call. Exactly one of *Empty or error will be non-nil. 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 information.

func (*ProjectsInstancesDeleteCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP 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. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesGetCall) Do

Do executes the "spanner.projects.instances.get" call. Exactly one of *Instance or error will be non-nil. 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) FieldMask

func (c *ProjectsInstancesGetCall) FieldMask(fieldMask string) *ProjectsInstancesGetCall

FieldMask sets the optional parameter "fieldMask": If field_mask is present, specifies the subset of Instance fields that should be returned. If absent, all Instance fields are returned.

func (*ProjectsInstancesGetCall) Fields

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

func (*ProjectsInstancesGetCall) Header

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

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

func (*ProjectsInstancesGetCall) IfNoneMatch

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

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

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. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesGetIamPolicyCall) Do

Do executes the "spanner.projects.instances.getIamPolicy" call. Exactly one of *Policy or error will be non-nil. 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 information.

func (*ProjectsInstancesGetIamPolicyCall) Header

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

type ProjectsInstancesInstancePartitionsOperationsCancelCall

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

func (*ProjectsInstancesInstancePartitionsOperationsCancelCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesInstancePartitionsOperationsCancelCall) Do

Do executes the "spanner.projects.instances.instancePartitions.operations.cancel" call. Exactly one of *Empty or error will be non-nil. 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 (*ProjectsInstancesInstancePartitionsOperationsCancelCall) Fields

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

func (*ProjectsInstancesInstancePartitionsOperationsCancelCall) Header

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

type ProjectsInstancesInstancePartitionsOperationsDeleteCall

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

func (*ProjectsInstancesInstancePartitionsOperationsDeleteCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesInstancePartitionsOperationsDeleteCall) Do

Do executes the "spanner.projects.instances.instancePartitions.operations.delete" call. Exactly one of *Empty or error will be non-nil. 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 (*ProjectsInstancesInstancePartitionsOperationsDeleteCall) Fields

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

func (*ProjectsInstancesInstancePartitionsOperationsDeleteCall) Header

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

type ProjectsInstancesInstancePartitionsOperationsGetCall

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

func (*ProjectsInstancesInstancePartitionsOperationsGetCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesInstancePartitionsOperationsGetCall) Do

Do executes the "spanner.projects.instances.instancePartitions.operations.get" call. Exactly one of *Operation or error will be non-nil. 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 (*ProjectsInstancesInstancePartitionsOperationsGetCall) Fields

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

func (*ProjectsInstancesInstancePartitionsOperationsGetCall) Header

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

func (*ProjectsInstancesInstancePartitionsOperationsGetCall) IfNoneMatch

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsInstancesInstancePartitionsOperationsListCall

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

func (*ProjectsInstancesInstancePartitionsOperationsListCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesInstancePartitionsOperationsListCall) Do

Do executes the "spanner.projects.instances.instancePartitions.operations.list" call. Exactly one of *ListOperationsResponse or error will be non-nil. 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 (*ProjectsInstancesInstancePartitionsOperationsListCall) Fields

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

func (*ProjectsInstancesInstancePartitionsOperationsListCall) Filter

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

func (*ProjectsInstancesInstancePartitionsOperationsListCall) Header

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

func (*ProjectsInstancesInstancePartitionsOperationsListCall) IfNoneMatch

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsInstancesInstancePartitionsOperationsListCall) PageSize

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

func (*ProjectsInstancesInstancePartitionsOperationsListCall) PageToken

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

func (*ProjectsInstancesInstancePartitionsOperationsListCall) 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 ProjectsInstancesInstancePartitionsOperationsService

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

func (*ProjectsInstancesInstancePartitionsOperationsService) Cancel

Cancel: Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.

- name: The name of the operation resource to be cancelled.

func (*ProjectsInstancesInstancePartitionsOperationsService) Delete

Delete: Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.

- name: The name of the operation resource to be deleted.

func (*ProjectsInstancesInstancePartitionsOperationsService) 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.

func (*ProjectsInstancesInstancePartitionsOperationsService) 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 ProjectsInstancesInstancePartitionsService

type ProjectsInstancesInstancePartitionsService struct {
	Operations *ProjectsInstancesInstancePartitionsOperationsService
	// contains filtered or unexported fields
}

func NewProjectsInstancesInstancePartitionsService

func NewProjectsInstancesInstancePartitionsService(s *Service) *ProjectsInstancesInstancePartitionsService

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. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesListCall) Do

Do executes the "spanner.projects.instances.list" call. Exactly one of *ListInstancesResponse or error will be non-nil. 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 information.

func (*ProjectsInstancesListCall) Filter

Filter sets the optional parameter "filter": An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `display_name` * `labels.key` where key is the name of a label Some examples of using filters are: * `name:*` --> The instance has a name. * `name:Howl` --> The instance's name contains the string "howl". * `name:HOWL` --> Equivalent to above. * `NAME:howl` --> Equivalent to above. * `labels.env:*` --> The instance has the label "env". * `labels.env:dev` --> The instance has the label "env" and the value of the label contains the string "dev". * `name:howl labels.env:dev` --> The instance's name contains "howl" and it has the label "env" with its value containing "dev".

func (*ProjectsInstancesListCall) Header

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

func (*ProjectsInstancesListCall) IfNoneMatch

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

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsInstancesListCall) InstanceDeadline

func (c *ProjectsInstancesListCall) InstanceDeadline(instanceDeadline string) *ProjectsInstancesListCall

InstanceDeadline sets the optional parameter "instanceDeadline": Deadline used while retrieving metadata for instances. Instances whose metadata cannot be retrieved within this deadline will be added to unreachable in ListInstancesResponse.

func (*ProjectsInstancesListCall) PageSize

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

func (*ProjectsInstancesListCall) PageToken

PageToken sets the optional parameter "pageToken": If non-empty, `page_token` should contain a next_page_token from a previous ListInstancesResponse.

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 ProjectsInstancesOperationsCancelCall

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

func (*ProjectsInstancesOperationsCancelCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesOperationsCancelCall) Do

Do executes the "spanner.projects.instances.operations.cancel" call. Exactly one of *Empty or error will be non-nil. 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 (*ProjectsInstancesOperationsCancelCall) Fields

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

func (*ProjectsInstancesOperationsCancelCall) Header

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

type ProjectsInstancesOperationsDeleteCall

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

func (*ProjectsInstancesOperationsDeleteCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesOperationsDeleteCall) Do

Do executes the "spanner.projects.instances.operations.delete" call. Exactly one of *Empty or error will be non-nil. 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 (*ProjectsInstancesOperationsDeleteCall) Fields

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

func (*ProjectsInstancesOperationsDeleteCall) Header

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

type ProjectsInstancesOperationsGetCall

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

func (*ProjectsInstancesOperationsGetCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesOperationsGetCall) Do

Do executes the "spanner.projects.instances.operations.get" call. Exactly one of *Operation or error will be non-nil. 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 (*ProjectsInstancesOperationsGetCall) Fields

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

func (*ProjectsInstancesOperationsGetCall) Header

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

func (*ProjectsInstancesOperationsGetCall) IfNoneMatch

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsInstancesOperationsListCall

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

func (*ProjectsInstancesOperationsListCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesOperationsListCall) Do

Do executes the "spanner.projects.instances.operations.list" call. Exactly one of *ListOperationsResponse or error will be non-nil. 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 (*ProjectsInstancesOperationsListCall) Fields

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

func (*ProjectsInstancesOperationsListCall) Filter

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

func (*ProjectsInstancesOperationsListCall) Header

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

func (*ProjectsInstancesOperationsListCall) IfNoneMatch

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsInstancesOperationsListCall) PageSize

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

func (*ProjectsInstancesOperationsListCall) PageToken

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

func (*ProjectsInstancesOperationsListCall) 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 ProjectsInstancesOperationsService

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

func NewProjectsInstancesOperationsService

func NewProjectsInstancesOperationsService(s *Service) *ProjectsInstancesOperationsService

func (*ProjectsInstancesOperationsService) Cancel

Cancel: Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.

- name: The name of the operation resource to be cancelled.

func (*ProjectsInstancesOperationsService) Delete

Delete: Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.

- name: The name of the operation resource to be deleted.

func (*ProjectsInstancesOperationsService) 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.

func (*ProjectsInstancesOperationsService) 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 ProjectsInstancesPatchCall

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

func (*ProjectsInstancesPatchCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesPatchCall) Do

Do executes the "spanner.projects.instances.patch" call. Exactly one of *Operation or error will be non-nil. 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 (*ProjectsInstancesPatchCall) Fields

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

func (*ProjectsInstancesPatchCall) Header

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

type ProjectsInstancesService

type ProjectsInstancesService struct {
	BackupOperations *ProjectsInstancesBackupOperationsService

	Backups *ProjectsInstancesBackupsService

	DatabaseOperations *ProjectsInstancesDatabaseOperationsService

	Databases *ProjectsInstancesDatabasesService

	InstancePartitions *ProjectsInstancesInstancePartitionsService

	Operations *ProjectsInstancesOperationsService
	// 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: Creates an instance and begins preparing it to begin serving. The returned long-running operation can be used to track the progress of preparing the new instance. The instance name is assigned by the caller. If the named instance already exists, `CreateInstance` returns `ALREADY_EXISTS`. Immediately upon completion of this request: * The instance is readable via the API, with all requested attributes but no allocated resources. Its state is `CREATING`. Until completion of the returned operation: * Cancelling the operation renders the instance immediately unreadable via the API. * The instance can be deleted. * All other attempts to modify the instance are rejected. Upon completion of the returned operation: * Billing for all successfully-allocated resources begins (some types may have lower than the requested levels). * Databases can be created in the instance. * The instance's allocated resource levels are readable via the API. * The instance's state becomes `READY`. The returned long-running operation will have a name of the format `/operations/` and can be used to track creation of the instance. The metadata field type is CreateInstanceMetadata. The response field type is Instance, if successful.

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

func (*ProjectsInstancesService) Delete

Delete: Deletes an instance. Immediately upon completion of the request: * Billing ceases for all of the instance's reserved resources. Soon afterward: * The instance and *all of its databases* immediately and irrevocably disappear from the API. All data in the databases is permanently deleted.

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

func (*ProjectsInstancesService) Get

Get: Gets information about a particular instance.

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

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. Authorization requires `spanner.instances.getIamPolicy` on resource.

  • resource: REQUIRED: The Cloud Spanner resource for which the policy is being retrieved. The format is `projects//instances/` for instance resources and `projects//instances//databases/` for database resources.

func (*ProjectsInstancesService) List

List: Lists all instances in the given project.

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

func (*ProjectsInstancesService) Patch

func (r *ProjectsInstancesService) Patch(nameid string, updateinstancerequest *UpdateInstanceRequest) *ProjectsInstancesPatchCall

Patch: Updates an instance, and begins allocating or releasing resources as requested. The returned long-running operation can be used to track the progress of updating the instance. If the named instance does not exist, returns `NOT_FOUND`. Immediately upon completion of this request: * For resource types for which a decrease in the instance's allocation has been requested, billing is based on the newly-requested level. Until completion of the returned operation: * Cancelling the operation sets its metadata's cancel_time, and begins restoring resources to their pre-request values. The operation is guaranteed to succeed at undoing all resource changes, after which point it terminates with a `CANCELLED` status. * All other attempts to modify the instance are rejected. * Reading the instance via the API continues to give the pre-request resource levels. Upon completion of the returned operation: * Billing begins for all successfully-allocated resources (some types may have lower than the requested levels). * All newly-reserved resources are available for serving the instance's tables. * The instance's new resource levels are readable via the API. The returned long-running operation will have a name of the format `/operations/` and can be used to track the instance modification. The metadata field type is UpdateInstanceMetadata. The response field type is Instance, if successful. Authorization requires `spanner.instances.update` permission on the resource name.

  • name: A unique identifier for the instance, which cannot be changed after the instance is created. Values are of the form `projects//instances/a-z*[a-z0-9]`. The final segment of the name must be between 2 and 64 characters in length.

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. Authorization requires `spanner.instances.setIamPolicy` on resource.

  • resource: REQUIRED: The Cloud Spanner resource for which the policy is being set. The format is `projects//instances/` for instance resources and `projects//instances//databases/` for databases resources.

func (*ProjectsInstancesService) TestIamPermissions

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

TestIamPermissions: Returns permissions that the caller has on the specified instance resource. Attempting this RPC on a non-existent Cloud Spanner instance resource will result in a NOT_FOUND error if the user has `spanner.instances.list` permission on the containing Google Cloud Project. Otherwise returns an empty set of permissions.

  • resource: REQUIRED: The Cloud Spanner resource for which permissions are being tested. The format is `projects//instances/` for instance resources and `projects//instances//databases/` for database resources.

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. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesSetIamPolicyCall) Do

Do executes the "spanner.projects.instances.setIamPolicy" call. Exactly one of *Policy or error will be non-nil. 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 information.

func (*ProjectsInstancesSetIamPolicyCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP 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. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsInstancesTestIamPermissionsCall) Do

Do executes the "spanner.projects.instances.testIamPermissions" call. Exactly one of *TestIamPermissionsResponse or error will be non-nil. 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 information.

func (*ProjectsInstancesTestIamPermissionsCall) Header

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

type ProjectsService

type ProjectsService struct {
	InstanceConfigOperations *ProjectsInstanceConfigOperationsService

	InstanceConfigs *ProjectsInstanceConfigsService

	Instances *ProjectsInstancesService
	// contains filtered or unexported fields
}

func NewProjectsService

func NewProjectsService(s *Service) *ProjectsService

type QueryAdvisorResult

type QueryAdvisorResult struct {
	// IndexAdvice: Optional. Index Recommendation for a query. This is an
	// optional field and the recommendation will only be available when the
	// recommendation guarantees significant improvement in query
	// performance.
	IndexAdvice []*IndexAdvice `json:"indexAdvice,omitempty"`

	// ForceSendFields is a list of field names (e.g. "IndexAdvice") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "IndexAdvice") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

QueryAdvisorResult: Output of query advisor analysis.

func (*QueryAdvisorResult) MarshalJSON

func (s *QueryAdvisorResult) MarshalJSON() ([]byte, error)

type QueryOptions

type QueryOptions struct {
	// OptimizerStatisticsPackage: An option to control the selection of
	// optimizer statistics package. This parameter allows individual
	// queries to use a different query optimizer statistics package.
	// Specifying `latest` as a value instructs Cloud Spanner to use the
	// latest generated statistics package. If not specified, Cloud Spanner
	// uses the statistics package set at the database level options, or the
	// latest package if the database option is not set. The statistics
	// package requested by the query has to be exempt from garbage
	// collection. This can be achieved with the following DDL statement:
	// “` ALTER STATISTICS SET OPTIONS (allow_gc=false) “` The list of
	// available statistics packages can be queried from
	// `INFORMATION_SCHEMA.SPANNER_STATISTICS`. Executing a SQL statement
	// with an invalid optimizer statistics package or with a statistics
	// package that allows garbage collection fails with an
	// `INVALID_ARGUMENT` error.
	OptimizerStatisticsPackage string `json:"optimizerStatisticsPackage,omitempty"`

	// OptimizerVersion: An option to control the selection of optimizer
	// version. This parameter allows individual queries to pick different
	// query optimizer versions. Specifying `latest` as a value instructs
	// Cloud Spanner to use the latest supported query optimizer version. If
	// not specified, Cloud Spanner uses the optimizer version set at the
	// database level options. Any other positive integer (from the list of
	// supported optimizer versions) overrides the default optimizer version
	// for query execution. The list of supported optimizer versions can be
	// queried from SPANNER_SYS.SUPPORTED_OPTIMIZER_VERSIONS. Executing a
	// SQL statement with an invalid optimizer version fails with an
	// `INVALID_ARGUMENT` error. See
	// https://cloud.google.com/spanner/docs/query-optimizer/manage-query-optimizer
	// for more information on managing the query optimizer. The
	// `optimizer_version` statement hint has precedence over this setting.
	OptimizerVersion string `json:"optimizerVersion,omitempty"`

	// ForceSendFields is a list of field names (e.g.
	// "OptimizerStatisticsPackage") to unconditionally include in API
	// requests. By default, fields with empty or default values are omitted
	// from API requests. However, any non-pointer, non-interface field
	// appearing in ForceSendFields will be sent to the server regardless of
	// whether the field is empty or not. This may be used to include empty
	// fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g.
	// "OptimizerStatisticsPackage") to include in API requests with the
	// JSON null value. By default, fields with empty values are omitted
	// from API requests. However, any field with an empty value appearing
	// in NullFields will be sent to the server as null. It is an error if a
	// field in this list has a non-empty value. This may be used to include
	// null fields in Patch requests.
	NullFields []string `json:"-"`
}

QueryOptions: Query optimizer configuration.

func (*QueryOptions) MarshalJSON

func (s *QueryOptions) MarshalJSON() ([]byte, error)

type QueryPlan

type QueryPlan struct {
	// PlanNodes: The nodes in the query plan. Plan nodes are returned in
	// pre-order starting with the plan root. Each PlanNode's `id`
	// corresponds to its index in `plan_nodes`.
	PlanNodes []*PlanNode `json:"planNodes,omitempty"`

	// QueryAdvice: Optional. The advices/recommendations for a query.
	// Currently this field will be serving index recommendations for a
	// query.
	QueryAdvice *QueryAdvisorResult `json:"queryAdvice,omitempty"`

	// ForceSendFields is a list of field names (e.g. "PlanNodes") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "PlanNodes") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

QueryPlan: Contains an ordered list of nodes appearing in the query plan.

func (*QueryPlan) MarshalJSON

func (s *QueryPlan) MarshalJSON() ([]byte, error)

type ReadOnly

type ReadOnly struct {
	// ExactStaleness: Executes all reads at a timestamp that is
	// `exact_staleness` old. The timestamp is chosen soon after the read is
	// started. Guarantees that all writes that have committed more than the
	// specified number of seconds ago are visible. Because Cloud Spanner
	// chooses the exact timestamp, this mode works even if the client's
	// local clock is substantially skewed from Cloud Spanner commit
	// timestamps. Useful for reading at nearby replicas without the
	// distributed timestamp negotiation overhead of `max_staleness`.
	ExactStaleness string `json:"exactStaleness,omitempty"`

	// MaxStaleness: Read data at a timestamp >= `NOW - max_staleness`
	// seconds. Guarantees that all writes that have committed more than the
	// specified number of seconds ago are visible. Because Cloud Spanner
	// chooses the exact timestamp, this mode works even if the client's
	// local clock is substantially skewed from Cloud Spanner commit
	// timestamps. Useful for reading the freshest data available at a
	// nearby replica, while bounding the possible staleness if the local
	// replica has fallen behind. Note that this option can only be used in
	// single-use transactions.
	MaxStaleness string `json:"maxStaleness,omitempty"`

	// MinReadTimestamp: Executes all reads at a timestamp >=
	// `min_read_timestamp`. This is useful for requesting fresher data than
	// some previous read, or data that is fresh enough to observe the
	// effects of some previously committed transaction whose timestamp is
	// known. Note that this option can only be used in single-use
	// transactions. A timestamp in RFC3339 UTC \"Zulu\" format, accurate to
	// nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".
	MinReadTimestamp string `json:"minReadTimestamp,omitempty"`

	// ReadTimestamp: Executes all reads at the given timestamp. Unlike
	// other modes, reads at a specific timestamp are repeatable; the same
	// read at the same timestamp always returns the same data. If the
	// timestamp is in the future, the read will block until the specified
	// timestamp, modulo the read's deadline. Useful for large scale
	// consistent reads such as mapreduces, or for coordinating many reads
	// against a consistent snapshot of the data. A timestamp in RFC3339 UTC
	// \"Zulu\" format, accurate to nanoseconds. Example:
	// "2014-10-02T15:01:23.045123456Z".
	ReadTimestamp string `json:"readTimestamp,omitempty"`

	// ReturnReadTimestamp: If true, the Cloud Spanner-selected read
	// timestamp is included in the Transaction message that describes the
	// transaction.
	ReturnReadTimestamp bool `json:"returnReadTimestamp,omitempty"`

	// Strong: Read at a timestamp where all previously committed
	// transactions are visible.
	Strong bool `json:"strong,omitempty"`

	// ForceSendFields is a list of field names (e.g. "ExactStaleness") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ExactStaleness") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

ReadOnly: Message type to initiate a read-only transaction.

func (*ReadOnly) MarshalJSON

func (s *ReadOnly) MarshalJSON() ([]byte, error)

type ReadRequest

type ReadRequest struct {
	// Columns: Required. The columns of table to be returned for each row
	// matching this request.
	Columns []string `json:"columns,omitempty"`

	// DataBoostEnabled: If this is for a partitioned read and this field is
	// set to `true`, the request is executed with Spanner Data Boost
	// independent compute resources. If the field is set to `true` but the
	// request does not set `partition_token`, the API returns an
	// `INVALID_ARGUMENT` error.
	DataBoostEnabled bool `json:"dataBoostEnabled,omitempty"`

	// DirectedReadOptions: Directed read options for this request.
	DirectedReadOptions *DirectedReadOptions `json:"directedReadOptions,omitempty"`

	// Index: If non-empty, the name of an index on table. This index is
	// used instead of the table primary key when interpreting key_set and
	// sorting result rows. See key_set for further information.
	Index string `json:"index,omitempty"`

	// KeySet: Required. `key_set` identifies the rows to be yielded.
	// `key_set` names the primary keys of the rows in table to be yielded,
	// unless index is present. If index is present, then key_set instead
	// names index keys in index. If the partition_token field is empty,
	// rows are yielded in table primary key order (if index is empty) or
	// index key order (if index is non-empty). If the partition_token field
	// is not empty, rows will be yielded in an unspecified order. It is not
	// an error for the `key_set` to name rows that do not exist in the
	// database. Read yields nothing for nonexistent rows.
	KeySet *KeySet `json:"keySet,omitempty"`

	// Limit: If greater than zero, only the first `limit` rows are yielded.
	// If `limit` is zero, the default is no limit. A limit cannot be
	// specified if `partition_token` is set.
	Limit int64 `json:"limit,omitempty,string"`

	// PartitionToken: If present, results will be restricted to the
	// specified partition previously created using PartitionRead(). There
	// must be an exact match for the values of fields common to this
	// message and the PartitionReadRequest message used to create this
	// partition_token.
	PartitionToken string `json:"partitionToken,omitempty"`

	// RequestOptions: Common options for this request.
	RequestOptions *RequestOptions `json:"requestOptions,omitempty"`

	// ResumeToken: If this request is resuming a previously interrupted
	// read, `resume_token` should be copied from the last PartialResultSet
	// yielded before the interruption. Doing this enables the new read to
	// resume where the last read left off. The rest of the request
	// parameters must exactly match the request that yielded this token.
	ResumeToken string `json:"resumeToken,omitempty"`

	// Table: Required. The name of the table in the database to be read.
	Table string `json:"table,omitempty"`

	// Transaction: The transaction to use. If none is provided, the default
	// is a temporary read-only transaction with strong concurrency.
	Transaction *TransactionSelector `json:"transaction,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Columns") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Columns") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ReadRequest: The request for Read and StreamingRead.

func (*ReadRequest) MarshalJSON

func (s *ReadRequest) MarshalJSON() ([]byte, error)

type ReadWrite

type ReadWrite struct {
	// ReadLockMode: Read lock mode for the transaction.
	//
	// Possible values:
	//   "READ_LOCK_MODE_UNSPECIFIED" - Default value. If the value is not
	// specified, the pessimistic read lock is used.
	//   "PESSIMISTIC" - Pessimistic lock mode. Read locks are acquired
	// immediately on read.
	//   "OPTIMISTIC" - Optimistic lock mode. Locks for reads within the
	// transaction are not acquired on read. Instead the locks are acquired
	// on a commit to validate that read/queried data has not changed since
	// the transaction started.
	ReadLockMode string `json:"readLockMode,omitempty"`

	// ForceSendFields is a list of field names (e.g. "ReadLockMode") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ReadLockMode") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ReadWrite: Message type to initiate a read-write transaction. Currently this transaction type has no options.

func (*ReadWrite) MarshalJSON

func (s *ReadWrite) MarshalJSON() ([]byte, error)

type ReplicaInfo

type ReplicaInfo struct {
	// DefaultLeaderLocation: If true, this location is designated as the
	// default leader location where leader replicas are placed. See the
	// region types documentation
	// (https://cloud.google.com/spanner/docs/instances#region_types) for
	// more details.
	DefaultLeaderLocation bool `json:"defaultLeaderLocation,omitempty"`

	// Location: The location of the serving resources, e.g., "us-central1".
	Location string `json:"location,omitempty"`

	// Type: The type of replica.
	//
	// Possible values:
	//   "TYPE_UNSPECIFIED" - Not specified.
	//   "READ_WRITE" - Read-write replicas support both reads and writes.
	// These replicas: * Maintain a full copy of your data. * Serve reads. *
	// Can vote whether to commit a write. * Participate in leadership
	// election. * Are eligible to become a leader.
	//   "READ_ONLY" - Read-only replicas only support reads (not writes).
	// Read-only replicas: * Maintain a full copy of your data. * Serve
	// reads. * Do not participate in voting to commit writes. * Are not
	// eligible to become a leader.
	//   "WITNESS" - Witness replicas don't support reads but do participate
	// in voting to commit writes. Witness replicas: * Do not maintain a
	// full copy of data. * Do not serve reads. * Vote whether to commit
	// writes. * Participate in leader election but are not eligible to
	// become leader.
	Type string `json:"type,omitempty"`

	// ForceSendFields is a list of field names (e.g.
	// "DefaultLeaderLocation") to unconditionally include in API requests.
	// By default, fields with empty or default values are omitted from API
	// requests. However, any non-pointer, non-interface field appearing in
	// ForceSendFields will be sent to the server regardless of whether the
	// field is empty or not. This may be used to include empty fields in
	// Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "DefaultLeaderLocation") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

func (*ReplicaInfo) MarshalJSON

func (s *ReplicaInfo) MarshalJSON() ([]byte, error)

type ReplicaSelection

type ReplicaSelection struct {
	// Location: The location or region of the serving requests, e.g.
	// "us-east1".
	Location string `json:"location,omitempty"`

	// Type: The type of replica.
	//
	// Possible values:
	//   "TYPE_UNSPECIFIED" - Not specified.
	//   "READ_WRITE" - Read-write replicas support both reads and writes.
	//   "READ_ONLY" - Read-only replicas only support reads (not writes).
	Type string `json:"type,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Location") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Location") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ReplicaSelection: The directed read replica selector. Callers must provide one or more of the following fields for replica selection: * `location` - The location must be one of the regions within the multi-region configuration of your database. * `type` - The type of the replica. Some examples of using replica_selectors are: * `location:us-east1` --> The "us-east1" replica(s) of any available type will be used to process the request. * `type:READ_ONLY` --> The "READ_ONLY" type replica(s) in nearest available location will be used to process the request. * `location:us-east1 type:READ_ONLY` --> The "READ_ONLY" type replica(s) in location "us-east1" will be used to process the request.

func (*ReplicaSelection) MarshalJSON

func (s *ReplicaSelection) MarshalJSON() ([]byte, error)

type RequestOptions

type RequestOptions struct {
	// Priority: Priority for the request.
	//
	// Possible values:
	//   "PRIORITY_UNSPECIFIED" - `PRIORITY_UNSPECIFIED` is equivalent to
	// `PRIORITY_HIGH`.
	//   "PRIORITY_LOW" - This specifies that the request is low priority.
	//   "PRIORITY_MEDIUM" - This specifies that the request is medium
	// priority.
	//   "PRIORITY_HIGH" - This specifies that the request is high priority.
	Priority string `json:"priority,omitempty"`

	// RequestTag: A per-request tag which can be applied to queries or
	// reads, used for statistics collection. Both request_tag and
	// transaction_tag can be specified for a read or query that belongs to
	// a transaction. This field is ignored for requests where it's not
	// applicable (e.g. CommitRequest). Legal characters for `request_tag`
	// values are all printable characters (ASCII 32 - 126) and the length
	// of a request_tag is limited to 50 characters. Values that exceed this
	// limit are truncated. Any leading underscore (_) characters will be
	// removed from the string.
	RequestTag string `json:"requestTag,omitempty"`

	// TransactionTag: A tag used for statistics collection about this
	// transaction. Both request_tag and transaction_tag can be specified
	// for a read or query that belongs to a transaction. The value of
	// transaction_tag should be the same for all requests belonging to the
	// same transaction. If this request doesn't belong to any transaction,
	// transaction_tag will be ignored. Legal characters for
	// `transaction_tag` values are all printable characters (ASCII 32 -
	// 126) and the length of a transaction_tag is limited to 50 characters.
	// Values that exceed this limit are truncated. Any leading underscore
	// (_) characters will be removed from the string.
	TransactionTag string `json:"transactionTag,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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

RequestOptions: Common request options for various APIs.

func (*RequestOptions) MarshalJSON

func (s *RequestOptions) MarshalJSON() ([]byte, error)

type RestoreDatabaseEncryptionConfig

type RestoreDatabaseEncryptionConfig struct {
	// EncryptionType: Required. The encryption type of the restored
	// database.
	//
	// Possible values:
	//   "ENCRYPTION_TYPE_UNSPECIFIED" - Unspecified. Do not use.
	//   "USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION" - This is the default
	// option when encryption_config is not specified.
	//   "GOOGLE_DEFAULT_ENCRYPTION" - Use Google default encryption.
	//   "CUSTOMER_MANAGED_ENCRYPTION" - Use customer managed encryption. If
	// specified, `kms_key_name` must must contain a valid Cloud KMS key.
	EncryptionType string `json:"encryptionType,omitempty"`

	// KmsKeyName: Optional. The Cloud KMS key that will be used to
	// encrypt/decrypt the restored database. This field should be set only
	// when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of
	// the form `projects//locations//keyRings//cryptoKeys/`.
	KmsKeyName string `json:"kmsKeyName,omitempty"`

	// ForceSendFields is a list of field names (e.g. "EncryptionType") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "EncryptionType") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

RestoreDatabaseEncryptionConfig: Encryption configuration for the restored database.

func (*RestoreDatabaseEncryptionConfig) MarshalJSON

func (s *RestoreDatabaseEncryptionConfig) MarshalJSON() ([]byte, error)

type RestoreDatabaseMetadata

type RestoreDatabaseMetadata struct {
	// BackupInfo: Information about the backup used to restore the
	// database.
	BackupInfo *BackupInfo `json:"backupInfo,omitempty"`

	// CancelTime: The time at which cancellation of this operation was
	// received. Operations.CancelOperation starts asynchronous cancellation
	// on a long-running operation. The server makes a best effort to cancel
	// the operation, but success is not guaranteed. Clients can use
	// Operations.GetOperation or other methods to check whether the
	// cancellation succeeded or whether the operation completed despite
	// cancellation. On successful cancellation, the operation is not
	// deleted; instead, it becomes an operation with an Operation.error
	// value with a google.rpc.Status.code of 1, corresponding to
	// `Code.CANCELLED`.
	CancelTime string `json:"cancelTime,omitempty"`

	// Name: Name of the database being created and restored to.
	Name string `json:"name,omitempty"`

	// OptimizeDatabaseOperationName: 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
	// database, and remove the dependency on the restore source. The name
	// is of the form `projects//instances//databases//operations/` where
	// the is the name of database being created and restored to. The
	// metadata type of the long-running operation is
	// OptimizeRestoredDatabaseMetadata. This long-running operation will be
	// automatically created by the system after the RestoreDatabase
	// long-running operation completes successfully. This operation will
	// not be created if the restore was not successful.
	OptimizeDatabaseOperationName string `json:"optimizeDatabaseOperationName,omitempty"`

	// Progress: The progress of the RestoreDatabase operation.
	Progress *OperationProgress `json:"progress,omitempty"`

	// SourceType: The type of the restore source.
	//
	// Possible values:
	//   "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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

RestoreDatabaseMetadata: Metadata type for the long-running operation returned by RestoreDatabase.

func (*RestoreDatabaseMetadata) MarshalJSON

func (s *RestoreDatabaseMetadata) MarshalJSON() ([]byte, error)

type RestoreDatabaseRequest

type RestoreDatabaseRequest struct {
	// Backup: Name of the backup from which to restore. Values are of the
	// form `projects//instances//backups/`.
	Backup string `json:"backup,omitempty"`

	// DatabaseId: Required. The id of the database to create and restore
	// to. This database must not already exist. The `database_id` appended
	// to `parent` forms the full database name of the form
	// `projects//instances//databases/`.
	DatabaseId string `json:"databaseId,omitempty"`

	// EncryptionConfig: Optional. An encryption configuration describing
	// the encryption type and key resources in Cloud KMS used to
	// encrypt/decrypt the database to restore to. If this field is not
	// specified, the restored database will use the same encryption
	// configuration as the backup by default, namely encryption_type =
	// `USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION`.
	EncryptionConfig *RestoreDatabaseEncryptionConfig `json:"encryptionConfig,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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

RestoreDatabaseRequest: The request for RestoreDatabase.

func (*RestoreDatabaseRequest) MarshalJSON

func (s *RestoreDatabaseRequest) MarshalJSON() ([]byte, error)

type RestoreInfo

type RestoreInfo struct {
	// BackupInfo: Information about the backup used to restore the
	// database. The backup may no longer exist.
	BackupInfo *BackupInfo `json:"backupInfo,omitempty"`

	// SourceType: The type of the restore source.
	//
	// Possible values:
	//   "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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

RestoreInfo: Information about the database restore.

func (*RestoreInfo) MarshalJSON

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

type ResultSet

type ResultSet struct {
	// Metadata: Metadata about the result set, such as row type
	// information.
	Metadata *ResultSetMetadata `json:"metadata,omitempty"`

	// Rows: Each element in `rows` is a row whose format is defined by
	// metadata.row_type. The ith element in each row matches the ith field
	// in metadata.row_type. Elements are encoded based on type as described
	// here.
	Rows [][]interface{} `json:"rows,omitempty"`

	// Stats: Query plan and execution statistics for the SQL statement that
	// produced this result set. These can be requested by setting
	// ExecuteSqlRequest.query_mode. DML statements always produce stats
	// containing the number of rows modified, unless executed using the
	// ExecuteSqlRequest.QueryMode.PLAN ExecuteSqlRequest.query_mode. Other
	// fields may or may not be populated, based on the
	// ExecuteSqlRequest.query_mode.
	Stats *ResultSetStats `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. "Metadata") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Metadata") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ResultSet: Results from Read or ExecuteSql.

func (*ResultSet) MarshalJSON

func (s *ResultSet) MarshalJSON() ([]byte, error)

type ResultSetMetadata

type ResultSetMetadata struct {
	// RowType: Indicates the field names and types for the rows in the
	// result set. For example, a SQL query like "SELECT UserId, UserName
	// FROM Users" could return a `row_type` value like: "fields": [ {
	// "name": "UserId", "type": { "code": "INT64" } }, { "name":
	// "UserName", "type": { "code": "STRING" } }, ]
	RowType *StructType `json:"rowType,omitempty"`

	// Transaction: If the read or SQL query began a transaction as a
	// side-effect, the information about the new transaction is yielded
	// here.
	Transaction *Transaction `json:"transaction,omitempty"`

	// UndeclaredParameters: A SQL query can be parameterized. In PLAN mode,
	// these parameters can be undeclared. This indicates the field names
	// and types for those undeclared parameters in the SQL query. For
	// example, a SQL query like "SELECT * FROM Users where UserId =
	// @userId and UserName = @userName " could return a
	// `undeclared_parameters` value like: "fields": [ { "name": "UserId",
	// "type": { "code": "INT64" } }, { "name": "UserName", "type": {
	// "code": "STRING" } }, ]
	UndeclaredParameters *StructType `json:"undeclaredParameters,omitempty"`

	// ForceSendFields is a list of field names (e.g. "RowType") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "RowType") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ResultSetMetadata: Metadata about a ResultSet or PartialResultSet.

func (*ResultSetMetadata) MarshalJSON

func (s *ResultSetMetadata) MarshalJSON() ([]byte, error)

type ResultSetStats

type ResultSetStats struct {
	// QueryPlan: QueryPlan for the query associated with this result.
	QueryPlan *QueryPlan `json:"queryPlan,omitempty"`

	// QueryStats: Aggregated statistics from the execution of the query.
	// Only present when the query is profiled. For example, a query could
	// return the statistics as follows: { "rows_returned": "3",
	// "elapsed_time": "1.22 secs", "cpu_time": "1.19 secs" }
	QueryStats googleapi.RawMessage `json:"queryStats,omitempty"`

	// RowCountExact: Standard DML returns an exact count of rows that were
	// modified.
	RowCountExact int64 `json:"rowCountExact,omitempty,string"`

	// RowCountLowerBound: Partitioned DML does not offer exactly-once
	// semantics, so it returns a lower bound of the rows modified.
	RowCountLowerBound int64 `json:"rowCountLowerBound,omitempty,string"`

	// ForceSendFields is a list of field names (e.g. "QueryPlan") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "QueryPlan") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ResultSetStats: Additional statistics about a ResultSet or PartialResultSet.

func (*ResultSetStats) MarshalJSON

func (s *ResultSetStats) MarshalJSON() ([]byte, error)

type RollbackRequest

type RollbackRequest struct {
	// TransactionId: Required. The transaction to roll back.
	TransactionId string `json:"transactionId,omitempty"`

	// ForceSendFields is a list of field names (e.g. "TransactionId") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "TransactionId") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

RollbackRequest: The request for Rollback.

func (*RollbackRequest) MarshalJSON

func (s *RollbackRequest) MarshalJSON() ([]byte, error)

type Scan

type Scan struct {
	// Details: Additional information provided by the implementer.
	Details googleapi.RawMessage `json:"details,omitempty"`

	// EndTime: The upper bound for when the scan is defined.
	EndTime string `json:"endTime,omitempty"`

	// Name: The unique name of the scan, specific to the Database service
	// implementing this interface.
	Name string `json:"name,omitempty"`

	// ScanData: Output only. Cloud Key Visualizer scan data. Note, this
	// field is not available to the ListScans method.
	ScanData *ScanData `json:"scanData,omitempty"`

	// StartTime: A range of time (inclusive) for when the scan is defined.
	// The lower bound for when the scan is defined.
	StartTime string `json:"startTime,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Details") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Details") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Scan: Scan is a structure which describes Cloud Key Visualizer scan information.

func (*Scan) MarshalJSON

func (s *Scan) MarshalJSON() ([]byte, error)

type ScanData

type ScanData struct {
	// Data: Cloud Key Visualizer scan data. The range of time this
	// information covers is captured via the above time range fields. Note,
	// this field is not available to the ListScans method.
	Data *VisualizationData `json:"data,omitempty"`

	// EndTime: The upper bound for when the contained data is defined.
	EndTime string `json:"endTime,omitempty"`

	// StartTime: A range of time (inclusive) for when the contained data is
	// defined. The lower bound for when the contained data is defined.
	StartTime string `json:"startTime,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Data") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Data") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ScanData: ScanData contains Cloud Key Visualizer scan data used by the caller to construct a visualization.

func (*ScanData) MarshalJSON

func (s *ScanData) MarshalJSON() ([]byte, error)

type ScansListCall

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

func (*ScansListCall) Context

func (c *ScansListCall) Context(ctx context.Context) *ScansListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ScansListCall) Do

Do executes the "spanner.scans.list" call. Exactly one of *ListScansResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListScansResponse.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 (*ScansListCall) Fields

func (c *ScansListCall) Fields(s ...googleapi.Field) *ScansListCall

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

func (*ScansListCall) Filter

func (c *ScansListCall) Filter(filter string) *ScansListCall

Filter sets the optional parameter "filter": A filter expression to restrict the results based on information present in the available Scan collection. The filter applies to all fields within the Scan message except for `data`.

func (*ScansListCall) Header

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

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

func (*ScansListCall) IfNoneMatch

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

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ScansListCall) PageSize

func (c *ScansListCall) PageSize(pageSize int64) *ScansListCall

PageSize sets the optional parameter "pageSize": The maximum number of items to return.

func (*ScansListCall) PageToken

func (c *ScansListCall) PageToken(pageToken string) *ScansListCall

PageToken sets the optional parameter "pageToken": The next_page_token value returned from a previous List request, if any.

func (*ScansListCall) Pages

func (c *ScansListCall) Pages(ctx context.Context, f func(*ListScansResponse) error) error

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 (*ScansListCall) View

func (c *ScansListCall) View(view string) *ScansListCall

View sets the optional parameter "view": Specifies which parts of the Scan should be returned in the response. Note, only the SUMMARY view (the default) is currently supported for ListScans.

Possible values:

"VIEW_UNSPECIFIED" - Not specified, equivalent to SUMMARY.
"SUMMARY" - Server responses only include `name`, `details`,

`start_time` and `end_time`. The default value. Note, the ListScans method may only use this view type, others view types are not supported.

"FULL" - Full representation of the scan is returned in the server

response, including `data`.

type ScansService

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

func NewScansService

func NewScansService(s *Service) *ScansService

func (*ScansService) List

func (r *ScansService) List(parent string) *ScansListCall

List: Return available scans given a Database-specific resource name.

  • parent: The unique name of the parent resource, specific to the Database service implementing this interface.

type Service

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

	Projects *ProjectsService

	Scans *ScansService
	// 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

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

NewService creates a new Service.

type Session

type Session struct {
	// ApproximateLastUseTime: Output only. The approximate timestamp when
	// the session is last used. It is typically earlier than the actual
	// last use time.
	ApproximateLastUseTime string `json:"approximateLastUseTime,omitempty"`

	// CreateTime: Output only. The timestamp when the session is created.
	CreateTime string `json:"createTime,omitempty"`

	// CreatorRole: The database role which created this session.
	CreatorRole string `json:"creatorRole,omitempty"`

	// Labels: The labels for the session. * Label keys must be between 1
	// and 63 characters long and must conform to the following regular
	// expression: `a-z ([-a-z0-9]*[a-z0-9])?`. * Label values must be
	// between 0 and 63 characters long and must conform to the regular
	// expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. * No more than 64 labels
	// can be associated with a given session. See https://goo.gl/xmQnxf for
	// more information on and examples of labels.
	Labels map[string]string `json:"labels,omitempty"`

	// Name: Output only. The name of the session. This is always
	// system-assigned.
	Name string `json:"name,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g.
	// "ApproximateLastUseTime") to unconditionally include in API requests.
	// By default, fields with empty or default values are omitted from API
	// requests. However, any non-pointer, non-interface field appearing in
	// ForceSendFields will be sent to the server regardless of whether the
	// field is empty or not. This may be used to include empty fields in
	// Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ApproximateLastUseTime")
	// to include in API requests with the JSON null value. By default,
	// fields with empty values are omitted from API requests. However, any
	// field with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

Session: A session in the Cloud Spanner API.

func (*Session) MarshalJSON

func (s *Session) MarshalJSON() ([]byte, error)

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

	// 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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

SetIamPolicyRequest: Request message for `SetIamPolicy` method.

func (*SetIamPolicyRequest) MarshalJSON

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

type ShortRepresentation

type ShortRepresentation struct {
	// Description: A string representation of the expression subtree rooted
	// at this node.
	Description string `json:"description,omitempty"`

	// Subqueries: A mapping of (subquery variable name) -> (subquery node
	// id) for cases where the `description` string of this node references
	// a `SCALAR` subquery contained in the expression subtree rooted at
	// this node. The referenced `SCALAR` subquery may not necessarily be a
	// direct child of this node.
	Subqueries map[string]int64 `json:"subqueries,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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ShortRepresentation: Condensed representation of a node and its subtree. Only present for `SCALAR` PlanNode(s).

func (*ShortRepresentation) MarshalJSON

func (s *ShortRepresentation) MarshalJSON() ([]byte, error)

type Statement

type Statement struct {
	// ParamTypes: It is not always possible for Cloud Spanner to infer the
	// right SQL type from a JSON value. For example, values of type `BYTES`
	// and values of type `STRING` both appear in params as JSON strings. In
	// these cases, `param_types` can be used to specify the exact SQL type
	// for some or all of the SQL statement parameters. See the definition
	// of Type for more information about SQL types.
	ParamTypes map[string]Type `json:"paramTypes,omitempty"`

	// Params: Parameter names and values that bind to placeholders in the
	// DML string. A parameter placeholder consists of the `@` character
	// followed by the parameter name (for example, `@firstName`). Parameter
	// names can contain letters, numbers, and underscores. Parameters can
	// appear anywhere that a literal value is expected. The same parameter
	// name can be used more than once, for example: "WHERE id > @msg_id
	// AND id < @msg_id + 100" It is an error to execute a SQL statement
	// with unbound parameters.
	Params googleapi.RawMessage `json:"params,omitempty"`

	// Sql: Required. The DML string.
	Sql string `json:"sql,omitempty"`

	// ForceSendFields is a list of field names (e.g. "ParamTypes") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ParamTypes") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Statement: A single DML statement.

func (*Statement) MarshalJSON

func (s *Statement) MarshalJSON() ([]byte, error)

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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	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 StructType

type StructType struct {
	// Fields: The list of fields that make up this struct. Order is
	// significant, because values of this struct type are represented as
	// lists, where the order of field values matches the order of fields in
	// the StructType. In turn, the order of fields matches the order of
	// columns in a read request, or the order of fields in the `SELECT`
	// clause of a query.
	Fields []*Field `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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

StructType: `StructType` defines the fields of a STRUCT type.

func (*StructType) MarshalJSON

func (s *StructType) MarshalJSON() ([]byte, error)

type TestIamPermissionsRequest

type TestIamPermissionsRequest struct {
	// Permissions: REQUIRED: The set of permissions to check for
	// 'resource'. Permissions with wildcards (such as '*', 'spanner.*',
	// 'spanner.instances.*') are not allowed.
	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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

TestIamPermissionsResponse: Response message for `TestIamPermissions` method.

func (*TestIamPermissionsResponse) MarshalJSON

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

type Transaction

type Transaction struct {
	// Id: `id` may be used to identify the transaction in subsequent Read,
	// ExecuteSql, Commit, or Rollback calls. Single-use read-only
	// transactions do not have IDs, because single-use transactions do not
	// support multiple requests.
	Id string `json:"id,omitempty"`

	// ReadTimestamp: For snapshot read-only transactions, the read
	// timestamp chosen for the transaction. Not returned by default: see
	// TransactionOptions.ReadOnly.return_read_timestamp. A timestamp in
	// RFC3339 UTC \"Zulu\" format, accurate to nanoseconds. Example:
	// "2014-10-02T15:01:23.045123456Z".
	ReadTimestamp string `json:"readTimestamp,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Id") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Id") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Transaction: A transaction.

func (*Transaction) MarshalJSON

func (s *Transaction) MarshalJSON() ([]byte, error)

type TransactionOptions

type TransactionOptions struct {
	// PartitionedDml: Partitioned DML transaction. Authorization to begin a
	// Partitioned DML transaction requires
	// `spanner.databases.beginPartitionedDmlTransaction` permission on the
	// `session` resource.
	PartitionedDml *PartitionedDml `json:"partitionedDml,omitempty"`

	// ReadOnly: Transaction will not write. Authorization to begin a
	// read-only transaction requires
	// `spanner.databases.beginReadOnlyTransaction` permission on the
	// `session` resource.
	ReadOnly *ReadOnly `json:"readOnly,omitempty"`

	// ReadWrite: Transaction may write. Authorization to begin a read-write
	// transaction requires
	// `spanner.databases.beginOrRollbackReadWriteTransaction` permission on
	// the `session` resource.
	ReadWrite *ReadWrite `json:"readWrite,omitempty"`

	// ForceSendFields is a list of field names (e.g. "PartitionedDml") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "PartitionedDml") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

TransactionOptions: Transactions: Each session can have at most one active transaction at a time (note that standalone reads and queries use a transaction internally and do count towards the one transaction limit). After the active transaction is completed, the session can immediately be re-used for the next transaction. It is not necessary to create a new session for each transaction. Transaction modes: Cloud Spanner supports three transaction modes: 1. Locking read-write. This type of transaction is the only way to write data into Cloud Spanner. These transactions rely on pessimistic locking and, if necessary, two-phase commit. Locking read-write transactions may abort, requiring the application to retry. 2. Snapshot read-only. Snapshot read-only transactions provide guaranteed consistency across several reads, but do not allow writes. Snapshot read-only transactions can be configured to read at timestamps in the past, or configured to perform a strong read (where Spanner will select a timestamp such that the read is guaranteed to see the effects of all transactions that have committed before the start of the read). Snapshot read-only transactions do not need to be committed. Queries on change streams must be performed with the snapshot read-only transaction mode, specifying a strong read. Please see TransactionOptions.ReadOnly.strong for more details. 3. Partitioned DML. This type of transaction is used to execute a single Partitioned DML statement. Partitioned DML partitions the key space and runs the DML statement over each partition in parallel using separate, internal transactions that commit independently. Partitioned DML transactions do not need to be committed. For transactions that only read, snapshot read-only transactions provide simpler semantics and are almost always faster. In particular, read-only transactions do not take locks, so they do not conflict with read-write transactions. As a consequence of not taking locks, they also do not abort, so retry loops are not needed. Transactions may only read-write data in a single database. They may, however, read-write data in different tables within that database. Locking read-write transactions: Locking transactions may be used to atomically read-modify-write data anywhere in a database. This type of transaction is externally consistent. Clients should attempt to minimize the amount of time a transaction is active. Faster transactions commit with higher probability and cause less contention. Cloud Spanner attempts to keep read locks active as long as the transaction continues to do reads, and the transaction has not been terminated by Commit or Rollback. Long periods of inactivity at the client may cause Cloud Spanner to release a transaction's locks and abort it. Conceptually, a read-write transaction consists of zero or more reads or SQL statements followed by Commit. At any time before Commit, the client can send a Rollback request to abort the transaction. Semantics: Cloud Spanner can commit the transaction if all read locks it acquired are still valid at commit time, and it is able to acquire write locks for all writes. Cloud Spanner can abort the transaction for any reason. If a commit attempt returns `ABORTED`, Cloud Spanner guarantees that the transaction has not modified any user data in Cloud Spanner. Unless the transaction commits, Cloud Spanner makes no guarantees about how long the transaction's locks were held for. It is an error to use Cloud Spanner locks for any sort of mutual exclusion other than between Cloud Spanner transactions themselves. Retrying aborted transactions: When a transaction aborts, the application can choose to retry the whole transaction again. To maximize the chances of successfully committing the retry, the client should execute the retry in the same session as the original attempt. The original session's lock priority increases with each consecutive abort, meaning that each attempt has a slightly better chance of success than the previous. Under some circumstances (for example, many transactions attempting to modify the same row(s)), a transaction can abort many times in a short period before successfully committing. Thus, it is not a good idea to cap the number of retries a transaction can attempt; instead, it is better to limit the total amount of time spent retrying. Idle transactions: A transaction is considered idle if it has no outstanding reads or SQL queries and has not started a read or SQL query within the last 10 seconds. Idle transactions can be aborted by Cloud Spanner so that they don't hold on to locks indefinitely. If an idle transaction is aborted, the commit will fail with error `ABORTED`. If this behavior is undesirable, periodically executing a simple SQL query in the transaction (for example, `SELECT 1`) prevents the transaction from becoming idle. Snapshot read-only transactions: Snapshot read-only transactions provides a simpler method than locking read-write transactions for doing several consistent reads. However, this type of transaction does not support writes. Snapshot transactions do not take locks. Instead, they work by choosing a Cloud Spanner timestamp, then executing all reads at that timestamp. Since they do not acquire locks, they do not block concurrent read-write transactions. Unlike locking read-write transactions, snapshot read-only transactions never abort. They can fail if the chosen read timestamp is garbage collected; however, the default garbage collection policy is generous enough that most applications do not need to worry about this in practice. Snapshot read-only transactions do not need to call Commit or Rollback (and in fact are not permitted to do so). To execute a snapshot transaction, the client specifies a timestamp bound, which tells Cloud Spanner how to choose a read timestamp. The types of timestamp bound are: - Strong (the default). - Bounded staleness. - Exact staleness. If the Cloud Spanner database to be read is geographically distributed, stale read-only transactions can execute more quickly than strong or read-write transactions, because they are able to execute far from the leader replica. Each type of timestamp bound is discussed in detail below. Strong: Strong reads are guaranteed to see the effects of all transactions that have committed before the start of the read. Furthermore, all rows yielded by a single read are consistent with each other -- if any part of the read observes a transaction, all parts of the read see the transaction. Strong reads are not repeatable: two consecutive strong read-only transactions might return inconsistent results if there are concurrent writes. If consistency across reads is required, the reads should be executed within a transaction or at an exact read timestamp. Queries on change streams (see below for more details) must also specify the strong read timestamp bound. See TransactionOptions.ReadOnly.strong. Exact staleness: These timestamp bounds execute reads at a user-specified timestamp. Reads at a timestamp are guaranteed to see a consistent prefix of the global transaction history: they observe modifications done by all transactions with a commit timestamp less than or equal to the read timestamp, and observe none of the modifications done by transactions with a larger commit timestamp. They will block until all conflicting transactions that may be assigned commit timestamps <= the read timestamp have finished. The timestamp can either be expressed as an absolute Cloud Spanner commit timestamp or a staleness relative to the current time. These modes do not require a "negotiation phase" to pick a timestamp. As a result, they execute slightly faster than the equivalent boundedly stale concurrency modes. On the other hand, boundedly stale reads usually return fresher results. See TransactionOptions.ReadOnly.read_timestamp and TransactionOptions.ReadOnly.exact_staleness. Bounded staleness: Bounded staleness modes allow Cloud Spanner to pick the read timestamp, subject to a user-provided staleness bound. Cloud Spanner chooses the newest timestamp within the staleness bound that allows execution of the reads at the closest available replica without blocking. All rows yielded are consistent with each other -- if any part of the read observes a transaction, all parts of the read see the transaction. Boundedly stale reads are not repeatable: two stale reads, even if they use the same staleness bound, can execute at different timestamps and thus return inconsistent results. Boundedly stale reads execute in two phases: the first phase negotiates a timestamp among all replicas needed to serve the read. In the second phase, reads are executed at the negotiated timestamp. As a result of the two phase execution, bounded staleness reads are usually a little slower than comparable exact staleness reads. However, they are typically able to return fresher results, and are more likely to execute at the closest replica. Because the timestamp negotiation requires up-front knowledge of which rows will be read, it can only be used with single-use read-only transactions. See TransactionOptions.ReadOnly.max_staleness and TransactionOptions.ReadOnly.min_read_timestamp. Old read timestamps and garbage collection: Cloud Spanner continuously garbage collects deleted and overwritten data in the background to reclaim storage space. This process is known as "version GC". By default, version GC reclaims versions after they are one hour old. Because of this, Cloud Spanner cannot perform reads at read timestamps more than one hour in the past. This restriction also applies to in-progress reads and/or SQL queries whose timestamp become too old while executing. Reads and SQL queries with too-old read timestamps fail with the error `FAILED_PRECONDITION`. You can configure and extend the `VERSION_RETENTION_PERIOD` of a database up to a period as long as one week, which allows Cloud Spanner to perform reads up to one week in the past. Querying change Streams: A Change Stream is a schema object that can be configured to watch data changes on the entire database, a set of tables, or a set of columns in a database. When a change stream is created, Spanner automatically defines a corresponding SQL Table-Valued Function (TVF) that can be used to query the change records in the associated change stream using the ExecuteStreamingSql API. The name of the TVF for a change stream is generated from the name of the change stream: READ_. All queries on change stream TVFs must be executed using the ExecuteStreamingSql API with a single-use read-only transaction with a strong read-only timestamp_bound. The change stream TVF allows users to specify the start_timestamp and end_timestamp for the time range of interest. All change records within the retention period is accessible using the strong read-only timestamp_bound. All other TransactionOptions are invalid for change stream queries. In addition, if TransactionOptions.read_only.return_read_timestamp is set to true, a special value of 2^63 - 2 will be returned in the Transaction message that describes the transaction, instead of a valid read timestamp. This special value should be discarded and not used for any subsequent queries. Please see https://cloud.google.com/spanner/docs/change-streams for more details on how to query the change stream TVFs. Partitioned DML transactions: Partitioned DML transactions are used to execute DML statements with a different execution strategy that provides different, and often better, scalability properties for large, table-wide operations than DML in a ReadWrite transaction. Smaller scoped statements, such as an OLTP workload, should prefer using ReadWrite transactions. Partitioned DML partitions the keyspace and runs the DML statement on each partition in separate, internal transactions. These transactions commit automatically when complete, and run independently from one another. To reduce lock contention, this execution strategy only acquires read locks on rows that match the WHERE clause of the statement. Additionally, the smaller per-partition transactions hold locks for less time. That said, Partitioned DML is not a drop-in replacement for standard DML used in ReadWrite transactions. - The DML statement must be fully-partitionable. Specifically, the statement must be expressible as the union of many statements which each access only a single row of the table. - The statement is not applied atomically to all rows of the table. Rather, the statement is applied atomically to partitions of the table, in independent transactions. Secondary index rows are updated atomically with the base table rows. - Partitioned DML does not guarantee exactly-once execution semantics against a partition. The statement will be applied at least once to each partition. It is strongly recommended that the DML statement should be idempotent to avoid unexpected results. For instance, it is potentially dangerous to run a statement such as `UPDATE table SET column = column + 1` as it could be run multiple times against some rows. - The partitions are committed automatically - there is no support for Commit or Rollback. If the call returns an error, or if the client issuing the ExecuteSql call dies, it is possible that some rows had the statement executed on them successfully. It is also possible that statement was never executed against other rows. - Partitioned DML transactions may only contain the execution of a single DML statement via ExecuteSql or ExecuteStreamingSql. - If any error is encountered during the execution of the partitioned DML operation (for instance, a UNIQUE INDEX violation, division by zero, or a value that cannot be stored due to schema constraints), then the operation is stopped at that point and an error is returned. It is possible that at this point, some partitions have been committed (or even committed multiple times), and other partitions have not been run at all. Given the above, Partitioned DML is good fit for large, database-wide, operations that are idempotent, such as deleting old rows from a very large table.

func (*TransactionOptions) MarshalJSON

func (s *TransactionOptions) MarshalJSON() ([]byte, error)

type TransactionSelector

type TransactionSelector struct {
	// Begin: Begin a new transaction and execute this read or SQL query in
	// it. The transaction ID of the new transaction is returned in
	// ResultSetMetadata.transaction, which is a Transaction.
	Begin *TransactionOptions `json:"begin,omitempty"`

	// Id: Execute the read or SQL query in a previously-started
	// transaction.
	Id string `json:"id,omitempty"`

	// SingleUse: Execute the read or SQL query in a temporary transaction.
	// This is the most efficient way to execute a transaction that consists
	// of a single SQL query.
	SingleUse *TransactionOptions `json:"singleUse,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Begin") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Begin") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

TransactionSelector: This message is used to select the transaction in which a Read or ExecuteSql call runs. See TransactionOptions for more information about transactions.

func (*TransactionSelector) MarshalJSON

func (s *TransactionSelector) MarshalJSON() ([]byte, error)

type Type

type Type struct {
	// ArrayElementType: If code == ARRAY, then `array_element_type` is the
	// type of the array elements.
	ArrayElementType *Type `json:"arrayElementType,omitempty"`

	// Code: Required. The TypeCode for this type.
	//
	// Possible values:
	//   "TYPE_CODE_UNSPECIFIED" - Not specified.
	//   "BOOL" - Encoded as JSON `true` or `false`.
	//   "INT64" - Encoded as `string`, in decimal format.
	//   "FLOAT64" - Encoded as `number`, or the strings "NaN",
	// "Infinity", or "-Infinity".
	//   "FLOAT32" - Encoded as `number`, or the strings "NaN",
	// "Infinity", or "-Infinity".
	//   "TIMESTAMP" - Encoded as `string` in RFC 3339 timestamp format. The
	// time zone must be present, and must be "Z". If the schema has the
	// column option `allow_commit_timestamp=true`, the placeholder string
	// "spanner.commit_timestamp()" can be used to instruct the system to
	// insert the commit timestamp associated with the transaction commit.
	//   "DATE" - Encoded as `string` in RFC 3339 date format.
	//   "STRING" - Encoded as `string`.
	//   "BYTES" - Encoded as a base64-encoded `string`, as described in RFC
	// 4648, section 4.
	//   "ARRAY" - Encoded as `list`, where the list elements are
	// represented according to array_element_type.
	//   "STRUCT" - Encoded as `list`, where list element `i` is represented
	// according to
	// [struct_type.fields[i]][google.spanner.v1.StructType.fields].
	//   "NUMERIC" - Encoded as `string`, in decimal format or scientific
	// notation format. Decimal format: `[+-]Digits[.[Digits]]` or
	// `+-.Digits` Scientific notation:
	// `[+-]Digits[.[Digits]][ExponentIndicator[+-]Digits]` or
	// `+-.Digits[ExponentIndicator[+-]Digits]` (ExponentIndicator is "e"
	// or "E")
	//   "JSON" - Encoded as a JSON-formatted `string` as described in RFC
	// 7159. The following rules are applied when parsing JSON input: -
	// Whitespace characters are not preserved. - If a JSON object has
	// duplicate keys, only the first key is preserved. - Members of a JSON
	// object are not guaranteed to have their order preserved. - JSON array
	// elements will have their order preserved.
	//   "PROTO" - Encoded as a base64-encoded `string`, as described in RFC
	// 4648, section 4.
	//   "ENUM" - Encoded as `string`, in decimal format.
	Code string `json:"code,omitempty"`

	// ProtoTypeFqn: If code == PROTO or code == ENUM, then `proto_type_fqn`
	// is the fully qualified name of the proto type representing the
	// proto/enum definition.
	ProtoTypeFqn string `json:"protoTypeFqn,omitempty"`

	// StructType: If code == STRUCT, then `struct_type` provides type
	// information for the struct's fields.
	StructType *StructType `json:"structType,omitempty"`

	// TypeAnnotation: The TypeAnnotationCode that disambiguates SQL type
	// that Spanner will use to represent values of this type during query
	// processing. This is necessary for some type codes because a single
	// TypeCode can be mapped to different SQL types depending on the SQL
	// dialect. type_annotation typically is not needed to process the
	// content of a value (it doesn't affect serialization) and clients can
	// ignore it on the read path.
	//
	// Possible values:
	//   "TYPE_ANNOTATION_CODE_UNSPECIFIED" - Not specified.
	//   "PG_NUMERIC" - PostgreSQL compatible NUMERIC type. This annotation
	// needs to be applied to Type instances having NUMERIC type code to
	// specify that values of this type should be treated as PostgreSQL
	// NUMERIC values. Currently this annotation is always needed for
	// NUMERIC when a client interacts with PostgreSQL-enabled Spanner
	// databases.
	//   "PG_JSONB" - PostgreSQL compatible JSONB type. This annotation
	// needs to be applied to Type instances having JSON type code to
	// specify that values of this type should be treated as PostgreSQL
	// JSONB values. Currently this annotation is always needed for JSON
	// when a client interacts with PostgreSQL-enabled Spanner databases.
	TypeAnnotation string `json:"typeAnnotation,omitempty"`

	// ForceSendFields is a list of field names (e.g. "ArrayElementType") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ArrayElementType") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

Type: `Type` indicates the type of a Cloud Spanner value, as might be stored in a table cell or returned from an SQL query.

func (*Type) MarshalJSON

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

type UpdateDatabaseDdlMetadata

type UpdateDatabaseDdlMetadata struct {
	// Actions: The brief action info for the DDL statements. `actions[i]`
	// is the brief info for `statements[i]`.
	Actions []*DdlStatementActionInfo `json:"actions,omitempty"`

	// CommitTimestamps: Reports the commit timestamps of all statements
	// that have succeeded so far, where `commit_timestamps[i]` is the
	// commit timestamp for the statement `statements[i]`.
	CommitTimestamps []string `json:"commitTimestamps,omitempty"`

	// Database: The database being modified.
	Database string `json:"database,omitempty"`

	// Progress: The progress of the UpdateDatabaseDdl operations. All DDL
	// statements will have continuously updating progress, and
	// `progress[i]` is the operation progress for `statements[i]`. Also,
	// `progress[i]` will have start time and end time populated with commit
	// timestamp of operation, as well as a progress of 100% once the
	// operation has completed.
	Progress []*OperationProgress `json:"progress,omitempty"`

	// Statements: For an update this list contains all the statements. For
	// an individual statement, this list contains only that statement.
	Statements []string `json:"statements,omitempty"`

	// Throttled: Output only. When true, indicates that the operation is
	// throttled e.g. due to resource constraints. When resources become
	// available the operation will resume and this field will be false
	// again.
	Throttled bool `json:"throttled,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Actions") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Actions") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

UpdateDatabaseDdlMetadata: Metadata type for the operation returned by UpdateDatabaseDdl.

func (*UpdateDatabaseDdlMetadata) MarshalJSON

func (s *UpdateDatabaseDdlMetadata) MarshalJSON() ([]byte, error)

type UpdateDatabaseDdlRequest

type UpdateDatabaseDdlRequest struct {
	// OperationId: If empty, the new update request is assigned an
	// automatically-generated operation ID. Otherwise, `operation_id` is
	// used to construct the name of the resulting Operation. Specifying an
	// explicit operation ID simplifies determining whether the statements
	// were executed in the event that the UpdateDatabaseDdl call is
	// replayed, or the return value is otherwise lost: the database and
	// `operation_id` fields can be combined to form the name of the
	// resulting longrunning.Operation: `/operations/`. `operation_id`
	// should be unique within the database, and must be a valid identifier:
	// `a-z*`. Note that automatically-generated operation IDs always begin
	// with an underscore. If the named operation already exists,
	// UpdateDatabaseDdl returns `ALREADY_EXISTS`.
	OperationId string `json:"operationId,omitempty"`

	// ProtoDescriptors: Optional. Proto descriptors used by CREATE/ALTER
	// PROTO BUNDLE statements. Contains a protobuf-serialized
	// google.protobuf.FileDescriptorSet
	// (https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/descriptor.proto).
	// To generate it, install (https://grpc.io/docs/protoc-installation/)
	// and run `protoc` with --include_imports and --descriptor_set_out. For
	// example, to generate for moon/shot/app.proto, run “` $protoc
	// --proto_path=/app_path --proto_path=/lib_path \ --include_imports \
	// --descriptor_set_out=descriptors.data \ moon/shot/app.proto “` For
	// more details, see protobuffer self description
	// (https://developers.google.com/protocol-buffers/docs/techniques#self-description).
	ProtoDescriptors string `json:"protoDescriptors,omitempty"`

	// Statements: Required. DDL statements to be applied to the database.
	Statements []string `json:"statements,omitempty"`

	// ForceSendFields is a list of field names (e.g. "OperationId") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "OperationId") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

UpdateDatabaseDdlRequest: Enqueues the given DDL statements to be applied, in order but not necessarily all at once, to the database schema at some point (or points) in the future. The server checks that the statements are executable (syntactically valid, name tables that exist, etc.) before enqueueing them, but they may still fail upon later execution (e.g., if a statement from another batch of statements is applied first and it conflicts in some way, or if there is some data-related problem like a `NULL` value in a column to which `NOT NULL` would be added). If a statement fails, all subsequent statements in the batch are automatically cancelled. Each batch of statements is assigned a name which can be used with the Operations API to monitor progress. See the operation_id field for more details.

func (*UpdateDatabaseDdlRequest) MarshalJSON

func (s *UpdateDatabaseDdlRequest) MarshalJSON() ([]byte, error)

type UpdateDatabaseMetadata

type UpdateDatabaseMetadata struct {
	// CancelTime: The time at which this operation was cancelled. If set,
	// this operation is in the process of undoing itself (which is
	// best-effort).
	CancelTime string `json:"cancelTime,omitempty"`

	// Progress: The progress of the UpdateDatabase operation.
	Progress *OperationProgress `json:"progress,omitempty"`

	// Request: The request for UpdateDatabase.
	Request *UpdateDatabaseRequest `json:"request,omitempty"`

	// ForceSendFields is a list of field names (e.g. "CancelTime") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "CancelTime") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

UpdateDatabaseMetadata: Metadata type for the operation returned by UpdateDatabase.

func (*UpdateDatabaseMetadata) MarshalJSON

func (s *UpdateDatabaseMetadata) MarshalJSON() ([]byte, error)

type UpdateDatabaseRequest

type UpdateDatabaseRequest struct {
	// Database: Required. The database to update. The `name` field of the
	// database is of the form `projects//instances//databases/`.
	Database *Database `json:"database,omitempty"`

	// UpdateMask: Required. The list of fields to update. Currently, only
	// `enable_drop_protection` field can be updated.
	UpdateMask string `json:"updateMask,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Database") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Database") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

UpdateDatabaseRequest: The request for UpdateDatabase.

func (*UpdateDatabaseRequest) MarshalJSON

func (s *UpdateDatabaseRequest) MarshalJSON() ([]byte, error)

type UpdateInstanceConfigMetadata

type UpdateInstanceConfigMetadata struct {
	// CancelTime: The time at which this operation was cancelled.
	CancelTime string `json:"cancelTime,omitempty"`

	// InstanceConfig: The desired instance config after updating.
	InstanceConfig *InstanceConfig `json:"instanceConfig,omitempty"`

	// Progress: The progress of the UpdateInstanceConfig operation.
	Progress *InstanceOperationProgress `json:"progress,omitempty"`

	// ForceSendFields is a list of field names (e.g. "CancelTime") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "CancelTime") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

UpdateInstanceConfigMetadata: Metadata type for the operation returned by UpdateInstanceConfig.

func (*UpdateInstanceConfigMetadata) MarshalJSON

func (s *UpdateInstanceConfigMetadata) MarshalJSON() ([]byte, error)

type UpdateInstanceConfigRequest

type UpdateInstanceConfigRequest struct {
	// InstanceConfig: Required. The user instance config to update, which
	// must always include the instance config name. Otherwise, only fields
	// mentioned in update_mask need be included. To prevent conflicts of
	// concurrent updates, etag can be used.
	InstanceConfig *InstanceConfig `json:"instanceConfig,omitempty"`

	// UpdateMask: Required. A mask specifying which fields in
	// InstanceConfig should be updated. The field mask must always be
	// specified; this prevents any future fields in InstanceConfig from
	// being erased accidentally by clients that do not know about them.
	// Only display_name and labels can be updated.
	UpdateMask string `json:"updateMask,omitempty"`

	// ValidateOnly: An option to validate, but not actually execute, a
	// request, and provide the same response.
	ValidateOnly bool `json:"validateOnly,omitempty"`

	// ForceSendFields is a list of field names (e.g. "InstanceConfig") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "InstanceConfig") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

UpdateInstanceConfigRequest: The request for UpdateInstanceConfigRequest.

func (*UpdateInstanceConfigRequest) MarshalJSON

func (s *UpdateInstanceConfigRequest) MarshalJSON() ([]byte, error)

type UpdateInstanceMetadata

type UpdateInstanceMetadata struct {
	// CancelTime: The time at which this operation was cancelled. If set,
	// this operation is in the process of undoing itself (which is
	// guaranteed to succeed) and cannot be cancelled again.
	CancelTime string `json:"cancelTime,omitempty"`

	// EndTime: The time at which this operation failed or was completed
	// successfully.
	EndTime string `json:"endTime,omitempty"`

	// ExpectedFulfillmentPeriod: The expected fulfillment period of this
	// update operation.
	//
	// Possible values:
	//   "FULFILLMENT_PERIOD_UNSPECIFIED" - Not specified.
	//   "FULFILLMENT_PERIOD_NORMAL" - Normal fulfillment period. The
	// operation is expected to complete within minutes.
	//   "FULFILLMENT_PERIOD_EXTENDED" - Extended fulfillment period. It can
	// take up to an hour for the operation to complete.
	ExpectedFulfillmentPeriod string `json:"expectedFulfillmentPeriod,omitempty"`

	// Instance: The desired end state of the update.
	Instance *Instance `json:"instance,omitempty"`

	// StartTime: The time at which UpdateInstance request was received.
	StartTime string `json:"startTime,omitempty"`

	// ForceSendFields is a list of field names (e.g. "CancelTime") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "CancelTime") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

UpdateInstanceMetadata: Metadata type for the operation returned by UpdateInstance.

func (*UpdateInstanceMetadata) MarshalJSON

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

type UpdateInstanceRequest

type UpdateInstanceRequest struct {
	// FieldMask: Required. A mask specifying which fields in Instance
	// should be updated. The field mask must always be specified; this
	// prevents any future fields in Instance from being erased accidentally
	// by clients that do not know about them.
	FieldMask string `json:"fieldMask,omitempty"`

	// Instance: Required. The instance to update, which must always include
	// the instance name. Otherwise, only fields mentioned in field_mask
	// need be included.
	Instance *Instance `json:"instance,omitempty"`

	// ForceSendFields is a list of field names (e.g. "FieldMask") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "FieldMask") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

UpdateInstanceRequest: The request for UpdateInstance.

func (*UpdateInstanceRequest) MarshalJSON

func (s *UpdateInstanceRequest) MarshalJSON() ([]byte, error)

type VisualizationData

type VisualizationData struct {
	// DataSourceEndToken: The token signifying the end of a data_source.
	DataSourceEndToken string `json:"dataSourceEndToken,omitempty"`

	// DataSourceSeparatorToken: The token delimiting a datasource name from
	// the rest of a key in a data_source.
	DataSourceSeparatorToken string `json:"dataSourceSeparatorToken,omitempty"`

	// DiagnosticMessages: The list of messages (info, alerts, ...)
	DiagnosticMessages []*DiagnosticMessage `json:"diagnosticMessages,omitempty"`

	// EndKeyStrings: We discretize the entire keyspace into buckets.
	// Assuming each bucket has an inclusive keyrange and covers keys from
	// k(i) ... k(n). In this case k(n) would be an end key for a given
	// range. end_key_string is the collection of all such end keys
	EndKeyStrings []string `json:"endKeyStrings,omitempty"`

	// HasPii: Whether this scan contains PII.
	HasPii bool `json:"hasPii,omitempty"`

	// IndexedKeys: Keys of key ranges that contribute significantly to a
	// given metric Can be thought of as heavy hitters.
	IndexedKeys []string `json:"indexedKeys,omitempty"`

	// KeySeparator: The token delimiting the key prefixes.
	KeySeparator string `json:"keySeparator,omitempty"`

	// KeyUnit: The unit for the key: e.g. 'key' or 'chunk'.
	//
	// Possible values:
	//   "KEY_UNIT_UNSPECIFIED" - Required default value
	//   "KEY" - Each entry corresponds to one key
	//   "CHUNK" - Each entry corresponds to a chunk of keys
	KeyUnit string `json:"keyUnit,omitempty"`

	// Metrics: The list of data objects for each metric.
	Metrics []*Metric `json:"metrics,omitempty"`

	// PrefixNodes: The list of extracted key prefix nodes used in the key
	// prefix hierarchy.
	PrefixNodes []*PrefixNode `json:"prefixNodes,omitempty"`

	// ForceSendFields is a list of field names (e.g. "DataSourceEndToken")
	// to unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "DataSourceEndToken") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

func (*VisualizationData) MarshalJSON

func (s *VisualizationData) MarshalJSON() ([]byte, error)

type Write

type Write struct {
	// Columns: The names of the columns in table to be written. The list of
	// columns must contain enough columns to allow Cloud Spanner to derive
	// values for all primary key columns in the row(s) to be modified.
	Columns []string `json:"columns,omitempty"`

	// Table: Required. The table whose rows will be written.
	Table string `json:"table,omitempty"`

	// Values: The values to be written. `values` can contain more than one
	// list of values. If it does, then multiple rows are written, one for
	// each entry in `values`. Each list in `values` must have exactly as
	// many entries as there are entries in columns above. Sending multiple
	// lists is equivalent to sending multiple `Mutation`s, each containing
	// one `values` entry and repeating table and columns. Individual values
	// in each list are encoded as described here.
	Values [][]interface{} `json:"values,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Columns") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Columns") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Write: Arguments to insert, update, insert_or_update, and replace operations.

func (*Write) MarshalJSON

func (s *Write) MarshalJSON() ([]byte, error)

Jump to

Keyboard shortcuts

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