database

package
Version: v0.0.0-...-00ab72f Latest Latest
Warning

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

Go to latest
Published: Jan 18, 2022 License: Apache-2.0 Imports: 15 Imported by: 227

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	Backup_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "CREATING",
		2: "READY",
	}
	Backup_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"CREATING":          1,
		"READY":             2,
	}
)

Enum value maps for Backup_State.

View Source
var (
	CreateBackupEncryptionConfig_EncryptionType_name = map[int32]string{
		0: "ENCRYPTION_TYPE_UNSPECIFIED",
		1: "USE_DATABASE_ENCRYPTION",
		2: "GOOGLE_DEFAULT_ENCRYPTION",
		3: "CUSTOMER_MANAGED_ENCRYPTION",
	}
	CreateBackupEncryptionConfig_EncryptionType_value = map[string]int32{
		"ENCRYPTION_TYPE_UNSPECIFIED": 0,
		"USE_DATABASE_ENCRYPTION":     1,
		"GOOGLE_DEFAULT_ENCRYPTION":   2,
		"CUSTOMER_MANAGED_ENCRYPTION": 3,
	}
)

Enum value maps for CreateBackupEncryptionConfig_EncryptionType.

View Source
var (
	EncryptionInfo_Type_name = map[int32]string{
		0: "TYPE_UNSPECIFIED",
		1: "GOOGLE_DEFAULT_ENCRYPTION",
		2: "CUSTOMER_MANAGED_ENCRYPTION",
	}
	EncryptionInfo_Type_value = map[string]int32{
		"TYPE_UNSPECIFIED":            0,
		"GOOGLE_DEFAULT_ENCRYPTION":   1,
		"CUSTOMER_MANAGED_ENCRYPTION": 2,
	}
)

Enum value maps for EncryptionInfo_Type.

View Source
var (
	RestoreSourceType_name = map[int32]string{
		0: "TYPE_UNSPECIFIED",
		1: "BACKUP",
	}
	RestoreSourceType_value = map[string]int32{
		"TYPE_UNSPECIFIED": 0,
		"BACKUP":           1,
	}
)

Enum value maps for RestoreSourceType.

View Source
var (
	Database_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "CREATING",
		2: "READY",
		3: "READY_OPTIMIZING",
	}
	Database_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"CREATING":          1,
		"READY":             2,
		"READY_OPTIMIZING":  3,
	}
)

Enum value maps for Database_State.

View Source
var (
	RestoreDatabaseEncryptionConfig_EncryptionType_name = map[int32]string{
		0: "ENCRYPTION_TYPE_UNSPECIFIED",
		1: "USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION",
		2: "GOOGLE_DEFAULT_ENCRYPTION",
		3: "CUSTOMER_MANAGED_ENCRYPTION",
	}
	RestoreDatabaseEncryptionConfig_EncryptionType_value = map[string]int32{
		"ENCRYPTION_TYPE_UNSPECIFIED":             0,
		"USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION": 1,
		"GOOGLE_DEFAULT_ENCRYPTION":               2,
		"CUSTOMER_MANAGED_ENCRYPTION":             3,
	}
)

Enum value maps for RestoreDatabaseEncryptionConfig_EncryptionType.

View Source
var File_google_spanner_admin_database_v1_backup_proto protoreflect.FileDescriptor
View Source
var File_google_spanner_admin_database_v1_common_proto protoreflect.FileDescriptor
View Source
var File_google_spanner_admin_database_v1_spanner_database_admin_proto protoreflect.FileDescriptor

Functions

func RegisterDatabaseAdminServer

func RegisterDatabaseAdminServer(s *grpc.Server, srv DatabaseAdminServer)

Types

type Backup

type Backup struct {

	// Required for the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.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/<project>/instances/<instance>/databases/<database>`.
	Database string `protobuf:"bytes,2,opt,name=database,proto3" json:"database,omitempty"`
	// The backup will contain an externally consistent copy of the database at
	// the timestamp specified by `version_time`. If `version_time` is not
	// specified, the system will set `version_time` to the `create_time` of the
	// backup.
	VersionTime *timestamppb.Timestamp `protobuf:"bytes,9,opt,name=version_time,json=versionTime,proto3" json:"version_time,omitempty"`
	// Required for the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup]
	// operation. The expiration time of the backup, with microseconds
	// granularity that must be at least 6 hours and at most 366 days
	// from the time the CreateBackup request is processed. Once the `expire_time`
	// has passed, the backup is eligible to be automatically deleted by Cloud
	// Spanner to free the resources used by the backup.
	ExpireTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=expire_time,json=expireTime,proto3" json:"expire_time,omitempty"`
	// Output only for the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] operation.
	// Required for the [UpdateBackup][google.spanner.admin.database.v1.DatabaseAdmin.UpdateBackup] operation.
	//
	// A globally unique identifier for the backup which cannot be
	// changed. Values are of the form
	// `projects/<project>/instances/<instance>/backups/[a-z][a-z0-9_\-]*[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/<project>/instances/<instance>`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Output only. The time the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup]
	// request is received. If the request does not specify `version_time`, the
	// `version_time` of the backup will be equivalent to the `create_time`.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Size of the backup in bytes.
	SizeBytes int64 `protobuf:"varint,5,opt,name=size_bytes,json=sizeBytes,proto3" json:"size_bytes,omitempty"`
	// Output only. The current state of the backup.
	State Backup_State `protobuf:"varint,6,opt,name=state,proto3,enum=google.spanner.admin.database.v1.Backup_State" json:"state,omitempty"`
	// Output only. The names of the restored databases that reference the backup.
	// The database names are of
	// the form `projects/<project>/instances/<instance>/databases/<database>`.
	// 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 `protobuf:"bytes,7,rep,name=referencing_databases,json=referencingDatabases,proto3" json:"referencing_databases,omitempty"`
	// Output only. The encryption information for the backup.
	EncryptionInfo *EncryptionInfo `protobuf:"bytes,8,opt,name=encryption_info,json=encryptionInfo,proto3" json:"encryption_info,omitempty"`
	// contains filtered or unexported fields
}

A backup of a Cloud Spanner database.

func (*Backup) Descriptor deprecated

func (*Backup) Descriptor() ([]byte, []int)

Deprecated: Use Backup.ProtoReflect.Descriptor instead.

func (*Backup) GetCreateTime

func (x *Backup) GetCreateTime() *timestamppb.Timestamp

func (*Backup) GetDatabase

func (x *Backup) GetDatabase() string

func (*Backup) GetEncryptionInfo

func (x *Backup) GetEncryptionInfo() *EncryptionInfo

func (*Backup) GetExpireTime

func (x *Backup) GetExpireTime() *timestamppb.Timestamp

func (*Backup) GetName

func (x *Backup) GetName() string

func (*Backup) GetReferencingDatabases

func (x *Backup) GetReferencingDatabases() []string

func (*Backup) GetSizeBytes

func (x *Backup) GetSizeBytes() int64

func (*Backup) GetState

func (x *Backup) GetState() Backup_State

func (*Backup) GetVersionTime

func (x *Backup) GetVersionTime() *timestamppb.Timestamp

func (*Backup) ProtoMessage

func (*Backup) ProtoMessage()

func (*Backup) ProtoReflect

func (x *Backup) ProtoReflect() protoreflect.Message

func (*Backup) Reset

func (x *Backup) Reset()

func (*Backup) String

func (x *Backup) String() string

type BackupInfo

type BackupInfo struct {

	// Name of the backup.
	Backup string `protobuf:"bytes,1,opt,name=backup,proto3" json:"backup,omitempty"`
	// The backup contains an externally consistent copy of `source_database` at
	// the timestamp specified by `version_time`. If the
	// [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] request did not specify
	// `version_time`, the `version_time` of the backup is equivalent to the
	// `create_time`.
	VersionTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=version_time,json=versionTime,proto3" json:"version_time,omitempty"`
	// The time the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] request was
	// received.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Name of the database the backup was created from.
	SourceDatabase string `protobuf:"bytes,3,opt,name=source_database,json=sourceDatabase,proto3" json:"source_database,omitempty"`
	// contains filtered or unexported fields
}

Information about a backup.

func (*BackupInfo) Descriptor deprecated

func (*BackupInfo) Descriptor() ([]byte, []int)

Deprecated: Use BackupInfo.ProtoReflect.Descriptor instead.

func (*BackupInfo) GetBackup

func (x *BackupInfo) GetBackup() string

func (*BackupInfo) GetCreateTime

func (x *BackupInfo) GetCreateTime() *timestamppb.Timestamp

func (*BackupInfo) GetSourceDatabase

func (x *BackupInfo) GetSourceDatabase() string

func (*BackupInfo) GetVersionTime

func (x *BackupInfo) GetVersionTime() *timestamppb.Timestamp

func (*BackupInfo) ProtoMessage

func (*BackupInfo) ProtoMessage()

func (*BackupInfo) ProtoReflect

func (x *BackupInfo) ProtoReflect() protoreflect.Message

func (*BackupInfo) Reset

func (x *BackupInfo) Reset()

func (*BackupInfo) String

func (x *BackupInfo) String() string

type Backup_State

type Backup_State int32

Indicates the current state of the backup.

const (
	// Not specified.
	Backup_STATE_UNSPECIFIED Backup_State = 0
	// The pending backup is still being created. Operations on the
	// backup may fail with `FAILED_PRECONDITION` in this state.
	Backup_CREATING Backup_State = 1
	// The backup is complete and ready for use.
	Backup_READY Backup_State = 2
)

func (Backup_State) Descriptor

func (Backup_State) Enum

func (x Backup_State) Enum() *Backup_State

func (Backup_State) EnumDescriptor deprecated

func (Backup_State) EnumDescriptor() ([]byte, []int)

Deprecated: Use Backup_State.Descriptor instead.

func (Backup_State) Number

func (Backup_State) String

func (x Backup_State) String() string

func (Backup_State) Type

type CreateBackupEncryptionConfig

type CreateBackupEncryptionConfig struct {

	// Required. The encryption type of the backup.
	EncryptionType CreateBackupEncryptionConfig_EncryptionType `` /* 186-byte string literal not displayed */
	// Optional. The Cloud KMS key that will be used to protect the backup.
	// This field should be set only when
	// [encryption_type][google.spanner.admin.database.v1.CreateBackupEncryptionConfig.encryption_type] is
	// `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form
	// `projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>`.
	KmsKeyName string `protobuf:"bytes,2,opt,name=kms_key_name,json=kmsKeyName,proto3" json:"kms_key_name,omitempty"`
	// contains filtered or unexported fields
}

Encryption configuration for the backup to create.

func (*CreateBackupEncryptionConfig) Descriptor deprecated

func (*CreateBackupEncryptionConfig) Descriptor() ([]byte, []int)

Deprecated: Use CreateBackupEncryptionConfig.ProtoReflect.Descriptor instead.

func (*CreateBackupEncryptionConfig) GetEncryptionType

func (*CreateBackupEncryptionConfig) GetKmsKeyName

func (x *CreateBackupEncryptionConfig) GetKmsKeyName() string

func (*CreateBackupEncryptionConfig) ProtoMessage

func (*CreateBackupEncryptionConfig) ProtoMessage()

func (*CreateBackupEncryptionConfig) ProtoReflect

func (*CreateBackupEncryptionConfig) Reset

func (x *CreateBackupEncryptionConfig) Reset()

func (*CreateBackupEncryptionConfig) String

type CreateBackupEncryptionConfig_EncryptionType

type CreateBackupEncryptionConfig_EncryptionType int32

Encryption types for the backup.

const (
	// Unspecified. Do not use.
	CreateBackupEncryptionConfig_ENCRYPTION_TYPE_UNSPECIFIED CreateBackupEncryptionConfig_EncryptionType = 0
	// Use the same encryption configuration as the database. This is the
	// default option when
	// [encryption_config][google.spanner.admin.database.v1.CreateBackupEncryptionConfig] 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.
	CreateBackupEncryptionConfig_USE_DATABASE_ENCRYPTION CreateBackupEncryptionConfig_EncryptionType = 1
	// Use Google default encryption.
	CreateBackupEncryptionConfig_GOOGLE_DEFAULT_ENCRYPTION CreateBackupEncryptionConfig_EncryptionType = 2
	// Use customer managed encryption. If specified, `kms_key_name`
	// must contain a valid Cloud KMS key.
	CreateBackupEncryptionConfig_CUSTOMER_MANAGED_ENCRYPTION CreateBackupEncryptionConfig_EncryptionType = 3
)

func (CreateBackupEncryptionConfig_EncryptionType) Descriptor

func (CreateBackupEncryptionConfig_EncryptionType) Enum

func (CreateBackupEncryptionConfig_EncryptionType) EnumDescriptor deprecated

func (CreateBackupEncryptionConfig_EncryptionType) EnumDescriptor() ([]byte, []int)

Deprecated: Use CreateBackupEncryptionConfig_EncryptionType.Descriptor instead.

func (CreateBackupEncryptionConfig_EncryptionType) Number

func (CreateBackupEncryptionConfig_EncryptionType) String

func (CreateBackupEncryptionConfig_EncryptionType) Type

type CreateBackupMetadata

type CreateBackupMetadata struct {

	// The name of the backup being created.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The name of the database the backup is created from.
	Database string `protobuf:"bytes,2,opt,name=database,proto3" json:"database,omitempty"`
	// The progress of the
	// [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] operation.
	Progress *OperationProgress `protobuf:"bytes,3,opt,name=progress,proto3" json:"progress,omitempty"`
	// The time at which cancellation of this operation was received.
	// [Operations.CancelOperation][google.longrunning.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][google.longrunning.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][google.longrunning.Operation.error] value with a
	// [google.rpc.Status.code][google.rpc.Status.code] of 1,
	// corresponding to `Code.CANCELLED`.
	CancelTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=cancel_time,json=cancelTime,proto3" json:"cancel_time,omitempty"`
	// contains filtered or unexported fields
}

Metadata type for the operation returned by [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup].

func (*CreateBackupMetadata) Descriptor deprecated

func (*CreateBackupMetadata) Descriptor() ([]byte, []int)

Deprecated: Use CreateBackupMetadata.ProtoReflect.Descriptor instead.

func (*CreateBackupMetadata) GetCancelTime

func (x *CreateBackupMetadata) GetCancelTime() *timestamppb.Timestamp

func (*CreateBackupMetadata) GetDatabase

func (x *CreateBackupMetadata) GetDatabase() string

func (*CreateBackupMetadata) GetName

func (x *CreateBackupMetadata) GetName() string

func (*CreateBackupMetadata) GetProgress

func (x *CreateBackupMetadata) GetProgress() *OperationProgress

func (*CreateBackupMetadata) ProtoMessage

func (*CreateBackupMetadata) ProtoMessage()

func (*CreateBackupMetadata) ProtoReflect

func (x *CreateBackupMetadata) ProtoReflect() protoreflect.Message

func (*CreateBackupMetadata) Reset

func (x *CreateBackupMetadata) Reset()

func (*CreateBackupMetadata) String

func (x *CreateBackupMetadata) String() string

type CreateBackupRequest

type CreateBackupRequest struct {

	// Required. The name of the instance in which the backup will be
	// created. This must be the same instance that contains the database the
	// backup will be created from. The backup will be stored in the
	// location(s) specified in the instance configuration of this
	// instance. Values are of the form
	// `projects/<project>/instances/<instance>`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The id of the backup to be created. The `backup_id` appended to
	// `parent` forms the full backup name of the form
	// `projects/<project>/instances/<instance>/backups/<backup_id>`.
	BackupId string `protobuf:"bytes,2,opt,name=backup_id,json=backupId,proto3" json:"backup_id,omitempty"`
	// Required. The backup to create.
	Backup *Backup `protobuf:"bytes,3,opt,name=backup,proto3" json:"backup,omitempty"`
	// 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 database by default, namely
	// [encryption_type][google.spanner.admin.database.v1.CreateBackupEncryptionConfig.encryption_type] =
	// `USE_DATABASE_ENCRYPTION`.
	EncryptionConfig *CreateBackupEncryptionConfig `protobuf:"bytes,4,opt,name=encryption_config,json=encryptionConfig,proto3" json:"encryption_config,omitempty"`
	// contains filtered or unexported fields
}

The request for [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup].

func (*CreateBackupRequest) Descriptor deprecated

func (*CreateBackupRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateBackupRequest.ProtoReflect.Descriptor instead.

func (*CreateBackupRequest) GetBackup

func (x *CreateBackupRequest) GetBackup() *Backup

func (*CreateBackupRequest) GetBackupId

func (x *CreateBackupRequest) GetBackupId() string

func (*CreateBackupRequest) GetEncryptionConfig

func (x *CreateBackupRequest) GetEncryptionConfig() *CreateBackupEncryptionConfig

func (*CreateBackupRequest) GetParent

func (x *CreateBackupRequest) GetParent() string

func (*CreateBackupRequest) ProtoMessage

func (*CreateBackupRequest) ProtoMessage()

func (*CreateBackupRequest) ProtoReflect

func (x *CreateBackupRequest) ProtoReflect() protoreflect.Message

func (*CreateBackupRequest) Reset

func (x *CreateBackupRequest) Reset()

func (*CreateBackupRequest) String

func (x *CreateBackupRequest) String() string

type CreateDatabaseMetadata

type CreateDatabaseMetadata struct {

	// The database being created.
	Database string `protobuf:"bytes,1,opt,name=database,proto3" json:"database,omitempty"`
	// contains filtered or unexported fields
}

Metadata type for the operation returned by [CreateDatabase][google.spanner.admin.database.v1.DatabaseAdmin.CreateDatabase].

func (*CreateDatabaseMetadata) Descriptor deprecated

func (*CreateDatabaseMetadata) Descriptor() ([]byte, []int)

Deprecated: Use CreateDatabaseMetadata.ProtoReflect.Descriptor instead.

func (*CreateDatabaseMetadata) GetDatabase

func (x *CreateDatabaseMetadata) GetDatabase() string

func (*CreateDatabaseMetadata) ProtoMessage

func (*CreateDatabaseMetadata) ProtoMessage()

func (*CreateDatabaseMetadata) ProtoReflect

func (x *CreateDatabaseMetadata) ProtoReflect() protoreflect.Message

func (*CreateDatabaseMetadata) Reset

func (x *CreateDatabaseMetadata) Reset()

func (*CreateDatabaseMetadata) String

func (x *CreateDatabaseMetadata) String() string

type CreateDatabaseRequest

type CreateDatabaseRequest struct {

	// Required. The name of the instance that will serve the new database.
	// Values are of the form `projects/<project>/instances/<instance>`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// 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_\-]*[a-z0-9]` and be between 2 and 30 characters in length.
	// If the database ID is a reserved word or if it contains a hyphen, the
	// database ID must be enclosed in backticks (“ ` “).
	CreateStatement string `protobuf:"bytes,2,opt,name=create_statement,json=createStatement,proto3" json:"create_statement,omitempty"`
	// 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 `protobuf:"bytes,3,rep,name=extra_statements,json=extraStatements,proto3" json:"extra_statements,omitempty"`
	// 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 `protobuf:"bytes,4,opt,name=encryption_config,json=encryptionConfig,proto3" json:"encryption_config,omitempty"`
	// contains filtered or unexported fields
}

The request for [CreateDatabase][google.spanner.admin.database.v1.DatabaseAdmin.CreateDatabase].

func (*CreateDatabaseRequest) Descriptor deprecated

func (*CreateDatabaseRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateDatabaseRequest.ProtoReflect.Descriptor instead.

func (*CreateDatabaseRequest) GetCreateStatement

func (x *CreateDatabaseRequest) GetCreateStatement() string

func (*CreateDatabaseRequest) GetEncryptionConfig

func (x *CreateDatabaseRequest) GetEncryptionConfig() *EncryptionConfig

func (*CreateDatabaseRequest) GetExtraStatements

func (x *CreateDatabaseRequest) GetExtraStatements() []string

func (*CreateDatabaseRequest) GetParent

func (x *CreateDatabaseRequest) GetParent() string

func (*CreateDatabaseRequest) ProtoMessage

func (*CreateDatabaseRequest) ProtoMessage()

func (*CreateDatabaseRequest) ProtoReflect

func (x *CreateDatabaseRequest) ProtoReflect() protoreflect.Message

func (*CreateDatabaseRequest) Reset

func (x *CreateDatabaseRequest) Reset()

func (*CreateDatabaseRequest) String

func (x *CreateDatabaseRequest) String() string

type Database

type Database struct {

	// Required. The name of the database. Values are of the form
	// `projects/<project>/instances/<instance>/databases/<database>`,
	// where `<database>` is as specified in the `CREATE DATABASE`
	// statement. This name can be passed to other API methods to
	// identify the database.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Output only. The current database state.
	State Database_State `protobuf:"varint,2,opt,name=state,proto3,enum=google.spanner.admin.database.v1.Database_State" json:"state,omitempty"`
	// Output only. If exists, the time at which the database creation started.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Applicable only for restored databases. Contains information
	// about the restore source.
	RestoreInfo *RestoreInfo `protobuf:"bytes,4,opt,name=restore_info,json=restoreInfo,proto3" json:"restore_info,omitempty"`
	// 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 `protobuf:"bytes,5,opt,name=encryption_config,json=encryptionConfig,proto3" json:"encryption_config,omitempty"`
	// Output only. For databases that are using customer managed encryption, this
	// field contains the encryption information for the database, such as
	// encryption state and the Cloud KMS key versions that are in use.
	//
	// 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 `protobuf:"bytes,8,rep,name=encryption_info,json=encryptionInfo,proto3" json:"encryption_info,omitempty"`
	// 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][google.spanner.admin.database.v1.DatabaseAdmin.UpdateDatabaseDdl]. Defaults to 1 hour,
	// if not set.
	VersionRetentionPeriod string `` /* 129-byte string literal not displayed */
	// Output only. Earliest timestamp at which older versions of the data can be
	// read. This value is continuously updated by Cloud Spanner and becomes stale
	// the moment it is queried. If you are using this value to recover data, make
	// sure to account for the time from the moment when the value is queried to
	// the moment when you initiate the recovery.
	EarliestVersionTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=earliest_version_time,json=earliestVersionTime,proto3" json:"earliest_version_time,omitempty"`
	// Output only. The read-write region which contains the database's leader
	// replicas.
	//
	// This is the same as the value of default_leader
	// database option set using DatabaseAdmin.CreateDatabase or
	// DatabaseAdmin.UpdateDatabaseDdl. If not explicitly set, this is empty.
	DefaultLeader string `protobuf:"bytes,9,opt,name=default_leader,json=defaultLeader,proto3" json:"default_leader,omitempty"`
	// contains filtered or unexported fields
}

A Cloud Spanner database.

func (*Database) Descriptor deprecated

func (*Database) Descriptor() ([]byte, []int)

Deprecated: Use Database.ProtoReflect.Descriptor instead.

func (*Database) GetCreateTime

func (x *Database) GetCreateTime() *timestamppb.Timestamp

func (*Database) GetDefaultLeader

func (x *Database) GetDefaultLeader() string

func (*Database) GetEarliestVersionTime

func (x *Database) GetEarliestVersionTime() *timestamppb.Timestamp

func (*Database) GetEncryptionConfig

func (x *Database) GetEncryptionConfig() *EncryptionConfig

func (*Database) GetEncryptionInfo

func (x *Database) GetEncryptionInfo() []*EncryptionInfo

func (*Database) GetName

func (x *Database) GetName() string

func (*Database) GetRestoreInfo

func (x *Database) GetRestoreInfo() *RestoreInfo

func (*Database) GetState

func (x *Database) GetState() Database_State

func (*Database) GetVersionRetentionPeriod

func (x *Database) GetVersionRetentionPeriod() string

func (*Database) ProtoMessage

func (*Database) ProtoMessage()

func (*Database) ProtoReflect

func (x *Database) ProtoReflect() protoreflect.Message

func (*Database) Reset

func (x *Database) Reset()

func (*Database) String

func (x *Database) String() string

type DatabaseAdminClient

type DatabaseAdminClient interface {
	// Lists Cloud Spanner databases.
	ListDatabases(ctx context.Context, in *ListDatabasesRequest, opts ...grpc.CallOption) (*ListDatabasesResponse, error)
	// Creates a new Cloud Spanner database and starts to prepare it for serving.
	// The returned [long-running operation][google.longrunning.Operation] will
	// have a name of the format `<database_name>/operations/<operation_id>` and
	// can be used to track preparation of the database. The
	// [metadata][google.longrunning.Operation.metadata] field type is
	// [CreateDatabaseMetadata][google.spanner.admin.database.v1.CreateDatabaseMetadata]. The
	// [response][google.longrunning.Operation.response] field type is
	// [Database][google.spanner.admin.database.v1.Database], if successful.
	CreateDatabase(ctx context.Context, in *CreateDatabaseRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
	// Gets the state of a Cloud Spanner database.
	GetDatabase(ctx context.Context, in *GetDatabaseRequest, opts ...grpc.CallOption) (*Database, error)
	// Updates the schema of a Cloud Spanner database by
	// creating/altering/dropping tables, columns, indexes, etc. The returned
	// [long-running operation][google.longrunning.Operation] will have a name of
	// the format `<database_name>/operations/<operation_id>` and can be used to
	// track execution of the schema change(s). The
	// [metadata][google.longrunning.Operation.metadata] field type is
	// [UpdateDatabaseDdlMetadata][google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata].  The operation has no response.
	UpdateDatabaseDdl(ctx context.Context, in *UpdateDatabaseDdlRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
	// Drops (aka deletes) a Cloud Spanner database.
	// Completed backups for the database will be retained according to their
	// `expire_time`.
	DropDatabase(ctx context.Context, in *DropDatabaseRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Returns the schema of a Cloud Spanner database as a list of formatted
	// DDL statements. This method does not show pending schema updates, those may
	// be queried using the [Operations][google.longrunning.Operations] API.
	GetDatabaseDdl(ctx context.Context, in *GetDatabaseDdlRequest, opts ...grpc.CallOption) (*GetDatabaseDdlResponse, error)
	// Sets the access control policy on a database or backup resource.
	// Replaces any existing policy.
	//
	// Authorization requires `spanner.databases.setIamPolicy`
	// permission on [resource][google.iam.v1.SetIamPolicyRequest.resource].
	// For backups, authorization requires `spanner.backups.setIamPolicy`
	// permission on [resource][google.iam.v1.SetIamPolicyRequest.resource].
	SetIamPolicy(ctx context.Context, in *v1.SetIamPolicyRequest, opts ...grpc.CallOption) (*v1.Policy, error)
	// Gets the access control policy for a database or backup resource.
	// Returns an empty policy if a database or backup exists but does not have a
	// policy set.
	//
	// Authorization requires `spanner.databases.getIamPolicy` permission on
	// [resource][google.iam.v1.GetIamPolicyRequest.resource].
	// For backups, authorization requires `spanner.backups.getIamPolicy`
	// permission on [resource][google.iam.v1.GetIamPolicyRequest.resource].
	GetIamPolicy(ctx context.Context, in *v1.GetIamPolicyRequest, opts ...grpc.CallOption) (*v1.Policy, error)
	// Returns permissions that the caller has on the specified database or backup
	// resource.
	//
	// Attempting this RPC on a non-existent Cloud Spanner database will
	// result in a NOT_FOUND error if the user has
	// `spanner.databases.list` permission on the containing Cloud
	// Spanner instance. Otherwise returns an empty set of permissions.
	// Calling this method on a backup that does not exist will
	// result in a NOT_FOUND error if the user has
	// `spanner.backups.list` permission on the containing instance.
	TestIamPermissions(ctx context.Context, in *v1.TestIamPermissionsRequest, opts ...grpc.CallOption) (*v1.TestIamPermissionsResponse, error)
	// Starts creating a new Cloud Spanner Backup.
	// The returned backup [long-running operation][google.longrunning.Operation]
	// will have a name of the format
	// `projects/<project>/instances/<instance>/backups/<backup>/operations/<operation_id>`
	// and can be used to track creation of the backup. The
	// [metadata][google.longrunning.Operation.metadata] field type is
	// [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata]. The
	// [response][google.longrunning.Operation.response] field type is
	// [Backup][google.spanner.admin.database.v1.Backup], if successful. Cancelling the returned operation will stop the
	// creation and delete the backup.
	// There can be only one pending backup creation per database. Backup creation
	// of different databases can run concurrently.
	CreateBackup(ctx context.Context, in *CreateBackupRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
	// Gets metadata on a pending or completed [Backup][google.spanner.admin.database.v1.Backup].
	GetBackup(ctx context.Context, in *GetBackupRequest, opts ...grpc.CallOption) (*Backup, error)
	// Updates a pending or completed [Backup][google.spanner.admin.database.v1.Backup].
	UpdateBackup(ctx context.Context, in *UpdateBackupRequest, opts ...grpc.CallOption) (*Backup, error)
	// Deletes a pending or completed [Backup][google.spanner.admin.database.v1.Backup].
	DeleteBackup(ctx context.Context, in *DeleteBackupRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Lists completed and pending backups.
	// Backups returned are ordered by `create_time` in descending order,
	// starting from the most recent `create_time`.
	ListBackups(ctx context.Context, in *ListBackupsRequest, opts ...grpc.CallOption) (*ListBackupsResponse, error)
	// Create a new database by restoring from a completed backup. The new
	// database must be in the same project and in an instance with the same
	// instance configuration as the instance containing
	// the backup. The returned database [long-running
	// operation][google.longrunning.Operation] has a name of the format
	// `projects/<project>/instances/<instance>/databases/<database>/operations/<operation_id>`,
	// and can be used to track the progress of the operation, and to cancel it.
	// The [metadata][google.longrunning.Operation.metadata] field type is
	// [RestoreDatabaseMetadata][google.spanner.admin.database.v1.RestoreDatabaseMetadata].
	// The [response][google.longrunning.Operation.response] type
	// is [Database][google.spanner.admin.database.v1.Database], if
	// successful. Cancelling the returned operation will stop the restore and
	// delete the database.
	// There can be only one database being restored into an instance at a time.
	// Once the restore operation completes, a new restore operation can be
	// initiated, without waiting for the optimize operation associated with the
	// first restore to complete.
	RestoreDatabase(ctx context.Context, in *RestoreDatabaseRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
	// Lists database [longrunning-operations][google.longrunning.Operation].
	// A database operation has a name of the form
	// `projects/<project>/instances/<instance>/databases/<database>/operations/<operation>`.
	// The long-running operation
	// [metadata][google.longrunning.Operation.metadata] field type
	// `metadata.type_url` describes the type of the metadata. Operations returned
	// include those that have completed/failed/canceled within the last 7 days,
	// and pending operations.
	ListDatabaseOperations(ctx context.Context, in *ListDatabaseOperationsRequest, opts ...grpc.CallOption) (*ListDatabaseOperationsResponse, error)
	// Lists the backup [long-running operations][google.longrunning.Operation] in
	// the given instance. A backup operation has a name of the form
	// `projects/<project>/instances/<instance>/backups/<backup>/operations/<operation>`.
	// The long-running operation
	// [metadata][google.longrunning.Operation.metadata] field type
	// `metadata.type_url` describes the type of the metadata. Operations returned
	// include those that have completed/failed/canceled within the last 7 days,
	// and pending operations. Operations returned are ordered by
	// `operation.metadata.value.progress.start_time` in descending order starting
	// from the most recently started operation.
	ListBackupOperations(ctx context.Context, in *ListBackupOperationsRequest, opts ...grpc.CallOption) (*ListBackupOperationsResponse, error)
}

DatabaseAdminClient is the client API for DatabaseAdmin service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

type DatabaseAdminServer

type DatabaseAdminServer interface {
	// Lists Cloud Spanner databases.
	ListDatabases(context.Context, *ListDatabasesRequest) (*ListDatabasesResponse, error)
	// Creates a new Cloud Spanner database and starts to prepare it for serving.
	// The returned [long-running operation][google.longrunning.Operation] will
	// have a name of the format `<database_name>/operations/<operation_id>` and
	// can be used to track preparation of the database. The
	// [metadata][google.longrunning.Operation.metadata] field type is
	// [CreateDatabaseMetadata][google.spanner.admin.database.v1.CreateDatabaseMetadata]. The
	// [response][google.longrunning.Operation.response] field type is
	// [Database][google.spanner.admin.database.v1.Database], if successful.
	CreateDatabase(context.Context, *CreateDatabaseRequest) (*longrunning.Operation, error)
	// Gets the state of a Cloud Spanner database.
	GetDatabase(context.Context, *GetDatabaseRequest) (*Database, error)
	// Updates the schema of a Cloud Spanner database by
	// creating/altering/dropping tables, columns, indexes, etc. The returned
	// [long-running operation][google.longrunning.Operation] will have a name of
	// the format `<database_name>/operations/<operation_id>` and can be used to
	// track execution of the schema change(s). The
	// [metadata][google.longrunning.Operation.metadata] field type is
	// [UpdateDatabaseDdlMetadata][google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata].  The operation has no response.
	UpdateDatabaseDdl(context.Context, *UpdateDatabaseDdlRequest) (*longrunning.Operation, error)
	// Drops (aka deletes) a Cloud Spanner database.
	// Completed backups for the database will be retained according to their
	// `expire_time`.
	DropDatabase(context.Context, *DropDatabaseRequest) (*emptypb.Empty, error)
	// Returns the schema of a Cloud Spanner database as a list of formatted
	// DDL statements. This method does not show pending schema updates, those may
	// be queried using the [Operations][google.longrunning.Operations] API.
	GetDatabaseDdl(context.Context, *GetDatabaseDdlRequest) (*GetDatabaseDdlResponse, error)
	// Sets the access control policy on a database or backup resource.
	// Replaces any existing policy.
	//
	// Authorization requires `spanner.databases.setIamPolicy`
	// permission on [resource][google.iam.v1.SetIamPolicyRequest.resource].
	// For backups, authorization requires `spanner.backups.setIamPolicy`
	// permission on [resource][google.iam.v1.SetIamPolicyRequest.resource].
	SetIamPolicy(context.Context, *v1.SetIamPolicyRequest) (*v1.Policy, error)
	// Gets the access control policy for a database or backup resource.
	// Returns an empty policy if a database or backup exists but does not have a
	// policy set.
	//
	// Authorization requires `spanner.databases.getIamPolicy` permission on
	// [resource][google.iam.v1.GetIamPolicyRequest.resource].
	// For backups, authorization requires `spanner.backups.getIamPolicy`
	// permission on [resource][google.iam.v1.GetIamPolicyRequest.resource].
	GetIamPolicy(context.Context, *v1.GetIamPolicyRequest) (*v1.Policy, error)
	// Returns permissions that the caller has on the specified database or backup
	// resource.
	//
	// Attempting this RPC on a non-existent Cloud Spanner database will
	// result in a NOT_FOUND error if the user has
	// `spanner.databases.list` permission on the containing Cloud
	// Spanner instance. Otherwise returns an empty set of permissions.
	// Calling this method on a backup that does not exist will
	// result in a NOT_FOUND error if the user has
	// `spanner.backups.list` permission on the containing instance.
	TestIamPermissions(context.Context, *v1.TestIamPermissionsRequest) (*v1.TestIamPermissionsResponse, error)
	// Starts creating a new Cloud Spanner Backup.
	// The returned backup [long-running operation][google.longrunning.Operation]
	// will have a name of the format
	// `projects/<project>/instances/<instance>/backups/<backup>/operations/<operation_id>`
	// and can be used to track creation of the backup. The
	// [metadata][google.longrunning.Operation.metadata] field type is
	// [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata]. The
	// [response][google.longrunning.Operation.response] field type is
	// [Backup][google.spanner.admin.database.v1.Backup], if successful. Cancelling the returned operation will stop the
	// creation and delete the backup.
	// There can be only one pending backup creation per database. Backup creation
	// of different databases can run concurrently.
	CreateBackup(context.Context, *CreateBackupRequest) (*longrunning.Operation, error)
	// Gets metadata on a pending or completed [Backup][google.spanner.admin.database.v1.Backup].
	GetBackup(context.Context, *GetBackupRequest) (*Backup, error)
	// Updates a pending or completed [Backup][google.spanner.admin.database.v1.Backup].
	UpdateBackup(context.Context, *UpdateBackupRequest) (*Backup, error)
	// Deletes a pending or completed [Backup][google.spanner.admin.database.v1.Backup].
	DeleteBackup(context.Context, *DeleteBackupRequest) (*emptypb.Empty, error)
	// Lists completed and pending backups.
	// Backups returned are ordered by `create_time` in descending order,
	// starting from the most recent `create_time`.
	ListBackups(context.Context, *ListBackupsRequest) (*ListBackupsResponse, error)
	// Create a new database by restoring from a completed backup. The new
	// database must be in the same project and in an instance with the same
	// instance configuration as the instance containing
	// the backup. The returned database [long-running
	// operation][google.longrunning.Operation] has a name of the format
	// `projects/<project>/instances/<instance>/databases/<database>/operations/<operation_id>`,
	// and can be used to track the progress of the operation, and to cancel it.
	// The [metadata][google.longrunning.Operation.metadata] field type is
	// [RestoreDatabaseMetadata][google.spanner.admin.database.v1.RestoreDatabaseMetadata].
	// The [response][google.longrunning.Operation.response] type
	// is [Database][google.spanner.admin.database.v1.Database], if
	// successful. Cancelling the returned operation will stop the restore and
	// delete the database.
	// There can be only one database being restored into an instance at a time.
	// Once the restore operation completes, a new restore operation can be
	// initiated, without waiting for the optimize operation associated with the
	// first restore to complete.
	RestoreDatabase(context.Context, *RestoreDatabaseRequest) (*longrunning.Operation, error)
	// Lists database [longrunning-operations][google.longrunning.Operation].
	// A database operation has a name of the form
	// `projects/<project>/instances/<instance>/databases/<database>/operations/<operation>`.
	// The long-running operation
	// [metadata][google.longrunning.Operation.metadata] field type
	// `metadata.type_url` describes the type of the metadata. Operations returned
	// include those that have completed/failed/canceled within the last 7 days,
	// and pending operations.
	ListDatabaseOperations(context.Context, *ListDatabaseOperationsRequest) (*ListDatabaseOperationsResponse, error)
	// Lists the backup [long-running operations][google.longrunning.Operation] in
	// the given instance. A backup operation has a name of the form
	// `projects/<project>/instances/<instance>/backups/<backup>/operations/<operation>`.
	// The long-running operation
	// [metadata][google.longrunning.Operation.metadata] field type
	// `metadata.type_url` describes the type of the metadata. Operations returned
	// include those that have completed/failed/canceled within the last 7 days,
	// and pending operations. Operations returned are ordered by
	// `operation.metadata.value.progress.start_time` in descending order starting
	// from the most recently started operation.
	ListBackupOperations(context.Context, *ListBackupOperationsRequest) (*ListBackupOperationsResponse, error)
}

DatabaseAdminServer is the server API for DatabaseAdmin service.

type Database_State

type Database_State int32

Indicates the current state of the database.

const (
	// Not specified.
	Database_STATE_UNSPECIFIED Database_State = 0
	// The database is still being created. Operations on the database may fail
	// with `FAILED_PRECONDITION` in this state.
	Database_CREATING Database_State = 1
	// The database is fully created and ready for use.
	Database_READY Database_State = 2
	// 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.
	Database_READY_OPTIMIZING Database_State = 3
)

func (Database_State) Descriptor

func (Database_State) Enum

func (x Database_State) Enum() *Database_State

func (Database_State) EnumDescriptor deprecated

func (Database_State) EnumDescriptor() ([]byte, []int)

Deprecated: Use Database_State.Descriptor instead.

func (Database_State) Number

func (Database_State) String

func (x Database_State) String() string

func (Database_State) Type

type DeleteBackupRequest

type DeleteBackupRequest struct {

	// Required. Name of the backup to delete.
	// Values are of the form
	// `projects/<project>/instances/<instance>/backups/<backup>`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

The request for [DeleteBackup][google.spanner.admin.database.v1.DatabaseAdmin.DeleteBackup].

func (*DeleteBackupRequest) Descriptor deprecated

func (*DeleteBackupRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteBackupRequest.ProtoReflect.Descriptor instead.

func (*DeleteBackupRequest) GetName

func (x *DeleteBackupRequest) GetName() string

func (*DeleteBackupRequest) ProtoMessage

func (*DeleteBackupRequest) ProtoMessage()

func (*DeleteBackupRequest) ProtoReflect

func (x *DeleteBackupRequest) ProtoReflect() protoreflect.Message

func (*DeleteBackupRequest) Reset

func (x *DeleteBackupRequest) Reset()

func (*DeleteBackupRequest) String

func (x *DeleteBackupRequest) String() string

type DropDatabaseRequest

type DropDatabaseRequest struct {

	// Required. The database to be dropped.
	Database string `protobuf:"bytes,1,opt,name=database,proto3" json:"database,omitempty"`
	// contains filtered or unexported fields
}

The request for [DropDatabase][google.spanner.admin.database.v1.DatabaseAdmin.DropDatabase].

func (*DropDatabaseRequest) Descriptor deprecated

func (*DropDatabaseRequest) Descriptor() ([]byte, []int)

Deprecated: Use DropDatabaseRequest.ProtoReflect.Descriptor instead.

func (*DropDatabaseRequest) GetDatabase

func (x *DropDatabaseRequest) GetDatabase() string

func (*DropDatabaseRequest) ProtoMessage

func (*DropDatabaseRequest) ProtoMessage()

func (*DropDatabaseRequest) ProtoReflect

func (x *DropDatabaseRequest) ProtoReflect() protoreflect.Message

func (*DropDatabaseRequest) Reset

func (x *DropDatabaseRequest) Reset()

func (*DropDatabaseRequest) String

func (x *DropDatabaseRequest) String() string

type EncryptionConfig

type EncryptionConfig struct {

	// The Cloud KMS key to be used for encrypting and decrypting
	// the database. Values are of the form
	// `projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>`.
	KmsKeyName string `protobuf:"bytes,2,opt,name=kms_key_name,json=kmsKeyName,proto3" json:"kms_key_name,omitempty"`
	// contains filtered or unexported fields
}

Encryption configuration for a Cloud Spanner database.

func (*EncryptionConfig) Descriptor deprecated

func (*EncryptionConfig) Descriptor() ([]byte, []int)

Deprecated: Use EncryptionConfig.ProtoReflect.Descriptor instead.

func (*EncryptionConfig) GetKmsKeyName

func (x *EncryptionConfig) GetKmsKeyName() string

func (*EncryptionConfig) ProtoMessage

func (*EncryptionConfig) ProtoMessage()

func (*EncryptionConfig) ProtoReflect

func (x *EncryptionConfig) ProtoReflect() protoreflect.Message

func (*EncryptionConfig) Reset

func (x *EncryptionConfig) Reset()

func (*EncryptionConfig) String

func (x *EncryptionConfig) String() string

type EncryptionInfo

type EncryptionInfo struct {

	// Output only. The type of encryption.
	EncryptionType EncryptionInfo_Type `` /* 162-byte string literal not displayed */
	// 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.Status `protobuf:"bytes,4,opt,name=encryption_status,json=encryptionStatus,proto3" json:"encryption_status,omitempty"`
	// Output only. A Cloud KMS key version that is being used to protect the database or
	// backup.
	KmsKeyVersion string `protobuf:"bytes,2,opt,name=kms_key_version,json=kmsKeyVersion,proto3" json:"kms_key_version,omitempty"`
	// contains filtered or unexported fields
}

Encryption information for a Cloud Spanner database or backup.

func (*EncryptionInfo) Descriptor deprecated

func (*EncryptionInfo) Descriptor() ([]byte, []int)

Deprecated: Use EncryptionInfo.ProtoReflect.Descriptor instead.

func (*EncryptionInfo) GetEncryptionStatus

func (x *EncryptionInfo) GetEncryptionStatus() *status.Status

func (*EncryptionInfo) GetEncryptionType

func (x *EncryptionInfo) GetEncryptionType() EncryptionInfo_Type

func (*EncryptionInfo) GetKmsKeyVersion

func (x *EncryptionInfo) GetKmsKeyVersion() string

func (*EncryptionInfo) ProtoMessage

func (*EncryptionInfo) ProtoMessage()

func (*EncryptionInfo) ProtoReflect

func (x *EncryptionInfo) ProtoReflect() protoreflect.Message

func (*EncryptionInfo) Reset

func (x *EncryptionInfo) Reset()

func (*EncryptionInfo) String

func (x *EncryptionInfo) String() string

type EncryptionInfo_Type

type EncryptionInfo_Type int32

Possible encryption types.

const (
	// Encryption type was not specified, though data at rest remains encrypted.
	EncryptionInfo_TYPE_UNSPECIFIED EncryptionInfo_Type = 0
	// 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.
	EncryptionInfo_GOOGLE_DEFAULT_ENCRYPTION EncryptionInfo_Type = 1
	// 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.
	EncryptionInfo_CUSTOMER_MANAGED_ENCRYPTION EncryptionInfo_Type = 2
)

func (EncryptionInfo_Type) Descriptor

func (EncryptionInfo_Type) Enum

func (EncryptionInfo_Type) EnumDescriptor deprecated

func (EncryptionInfo_Type) EnumDescriptor() ([]byte, []int)

Deprecated: Use EncryptionInfo_Type.Descriptor instead.

func (EncryptionInfo_Type) Number

func (EncryptionInfo_Type) String

func (x EncryptionInfo_Type) String() string

func (EncryptionInfo_Type) Type

type GetBackupRequest

type GetBackupRequest struct {

	// Required. Name of the backup.
	// Values are of the form
	// `projects/<project>/instances/<instance>/backups/<backup>`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

The request for [GetBackup][google.spanner.admin.database.v1.DatabaseAdmin.GetBackup].

func (*GetBackupRequest) Descriptor deprecated

func (*GetBackupRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetBackupRequest.ProtoReflect.Descriptor instead.

func (*GetBackupRequest) GetName

func (x *GetBackupRequest) GetName() string

func (*GetBackupRequest) ProtoMessage

func (*GetBackupRequest) ProtoMessage()

func (*GetBackupRequest) ProtoReflect

func (x *GetBackupRequest) ProtoReflect() protoreflect.Message

func (*GetBackupRequest) Reset

func (x *GetBackupRequest) Reset()

func (*GetBackupRequest) String

func (x *GetBackupRequest) String() string

type GetDatabaseDdlRequest

type GetDatabaseDdlRequest struct {

	// Required. The database whose schema we wish to get.
	// Values are of the form
	// `projects/<project>/instances/<instance>/databases/<database>`
	Database string `protobuf:"bytes,1,opt,name=database,proto3" json:"database,omitempty"`
	// contains filtered or unexported fields
}

The request for [GetDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.GetDatabaseDdl].

func (*GetDatabaseDdlRequest) Descriptor deprecated

func (*GetDatabaseDdlRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetDatabaseDdlRequest.ProtoReflect.Descriptor instead.

func (*GetDatabaseDdlRequest) GetDatabase

func (x *GetDatabaseDdlRequest) GetDatabase() string

func (*GetDatabaseDdlRequest) ProtoMessage

func (*GetDatabaseDdlRequest) ProtoMessage()

func (*GetDatabaseDdlRequest) ProtoReflect

func (x *GetDatabaseDdlRequest) ProtoReflect() protoreflect.Message

func (*GetDatabaseDdlRequest) Reset

func (x *GetDatabaseDdlRequest) Reset()

func (*GetDatabaseDdlRequest) String

func (x *GetDatabaseDdlRequest) String() string

type GetDatabaseDdlResponse

type GetDatabaseDdlResponse struct {

	// A list of formatted DDL statements defining the schema of the database
	// specified in the request.
	Statements []string `protobuf:"bytes,1,rep,name=statements,proto3" json:"statements,omitempty"`
	// contains filtered or unexported fields
}

The response for [GetDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.GetDatabaseDdl].

func (*GetDatabaseDdlResponse) Descriptor deprecated

func (*GetDatabaseDdlResponse) Descriptor() ([]byte, []int)

Deprecated: Use GetDatabaseDdlResponse.ProtoReflect.Descriptor instead.

func (*GetDatabaseDdlResponse) GetStatements

func (x *GetDatabaseDdlResponse) GetStatements() []string

func (*GetDatabaseDdlResponse) ProtoMessage

func (*GetDatabaseDdlResponse) ProtoMessage()

func (*GetDatabaseDdlResponse) ProtoReflect

func (x *GetDatabaseDdlResponse) ProtoReflect() protoreflect.Message

func (*GetDatabaseDdlResponse) Reset

func (x *GetDatabaseDdlResponse) Reset()

func (*GetDatabaseDdlResponse) String

func (x *GetDatabaseDdlResponse) String() string

type GetDatabaseRequest

type GetDatabaseRequest struct {

	// Required. The name of the requested database. Values are of the form
	// `projects/<project>/instances/<instance>/databases/<database>`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

The request for [GetDatabase][google.spanner.admin.database.v1.DatabaseAdmin.GetDatabase].

func (*GetDatabaseRequest) Descriptor deprecated

func (*GetDatabaseRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetDatabaseRequest.ProtoReflect.Descriptor instead.

func (*GetDatabaseRequest) GetName

func (x *GetDatabaseRequest) GetName() string

func (*GetDatabaseRequest) ProtoMessage

func (*GetDatabaseRequest) ProtoMessage()

func (*GetDatabaseRequest) ProtoReflect

func (x *GetDatabaseRequest) ProtoReflect() protoreflect.Message

func (*GetDatabaseRequest) Reset

func (x *GetDatabaseRequest) Reset()

func (*GetDatabaseRequest) String

func (x *GetDatabaseRequest) String() string

type ListBackupOperationsRequest

type ListBackupOperationsRequest struct {

	// Required. The instance of the backup operations. Values are of
	// the form `projects/<project>/instances/<instance>`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// An expression that filters the list of returned backup operations.
	//
	// A filter expression consists of a field name, a
	// comparison operator, and a value for filtering.
	// The value must be a string, a number, or a boolean. The comparison operator
	// must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`.
	// Colon `:` is the contains operator. Filter rules are not case sensitive.
	//
	// The following fields in the [operation][google.longrunning.Operation]
	// are eligible for filtering:
	//
	//   * `name` - The name of the long-running operation
	//   * `done` - False if the operation is in progress, else true.
	//   * `metadata.@type` - the type of metadata. For example, the type string
	//      for [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata] is
	//      `type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata`.
	//   * `metadata.<field_name>` - any field in metadata.value.
	//   * `error` - Error associated with the long-running operation.
	//   * `response.@type` - the type of response.
	//   * `response.<field_name>` - any field in response.value.
	//
	// You can combine multiple expressions by enclosing each expression in
	// parentheses. By default, expressions are combined with AND logic, but
	// you can specify AND, OR, and NOT logic explicitly.
	//
	// Here are a few examples:
	//
	//   * `done:true` - The operation is complete.
	//   * `metadata.database:prod` - The database the backup was taken from has
	//      a name containing the string "prod".
	//   * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` \
	//     `(metadata.name:howl) AND` \
	//     `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` \
	//     `(error:*)` - Returns operations where:
	//     * The operation's metadata type is [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata].
	//     * The backup name contains the string "howl".
	//     * The operation started before 2018-03-28T14:50:00Z.
	//     * The operation resulted in an error.
	Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
	// Number of operations to be returned in the response. If 0 or
	// less, defaults to the server's maximum allowed page size.
	PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// If non-empty, `page_token` should contain a
	// [next_page_token][google.spanner.admin.database.v1.ListBackupOperationsResponse.next_page_token]
	// from a previous [ListBackupOperationsResponse][google.spanner.admin.database.v1.ListBackupOperationsResponse] to the
	// same `parent` and with the same `filter`.
	PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

The request for [ListBackupOperations][google.spanner.admin.database.v1.DatabaseAdmin.ListBackupOperations].

func (*ListBackupOperationsRequest) Descriptor deprecated

func (*ListBackupOperationsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListBackupOperationsRequest.ProtoReflect.Descriptor instead.

func (*ListBackupOperationsRequest) GetFilter

func (x *ListBackupOperationsRequest) GetFilter() string

func (*ListBackupOperationsRequest) GetPageSize

func (x *ListBackupOperationsRequest) GetPageSize() int32

func (*ListBackupOperationsRequest) GetPageToken

func (x *ListBackupOperationsRequest) GetPageToken() string

func (*ListBackupOperationsRequest) GetParent

func (x *ListBackupOperationsRequest) GetParent() string

func (*ListBackupOperationsRequest) ProtoMessage

func (*ListBackupOperationsRequest) ProtoMessage()

func (*ListBackupOperationsRequest) ProtoReflect

func (*ListBackupOperationsRequest) Reset

func (x *ListBackupOperationsRequest) Reset()

func (*ListBackupOperationsRequest) String

func (x *ListBackupOperationsRequest) String() string

type ListBackupOperationsResponse

type ListBackupOperationsResponse struct {

	// The list of matching backup [long-running
	// operations][google.longrunning.Operation]. Each operation's name will be
	// prefixed by the backup's name and the operation's
	// [metadata][google.longrunning.Operation.metadata] will be of type
	// [CreateBackupMetadata][google.spanner.admin.database.v1.CreateBackupMetadata]. Operations returned include those that are
	// pending or have completed/failed/canceled within the last 7 days.
	// Operations returned are ordered by
	// `operation.metadata.value.progress.start_time` in descending order starting
	// from the most recently started operation.
	Operations []*longrunning.Operation `protobuf:"bytes,1,rep,name=operations,proto3" json:"operations,omitempty"`
	// `next_page_token` can be sent in a subsequent
	// [ListBackupOperations][google.spanner.admin.database.v1.DatabaseAdmin.ListBackupOperations]
	// call to fetch more of the matching metadata.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

The response for [ListBackupOperations][google.spanner.admin.database.v1.DatabaseAdmin.ListBackupOperations].

func (*ListBackupOperationsResponse) Descriptor deprecated

func (*ListBackupOperationsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListBackupOperationsResponse.ProtoReflect.Descriptor instead.

func (*ListBackupOperationsResponse) GetNextPageToken

func (x *ListBackupOperationsResponse) GetNextPageToken() string

func (*ListBackupOperationsResponse) GetOperations

func (x *ListBackupOperationsResponse) GetOperations() []*longrunning.Operation

func (*ListBackupOperationsResponse) ProtoMessage

func (*ListBackupOperationsResponse) ProtoMessage()

func (*ListBackupOperationsResponse) ProtoReflect

func (*ListBackupOperationsResponse) Reset

func (x *ListBackupOperationsResponse) Reset()

func (*ListBackupOperationsResponse) String

type ListBackupsRequest

type ListBackupsRequest struct {

	// Required. The instance to list backups from.  Values are of the
	// form `projects/<project>/instances/<instance>`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// An expression that filters the list of returned backups.
	//
	// A filter expression consists of a field name, a comparison operator, and a
	// value for filtering.
	// The value must be a string, a number, or a boolean. The comparison operator
	// must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`.
	// Colon `:` is the contains operator. Filter rules are not case sensitive.
	//
	// The following fields in the [Backup][google.spanner.admin.database.v1.Backup] are eligible for filtering:
	//
	//   * `name`
	//   * `database`
	//   * `state`
	//   * `create_time`  (and values are of the format YYYY-MM-DDTHH:MM:SSZ)
	//   * `expire_time`  (and values are of the format YYYY-MM-DDTHH:MM:SSZ)
	//   * `version_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ)
	//   * `size_bytes`
	//
	// You can combine multiple expressions by enclosing each expression in
	// parentheses. By default, expressions are combined with AND logic, but
	// you can specify AND, OR, and NOT logic explicitly.
	//
	// Here are a few examples:
	//
	//   * `name:Howl` - The backup's name contains the string "howl".
	//   * `database:prod`
	//          - The database's name contains the string "prod".
	//   * `state:CREATING` - The backup is pending creation.
	//   * `state:READY` - The backup is fully created and ready for use.
	//   * `(name:howl) AND (create_time < \"2018-03-28T14:50:00Z\")`
	//          - The backup name contains the string "howl" and `create_time`
	//              of the backup is before 2018-03-28T14:50:00Z.
	//   * `expire_time < \"2018-03-28T14:50:00Z\"`
	//          - The backup `expire_time` is before 2018-03-28T14:50:00Z.
	//   * `size_bytes > 10000000000` - The backup's size is greater than 10GB
	Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
	// Number of backups to be returned in the response. If 0 or
	// less, defaults to the server's maximum allowed page size.
	PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// If non-empty, `page_token` should contain a
	// [next_page_token][google.spanner.admin.database.v1.ListBackupsResponse.next_page_token] from a
	// previous [ListBackupsResponse][google.spanner.admin.database.v1.ListBackupsResponse] to the same `parent` and with the same
	// `filter`.
	PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

The request for [ListBackups][google.spanner.admin.database.v1.DatabaseAdmin.ListBackups].

func (*ListBackupsRequest) Descriptor deprecated

func (*ListBackupsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListBackupsRequest.ProtoReflect.Descriptor instead.

func (*ListBackupsRequest) GetFilter

func (x *ListBackupsRequest) GetFilter() string

func (*ListBackupsRequest) GetPageSize

func (x *ListBackupsRequest) GetPageSize() int32

func (*ListBackupsRequest) GetPageToken

func (x *ListBackupsRequest) GetPageToken() string

func (*ListBackupsRequest) GetParent

func (x *ListBackupsRequest) GetParent() string

func (*ListBackupsRequest) ProtoMessage

func (*ListBackupsRequest) ProtoMessage()

func (*ListBackupsRequest) ProtoReflect

func (x *ListBackupsRequest) ProtoReflect() protoreflect.Message

func (*ListBackupsRequest) Reset

func (x *ListBackupsRequest) Reset()

func (*ListBackupsRequest) String

func (x *ListBackupsRequest) String() string

type ListBackupsResponse

type ListBackupsResponse struct {

	// The list of matching backups. Backups returned are ordered by `create_time`
	// in descending order, starting from the most recent `create_time`.
	Backups []*Backup `protobuf:"bytes,1,rep,name=backups,proto3" json:"backups,omitempty"`
	// `next_page_token` can be sent in a subsequent
	// [ListBackups][google.spanner.admin.database.v1.DatabaseAdmin.ListBackups] call to fetch more
	// of the matching backups.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

The response for [ListBackups][google.spanner.admin.database.v1.DatabaseAdmin.ListBackups].

func (*ListBackupsResponse) Descriptor deprecated

func (*ListBackupsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListBackupsResponse.ProtoReflect.Descriptor instead.

func (*ListBackupsResponse) GetBackups

func (x *ListBackupsResponse) GetBackups() []*Backup

func (*ListBackupsResponse) GetNextPageToken

func (x *ListBackupsResponse) GetNextPageToken() string

func (*ListBackupsResponse) ProtoMessage

func (*ListBackupsResponse) ProtoMessage()

func (*ListBackupsResponse) ProtoReflect

func (x *ListBackupsResponse) ProtoReflect() protoreflect.Message

func (*ListBackupsResponse) Reset

func (x *ListBackupsResponse) Reset()

func (*ListBackupsResponse) String

func (x *ListBackupsResponse) String() string

type ListDatabaseOperationsRequest

type ListDatabaseOperationsRequest struct {

	// Required. The instance of the database operations.
	// Values are of the form `projects/<project>/instances/<instance>`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// An expression that filters the list of returned operations.
	//
	// A filter expression consists of a field name, a
	// comparison operator, and a value for filtering.
	// The value must be a string, a number, or a boolean. The comparison operator
	// must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`.
	// Colon `:` is the contains operator. Filter rules are not case sensitive.
	//
	// The following fields in the [Operation][google.longrunning.Operation]
	// are eligible for filtering:
	//
	//   * `name` - The name of the long-running operation
	//   * `done` - False if the operation is in progress, else true.
	//   * `metadata.@type` - the type of metadata. For example, the type string
	//      for [RestoreDatabaseMetadata][google.spanner.admin.database.v1.RestoreDatabaseMetadata] is
	//      `type.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata`.
	//   * `metadata.<field_name>` - any field in metadata.value.
	//   * `error` - Error associated with the long-running operation.
	//   * `response.@type` - the type of response.
	//   * `response.<field_name>` - any field in response.value.
	//
	// You can combine multiple expressions by enclosing each expression in
	// parentheses. By default, expressions are combined with AND logic. However,
	// you can specify AND, OR, and NOT logic explicitly.
	//
	// Here are a few examples:
	//
	//   * `done:true` - The operation is complete.
	//   * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata) AND` \
	//     `(metadata.source_type:BACKUP) AND` \
	//     `(metadata.backup_info.backup:backup_howl) AND` \
	//     `(metadata.name:restored_howl) AND` \
	//     `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` \
	//     `(error:*)` - Return operations where:
	//     * The operation's metadata type is [RestoreDatabaseMetadata][google.spanner.admin.database.v1.RestoreDatabaseMetadata].
	//     * The database is restored from a backup.
	//     * The backup name contains "backup_howl".
	//     * The restored database's name contains "restored_howl".
	//     * The operation started before 2018-03-28T14:50:00Z.
	//     * The operation resulted in an error.
	Filter string `protobuf:"bytes,2,opt,name=filter,proto3" json:"filter,omitempty"`
	// Number of operations to be returned in the response. If 0 or
	// less, defaults to the server's maximum allowed page size.
	PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// If non-empty, `page_token` should contain a
	// [next_page_token][google.spanner.admin.database.v1.ListDatabaseOperationsResponse.next_page_token]
	// from a previous [ListDatabaseOperationsResponse][google.spanner.admin.database.v1.ListDatabaseOperationsResponse] to the
	// same `parent` and with the same `filter`.
	PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

The request for [ListDatabaseOperations][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabaseOperations].

func (*ListDatabaseOperationsRequest) Descriptor deprecated

func (*ListDatabaseOperationsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListDatabaseOperationsRequest.ProtoReflect.Descriptor instead.

func (*ListDatabaseOperationsRequest) GetFilter

func (x *ListDatabaseOperationsRequest) GetFilter() string

func (*ListDatabaseOperationsRequest) GetPageSize

func (x *ListDatabaseOperationsRequest) GetPageSize() int32

func (*ListDatabaseOperationsRequest) GetPageToken

func (x *ListDatabaseOperationsRequest) GetPageToken() string

func (*ListDatabaseOperationsRequest) GetParent

func (x *ListDatabaseOperationsRequest) GetParent() string

func (*ListDatabaseOperationsRequest) ProtoMessage

func (*ListDatabaseOperationsRequest) ProtoMessage()

func (*ListDatabaseOperationsRequest) ProtoReflect

func (*ListDatabaseOperationsRequest) Reset

func (x *ListDatabaseOperationsRequest) Reset()

func (*ListDatabaseOperationsRequest) String

type ListDatabaseOperationsResponse

type ListDatabaseOperationsResponse struct {

	// The list of matching database [long-running
	// operations][google.longrunning.Operation]. Each operation's name will be
	// prefixed by the database's name. The operation's
	// [metadata][google.longrunning.Operation.metadata] field type
	// `metadata.type_url` describes the type of the metadata.
	Operations []*longrunning.Operation `protobuf:"bytes,1,rep,name=operations,proto3" json:"operations,omitempty"`
	// `next_page_token` can be sent in a subsequent
	// [ListDatabaseOperations][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabaseOperations]
	// call to fetch more of the matching metadata.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

The response for [ListDatabaseOperations][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabaseOperations].

func (*ListDatabaseOperationsResponse) Descriptor deprecated

func (*ListDatabaseOperationsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListDatabaseOperationsResponse.ProtoReflect.Descriptor instead.

func (*ListDatabaseOperationsResponse) GetNextPageToken

func (x *ListDatabaseOperationsResponse) GetNextPageToken() string

func (*ListDatabaseOperationsResponse) GetOperations

func (*ListDatabaseOperationsResponse) ProtoMessage

func (*ListDatabaseOperationsResponse) ProtoMessage()

func (*ListDatabaseOperationsResponse) ProtoReflect

func (*ListDatabaseOperationsResponse) Reset

func (x *ListDatabaseOperationsResponse) Reset()

func (*ListDatabaseOperationsResponse) String

type ListDatabasesRequest

type ListDatabasesRequest struct {

	// Required. The instance whose databases should be listed.
	// Values are of the form `projects/<project>/instances/<instance>`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Number of databases to be returned in the response. If 0 or less,
	// defaults to the server's maximum allowed page size.
	PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// If non-empty, `page_token` should contain a
	// [next_page_token][google.spanner.admin.database.v1.ListDatabasesResponse.next_page_token] from a
	// previous [ListDatabasesResponse][google.spanner.admin.database.v1.ListDatabasesResponse].
	PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

The request for [ListDatabases][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabases].

func (*ListDatabasesRequest) Descriptor deprecated

func (*ListDatabasesRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListDatabasesRequest.ProtoReflect.Descriptor instead.

func (*ListDatabasesRequest) GetPageSize

func (x *ListDatabasesRequest) GetPageSize() int32

func (*ListDatabasesRequest) GetPageToken

func (x *ListDatabasesRequest) GetPageToken() string

func (*ListDatabasesRequest) GetParent

func (x *ListDatabasesRequest) GetParent() string

func (*ListDatabasesRequest) ProtoMessage

func (*ListDatabasesRequest) ProtoMessage()

func (*ListDatabasesRequest) ProtoReflect

func (x *ListDatabasesRequest) ProtoReflect() protoreflect.Message

func (*ListDatabasesRequest) Reset

func (x *ListDatabasesRequest) Reset()

func (*ListDatabasesRequest) String

func (x *ListDatabasesRequest) String() string

type ListDatabasesResponse

type ListDatabasesResponse struct {

	// Databases that matched the request.
	Databases []*Database `protobuf:"bytes,1,rep,name=databases,proto3" json:"databases,omitempty"`
	// `next_page_token` can be sent in a subsequent
	// [ListDatabases][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabases] call to fetch more
	// of the matching databases.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

The response for [ListDatabases][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabases].

func (*ListDatabasesResponse) Descriptor deprecated

func (*ListDatabasesResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListDatabasesResponse.ProtoReflect.Descriptor instead.

func (*ListDatabasesResponse) GetDatabases

func (x *ListDatabasesResponse) GetDatabases() []*Database

func (*ListDatabasesResponse) GetNextPageToken

func (x *ListDatabasesResponse) GetNextPageToken() string

func (*ListDatabasesResponse) ProtoMessage

func (*ListDatabasesResponse) ProtoMessage()

func (*ListDatabasesResponse) ProtoReflect

func (x *ListDatabasesResponse) ProtoReflect() protoreflect.Message

func (*ListDatabasesResponse) Reset

func (x *ListDatabasesResponse) Reset()

func (*ListDatabasesResponse) String

func (x *ListDatabasesResponse) String() string

type OperationProgress

type OperationProgress struct {

	// Percent completion of the operation.
	// Values are between 0 and 100 inclusive.
	ProgressPercent int32 `protobuf:"varint,1,opt,name=progress_percent,json=progressPercent,proto3" json:"progress_percent,omitempty"`
	// Time the request was received.
	StartTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
	// If set, the time at which this operation failed or was completed
	// successfully.
	EndTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
	// contains filtered or unexported fields
}

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

func (*OperationProgress) Descriptor deprecated

func (*OperationProgress) Descriptor() ([]byte, []int)

Deprecated: Use OperationProgress.ProtoReflect.Descriptor instead.

func (*OperationProgress) GetEndTime

func (x *OperationProgress) GetEndTime() *timestamppb.Timestamp

func (*OperationProgress) GetProgressPercent

func (x *OperationProgress) GetProgressPercent() int32

func (*OperationProgress) GetStartTime

func (x *OperationProgress) GetStartTime() *timestamppb.Timestamp

func (*OperationProgress) ProtoMessage

func (*OperationProgress) ProtoMessage()

func (*OperationProgress) ProtoReflect

func (x *OperationProgress) ProtoReflect() protoreflect.Message

func (*OperationProgress) Reset

func (x *OperationProgress) Reset()

func (*OperationProgress) String

func (x *OperationProgress) String() string

type OptimizeRestoredDatabaseMetadata

type OptimizeRestoredDatabaseMetadata struct {

	// Name of the restored database being optimized.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The progress of the post-restore optimizations.
	Progress *OperationProgress `protobuf:"bytes,2,opt,name=progress,proto3" json:"progress,omitempty"`
	// contains filtered or unexported fields
}

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

func (*OptimizeRestoredDatabaseMetadata) Descriptor deprecated

func (*OptimizeRestoredDatabaseMetadata) Descriptor() ([]byte, []int)

Deprecated: Use OptimizeRestoredDatabaseMetadata.ProtoReflect.Descriptor instead.

func (*OptimizeRestoredDatabaseMetadata) GetName

func (*OptimizeRestoredDatabaseMetadata) GetProgress

func (*OptimizeRestoredDatabaseMetadata) ProtoMessage

func (*OptimizeRestoredDatabaseMetadata) ProtoMessage()

func (*OptimizeRestoredDatabaseMetadata) ProtoReflect

func (*OptimizeRestoredDatabaseMetadata) Reset

func (*OptimizeRestoredDatabaseMetadata) String

type RestoreDatabaseEncryptionConfig

type RestoreDatabaseEncryptionConfig struct {

	// Required. The encryption type of the restored database.
	EncryptionType RestoreDatabaseEncryptionConfig_EncryptionType `` /* 189-byte string literal not displayed */
	// Optional. The Cloud KMS key that will be used to encrypt/decrypt the restored
	// database. This field should be set only when
	// [encryption_type][google.spanner.admin.database.v1.RestoreDatabaseEncryptionConfig.encryption_type] is
	// `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form
	// `projects/<project>/locations/<location>/keyRings/<key_ring>/cryptoKeys/<kms_key_name>`.
	KmsKeyName string `protobuf:"bytes,2,opt,name=kms_key_name,json=kmsKeyName,proto3" json:"kms_key_name,omitempty"`
	// contains filtered or unexported fields
}

Encryption configuration for the restored database.

func (*RestoreDatabaseEncryptionConfig) Descriptor deprecated

func (*RestoreDatabaseEncryptionConfig) Descriptor() ([]byte, []int)

Deprecated: Use RestoreDatabaseEncryptionConfig.ProtoReflect.Descriptor instead.

func (*RestoreDatabaseEncryptionConfig) GetEncryptionType

func (*RestoreDatabaseEncryptionConfig) GetKmsKeyName

func (x *RestoreDatabaseEncryptionConfig) GetKmsKeyName() string

func (*RestoreDatabaseEncryptionConfig) ProtoMessage

func (*RestoreDatabaseEncryptionConfig) ProtoMessage()

func (*RestoreDatabaseEncryptionConfig) ProtoReflect

func (*RestoreDatabaseEncryptionConfig) Reset

func (*RestoreDatabaseEncryptionConfig) String

type RestoreDatabaseEncryptionConfig_EncryptionType

type RestoreDatabaseEncryptionConfig_EncryptionType int32

Encryption types for the database to be restored.

const (
	// Unspecified. Do not use.
	RestoreDatabaseEncryptionConfig_ENCRYPTION_TYPE_UNSPECIFIED RestoreDatabaseEncryptionConfig_EncryptionType = 0
	// This is the default option when
	// [encryption_config][google.spanner.admin.database.v1.RestoreDatabaseEncryptionConfig] is not specified.
	RestoreDatabaseEncryptionConfig_USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION RestoreDatabaseEncryptionConfig_EncryptionType = 1
	// Use Google default encryption.
	RestoreDatabaseEncryptionConfig_GOOGLE_DEFAULT_ENCRYPTION RestoreDatabaseEncryptionConfig_EncryptionType = 2
	// Use customer managed encryption. If specified, `kms_key_name` must
	// must contain a valid Cloud KMS key.
	RestoreDatabaseEncryptionConfig_CUSTOMER_MANAGED_ENCRYPTION RestoreDatabaseEncryptionConfig_EncryptionType = 3
)

func (RestoreDatabaseEncryptionConfig_EncryptionType) Descriptor

func (RestoreDatabaseEncryptionConfig_EncryptionType) Enum

func (RestoreDatabaseEncryptionConfig_EncryptionType) EnumDescriptor deprecated

Deprecated: Use RestoreDatabaseEncryptionConfig_EncryptionType.Descriptor instead.

func (RestoreDatabaseEncryptionConfig_EncryptionType) Number

func (RestoreDatabaseEncryptionConfig_EncryptionType) String

func (RestoreDatabaseEncryptionConfig_EncryptionType) Type

type RestoreDatabaseMetadata

type RestoreDatabaseMetadata struct {

	// Name of the database being created and restored to.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The type of the restore source.
	SourceType RestoreSourceType `` /* 148-byte string literal not displayed */
	// Information about the source used to restore the database, as specified by
	// `source` in [RestoreDatabaseRequest][google.spanner.admin.database.v1.RestoreDatabaseRequest].
	//
	// Types that are assignable to SourceInfo:
	//	*RestoreDatabaseMetadata_BackupInfo
	SourceInfo isRestoreDatabaseMetadata_SourceInfo `protobuf_oneof:"source_info"`
	// The progress of the
	// [RestoreDatabase][google.spanner.admin.database.v1.DatabaseAdmin.RestoreDatabase]
	// operation.
	Progress *OperationProgress `protobuf:"bytes,4,opt,name=progress,proto3" json:"progress,omitempty"`
	// The time at which cancellation of this operation was received.
	// [Operations.CancelOperation][google.longrunning.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][google.longrunning.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][google.longrunning.Operation.error] value with a
	// [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`.
	CancelTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=cancel_time,json=cancelTime,proto3" json:"cancel_time,omitempty"`
	// If exists, the name of the long-running operation that will be used to
	// track the post-restore optimization process to optimize the performance of
	// the restored database, and remove the dependency on the restore source.
	// The name is of the form
	// `projects/<project>/instances/<instance>/databases/<database>/operations/<operation>`
	// where the <database> is the name of database being created and restored to.
	// The metadata type of the  long-running operation is
	// [OptimizeRestoredDatabaseMetadata][google.spanner.admin.database.v1.OptimizeRestoredDatabaseMetadata]. This long-running operation will be
	// automatically created by the system after the RestoreDatabase long-running
	// operation completes successfully. This operation will not be created if the
	// restore was not successful.
	OptimizeDatabaseOperationName string `` /* 152-byte string literal not displayed */
	// contains filtered or unexported fields
}

Metadata type for the long-running operation returned by [RestoreDatabase][google.spanner.admin.database.v1.DatabaseAdmin.RestoreDatabase].

func (*RestoreDatabaseMetadata) Descriptor deprecated

func (*RestoreDatabaseMetadata) Descriptor() ([]byte, []int)

Deprecated: Use RestoreDatabaseMetadata.ProtoReflect.Descriptor instead.

func (*RestoreDatabaseMetadata) GetBackupInfo

func (x *RestoreDatabaseMetadata) GetBackupInfo() *BackupInfo

func (*RestoreDatabaseMetadata) GetCancelTime

func (x *RestoreDatabaseMetadata) GetCancelTime() *timestamppb.Timestamp

func (*RestoreDatabaseMetadata) GetName

func (x *RestoreDatabaseMetadata) GetName() string

func (*RestoreDatabaseMetadata) GetOptimizeDatabaseOperationName

func (x *RestoreDatabaseMetadata) GetOptimizeDatabaseOperationName() string

func (*RestoreDatabaseMetadata) GetProgress

func (x *RestoreDatabaseMetadata) GetProgress() *OperationProgress

func (*RestoreDatabaseMetadata) GetSourceInfo

func (m *RestoreDatabaseMetadata) GetSourceInfo() isRestoreDatabaseMetadata_SourceInfo

func (*RestoreDatabaseMetadata) GetSourceType

func (x *RestoreDatabaseMetadata) GetSourceType() RestoreSourceType

func (*RestoreDatabaseMetadata) ProtoMessage

func (*RestoreDatabaseMetadata) ProtoMessage()

func (*RestoreDatabaseMetadata) ProtoReflect

func (x *RestoreDatabaseMetadata) ProtoReflect() protoreflect.Message

func (*RestoreDatabaseMetadata) Reset

func (x *RestoreDatabaseMetadata) Reset()

func (*RestoreDatabaseMetadata) String

func (x *RestoreDatabaseMetadata) String() string

type RestoreDatabaseMetadata_BackupInfo

type RestoreDatabaseMetadata_BackupInfo struct {
	// Information about the backup used to restore the database.
	BackupInfo *BackupInfo `protobuf:"bytes,3,opt,name=backup_info,json=backupInfo,proto3,oneof"`
}

type RestoreDatabaseRequest

type RestoreDatabaseRequest struct {

	// Required. The name of the instance in which to create the
	// restored database. This instance must be in the same project and
	// have the same instance configuration as the instance containing
	// the source backup. Values are of the form
	// `projects/<project>/instances/<instance>`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The id of the database to create and restore to. This
	// database must not already exist. The `database_id` appended to
	// `parent` forms the full database name of the form
	// `projects/<project>/instances/<instance>/databases/<database_id>`.
	DatabaseId string `protobuf:"bytes,2,opt,name=database_id,json=databaseId,proto3" json:"database_id,omitempty"`
	// Required. The source from which to restore.
	//
	// Types that are assignable to Source:
	//	*RestoreDatabaseRequest_Backup
	Source isRestoreDatabaseRequest_Source `protobuf_oneof:"source"`
	// Optional. An encryption configuration describing the encryption type and key
	// resources in Cloud KMS used to encrypt/decrypt the database to restore to.
	// If this field is not specified, the restored database will use
	// the same encryption configuration as the backup by default, namely
	// [encryption_type][google.spanner.admin.database.v1.RestoreDatabaseEncryptionConfig.encryption_type] =
	// `USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION`.
	EncryptionConfig *RestoreDatabaseEncryptionConfig `protobuf:"bytes,4,opt,name=encryption_config,json=encryptionConfig,proto3" json:"encryption_config,omitempty"`
	// contains filtered or unexported fields
}

The request for [RestoreDatabase][google.spanner.admin.database.v1.DatabaseAdmin.RestoreDatabase].

func (*RestoreDatabaseRequest) Descriptor deprecated

func (*RestoreDatabaseRequest) Descriptor() ([]byte, []int)

Deprecated: Use RestoreDatabaseRequest.ProtoReflect.Descriptor instead.

func (*RestoreDatabaseRequest) GetBackup

func (x *RestoreDatabaseRequest) GetBackup() string

func (*RestoreDatabaseRequest) GetDatabaseId

func (x *RestoreDatabaseRequest) GetDatabaseId() string

func (*RestoreDatabaseRequest) GetEncryptionConfig

func (x *RestoreDatabaseRequest) GetEncryptionConfig() *RestoreDatabaseEncryptionConfig

func (*RestoreDatabaseRequest) GetParent

func (x *RestoreDatabaseRequest) GetParent() string

func (*RestoreDatabaseRequest) GetSource

func (m *RestoreDatabaseRequest) GetSource() isRestoreDatabaseRequest_Source

func (*RestoreDatabaseRequest) ProtoMessage

func (*RestoreDatabaseRequest) ProtoMessage()

func (*RestoreDatabaseRequest) ProtoReflect

func (x *RestoreDatabaseRequest) ProtoReflect() protoreflect.Message

func (*RestoreDatabaseRequest) Reset

func (x *RestoreDatabaseRequest) Reset()

func (*RestoreDatabaseRequest) String

func (x *RestoreDatabaseRequest) String() string

type RestoreDatabaseRequest_Backup

type RestoreDatabaseRequest_Backup struct {
	// Name of the backup from which to restore.  Values are of the form
	// `projects/<project>/instances/<instance>/backups/<backup>`.
	Backup string `protobuf:"bytes,3,opt,name=backup,proto3,oneof"`
}

type RestoreInfo

type RestoreInfo struct {

	// The type of the restore source.
	SourceType RestoreSourceType `` /* 148-byte string literal not displayed */
	// Information about the source used to restore the database.
	//
	// Types that are assignable to SourceInfo:
	//	*RestoreInfo_BackupInfo
	SourceInfo isRestoreInfo_SourceInfo `protobuf_oneof:"source_info"`
	// contains filtered or unexported fields
}

Information about the database restore.

func (*RestoreInfo) Descriptor deprecated

func (*RestoreInfo) Descriptor() ([]byte, []int)

Deprecated: Use RestoreInfo.ProtoReflect.Descriptor instead.

func (*RestoreInfo) GetBackupInfo

func (x *RestoreInfo) GetBackupInfo() *BackupInfo

func (*RestoreInfo) GetSourceInfo

func (m *RestoreInfo) GetSourceInfo() isRestoreInfo_SourceInfo

func (*RestoreInfo) GetSourceType

func (x *RestoreInfo) GetSourceType() RestoreSourceType

func (*RestoreInfo) ProtoMessage

func (*RestoreInfo) ProtoMessage()

func (*RestoreInfo) ProtoReflect

func (x *RestoreInfo) ProtoReflect() protoreflect.Message

func (*RestoreInfo) Reset

func (x *RestoreInfo) Reset()

func (*RestoreInfo) String

func (x *RestoreInfo) String() string

type RestoreInfo_BackupInfo

type RestoreInfo_BackupInfo struct {
	// Information about the backup used to restore the database. The backup
	// may no longer exist.
	BackupInfo *BackupInfo `protobuf:"bytes,2,opt,name=backup_info,json=backupInfo,proto3,oneof"`
}

type RestoreSourceType

type RestoreSourceType int32

Indicates the type of the restore source.

const (
	// No restore associated.
	RestoreSourceType_TYPE_UNSPECIFIED RestoreSourceType = 0
	// A backup was used as the source of the restore.
	RestoreSourceType_BACKUP RestoreSourceType = 1
)

func (RestoreSourceType) Descriptor

func (RestoreSourceType) Enum

func (RestoreSourceType) EnumDescriptor deprecated

func (RestoreSourceType) EnumDescriptor() ([]byte, []int)

Deprecated: Use RestoreSourceType.Descriptor instead.

func (RestoreSourceType) Number

func (RestoreSourceType) String

func (x RestoreSourceType) String() string

func (RestoreSourceType) Type

type UnimplementedDatabaseAdminServer

type UnimplementedDatabaseAdminServer struct {
}

UnimplementedDatabaseAdminServer can be embedded to have forward compatible implementations.

func (*UnimplementedDatabaseAdminServer) CreateBackup

func (*UnimplementedDatabaseAdminServer) CreateDatabase

func (*UnimplementedDatabaseAdminServer) DeleteBackup

func (*UnimplementedDatabaseAdminServer) DropDatabase

func (*UnimplementedDatabaseAdminServer) GetBackup

func (*UnimplementedDatabaseAdminServer) GetDatabase

func (*UnimplementedDatabaseAdminServer) GetDatabaseDdl

func (*UnimplementedDatabaseAdminServer) GetIamPolicy

func (*UnimplementedDatabaseAdminServer) ListBackupOperations

func (*UnimplementedDatabaseAdminServer) ListBackups

func (*UnimplementedDatabaseAdminServer) ListDatabases

func (*UnimplementedDatabaseAdminServer) RestoreDatabase

func (*UnimplementedDatabaseAdminServer) SetIamPolicy

func (*UnimplementedDatabaseAdminServer) TestIamPermissions

func (*UnimplementedDatabaseAdminServer) UpdateBackup

func (*UnimplementedDatabaseAdminServer) UpdateDatabaseDdl

type UpdateBackupRequest

type UpdateBackupRequest struct {

	// Required. The backup to update. `backup.name`, and the fields to be updated
	// as specified by `update_mask` are required. Other fields are ignored.
	// Update is only supported for the following fields:
	//  * `backup.expire_time`.
	Backup *Backup `protobuf:"bytes,1,opt,name=backup,proto3" json:"backup,omitempty"`
	// Required. A mask specifying which fields (e.g. `expire_time`) in the
	// Backup resource should be updated. This mask is relative to the Backup
	// resource, not to the request message. The field mask must always be
	// specified; this prevents any future fields from being erased accidentally
	// by clients that do not know about them.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

The request for [UpdateBackup][google.spanner.admin.database.v1.DatabaseAdmin.UpdateBackup].

func (*UpdateBackupRequest) Descriptor deprecated

func (*UpdateBackupRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateBackupRequest.ProtoReflect.Descriptor instead.

func (*UpdateBackupRequest) GetBackup

func (x *UpdateBackupRequest) GetBackup() *Backup

func (*UpdateBackupRequest) GetUpdateMask

func (x *UpdateBackupRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateBackupRequest) ProtoMessage

func (*UpdateBackupRequest) ProtoMessage()

func (*UpdateBackupRequest) ProtoReflect

func (x *UpdateBackupRequest) ProtoReflect() protoreflect.Message

func (*UpdateBackupRequest) Reset

func (x *UpdateBackupRequest) Reset()

func (*UpdateBackupRequest) String

func (x *UpdateBackupRequest) String() string

type UpdateDatabaseDdlMetadata

type UpdateDatabaseDdlMetadata struct {

	// The database being modified.
	Database string `protobuf:"bytes,1,opt,name=database,proto3" json:"database,omitempty"`
	// For an update this list contains all the statements. For an
	// individual statement, this list contains only that statement.
	Statements []string `protobuf:"bytes,2,rep,name=statements,proto3" json:"statements,omitempty"`
	// Reports the commit timestamps of all statements that have
	// succeeded so far, where `commit_timestamps[i]` is the commit
	// timestamp for the statement `statements[i]`.
	CommitTimestamps []*timestamppb.Timestamp `protobuf:"bytes,3,rep,name=commit_timestamps,json=commitTimestamps,proto3" json:"commit_timestamps,omitempty"`
	// Output only. When true, indicates that the operation is throttled e.g
	// due to resource constraints. When resources become available the operation
	// will resume and this field will be false again.
	Throttled bool `protobuf:"varint,4,opt,name=throttled,proto3" json:"throttled,omitempty"`
	// The progress of the
	// [UpdateDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.UpdateDatabaseDdl] operations.
	// Currently, only index creation statements will have a continuously
	// updating progress.
	// For non-index creation statements, `progress[i]` will have start time
	// and end time populated with commit timestamp of operation,
	// as well as a progress of 100% once the operation has completed.
	// `progress[i]` is the operation progress for `statements[i]`.
	Progress []*OperationProgress `protobuf:"bytes,5,rep,name=progress,proto3" json:"progress,omitempty"`
	// contains filtered or unexported fields
}

Metadata type for the operation returned by [UpdateDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.UpdateDatabaseDdl].

func (*UpdateDatabaseDdlMetadata) Descriptor deprecated

func (*UpdateDatabaseDdlMetadata) Descriptor() ([]byte, []int)

Deprecated: Use UpdateDatabaseDdlMetadata.ProtoReflect.Descriptor instead.

func (*UpdateDatabaseDdlMetadata) GetCommitTimestamps

func (x *UpdateDatabaseDdlMetadata) GetCommitTimestamps() []*timestamppb.Timestamp

func (*UpdateDatabaseDdlMetadata) GetDatabase

func (x *UpdateDatabaseDdlMetadata) GetDatabase() string

func (*UpdateDatabaseDdlMetadata) GetProgress

func (x *UpdateDatabaseDdlMetadata) GetProgress() []*OperationProgress

func (*UpdateDatabaseDdlMetadata) GetStatements

func (x *UpdateDatabaseDdlMetadata) GetStatements() []string

func (*UpdateDatabaseDdlMetadata) GetThrottled

func (x *UpdateDatabaseDdlMetadata) GetThrottled() bool

func (*UpdateDatabaseDdlMetadata) ProtoMessage

func (*UpdateDatabaseDdlMetadata) ProtoMessage()

func (*UpdateDatabaseDdlMetadata) ProtoReflect

func (*UpdateDatabaseDdlMetadata) Reset

func (x *UpdateDatabaseDdlMetadata) Reset()

func (*UpdateDatabaseDdlMetadata) String

func (x *UpdateDatabaseDdlMetadata) String() string

type UpdateDatabaseDdlRequest

type UpdateDatabaseDdlRequest struct {

	// Required. The database to update.
	Database string `protobuf:"bytes,1,opt,name=database,proto3" json:"database,omitempty"`
	// Required. DDL statements to be applied to the database.
	Statements []string `protobuf:"bytes,2,rep,name=statements,proto3" json:"statements,omitempty"`
	// If empty, the new update request is assigned an
	// automatically-generated operation ID. Otherwise, `operation_id`
	// is used to construct the name of the resulting
	// [Operation][google.longrunning.Operation].
	//
	// Specifying an explicit operation ID simplifies determining
	// whether the statements were executed in the event that the
	// [UpdateDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.UpdateDatabaseDdl] call is replayed,
	// or the return value is otherwise lost: the [database][google.spanner.admin.database.v1.UpdateDatabaseDdlRequest.database] and
	// `operation_id` fields can be combined to form the
	// [name][google.longrunning.Operation.name] of the resulting
	// [longrunning.Operation][google.longrunning.Operation]: `<database>/operations/<operation_id>`.
	//
	// `operation_id` should be unique within the database, and must be
	// a valid identifier: `[a-z][a-z0-9_]*`. Note that
	// automatically-generated operation IDs always begin with an
	// underscore. If the named operation already exists,
	// [UpdateDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.UpdateDatabaseDdl] returns
	// `ALREADY_EXISTS`.
	OperationId string `protobuf:"bytes,3,opt,name=operation_id,json=operationId,proto3" json:"operation_id,omitempty"`
	// contains filtered or unexported fields
}

Enqueues the given DDL statements to be applied, in order but not necessarily all at once, to the database schema at some point (or points) in the future. The server checks that the statements are executable (syntactically valid, name tables that exist, etc.) before enqueueing them, but they may still fail upon later execution (e.g., if a statement from another batch of statements is applied first and it conflicts in some way, or if there is some data-related problem like a `NULL` value in a column to which `NOT NULL` would be added). If a statement fails, all subsequent statements in the batch are automatically cancelled.

Each batch of statements is assigned a name which can be used with the [Operations][google.longrunning.Operations] API to monitor progress. See the [operation_id][google.spanner.admin.database.v1.UpdateDatabaseDdlRequest.operation_id] field for more details.

func (*UpdateDatabaseDdlRequest) Descriptor deprecated

func (*UpdateDatabaseDdlRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateDatabaseDdlRequest.ProtoReflect.Descriptor instead.

func (*UpdateDatabaseDdlRequest) GetDatabase

func (x *UpdateDatabaseDdlRequest) GetDatabase() string

func (*UpdateDatabaseDdlRequest) GetOperationId

func (x *UpdateDatabaseDdlRequest) GetOperationId() string

func (*UpdateDatabaseDdlRequest) GetStatements

func (x *UpdateDatabaseDdlRequest) GetStatements() []string

func (*UpdateDatabaseDdlRequest) ProtoMessage

func (*UpdateDatabaseDdlRequest) ProtoMessage()

func (*UpdateDatabaseDdlRequest) ProtoReflect

func (x *UpdateDatabaseDdlRequest) ProtoReflect() protoreflect.Message

func (*UpdateDatabaseDdlRequest) Reset

func (x *UpdateDatabaseDdlRequest) Reset()

func (*UpdateDatabaseDdlRequest) String

func (x *UpdateDatabaseDdlRequest) String() string

Jump to

Keyboard shortcuts

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