type AdaptMessageRequest struct {// Attachments: Optional. Opaque request state passed by the client to the// server.Attachments map[string]string `json:"attachments,omitempty"`// Payload: Optional. Uninterpreted bytes from the underlying wire protocol.Payloadstring `json:"payload,omitempty"`// Protocol: Required. Identifier for the underlying wire protocol.Protocolstring `json:"protocol,omitempty"`// ForceSendFields is a list of field names (e.g. "Attachments") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Attachments") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (AdaptMessageRequest)MarshalJSON¶added inv0.224.0

func (sAdaptMessageRequest) MarshalJSON() ([]byte,error)

type AdaptMessageResponse struct {// Last: Optional. Indicates whether this is the last AdaptMessageResponse in// the stream. This field may be optionally set by the server. Clients should// not rely on this field being set in all cases.Lastbool `json:"last,omitempty"`// Payload: Optional. Uninterpreted bytes from the underlying wire protocol.Payloadstring `json:"payload,omitempty"`// StateUpdates: Optional. Opaque state updates to be applied by the client.StateUpdates map[string]string `json:"stateUpdates,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Last") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Last") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (AdaptMessageResponse)MarshalJSON¶added inv0.224.0

func (sAdaptMessageResponse) MarshalJSON() ([]byte,error)

type AdapterSession struct {// Name: Identifier. The name of the session. This is always system-assigned.Namestring `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. "Name") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Name") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (AdapterSession)MarshalJSON¶added inv0.224.0

func (sAdapterSession) MarshalJSON() ([]byte,error)

type AddSplitPointsRequest struct {// Initiator: Optional. A user-supplied tag associated with the split points.// For example, "initial_data_load", "special_event_1". Defaults to// "CloudAddSplitPointsAPI" if not specified. The length of the tag must not// exceed 50 characters, or else it is trimmed. Only valid UTF8 characters are// allowed.Initiatorstring `json:"initiator,omitempty"`// SplitPoints: Required. The split points to add.SplitPoints []*SplitPoints `json:"splitPoints,omitempty"`// ForceSendFields is a list of field names (e.g. "Initiator") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Initiator") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (AddSplitPointsRequest)MarshalJSON¶added inv0.218.0

func (sAddSplitPointsRequest) MarshalJSON() ([]byte,error)

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

type AsymmetricAutoscalingOption struct {// Overrides: Optional. Overrides applied to the top-level autoscaling// configuration for the selected replicas.Overrides *AutoscalingConfigOverrides `json:"overrides,omitempty"`// ReplicaSelection: Required. Selects the replicas to which this// AsymmetricAutoscalingOption applies. Only read-only replicas are supported.ReplicaSelection *InstanceReplicaSelection `json:"replicaSelection,omitempty"`// ForceSendFields is a list of field names (e.g. "Overrides") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Overrides") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (AsymmetricAutoscalingOption)MarshalJSON¶added inv0.202.0

func (sAsymmetricAutoscalingOption) MarshalJSON() ([]byte,error)

type AutoscalingConfig struct {// AsymmetricAutoscalingOptions: Optional. Optional asymmetric autoscaling// options. Replicas matching the replica selection criteria will be autoscaled// independently from other replicas. The autoscaler will scale the replicas// based on the utilization of replicas identified by the replica selection.// Replica selections should not overlap with each other. Other replicas (those// do not match any replica selection) will be autoscaled together and will// have the same compute capacity allocated to them.AsymmetricAutoscalingOptions []*AsymmetricAutoscalingOption `json:"asymmetricAutoscalingOptions,omitempty"`// 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.// "AsymmetricAutoscalingOptions") to unconditionally include in API requests.// By default, fields with empty or default values are omitted from API// requests. Seehttps://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields// for more details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AsymmetricAutoscalingOptions") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (AutoscalingConfig)MarshalJSON¶added inv0.149.0

func (sAutoscalingConfig) MarshalJSON() ([]byte,error)

type AutoscalingConfigOverrides struct {// AutoscalingLimits: Optional. If specified, overrides the min/max limit in// the top-level autoscaling configuration for the selected replicas.AutoscalingLimits *AutoscalingLimits `json:"autoscalingLimits,omitempty"`// AutoscalingTargetHighPriorityCpuUtilizationPercent: Optional. If specified,// overrides the autoscaling target high_priority_cpu_utilization_percent in// the top-level autoscaling configuration for the selected replicas.AutoscalingTargetHighPriorityCpuUtilizationPercentint64 `json:"autoscalingTargetHighPriorityCpuUtilizationPercent,omitempty"`// ForceSendFields is a list of field names (e.g. "AutoscalingLimits") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AutoscalingLimits") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (AutoscalingConfigOverrides)MarshalJSON¶added inv0.202.0

func (sAutoscalingConfigOverrides) MarshalJSON() ([]byte,error)

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.MaxNodesint64 `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.MaxProcessingUnitsint64 `json:"maxProcessingUnits,omitempty"`// MinNodes: Minimum number of nodes allocated to the instance. If set, this// number should be greater than or equal to 1.MinNodesint64 `json:"minNodes,omitempty"`// MinProcessingUnits: Minimum number of processing units allocated to the// instance. If set, this number should be multiples of 1000.MinProcessingUnitsint64 `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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "MaxNodes") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (AutoscalingLimits)MarshalJSON¶added inv0.149.0

func (sAutoscalingLimits) MarshalJSON() ([]byte,error)

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.HighPriorityCpuUtilizationPercentint64 `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.StorageUtilizationPercentint64 `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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g.// "HighPriorityCpuUtilizationPercent") to include in API requests with the// JSON null value. By default, fields with empty values are omitted from API// requests. Seehttps://pkg.go.dev/google.golang.org/api#hdr-NullFields for// more details.NullFields []string `json:"-"`}

func (AutoscalingTargets)MarshalJSON¶added inv0.149.0

func (sAutoscalingTargets) MarshalJSON() ([]byte,error)

type Backup struct {// BackupSchedules: Output only. List of backup schedule URIs that are// associated with creating this backup. This is only applicable for scheduled// backups, and is empty for on-demand backups. To optimize for storage,// whenever possible, multiple schedules are collapsed together to create one// backup. In such cases, this field captures the list of all backup schedule// URIs that are associated with creating this backup. If collapsing is not// done, then this field captures the single backup schedule URI associated// with creating this backup.BackupSchedules []string `json:"backupSchedules,omitempty"`// 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`.CreateTimestring `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/`.Databasestring `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.DatabaseDialectstring `json:"databaseDialect,omitempty"`// EncryptionInfo: Output only. The encryption information for the backup.EncryptionInfo *EncryptionInfo `json:"encryptionInfo,omitempty"`// EncryptionInformation: Output only. The encryption information for the// backup, whether it is protected by one or more KMS keys. The information// includes all Cloud KMS key versions used to encrypt the backup. The// `encryption_status` field inside of each `EncryptionInfo` is not populated.// At least one of the key versions must be available for the backup to be// restored. If a key version is revoked in the middle of a restore, the// restore behavior is undefined.EncryptionInformation []*EncryptionInfo `json:"encryptionInformation,omitempty"`// ExclusiveSizeBytes: Output only. For a backup in an incremental backup// chain, this is the storage space needed to keep the data that has changed// since the previous backup. For all other backups, this is always the size of// the backup. This value may change if backups on the same chain get deleted// or expired. This field can be used to calculate the total storage space used// by a set of backups. For example, the total space used by all backups of a// database can be computed by summing up this field.ExclusiveSizeBytesint64 `json:"exclusiveSizeBytes,omitempty,string"`// 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.ExpireTimestring `json:"expireTime,omitempty"`// FreeableSizeBytes: Output only. The number of bytes that will be freed by// deleting this backup. This value will be zero if, for example, this backup// is part of an incremental backup chain and younger backups in the chain// require that we keep its data. For backups not in an incremental backup// chain, this is always the size of the backup. This value may change if// backups on the same chain get created, deleted or expired.FreeableSizeBytesint64 `json:"freeableSizeBytes,omitempty,string"`// IncrementalBackupChainId: Output only. Populated only for backups in an// incremental backup chain. Backups share the same chain id if and only if// they belong to the same incremental backup chain. Use this field to// determine which backups are part of the same incremental backup chain. The// ordering of backups in the chain can be determined by ordering the backup// `version_time`.IncrementalBackupChainIdstring `json:"incrementalBackupChainId,omitempty"`// InstancePartitions: Output only. The instance partition storing the backup.// This is the same as the list of the instance partitions that the database// recorded at the backup's `version_time`.InstancePartitions []*BackupInstancePartition `json:"instancePartitions,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`.MaxExpireTimestring `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/`.Namestring `json:"name,omitempty"`// OldestVersionTime: Output only. Data deleted at a time older than this is// guaranteed not to be retained in order to support this backup. For a backup// in an incremental backup chain, this is the version time of the oldest// backup that exists or ever existed in the chain. For all other backups, this// is the version time of the backup. This field can be used to understand what// data is being retained by the backup system.OldestVersionTimestring `json:"oldestVersionTime,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. For a backup in an// incremental backup chain, this is the sum of the `exclusive_size_bytes` of// itself and all older backups in the chain.SizeBytesint64 `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.Statestring `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.VersionTimestring `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. "BackupSchedules") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "BackupSchedules") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (Backup)MarshalJSON¶added inv0.21.0

func (sBackup) MarshalJSON() ([]byte,error)

type BackupInfo struct {// Backup: Name of the backup.Backupstring `json:"backup,omitempty"`// CreateTime: The time the CreateBackup request was received.CreateTimestring `json:"createTime,omitempty"`// SourceDatabase: Name of the database the backup was created from.SourceDatabasestring `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`.VersionTimestring `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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Backup") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (BackupInfo)MarshalJSON¶added inv0.21.0

func (sBackupInfo) MarshalJSON() ([]byte,error)

type BackupInstancePartition struct {// InstancePartition: A unique identifier for the instance partition. Values// are of the form `projects//instances//instancePartitions/`InstancePartitionstring `json:"instancePartition,omitempty"`// ForceSendFields is a list of field names (e.g. "InstancePartition") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "InstancePartition") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (BackupInstancePartition)MarshalJSON¶added inv0.221.0

func (sBackupInstancePartition) MarshalJSON() ([]byte,error)

type BackupSchedule struct {// EncryptionConfig: Optional. The encryption configuration that is used to// encrypt the backup. If this field is not specified, the backup uses the same// encryption configuration as the database.EncryptionConfig *CreateBackupEncryptionConfig `json:"encryptionConfig,omitempty"`// FullBackupSpec: The schedule creates only full backups.FullBackupSpec *FullBackupSpec `json:"fullBackupSpec,omitempty"`// IncrementalBackupSpec: The schedule creates incremental backup chains.IncrementalBackupSpec *IncrementalBackupSpec `json:"incrementalBackupSpec,omitempty"`// Name: Identifier. Output only for the CreateBackupSchedule operation.// Required for the UpdateBackupSchedule operation. A globally unique// identifier for the backup schedule which cannot be changed. Values are of// the form `projects//instances//databases//backupSchedules/a-z*[a-z0-9]` The// final segment of the name must be between 2 and 60 characters in length.Namestring `json:"name,omitempty"`// RetentionDuration: Optional. The retention duration of a backup that must be// at least 6 hours and at most 366 days. The backup is eligible to be// automatically deleted once the retention period has elapsed.RetentionDurationstring `json:"retentionDuration,omitempty"`// Spec: Optional. The schedule specification based on which the backup// creations are triggered.Spec *BackupScheduleSpec `json:"spec,omitempty"`// UpdateTime: Output only. The timestamp at which the schedule was last// updated. If the schedule has never been updated, this field contains the// timestamp when the schedule was first created.UpdateTimestring `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. "EncryptionConfig") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "EncryptionConfig") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (BackupSchedule)MarshalJSON¶added inv0.190.0

func (sBackupSchedule) MarshalJSON() ([]byte,error)

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

func (BackupScheduleSpec)MarshalJSON¶added inv0.190.0

func (sBackupScheduleSpec) MarshalJSON() ([]byte,error)

type BatchCreateSessionsRequest struct {// SessionCount: Required. The number of sessions to be created in this batch// call. At least one session is created. The API can 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).SessionCountint64 `json:"sessionCount,omitempty"`// SessionTemplate: Parameters to apply 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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "SessionCount") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (BatchCreateSessionsRequest)MarshalJSON¶added inv0.9.0

func (sBatchCreateSessionsRequest) MarshalJSON() ([]byte,error)

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

func (BatchCreateSessionsResponse)MarshalJSON¶added inv0.9.0

func (sBatchCreateSessionsResponse) MarshalJSON() ([]byte,error)

type BatchWriteRequest struct {// ExcludeTxnFromChangeStreams: Optional. If you don't set the// `exclude_txn_from_change_streams` option or if it's set to `false`, then any// change streams monitoring columns modified by transactions will capture the// updates made within that transaction.ExcludeTxnFromChangeStreamsbool `json:"excludeTxnFromChangeStreams,omitempty"`// 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.// "ExcludeTxnFromChangeStreams") to unconditionally include in API requests.// By default, fields with empty or default values are omitted from API// requests. Seehttps://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields// for more details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ExcludeTxnFromChangeStreams") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (BatchWriteRequest)MarshalJSON¶added inv0.143.0

func (sBatchWriteRequest) MarshalJSON() ([]byte,error)

type BatchWriteResponse struct {// CommitTimestamp: The commit timestamp of the transaction that applied this// batch. Present if `status` is `OK`, absent otherwise.CommitTimestampstring `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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CommitTimestamp") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (BatchWriteResponse)MarshalJSON¶added inv0.143.0

func (sBatchWriteResponse) MarshalJSON() ([]byte,error)

type BeginTransactionRequest struct {// MutationKey: Optional. Required for read-write transactions on a multiplexed// session that commit mutations but don't perform any reads or queries. You// must randomly select one of the mutations from the mutation set and send it// as a part of this request.MutationKey *Mutation `json:"mutationKey,omitempty"`// 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 doesn't// 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. "MutationKey") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "MutationKey") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (BeginTransactionRequest)MarshalJSON¶

func (sBeginTransactionRequest) MarshalJSON() ([]byte,error)

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

func (Binding)MarshalJSON¶

func (sBinding) MarshalJSON() ([]byte,error)

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

func (ChangeQuorumMetadata)MarshalJSON¶added inv0.183.0

func (sChangeQuorumMetadata) MarshalJSON() ([]byte,error)

type ChangeQuorumRequest struct {// Etag: Optional. The etag is the hash of the `QuorumInfo`. The `ChangeQuorum`// operation is only performed if the etag matches that of the `QuorumInfo` in// the current database resource. Otherwise the API returns an `ABORTED` error.// The etag is used for optimistic concurrency control as a way to help prevent// simultaneous change quorum requests that could create a race condition.Etagstring `json:"etag,omitempty"`// Name: Required. Name of the database in which to apply `ChangeQuorum`.// Values are of the form `projects//instances//databases/`.Namestring `json:"name,omitempty"`// QuorumType: Required. The type of this quorum.QuorumType *QuorumType `json:"quorumType,omitempty"`// ForceSendFields is a list of field names (e.g. "Etag") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Etag") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (ChangeQuorumRequest)MarshalJSON¶added inv0.183.0

func (sChangeQuorumRequest) MarshalJSON() ([]byte,error)

type ChangeStreamRecord struct {// DataChangeRecord: Data change record describing a data change for a change// stream partition.DataChangeRecord *DataChangeRecord `json:"dataChangeRecord,omitempty"`// HeartbeatRecord: Heartbeat record describing a heartbeat for a change stream// partition.HeartbeatRecord *HeartbeatRecord `json:"heartbeatRecord,omitempty"`// PartitionEndRecord: Partition end record describing a terminated change// stream partition.PartitionEndRecord *PartitionEndRecord `json:"partitionEndRecord,omitempty"`// PartitionEventRecord: Partition event record describing key range changes// for a change stream partition.PartitionEventRecord *PartitionEventRecord `json:"partitionEventRecord,omitempty"`// PartitionStartRecord: Partition start record describing a new change stream// partition.PartitionStartRecord *PartitionStartRecord `json:"partitionStartRecord,omitempty"`// ForceSendFields is a list of field names (e.g. "DataChangeRecord") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DataChangeRecord") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (ChangeStreamRecord)MarshalJSON¶added inv0.240.0

func (sChangeStreamRecord) MarshalJSON() ([]byte,error)

type ChildLink struct {// ChildIndex: The node to which the link points.ChildIndexint64 `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.Typestring `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.Variablestring `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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ChildIndex") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (ChildLink)MarshalJSON¶

func (sChildLink) MarshalJSON() ([]byte,error)

type ColumnMetadata struct {// IsPrimaryKey: Indicates whether the column is a primary key column.IsPrimaryKeybool `json:"isPrimaryKey,omitempty"`// Name: Name of the column.Namestring `json:"name,omitempty"`// OrdinalPosition: Ordinal position of the column based on the original table// definition in the schema starting with a value of 1.OrdinalPositionint64 `json:"ordinalPosition,omitempty,string"`// Type: Type of the column.Type *Type `json:"type,omitempty"`// ForceSendFields is a list of field names (e.g. "IsPrimaryKey") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "IsPrimaryKey") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (ColumnMetadata)MarshalJSON¶added inv0.240.0

func (sColumnMetadata) MarshalJSON() ([]byte,error)

type CommitRequest struct {// MaxCommitDelay: Optional. The amount of latency this request is configured// to incur in order to improve throughput. If this field isn't set, Spanner// assumes requests are relatively latency sensitive and automatically// determines an appropriate delay time. You can specify a commit delay value// between 0 and 500 ms.MaxCommitDelaystring `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"`// PrecommitToken: Optional. If the read-write transaction was executed on a// multiplexed session, then you must include the precommit token with the// highest sequence number received in this transaction attempt. Failing to do// so results in a `FailedPrecondition` error.PrecommitToken *MultiplexedSessionPrecommitToken `json:"precommitToken,omitempty"`// RequestOptions: Common options for this request.RequestOptions *RequestOptions `json:"requestOptions,omitempty"`// ReturnCommitStats: If `true`, then statistics related to the transaction is// included in the CommitResponse. Default value is `false`.ReturnCommitStatsbool `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's 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.TransactionIdstring `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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "MaxCommitDelay") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (CommitRequest)MarshalJSON¶

func (sCommitRequest) MarshalJSON() ([]byte,error)

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.CommitTimestampstring `json:"commitTimestamp,omitempty"`// PrecommitToken: If specified, transaction has not committed yet. You must// retry the commit with the new precommit token.PrecommitToken *MultiplexedSessionPrecommitToken `json:"precommitToken,omitempty"`// SnapshotTimestamp: If `TransactionOptions.isolation_level` is set to// `IsolationLevel.REPEATABLE_READ`, then the snapshot timestamp is the// timestamp at which all reads in the transaction ran. This timestamp is never// returned.SnapshotTimestampstring `json:"snapshotTimestamp,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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CommitStats") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (CommitResponse)MarshalJSON¶

func (sCommitResponse) MarshalJSON() ([]byte,error)

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

func (CommitStats)MarshalJSON¶added inv0.39.0

func (sCommitStats) MarshalJSON() ([]byte,error)

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"Severitystring `json:"severity,omitempty"`// Unit: The unit of the context value.Unitstring `json:"unit,omitempty"`// Value: The value for the context.Valuefloat64 `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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Label") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (ContextValue)MarshalJSON¶added inv0.48.0

func (sContextValue) MarshalJSON() ([]byte,error)

func (*ContextValue)UnmarshalJSON¶added inv0.48.0

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

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 keys.EncryptionTypestring `json:"encryptionType,omitempty"`// KmsKeyName: Optional. This field is maintained for backwards compatibility.// For new callers, we recommend using `kms_key_names` to specify the KMS key.// Only use `kms_key_name` if the location of the KMS key matches the database// instance's configuration (location) exactly. For example, if the KMS// location is in `us-central1` or `nam3`, then the database instance must also// be in `us-central1` or `nam3`. The Cloud KMS key that is used to encrypt and// decrypt the restored database. Set this field only when encryption_type is// `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form// `projects//locations//keyRings//cryptoKeys/`.KmsKeyNamestring `json:"kmsKeyName,omitempty"`// KmsKeyNames: Optional. Specifies the KMS configuration for the one or more// keys used to protect the backup. Values are of the form// `projects//locations//keyRings//cryptoKeys/`. KMS keys specified can be in// any order. The keys referenced by `kms_key_names` must fully cover all// regions of the backup's instance configuration. Some examples: * For// regional (single-region) instance configurations, specify a regional// location KMS key. * For multi-region instance configurations of type// `GOOGLE_MANAGED`, either specify a multi-region location KMS key or multiple// regional location KMS keys that cover all regions in the instance// configuration. * For an instance configuration of type `USER_MANAGED`,// specify only regional location KMS keys to cover each region in the instance// configuration. Multi-region location KMS keys aren't supported for// `USER_MANAGED` type instance configurations.KmsKeyNames []string `json:"kmsKeyNames,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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "EncryptionType") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (CopyBackupEncryptionConfig)MarshalJSON¶added inv0.74.0

func (sCopyBackupEncryptionConfig) MarshalJSON() ([]byte,error)

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`.CancelTimestring `json:"cancelTime,omitempty"`// Name: The name of the backup being created through the copy operation.// Values are of the form `projects//instances//backups/`.Namestring `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/`.SourceBackupstring `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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CancelTime") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (CopyBackupMetadata)MarshalJSON¶added inv0.74.0

func (sCopyBackupMetadata) MarshalJSON() ([]byte,error)

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

func (CopyBackupRequest)MarshalJSON¶added inv0.74.0

func (sCopyBackupRequest) MarshalJSON() ([]byte,error)

type CreateBackupEncryptionConfig struct {// 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.EncryptionTypestring `json:"encryptionType,omitempty"`// KmsKeyName: Optional. This field is maintained for backwards compatibility.// For new callers, we recommend using `kms_key_names` to specify the KMS key.// Only use `kms_key_name` if the location of the KMS key matches the database// instance's configuration (location) exactly. For example, if the KMS// location is in `us-central1` or `nam3`, then the database instance must also// be in `us-central1` or `nam3`. The Cloud KMS key that is used to encrypt and// decrypt the restored database. Set this field only when encryption_type is// `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form// `projects//locations//keyRings//cryptoKeys/`.KmsKeyNamestring `json:"kmsKeyName,omitempty"`// KmsKeyNames: Optional. Specifies the KMS configuration for the one or more// keys used to protect the backup. Values are of the form// `projects//locations//keyRings//cryptoKeys/`. The keys referenced by// `kms_key_names` must fully cover all regions of the backup's instance// configuration. Some examples: * For regional (single-region) instance// configurations, specify a regional location KMS key. * For multi-region// instance configurations of type `GOOGLE_MANAGED`, either specify a// multi-region location KMS key or multiple regional location KMS keys that// cover all regions in the instance configuration. * For an instance// configuration of type `USER_MANAGED`, specify only regional location KMS// keys to cover each region in the instance configuration. Multi-region// location KMS keys aren't supported for `USER_MANAGED` type instance// configurations.KmsKeyNames []string `json:"kmsKeyNames,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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "EncryptionType") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (CreateBackupEncryptionConfig)MarshalJSON¶added inv0.190.0

func (sCreateBackupEncryptionConfig) MarshalJSON() ([]byte,error)

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`.CancelTimestring `json:"cancelTime,omitempty"`// Database: The name of the database the backup is created from.Databasestring `json:"database,omitempty"`// Name: The name of the backup being created.Namestring `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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CancelTime") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (CreateBackupMetadata)MarshalJSON¶added inv0.21.0

func (sCreateBackupMetadata) MarshalJSON() ([]byte,error)

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

func (CreateDatabaseMetadata)MarshalJSON¶

func (sCreateDatabaseMetadata) MarshalJSON() ([]byte,error)

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 (“ ` “).CreateStatementstring `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.DatabaseDialectstring `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'. Contains a protobuf-serialized// `google.protobuf.FileDescriptorSet`// (https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/descriptor.proto)// descriptor set. 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).ProtoDescriptorsstring `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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CreateStatement") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (CreateDatabaseRequest)MarshalJSON¶

func (sCreateDatabaseRequest) MarshalJSON() ([]byte,error)

type CreateInstanceConfigMetadata struct {// CancelTime: The time at which this operation was cancelled.CancelTimestring `json:"cancelTime,omitempty"`// InstanceConfig: The target instance configuration 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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CancelTime") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (CreateInstanceConfigMetadata)MarshalJSON¶added inv0.98.0

func (sCreateInstanceConfigMetadata) MarshalJSON() ([]byte,error)

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 configuration 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.InstanceConfigIdstring `json:"instanceConfigId,omitempty"`// ValidateOnly: An option to validate, but not actually execute, a request,// and provide the same response.ValidateOnlybool `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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "InstanceConfig") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (CreateInstanceConfigRequest)MarshalJSON¶added inv0.98.0

func (sCreateInstanceConfigRequest) MarshalJSON() ([]byte,error)

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.CancelTimestring `json:"cancelTime,omitempty"`// EndTime: The time at which this operation failed or was completed// successfully.EndTimestring `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.ExpectedFulfillmentPeriodstring `json:"expectedFulfillmentPeriod,omitempty"`// Instance: The instance being created.Instance *Instance `json:"instance,omitempty"`// StartTime: The time at which the CreateInstance request was received.StartTimestring `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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CancelTime") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (CreateInstanceMetadata)MarshalJSON¶

func (sCreateInstanceMetadata) MarshalJSON() ([]byte,error)

type CreateInstancePartitionMetadata 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.CancelTimestring `json:"cancelTime,omitempty"`// EndTime: The time at which this operation failed or was completed// successfully.EndTimestring `json:"endTime,omitempty"`// InstancePartition: The instance partition being created.InstancePartition *InstancePartition `json:"instancePartition,omitempty"`// StartTime: The time at which the CreateInstancePartition request was// received.StartTimestring `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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CancelTime") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (CreateInstancePartitionMetadata)MarshalJSON¶added inv0.171.0

func (sCreateInstancePartitionMetadata) MarshalJSON() ([]byte,error)

type CreateInstancePartitionRequest struct {// InstancePartition: Required. The instance partition to create. The// instance_partition.name may be omitted, but if specified must be// `/instancePartitions/`.InstancePartition *InstancePartition `json:"instancePartition,omitempty"`// InstancePartitionId: Required. The ID of the instance partition to create.// Valid identifiers are of the form `a-z*[a-z0-9]` and must be between 2 and// 64 characters in length.InstancePartitionIdstring `json:"instancePartitionId,omitempty"`// ForceSendFields is a list of field names (e.g. "InstancePartition") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "InstancePartition") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (CreateInstancePartitionRequest)MarshalJSON¶added inv0.171.0

func (sCreateInstancePartitionRequest) MarshalJSON() ([]byte,error)

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

func (CreateInstanceRequest)MarshalJSON¶

func (sCreateInstanceRequest) MarshalJSON() ([]byte,error)

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

func (CreateSessionRequest)MarshalJSON¶

func (sCreateSessionRequest) MarshalJSON() ([]byte,error)

type CrontabSpec struct {// CreationWindow: Output only. Scheduled backups contain an externally// consistent copy of the database at the version time specified in// `schedule_spec.cron_spec`. However, Spanner might not initiate the creation// of the scheduled backups at that version time. Spanner initiates the// creation of scheduled backups within the time window bounded by the// version_time specified in `schedule_spec.cron_spec` and version_time +// `creation_window`.CreationWindowstring `json:"creationWindow,omitempty"`// Text: Required. Textual representation of the crontab. User can customize// the backup frequency and the backup version time using the cron expression.// The version time must be in UTC timezone. The backup will contain an// externally consistent copy of the database at the version time. Full backups// must be scheduled a minimum of 12 hours apart and incremental backups must// be scheduled a minimum of 4 hours apart. Examples of valid cron// specifications: * `0 2/12 * * *` : every 12 hours at (2, 14) hours past// midnight in UTC. * `0 2,14 * * *` : every 12 hours at (2, 14) hours past// midnight in UTC. * `0 */4 * * *` : (incremental backups only) every 4 hours// at (0, 4, 8, 12, 16, 20) hours past midnight in UTC. * `0 2 * * *` : once a// day at 2 past midnight in UTC. * `0 2 * * 0` : once a week every Sunday at 2// past midnight in UTC. * `0 2 8 * *` : once a month on 8th day at 2 past// midnight in UTC.Textstring `json:"text,omitempty"`// TimeZone: Output only. The time zone of the times in `CrontabSpec.text`.// Currently, only UTC is supported.TimeZonestring `json:"timeZone,omitempty"`// ForceSendFields is a list of field names (e.g. "CreationWindow") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CreationWindow") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (CrontabSpec)MarshalJSON¶added inv0.190.0

func (sCrontabSpec) MarshalJSON() ([]byte,error)

type DataChangeRecord struct {// ColumnMetadata: Provides metadata describing the columns associated with the// mods listed below.ColumnMetadata []*ColumnMetadata `json:"columnMetadata,omitempty"`// CommitTimestamp: Indicates the timestamp in which the change was committed.// DataChangeRecord.commit_timestamps, PartitionStartRecord.start_timestamps,// PartitionEventRecord.commit_timestamps, and// PartitionEndRecord.end_timestamps can have the same value in the same// partition.CommitTimestampstring `json:"commitTimestamp,omitempty"`// IsLastRecordInTransactionInPartition: Indicates whether this is the last// record for a transaction in the current partition. Clients can use this// field to determine when all records for a transaction in the current// partition have been received.IsLastRecordInTransactionInPartitionbool `json:"isLastRecordInTransactionInPartition,omitempty"`// IsSystemTransaction: Indicates whether the transaction is a system// transaction. System transactions include those issued by time-to-live (TTL),// column backfill, etc.IsSystemTransactionbool `json:"isSystemTransaction,omitempty"`// ModType: Describes the type of change.//// Possible values://   "MOD_TYPE_UNSPECIFIED" - Not specified.//   "INSERT" - Indicates data was inserted.//   "UPDATE" - Indicates existing data was updated.//   "DELETE" - Indicates existing data was deleted.ModTypestring `json:"modType,omitempty"`// Mods: Describes the changes that were made.Mods []*Mod `json:"mods,omitempty"`// NumberOfPartitionsInTransaction: Indicates the number of partitions that// return data change records for this transaction. This value can be helpful// in assembling all records associated with a particular transaction.NumberOfPartitionsInTransactionint64 `json:"numberOfPartitionsInTransaction,omitempty"`// NumberOfRecordsInTransaction: Indicates the number of data change records// that are part of this transaction across all change stream partitions. This// value can be used to assemble all the records associated with a particular// transaction.NumberOfRecordsInTransactionint64 `json:"numberOfRecordsInTransaction,omitempty"`// RecordSequence: Record sequence numbers are unique and monotonically// increasing (but not necessarily contiguous) for a specific timestamp across// record types in the same partition. To guarantee ordered processing, the// reader should process records (of potentially different types) in// record_sequence order for a specific timestamp in the same partition. The// record sequence number ordering across partitions is only meaningful in the// context of a specific transaction. Record sequence numbers are unique across// partitions for a specific transaction. Sort the DataChangeRecords for the// same server_transaction_id by record_sequence to reconstruct the ordering of// the changes within the transaction.RecordSequencestring `json:"recordSequence,omitempty"`// ServerTransactionId: Provides a globally unique string that represents the// transaction in which the change was committed. Multiple transactions can// have the same commit timestamp, but each transaction has a unique// server_transaction_id.ServerTransactionIdstring `json:"serverTransactionId,omitempty"`// Table: Name of the table affected by the change.Tablestring `json:"table,omitempty"`// TransactionTag: Indicates the transaction tag associated with this// transaction.TransactionTagstring `json:"transactionTag,omitempty"`// ValueCaptureType: Describes the value capture type that was specified in the// change stream configuration when this change was captured.//// Possible values://   "VALUE_CAPTURE_TYPE_UNSPECIFIED" - Not specified.//   "OLD_AND_NEW_VALUES" - Records both old and new values of the modified// watched columns.//   "NEW_VALUES" - Records only new values of the modified watched columns.//   "NEW_ROW" - Records new values of all watched columns, including modified// and unmodified columns.//   "NEW_ROW_AND_OLD_VALUES" - Records the new values of all watched columns,// including modified and unmodified columns. Also records the old values of// the modified columns.ValueCaptureTypestring `json:"valueCaptureType,omitempty"`// ForceSendFields is a list of field names (e.g. "ColumnMetadata") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ColumnMetadata") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (DataChangeRecord)MarshalJSON¶added inv0.240.0

func (sDataChangeRecord) MarshalJSON() ([]byte,error)

type Database struct {// CreateTime: Output only. If exists, the time at which the database creation// started.CreateTimestring `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.DatabaseDialectstring `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.DefaultLeaderstring `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.EarliestVersionTimestring `json:"earliestVersionTime,omitempty"`// EnableDropProtection: Optional. 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).EnableDropProtectionbool `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.Namestring `json:"name,omitempty"`// QuorumInfo: Output only. Applicable only for databases that use dual-region// instance configurations. Contains information about the quorum.QuorumInfo *QuorumInfo `json:"quorumInfo,omitempty"`// Reconciling: Output only. If true, the database is being updated. If false,// there are no ongoing update operations for the database.Reconcilingbool `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.Statestring `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.VersionRetentionPeriodstring `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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CreateTime") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (Database)MarshalJSON¶

func (sDatabase) MarshalJSON() ([]byte,error)

type DatabaseMoveConfig struct {// DatabaseId: Required. The unique identifier of the database resource in the// Instance. For example, if the database uri is// `projects/foo/instances/bar/databases/baz`, then the id to supply here is// baz.DatabaseIdstring `json:"databaseId,omitempty"`// EncryptionConfig: Optional. Encryption configuration to be used for the// database in the target configuration. The encryption configuration must be// specified for every database which currently uses CMEK encryption. If a// database currently uses Google-managed encryption and a target encryption// configuration is not specified, then the database defaults to Google-managed// encryption. If a database currently uses Google-managed encryption and a// target CMEK encryption is specified, the request is rejected. If a database// currently uses CMEK encryption, then a target encryption configuration must// be specified. You can't move a CMEK database to a Google-managed encryption// database using the MoveInstance API.EncryptionConfig *InstanceEncryptionConfig `json:"encryptionConfig,omitempty"`// ForceSendFields is a list of field names (e.g. "DatabaseId") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DatabaseId") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (DatabaseMoveConfig)MarshalJSON¶added inv0.235.0

func (sDatabaseMoveConfig) MarshalJSON() ([]byte,error)

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

func (DatabaseRole)MarshalJSON¶added inv0.83.0

func (sDatabaseRole) MarshalJSON() ([]byte,error)

type DdlStatementActionInfo struct {// Action: The action for the DDL statement, for example, CREATE, ALTER, DROP,// GRANT, etc. This field is a non-empty string.Actionstring `json:"action,omitempty"`// EntityNames: The entity names being operated on the DDL statement. For// example, 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, for example, TABLE,// INDEX, VIEW, etc. This field can be empty string for some DDL statement, for// example, for statement "ANALYZE", `entity_type` = "".EntityTypestring `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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Action") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (DdlStatementActionInfo)MarshalJSON¶added inv0.129.0

func (sDdlStatementActionInfo) MarshalJSON() ([]byte,error)

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

func (Delete)MarshalJSON¶

func (sDelete) MarshalJSON() ([]byte,error)

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

func (DerivedMetric)MarshalJSON¶added inv0.48.0

func (sDerivedMetric) MarshalJSON() ([]byte,error)

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

func (DiagnosticMessage)MarshalJSON¶added inv0.48.0

func (sDiagnosticMessage) MarshalJSON() ([]byte,error)

type DirectedReadOptions struct {// ExcludeReplicas: `Exclude_replicas` indicates that specified replicas should// be excluded from serving requests. Spanner doesn't 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 waits for a replica in the list to become available,// requests might 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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ExcludeReplicas") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (DirectedReadOptions)MarshalJSON¶added inv0.151.0

func (sDirectedReadOptions) MarshalJSON() ([]byte,error)

type DualRegionQuorum struct {}

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

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/`.KmsKeyNamestring `json:"kmsKeyName,omitempty"`// KmsKeyNames: Specifies the KMS configuration for one or more keys used to// encrypt the database. Values are of the form// `projects//locations//keyRings//cryptoKeys/`. The keys referenced by// `kms_key_names` must fully cover all regions of the database's instance// configuration. Some examples: * For regional (single-region) instance// configurations, specify a regional location KMS key. * For multi-region// instance configurations of type `GOOGLE_MANAGED`, either specify a// multi-region location KMS key or multiple regional location KMS keys that// cover all regions in the instance configuration. * For an instance// configuration of type `USER_MANAGED`, specify only regional location KMS// keys to cover each region in the instance configuration. Multi-region// location KMS keys aren't supported for `USER_MANAGED` type instance// configurations.KmsKeyNames []string `json:"kmsKeyNames,omitempty"`// ForceSendFields is a list of field names (e.g. "KmsKeyName") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "KmsKeyName") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (EncryptionConfig)MarshalJSON¶added inv0.41.0

func (sEncryptionConfig) MarshalJSON() ([]byte,error)

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.EncryptionTypestring `json:"encryptionType,omitempty"`// KmsKeyVersion: Output only. A Cloud KMS key version that is being used to// protect the database or backup.KmsKeyVersionstring `json:"kmsKeyVersion,omitempty"`// ForceSendFields is a list of field names (e.g. "EncryptionStatus") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "EncryptionStatus") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (EncryptionInfo)MarshalJSON¶added inv0.41.0

func (sEncryptionInfo) MarshalJSON() ([]byte,error)

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

func (ExcludeReplicas)MarshalJSON¶added inv0.151.0

func (sExcludeReplicas) MarshalJSON() ([]byte,error)

type ExecuteBatchDmlRequest struct {// LastStatements: Optional. If set to `true`, this request marks the end of// the transaction. After these statements execute, you must commit or abort// the transaction. Attempts to execute any other requests against this// transaction (including reads and queries) are rejected. Setting this option// might cause some error reporting to be deferred until commit time (for// example, validation of unique constraints). Given this, successful execution// of statements shouldn't be assumed until a subsequent `Commit` call// completes successfully.LastStatementsbool `json:"lastStatements,omitempty"`// 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 succeeds. 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 might// be aborted. Replays of previously handled requests yield the same response// as the first execution.Seqnoint64 `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. "LastStatements") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "LastStatements") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (ExecuteBatchDmlRequest)MarshalJSON¶added inv0.2.0

func (sExecuteBatchDmlRequest) MarshalJSON() ([]byte,error)

type ExecuteBatchDmlResponse struct {// PrecommitToken: Optional. A precommit token is included if the read-write// transaction is on a multiplexed session. Pass the precommit token with the// highest sequence number from this transaction attempt should be passed to// the Commit request for this transaction.PrecommitToken *MultiplexedSessionPrecommitToken `json:"precommitToken,omitempty"`// 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. "PrecommitToken") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "PrecommitToken") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (ExecuteBatchDmlResponse)MarshalJSON¶added inv0.2.0

func (sExecuteBatchDmlResponse) MarshalJSON() ([]byte,error)

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 doesn't set// `partition_token`, the API returns an `INVALID_ARGUMENT` error.DataBoostEnabledbool `json:"dataBoostEnabled,omitempty"`// DirectedReadOptions: Directed read options for this request.DirectedReadOptions *DirectedReadOptions `json:"directedReadOptions,omitempty"`// LastStatement: Optional. If set to `true`, this statement marks the end of// the transaction. After this statement executes, you must commit or abort the// transaction. Attempts to execute any other requests against this transaction// (including reads and queries) are rejected. For DML statements, setting this// option might cause some error reporting to be deferred until commit time// (for example, validation of unique constraints). Given this, successful// execution of a DML statement shouldn't be assumed until a subsequent// `Commit` call completes successfully.LastStatementbool `json:"lastStatement,omitempty"`// ParamTypes: It isn't 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, you// can use `param_types` 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's an error to execute a SQL statement with unbound// parameters.Paramsgoogleapi.RawMessage `json:"params,omitempty"`// PartitionToken: If present, results are 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`.PartitionTokenstring `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 the query plan, overall execution// statistics, operator level execution statistics along with the results. This// has a performance overhead compared to the other modes. It isn't recommended// to use this mode for production traffic.//   "WITH_STATS" - This mode returns the overall (but not operator-level)// execution statistics along with the results.//   "WITH_PLAN_AND_STATS" - This mode returns the query plan, overall (but not// operator-level) execution statistics along with the results.QueryModestring `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.ResumeTokenstring `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 succeeds. 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 can be// aborted. Replays of previously handled requests yield the same response as// the first execution. Required for DML statements. Ignored for queries.Seqnoint64 `json:"seqno,omitempty,string"`// Sql: Required. The SQL string.Sqlstring `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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DataBoostEnabled") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (ExecuteSqlRequest)MarshalJSON¶

func (sExecuteSqlRequest) MarshalJSON() ([]byte,error)

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.Descriptionstring `json:"description,omitempty"`// Expression: Textual representation of an expression in Common Expression// Language syntax.Expressionstring `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.Locationstring `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.Titlestring `json:"title,omitempty"`// ForceSendFields is a list of field names (e.g. "Description") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Description") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (Expr)MarshalJSON¶

func (sExpr) MarshalJSON() ([]byte,error)

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

func (Field)MarshalJSON¶

func (sField) MarshalJSON() ([]byte,error)

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.ExpireBehaviorstring `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.ExpireTimestring `json:"expireTime,omitempty"`// UpgradeTime: Output only. If present, the timestamp at which the free// instance was upgraded to a provisioned instance.UpgradeTimestring `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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ExpireBehavior") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (FreeInstanceMetadata)MarshalJSON¶added inv0.90.0

func (sFreeInstanceMetadata) MarshalJSON() ([]byte,error)

type FullBackupSpec struct {}

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

func (GetDatabaseDdlResponse)MarshalJSON¶

func (sGetDatabaseDdlResponse) MarshalJSON() ([]byte,error)

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

func (GetIamPolicyRequest)MarshalJSON¶added inv0.9.0

func (sGetIamPolicyRequest) MarshalJSON() ([]byte,error)

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

func (GetPolicyOptions)MarshalJSON¶added inv0.9.0

func (sGetPolicyOptions) MarshalJSON() ([]byte,error)

type HeartbeatRecord struct {// Timestamp: Indicates the timestamp at which the query has returned all the// records in the change stream partition with timestamp <= heartbeat// timestamp. The heartbeat timestamp will not be the same as the timestamps of// other record types in the same partition.Timestampstring `json:"timestamp,omitempty"`// ForceSendFields is a list of field names (e.g. "Timestamp") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Timestamp") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (HeartbeatRecord)MarshalJSON¶added inv0.240.0

func (sHeartbeatRecord) MarshalJSON() ([]byte,error)

type IncludeReplicas struct {// AutoFailoverDisabled: If `true`, Spanner doesn't route requests to a replica// outside the <`include_replicas` list when all of the specified replicas are// unavailable or unhealthy. Default value is `false`.AutoFailoverDisabledbool `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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AutoFailoverDisabled") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (IncludeReplicas)MarshalJSON¶added inv0.151.0

func (sIncludeReplicas) MarshalJSON() ([]byte,error)

type IncrementalBackupSpec struct {}

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

func (IndexAdvice)MarshalJSON¶added inv0.149.0

func (sIndexAdvice) MarshalJSON() ([]byte,error)

func (*IndexAdvice)UnmarshalJSON¶added inv0.149.0

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

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

func (IndexedHotKey)MarshalJSON¶added inv0.48.0

func (sIndexedHotKey) MarshalJSON() ([]byte,error)

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

func (IndexedKeyRangeInfos)MarshalJSON¶added inv0.48.0

func (sIndexedKeyRangeInfos) MarshalJSON() ([]byte,error)

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.Configstring `json:"config,omitempty"`// CreateTime: Output only. The time at which the instance was created.CreateTimestring `json:"createTime,omitempty"`// DefaultBackupScheduleType: Optional. Controls the default backup schedule// behavior for new databases within the instance. By default, a backup// schedule is created automatically when a new database is created in a new// instance. Note that the `AUTOMATIC` value isn't permitted for free// instances, as backups and backup schedules aren't supported for free// instances. In the `GetInstance` or `ListInstances` response, if the value of// `default_backup_schedule_type` isn't set, or set to `NONE`, Spanner doesn't// create a default backup schedule for new databases in the instance.//// Possible values://   "DEFAULT_BACKUP_SCHEDULE_TYPE_UNSPECIFIED" - Not specified.//   "NONE" - A default backup schedule isn't created automatically when a new// database is created in the instance.//   "AUTOMATIC" - A default backup schedule is created automatically when a// new database is created in the instance. The default backup schedule creates// a full backup every 24 hours. These full backups are retained for 7 days.// You can edit or delete the default backup schedule once it's created.DefaultBackupScheduleTypestring `json:"defaultBackupScheduleType,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.DisplayNamestring `json:"displayName,omitempty"`// Edition: Optional. The `Edition` of the current instance.//// Possible values://   "EDITION_UNSPECIFIED" - Edition not specified.//   "STANDARD" - Standard edition.//   "ENTERPRISE" - Enterprise edition.//   "ENTERPRISE_PLUS" - Enterprise Plus edition.Editionstring `json:"edition,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.InstanceTypestring `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. Seehttps://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.Namestring `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. If autoscaling is enabled, `node_count` is// treated as an `OUTPUT_ONLY` field and reflects the current number of nodes// allocated to the instance. This might be zero in API responses for instances// that are not yet in the `READY` state. If the instance has varying node// count across replicas (achieved by setting `asymmetric_autoscaling_options`// in the autoscaling configuration), the `node_count` set here is the maximum// node count across all replicas. For more information, see Compute capacity,// nodes, and processing units// (https://cloud.google.com/spanner/docs/compute-capacity).NodeCountint64 `json:"nodeCount,omitempty"`// ProcessingUnits: The number of processing units allocated to this instance.// At most, one of either `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. If autoscaling// is enabled, `processing_units` is treated as an `OUTPUT_ONLY` field and// reflects the current number of processing units allocated to the instance.// This might be zero in API responses for instances that are not yet in the// `READY` state. If the instance has varying processing units per replica// (achieved by setting `asymmetric_autoscaling_options` in the autoscaling// configuration), the `processing_units` set here is the maximum processing// units across all replicas. For more information, see Compute capacity, nodes// and processing units// (https://cloud.google.com/spanner/docs/compute-capacity).ProcessingUnitsint64 `json:"processingUnits,omitempty"`// ReplicaComputeCapacity: Output only. Lists the compute capacity per// ReplicaSelection. A replica selection identifies a set of replicas with// common properties. Replicas identified by a ReplicaSelection are scaled with// the same compute capacity.ReplicaComputeCapacity []*ReplicaComputeCapacity `json:"replicaComputeCapacity,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.Statestring `json:"state,omitempty"`// UpdateTime: Output only. The time at which the instance was most recently// updated.UpdateTimestring `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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AutoscalingConfig") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (Instance)MarshalJSON¶

func (sInstance) MarshalJSON() ([]byte,error)

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.BaseConfigstring `json:"baseConfig,omitempty"`// ConfigType: Output only. Whether this instance configuration is a// Google-managed or user-managed configuration.//// Possible values://   "TYPE_UNSPECIFIED" - Unspecified.//   "GOOGLE_MANAGED" - Google-managed configuration.//   "USER_MANAGED" - User-managed configuration.ConfigTypestring `json:"configType,omitempty"`// DisplayName: The name of this instance configuration as it appears in UIs.DisplayNamestring `json:"displayName,omitempty"`// Etag: etag is used for optimistic concurrency control as a way to help// prevent simultaneous updates of a instance configuration from overwriting// each other. It is strongly suggested that systems make use of the etag in// the read-modify-write cycle to perform instance configuration updates in// order to avoid race conditions: An etag is returned in the response which// contains instance configurations, and systems are expected to put that etag// in the request to update instance configuration to ensure that their change// is applied to the same version of the instance configuration. If no etag is// provided in the call to update the instance configuration, then the existing// instance configuration is overwritten blindly.Etagstring `json:"etag,omitempty"`// FreeInstanceAvailability: Output only. Describes whether free instances are// available to be created in this instance configuration.//// Possible values://   "FREE_INSTANCE_AVAILABILITY_UNSPECIFIED" - Not specified.//   "AVAILABLE" - Indicates that free instances are available to be created in// this instance configuration.//   "UNSUPPORTED" - Indicates that free instances are not supported in this// instance configuration.//   "DISABLED" - Indicates that free instances are currently not available to// be created in this instance configuration.//   "QUOTA_EXCEEDED" - Indicates that additional free instances cannot be// created in this instance configuration because the project has reached its// limit of free instances.FreeInstanceAvailabilitystring `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. Seehttps://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*`. User instance configuration must// start with `custom-`.Namestring `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"`// QuorumType: Output only. The `QuorumType` of the instance configuration.//// Possible values://   "QUORUM_TYPE_UNSPECIFIED" - Quorum type not specified.//   "REGION" - An instance configuration tagged with `REGION` quorum type// forms a write quorum in a single region.//   "DUAL_REGION" - An instance configuration tagged with the `DUAL_REGION`// quorum type forms a write quorum with exactly two read-write regions in a// multi-region configuration. This instance configuration requires failover in// the event of regional failures.//   "MULTI_REGION" - An instance configuration tagged with the `MULTI_REGION`// quorum type forms a write quorum from replicas that are spread across more// than one region in a multi-region configuration.QuorumTypestring `json:"quorumType,omitempty"`// Reconciling: Output only. If true, the instance configuration is being// created or updated. If false, there are no ongoing operations for the// instance configuration.Reconcilingbool `json:"reconciling,omitempty"`// Replicas: The geographic placement of nodes in this instance configuration// and their replication properties. To create user-managed configurations,// input `replicas` must include all replicas in `replicas` of the// `base_config` and include one or more replicas in the `optional_replicas` of// the `base_config`.Replicas []*ReplicaInfo `json:"replicas,omitempty"`// State: Output only. The current instance configuration state. Applicable// only for `USER_MANAGED` configurations.//// Possible values://   "STATE_UNSPECIFIED" - Not specified.//   "CREATING" - The instance configuration is still being created.//   "READY" - The instance configuration is fully created and ready to be used// to create instances.Statestring `json:"state,omitempty"`// StorageLimitPerProcessingUnit: Output only. The storage limit in bytes per// processing unit.StorageLimitPerProcessingUnitint64 `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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "BaseConfig") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (InstanceConfig)MarshalJSON¶

func (sInstanceConfig) MarshalJSON() ([]byte,error)

type InstanceEncryptionConfig struct {// KmsKeyName: Optional. This field is maintained for backwards compatibility.// For new callers, we recommend using `kms_key_names` to specify the KMS key.// Only use `kms_key_name` if the location of the KMS key matches the database// instance's configuration (location) exactly. For example, if the KMS// location is in `us-central1` or `nam3`, then the database instance must also// be in `us-central1` or `nam3`. The Cloud KMS key that is used to encrypt and// decrypt the restored database. Values are of the form// `projects//locations//keyRings//cryptoKeys/`.KmsKeyNamestring `json:"kmsKeyName,omitempty"`// KmsKeyNames: Optional. Specifies the KMS configuration for one or more keys// used to encrypt the database. Values are of the form// `projects//locations//keyRings//cryptoKeys/`. The keys referenced by// `kms_key_names` must fully cover all regions of the database's instance// configuration. Some examples: * For regional (single-region) instance// configurations, specify a regional location KMS key. * For multi-region// instance configurations of type `GOOGLE_MANAGED`, either specify a// multi-region location KMS key or multiple regional location KMS keys that// cover all regions in the instance configuration. * For an instance// configuration of type `USER_MANAGED`, specify only regional location KMS// keys to cover each region in the instance configuration. Multi-region// location KMS keys aren't supported for `USER_MANAGED` type instance// configurations.KmsKeyNames []string `json:"kmsKeyNames,omitempty"`// ForceSendFields is a list of field names (e.g. "KmsKeyName") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "KmsKeyName") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (InstanceEncryptionConfig)MarshalJSON¶added inv0.235.0

func (sInstanceEncryptionConfig) MarshalJSON() ([]byte,error)

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

func (InstanceOperationProgress)MarshalJSON¶added inv0.100.0

func (sInstanceOperationProgress) MarshalJSON() ([]byte,error)

type InstancePartition struct {// AutoscalingConfig: Optional. The autoscaling configuration. Autoscaling is// enabled if this field is set. When autoscaling is enabled, fields in// compute_capacity are treated as OUTPUT_ONLY fields and reflect the current// compute capacity allocated to the instance partition.AutoscalingConfig *AutoscalingConfig `json:"autoscalingConfig,omitempty"`// Config: Required. The name of the instance partition's configuration. Values// are of the form `projects//instanceConfigs/`. See also InstanceConfig and// ListInstanceConfigs.Configstring `json:"config,omitempty"`// CreateTime: Output only. The time at which the instance partition was// created.CreateTimestring `json:"createTime,omitempty"`// DisplayName: Required. The descriptive name for this instance partition as// it appears in UIs. Must be unique per project and between 4 and 30// characters in length.DisplayNamestring `json:"displayName,omitempty"`// Etag: Used for optimistic concurrency control as a way to help prevent// simultaneous updates of a instance partition from overwriting each other. It// is strongly suggested that systems make use of the etag in the// read-modify-write cycle to perform instance partition updates in order to// avoid race conditions: An etag is returned in the response which contains// instance partitions, and systems are expected to put that etag in the// request to update instance partitions to ensure that their change will be// applied to the same version of the instance partition. If no etag is// provided in the call to update instance partition, then the existing// instance partition is overwritten blindly.Etagstring `json:"etag,omitempty"`// Name: Required. A unique identifier for the instance partition. Values are// of the form `projects//instances//instancePartitions/a-z*[a-z0-9]`. The// final segment of the name must be between 2 and 64 characters in length. An// instance partition's name cannot be changed after the instance partition is// created.Namestring `json:"name,omitempty"`// NodeCount: The number of nodes allocated to this instance partition. Users// can set the `node_count` field to specify the target number of nodes// allocated to the instance partition. This may be zero in API responses for// instance partitions that are not yet in state `READY`.NodeCountint64 `json:"nodeCount,omitempty"`// ProcessingUnits: The number of processing units allocated to this instance// partition. Users can set the `processing_units` field to specify the target// number of processing units allocated to the instance partition. This might// be zero in API responses for instance partitions that are not yet in the// `READY` state.ProcessingUnitsint64 `json:"processingUnits,omitempty"`// ReferencingBackups: Output only. Deprecated: This field is not populated.// Output only. The names of the backups that reference this instance// partition. Referencing backups should share the parent instance. The// existence of any referencing backup prevents the instance partition from// being deleted.ReferencingBackups []string `json:"referencingBackups,omitempty"`// ReferencingDatabases: Output only. The names of the databases that reference// this instance partition. Referencing databases should share the parent// instance. The existence of any referencing database prevents the instance// partition from being deleted.ReferencingDatabases []string `json:"referencingDatabases,omitempty"`// State: Output only. The current instance partition state.//// Possible values://   "STATE_UNSPECIFIED" - Not specified.//   "CREATING" - The instance partition is still being created. Resources may// not be available yet, and operations such as creating placements using this// instance partition may not work.//   "READY" - The instance partition is fully created and ready to do work// such as creating placements and using in databases.Statestring `json:"state,omitempty"`// UpdateTime: Output only. The time at which the instance partition was most// recently updated.UpdateTimestring `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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AutoscalingConfig") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (InstancePartition)MarshalJSON¶added inv0.171.0

func (sInstancePartition) MarshalJSON() ([]byte,error)

type InstanceReplicaSelection struct {// Location: Required. Name of the location of the replicas (for example,// "us-central1").Locationstring `json:"location,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. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Location") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (InstanceReplicaSelection)MarshalJSON¶added inv0.202.0

func (sInstanceReplicaSelection) MarshalJSON() ([]byte,error)

type Key struct {// KeyParts: Required. The column values making up the split key.KeyParts []interface{} `json:"keyParts,omitempty"`// ForceSendFields is a list of field names (e.g. "KeyParts") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "KeyParts") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

func (Key)MarshalJSON¶added inv0.218.0

func (sKey) MarshalJSON() ([]byte,error)

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