Package cloud.google.com/go/spanner/admin/database/apiv1/databasepb (v1.66.0)

Version 1.66.0

• 1.73.0 (latest)
• 1.72.0
• 1.71.0
• 1.70.0
• 1.69.0
• 1.68.0
• 1.67.0
• 1.66.0
• 1.65.0
• 1.64.0
• 1.63.0
• 1.62.0
• 1.61.0
• 1.60.0
• 1.59.0
• 1.58.0
• 1.57.0
• 1.56.0
• 1.55.0
• 1.54.0
• 1.53.1
• 1.52.0
• 1.49.0
• 1.48.0
• 1.47.0
• 1.46.0
• 1.45.1
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.36.0
• 1.35.0
• 1.34.1
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.1
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.24.1
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.1
• 1.13.0

Note: To get more information about this package, such as access to older versions, view this package on pkg.go.dev.

Variables

Backup_State_name, Backup_State_value

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.

CreateBackupEncryptionConfig_EncryptionType_name, CreateBackupEncryptionConfig_EncryptionType_value

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.

CopyBackupEncryptionConfig_EncryptionType_name, CopyBackupEncryptionConfig_EncryptionType_value

var (
	CopyBackupEncryptionConfig_EncryptionType_name = map[int32]string{
		0: "ENCRYPTION_TYPE_UNSPECIFIED",
		1: "USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION",
		2: "GOOGLE_DEFAULT_ENCRYPTION",
		3: "CUSTOMER_MANAGED_ENCRYPTION",
	}
	CopyBackupEncryptionConfig_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 CopyBackupEncryptionConfig_EncryptionType.

DatabaseDialect_name, DatabaseDialect_value

var (
	DatabaseDialect_name = map[int32]string{
		0: "DATABASE_DIALECT_UNSPECIFIED",
		1: "GOOGLE_STANDARD_SQL",
		2: "POSTGRESQL",
	}
	DatabaseDialect_value = map[string]int32{
		"DATABASE_DIALECT_UNSPECIFIED": 0,
		"GOOGLE_STANDARD_SQL":          1,
		"POSTGRESQL":                   2,
	}
)

Enum value maps for DatabaseDialect.

EncryptionInfo_Type_name, EncryptionInfo_Type_value

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.

RestoreSourceType_name, RestoreSourceType_value

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.

Database_State_name, Database_State_value

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.

RestoreDatabaseEncryptionConfig_EncryptionType_name, RestoreDatabaseEncryptionConfig_EncryptionType_value

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.

File_google_spanner_admin_database_v1_backup_proto

var File_google_spanner_admin_database_v1_backup_proto protoreflect.FileDescriptor

File_google_spanner_admin_database_v1_backup_schedule_proto

var File_google_spanner_admin_database_v1_backup_schedule_proto protoreflect.FileDescriptor

File_google_spanner_admin_database_v1_common_proto

var File_google_spanner_admin_database_v1_common_proto protoreflect.FileDescriptor

File_google_spanner_admin_database_v1_spanner_database_admin_proto

var File_google_spanner_admin_database_v1_spanner_database_admin_proto protoreflect.FileDescriptor

Functions

func RegisterDatabaseAdminServer

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

Backup

type Backup struct {
	Database string `protobuf:"bytes,2,opt,name=database,proto3" json:"database,omitempty"`

	VersionTime *timestamppb.Timestamp `protobuf:"bytes,9,opt,name=version_time,json=versionTime,proto3" json:"version_time,omitempty"`

	ExpireTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=expire_time,json=expireTime,proto3" json:"expire_time,omitempty"`

	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`

	CreateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`

	SizeBytes int64 `protobuf:"varint,5,opt,name=size_bytes,json=sizeBytes,proto3" json:"size_bytes,omitempty"`

	FreeableSizeBytes int64 `protobuf:"varint,15,opt,name=freeable_size_bytes,json=freeableSizeBytes,proto3" json:"freeable_size_bytes,omitempty"`

	ExclusiveSizeBytes int64 `protobuf:"varint,16,opt,name=exclusive_size_bytes,json=exclusiveSizeBytes,proto3" json:"exclusive_size_bytes,omitempty"`

	State Backup_State `protobuf:"varint,6,opt,name=state,proto3,enum=google.spanner.admin.database.v1.Backup_State" json:"state,omitempty"`

	ReferencingDatabases []string `protobuf:"bytes,7,rep,name=referencing_databases,json=referencingDatabases,proto3" json:"referencing_databases,omitempty"`

	EncryptionInfo *EncryptionInfo `protobuf:"bytes,8,opt,name=encryption_info,json=encryptionInfo,proto3" json:"encryption_info,omitempty"`

	EncryptionInformation []*EncryptionInfo `protobuf:"bytes,13,rep,name=encryption_information,json=encryptionInformation,proto3" json:"encryption_information,omitempty"`

	DatabaseDialect DatabaseDialect "" /* 162 byte string literal not displayed */

	ReferencingBackups []string `protobuf:"bytes,11,rep,name=referencing_backups,json=referencingBackups,proto3" json:"referencing_backups,omitempty"`

	MaxExpireTime *timestamppb.Timestamp `protobuf:"bytes,12,opt,name=max_expire_time,json=maxExpireTime,proto3" json:"max_expire_time,omitempty"`

	BackupSchedules []string `protobuf:"bytes,14,rep,name=backup_schedules,json=backupSchedules,proto3" json:"backup_schedules,omitempty"`

	IncrementalBackupChainId string "" /* 138 byte string literal not displayed */

	OldestVersionTime *timestamppb.Timestamp `protobuf:"bytes,18,opt,name=oldest_version_time,json=oldestVersionTime,proto3" json:"oldest_version_time,omitempty"`

}

A backup of a Cloud Spanner database.

func (*Backup) Descriptor

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

Deprecated: Use Backup.ProtoReflect.Descriptor instead.

func (*Backup) GetBackupSchedules

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

func (*Backup) GetCreateTime

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

func (*Backup) GetDatabase

func (x *Backup) GetDatabase() string

func (*Backup) GetDatabaseDialect

func (x *Backup) GetDatabaseDialect() DatabaseDialect

func (*Backup) GetEncryptionInfo

func (x *Backup) GetEncryptionInfo() *EncryptionInfo

func (*Backup) GetEncryptionInformation

func (x *Backup) GetEncryptionInformation() []*EncryptionInfo

func (*Backup) GetExclusiveSizeBytes

func (x *Backup) GetExclusiveSizeBytes() int64

func (*Backup) GetExpireTime

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

func (*Backup) GetFreeableSizeBytes

func (x *Backup) GetFreeableSizeBytes() int64

func (*Backup) GetIncrementalBackupChainId

func (x *Backup) GetIncrementalBackupChainId() string

func (*Backup) GetMaxExpireTime

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

func (*Backup) GetName

func (x *Backup) GetName() string

func (*Backup) GetOldestVersionTime

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

func (*Backup) GetReferencingBackups

func (x *Backup) GetReferencingBackups() []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

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

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

BackupSchedule

type BackupSchedule struct {

	// Identifier. Output only for the
	// [CreateBackupSchedule][DatabaseAdmin.CreateBackupSchededule] operation.
	// Required for the
	// [UpdateBackupSchedule][google.spanner.admin.database.v1.DatabaseAdmin.UpdateBackupSchedule]
	// operation. A globally unique identifier for the backup schedule which
	// cannot be changed. Values are of the form
	// `projects/

BackupSchedule expresses the automated backup creation specification for a Spanner database. Next ID: 10

func (*BackupSchedule) Descriptor

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

Deprecated: Use BackupSchedule.ProtoReflect.Descriptor instead.

func (*BackupSchedule) GetBackupTypeSpec

func (m *BackupSchedule) GetBackupTypeSpec() isBackupSchedule_BackupTypeSpec

func (*BackupSchedule) GetEncryptionConfig

func (x *BackupSchedule) GetEncryptionConfig() *CreateBackupEncryptionConfig

func (*BackupSchedule) GetFullBackupSpec

func (x *BackupSchedule) GetFullBackupSpec() *FullBackupSpec

func (*BackupSchedule) GetIncrementalBackupSpec

func (x *BackupSchedule) GetIncrementalBackupSpec() *IncrementalBackupSpec

func (*BackupSchedule) GetName

func (x *BackupSchedule) GetName() string

func (*BackupSchedule) GetRetentionDuration

func (x *BackupSchedule) GetRetentionDuration() *durationpb.Duration

func (*BackupSchedule) GetSpec

func (x *BackupSchedule) GetSpec() *BackupScheduleSpec

func (*BackupSchedule) GetUpdateTime

func (x *BackupSchedule) GetUpdateTime() *timestamppb.Timestamp

func (*BackupSchedule) ProtoMessage

func (*BackupSchedule) ProtoMessage()

func (*BackupSchedule) ProtoReflect

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

func (*BackupSchedule) Reset

func (x *BackupSchedule) Reset()

func (*BackupSchedule) String

func (x *BackupSchedule) String() string

BackupScheduleSpec

type BackupScheduleSpec struct {

	// Required.
	//
	// Types that are assignable to ScheduleSpec:
	//
	//	*BackupScheduleSpec_CronSpec
	ScheduleSpec isBackupScheduleSpec_ScheduleSpec `protobuf_oneof:"schedule_spec"`
	// contains filtered or unexported fields
}

Defines specifications of the backup schedule.

func (*BackupScheduleSpec) Descriptor

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

Deprecated: Use BackupScheduleSpec.ProtoReflect.Descriptor instead.

func (*BackupScheduleSpec) GetCronSpec

func (x *BackupScheduleSpec) GetCronSpec() *CrontabSpec

func (*BackupScheduleSpec) GetScheduleSpec

func (m *BackupScheduleSpec) GetScheduleSpec() isBackupScheduleSpec_ScheduleSpec

func (*BackupScheduleSpec) ProtoMessage

func (*BackupScheduleSpec) ProtoMessage()

func (*BackupScheduleSpec) ProtoReflect

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

func (*BackupScheduleSpec) Reset

func (x *BackupScheduleSpec) Reset()

func (*BackupScheduleSpec) String

func (x *BackupScheduleSpec) String() string

BackupScheduleSpec_CronSpec

type BackupScheduleSpec_CronSpec struct {
	// Cron style schedule specification.
	CronSpec *CrontabSpec `protobuf:"bytes,1,opt,name=cron_spec,json=cronSpec,proto3,oneof"`
}

BackupSchedule_FullBackupSpec

type BackupSchedule_FullBackupSpec struct {
	// The schedule creates only full backups.
	FullBackupSpec *FullBackupSpec `protobuf:"bytes,7,opt,name=full_backup_spec,json=fullBackupSpec,proto3,oneof"`
}

BackupSchedule_IncrementalBackupSpec

type BackupSchedule_IncrementalBackupSpec struct {
	// The schedule creates incremental backup chains.
	IncrementalBackupSpec *IncrementalBackupSpec `protobuf:"bytes,8,opt,name=incremental_backup_spec,json=incrementalBackupSpec,proto3,oneof"`
}

Backup_State

type Backup_State int32

Indicates the current state of the backup.

Backup_STATE_UNSPECIFIED, Backup_CREATING, Backup_READY

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) Descriptor() protoreflect.EnumDescriptor

func (Backup_State) Enum

func (x Backup_State) Enum() *Backup_State

func (Backup_State) EnumDescriptor

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

Deprecated: Use Backup_State.Descriptor instead.

func (Backup_State) Number

func (x Backup_State) Number() protoreflect.EnumNumber

func (Backup_State) String

func (x Backup_State) String() string

func (Backup_State) Type

func (Backup_State) Type() protoreflect.EnumType

CopyBackupEncryptionConfig

type CopyBackupEncryptionConfig struct {
	EncryptionType CopyBackupEncryptionConfig_EncryptionType "" /* 184 byte string literal not displayed */

	KmsKeyName string `protobuf:"bytes,2,opt,name=kms_key_name,json=kmsKeyName,proto3" json:"kms_key_name,omitempty"`

	KmsKeyNames []string `protobuf:"bytes,3,rep,name=kms_key_names,json=kmsKeyNames,proto3" json:"kms_key_names,omitempty"`

}

Encryption configuration for the copied backup.

func (*CopyBackupEncryptionConfig) Descriptor

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

Deprecated: Use CopyBackupEncryptionConfig.ProtoReflect.Descriptor instead.

func (*CopyBackupEncryptionConfig) GetEncryptionType

func (x *CopyBackupEncryptionConfig) GetEncryptionType() CopyBackupEncryptionConfig_EncryptionType

func (*CopyBackupEncryptionConfig) GetKmsKeyName

func (x *CopyBackupEncryptionConfig) GetKmsKeyName() string

func (*CopyBackupEncryptionConfig) GetKmsKeyNames

func (x *CopyBackupEncryptionConfig) GetKmsKeyNames() []string

func (*CopyBackupEncryptionConfig) ProtoMessage

func (*CopyBackupEncryptionConfig) ProtoMessage()

func (*CopyBackupEncryptionConfig) ProtoReflect

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

func (*CopyBackupEncryptionConfig) Reset

func (x *CopyBackupEncryptionConfig) Reset()

func (*CopyBackupEncryptionConfig) String

func (x *CopyBackupEncryptionConfig) String() string

CopyBackupEncryptionConfig_EncryptionType

type CopyBackupEncryptionConfig_EncryptionType int32

Encryption types for the backup.

CopyBackupEncryptionConfig_ENCRYPTION_TYPE_UNSPECIFIED, CopyBackupEncryptionConfig_USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION, CopyBackupEncryptionConfig_GOOGLE_DEFAULT_ENCRYPTION, CopyBackupEncryptionConfig_CUSTOMER_MANAGED_ENCRYPTION

const (
	// Unspecified. Do not use.
	CopyBackupEncryptionConfig_ENCRYPTION_TYPE_UNSPECIFIED CopyBackupEncryptionConfig_EncryptionType = 0
	// This is the default option for
	// [CopyBackup][google.spanner.admin.database.v1.DatabaseAdmin.CopyBackup]
	// when
	// [encryption_config][google.spanner.admin.database.v1.CopyBackupEncryptionConfig]
	// is not specified. For example, if the source backup is using
	// `Customer_Managed_Encryption`, the backup will be using the same Cloud
	// KMS key as the source backup.
	CopyBackupEncryptionConfig_USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION CopyBackupEncryptionConfig_EncryptionType = 1
	// Use Google default encryption.
	CopyBackupEncryptionConfig_GOOGLE_DEFAULT_ENCRYPTION CopyBackupEncryptionConfig_EncryptionType = 2
	// Use customer managed encryption. If specified, either `kms_key_name` or
	// `kms_key_names` must contain valid Cloud KMS key(s).
	CopyBackupEncryptionConfig_CUSTOMER_MANAGED_ENCRYPTION CopyBackupEncryptionConfig_EncryptionType = 3
)

func (CopyBackupEncryptionConfig_EncryptionType) Descriptor

func (CopyBackupEncryptionConfig_EncryptionType) Descriptor() protoreflect.EnumDescriptor

func (CopyBackupEncryptionConfig_EncryptionType) Enum

func (x CopyBackupEncryptionConfig_EncryptionType) Enum() *CopyBackupEncryptionConfig_EncryptionType

func (CopyBackupEncryptionConfig_EncryptionType) EnumDescriptor

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

Deprecated: Use CopyBackupEncryptionConfig_EncryptionType.Descriptor instead.

func (CopyBackupEncryptionConfig_EncryptionType) Number

func (x CopyBackupEncryptionConfig_EncryptionType) Number() protoreflect.EnumNumber

func (CopyBackupEncryptionConfig_EncryptionType) String

func (x CopyBackupEncryptionConfig_EncryptionType) String() string

func (CopyBackupEncryptionConfig_EncryptionType) Type

func (CopyBackupEncryptionConfig_EncryptionType) Type() protoreflect.EnumType

CopyBackupMetadata

type CopyBackupMetadata struct {

	// The name of the backup being created through the copy operation.
	// Values are of the form
	// `projects/

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

func (*CopyBackupMetadata) Descriptor

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

Deprecated: Use CopyBackupMetadata.ProtoReflect.Descriptor instead.

func (*CopyBackupMetadata) GetCancelTime

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

func (*CopyBackupMetadata) GetName

func (x *CopyBackupMetadata) GetName() string

func (*CopyBackupMetadata) GetProgress

func (x *CopyBackupMetadata) GetProgress() *OperationProgress

func (*CopyBackupMetadata) GetSourceBackup

func (x *CopyBackupMetadata) GetSourceBackup() string

func (*CopyBackupMetadata) ProtoMessage

func (*CopyBackupMetadata) ProtoMessage()

func (*CopyBackupMetadata) ProtoReflect

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

func (*CopyBackupMetadata) Reset

func (x *CopyBackupMetadata) Reset()

func (*CopyBackupMetadata) String

func (x *CopyBackupMetadata) String() string

CopyBackupRequest

type CopyBackupRequest struct {

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

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

func (*CopyBackupRequest) Descriptor

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

Deprecated: Use CopyBackupRequest.ProtoReflect.Descriptor instead.

func (*CopyBackupRequest) GetBackupId

func (x *CopyBackupRequest) GetBackupId() string

func (*CopyBackupRequest) GetEncryptionConfig

func (x *CopyBackupRequest) GetEncryptionConfig() *CopyBackupEncryptionConfig

func (*CopyBackupRequest) GetExpireTime

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

func (*CopyBackupRequest) GetParent

func (x *CopyBackupRequest) GetParent() string

func (*CopyBackupRequest) GetSourceBackup

func (x *CopyBackupRequest) GetSourceBackup() string

func (*CopyBackupRequest) ProtoMessage

func (*CopyBackupRequest) ProtoMessage()

func (*CopyBackupRequest) ProtoReflect

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

func (*CopyBackupRequest) Reset

func (x *CopyBackupRequest) Reset()

func (*CopyBackupRequest) String

func (x *CopyBackupRequest) String() string

CreateBackupEncryptionConfig

type CreateBackupEncryptionConfig struct {
	EncryptionType CreateBackupEncryptionConfig_EncryptionType "" /* 186 byte string literal not displayed */

	KmsKeyName string `protobuf:"bytes,2,opt,name=kms_key_name,json=kmsKeyName,proto3" json:"kms_key_name,omitempty"`

	KmsKeyNames []string `protobuf:"bytes,3,rep,name=kms_key_names,json=kmsKeyNames,proto3" json:"kms_key_names,omitempty"`

}

Encryption configuration for the backup to create.

func (*CreateBackupEncryptionConfig) Descriptor

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

Deprecated: Use CreateBackupEncryptionConfig.ProtoReflect.Descriptor instead.

func (*CreateBackupEncryptionConfig) GetEncryptionType

func (x *CreateBackupEncryptionConfig) GetEncryptionType() CreateBackupEncryptionConfig_EncryptionType

func (*CreateBackupEncryptionConfig) GetKmsKeyName

func (x *CreateBackupEncryptionConfig) GetKmsKeyName() string

func (*CreateBackupEncryptionConfig) GetKmsKeyNames

func (x *CreateBackupEncryptionConfig) GetKmsKeyNames() []string

func (*CreateBackupEncryptionConfig) ProtoMessage

func (*CreateBackupEncryptionConfig) ProtoMessage()

func (*CreateBackupEncryptionConfig) ProtoReflect

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

func (*CreateBackupEncryptionConfig) Reset

func (x *CreateBackupEncryptionConfig) Reset()

func (*CreateBackupEncryptionConfig) String

func (x *CreateBackupEncryptionConfig) String() string

CreateBackupEncryptionConfig_EncryptionType

type CreateBackupEncryptionConfig_EncryptionType int32

Encryption types for the backup.

CreateBackupEncryptionConfig_ENCRYPTION_TYPE_UNSPECIFIED, CreateBackupEncryptionConfig_USE_DATABASE_ENCRYPTION, CreateBackupEncryptionConfig_GOOGLE_DEFAULT_ENCRYPTION, CreateBackupEncryptionConfig_CUSTOMER_MANAGED_ENCRYPTION

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) Descriptor() protoreflect.EnumDescriptor

func (CreateBackupEncryptionConfig_EncryptionType) Enum

func (x CreateBackupEncryptionConfig_EncryptionType) Enum() *CreateBackupEncryptionConfig_EncryptionType

func (CreateBackupEncryptionConfig_EncryptionType) EnumDescriptor

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

Deprecated: Use CreateBackupEncryptionConfig_EncryptionType.Descriptor instead.

func (CreateBackupEncryptionConfig_EncryptionType) Number

func (x CreateBackupEncryptionConfig_EncryptionType) Number() protoreflect.EnumNumber

func (CreateBackupEncryptionConfig_EncryptionType) String

func (x CreateBackupEncryptionConfig_EncryptionType) String() string

func (CreateBackupEncryptionConfig_EncryptionType) Type

func (CreateBackupEncryptionConfig_EncryptionType) Type() protoreflect.EnumType

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

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

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/

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

func (*CreateBackupRequest) Descriptor

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

CreateBackupScheduleRequest

type CreateBackupScheduleRequest struct {

	// Required. The name of the database that this backup schedule applies to.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The Id to use for the backup schedule. The `backup_schedule_id`
	// appended to `parent` forms the full backup schedule name of the form
	// `projects/

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

func (*CreateBackupScheduleRequest) Descriptor

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

Deprecated: Use CreateBackupScheduleRequest.ProtoReflect.Descriptor instead.

func (*CreateBackupScheduleRequest) GetBackupSchedule

func (x *CreateBackupScheduleRequest) GetBackupSchedule() *BackupSchedule

func (*CreateBackupScheduleRequest) GetBackupScheduleId

func (x *CreateBackupScheduleRequest) GetBackupScheduleId() string

func (*CreateBackupScheduleRequest) GetParent

func (x *CreateBackupScheduleRequest) GetParent() string

func (*CreateBackupScheduleRequest) ProtoMessage

func (*CreateBackupScheduleRequest) ProtoMessage()

func (*CreateBackupScheduleRequest) ProtoReflect

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

func (*CreateBackupScheduleRequest) Reset

func (x *CreateBackupScheduleRequest) Reset()

func (*CreateBackupScheduleRequest) String

func (x *CreateBackupScheduleRequest) String() string

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

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

CreateDatabaseRequest

type CreateDatabaseRequest struct {
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`

	CreateStatement string `protobuf:"bytes,2,opt,name=create_statement,json=createStatement,proto3" json:"create_statement,omitempty"`

	ExtraStatements []string `protobuf:"bytes,3,rep,name=extra_statements,json=extraStatements,proto3" json:"extra_statements,omitempty"`

	EncryptionConfig *EncryptionConfig `protobuf:"bytes,4,opt,name=encryption_config,json=encryptionConfig,proto3" json:"encryption_config,omitempty"`

	DatabaseDialect DatabaseDialect "" /* 161 byte string literal not displayed */

	ProtoDescriptors []byte `protobuf:"bytes,6,opt,name=proto_descriptors,json=protoDescriptors,proto3" json:"proto_descriptors,omitempty"`

}

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

func (*CreateDatabaseRequest) Descriptor

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

Deprecated: Use CreateDatabaseRequest.ProtoReflect.Descriptor instead.

func (*CreateDatabaseRequest) GetCreateStatement

func (x *CreateDatabaseRequest) GetCreateStatement() string

func (*CreateDatabaseRequest) GetDatabaseDialect

func (x *CreateDatabaseRequest) GetDatabaseDialect() DatabaseDialect

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) GetProtoDescriptors

func (x *CreateDatabaseRequest) GetProtoDescriptors() []byte

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

CrontabSpec

type CrontabSpec struct {

	// Required. Textual representation of the crontab. User can customize the
	// backup frequency and the backup version time using the cron
	// expression. The version time must be in UTC timzeone.
	//
	// The backup will contain an externally consistent copy of the
	// database at the version time. Allowed frequencies are 12 hour, 1 day,
	// 1 week and 1 month. Examples of valid cron specifications:
	//   - `0 2/12 * * * ` : every 12 hours at (2, 14) hours past midnight in UTC.
	//   - `0 2,14 * * * ` : every 12 hours at (2,14) hours past midnight in UTC.
	//   - `0 2 * * * `    : once a day at 2 past midnight in UTC.
	//   - `0 2 * * 0 `    : once a week every Sunday at 2 past midnight in UTC.
	//   - `0 2 8 * * `    : once a month on 8th day at 2 past midnight in UTC.
	Text string `protobuf:"bytes,1,opt,name=text,proto3" json:"text,omitempty"`
	// Output only. The time zone of the times in `CrontabSpec.text`. Currently
	// only UTC is supported.
	TimeZone string `protobuf:"bytes,2,opt,name=time_zone,json=timeZone,proto3" json:"time_zone,omitempty"`
	// Output only. Schedule backups will contain an externally consistent copy
	// of the database at the version time specified in
	// `schedule_spec.cron_spec`. However, Spanner may not initiate the creation
	// of the scheduled backups at that version time. Spanner will initiate
	// the creation of scheduled backups within the time window bounded by the
	// version_time specified in `schedule_spec.cron_spec` and version_time +
	// `creation_window`.
	CreationWindow *durationpb.Duration `protobuf:"bytes,3,opt,name=creation_window,json=creationWindow,proto3" json:"creation_window,omitempty"`
	// contains filtered or unexported fields
}

CrontabSpec can be used to specify the version time and frequency at which the backup should be created.

func (*CrontabSpec) Descriptor

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

Deprecated: Use CrontabSpec.ProtoReflect.Descriptor instead.

func (*CrontabSpec) GetCreationWindow

func (x *CrontabSpec) GetCreationWindow() *durationpb.Duration

func (*CrontabSpec) GetText

func (x *CrontabSpec) GetText() string

func (*CrontabSpec) GetTimeZone

func (x *CrontabSpec) GetTimeZone() string

func (*CrontabSpec) ProtoMessage

func (*CrontabSpec) ProtoMessage()

func (*CrontabSpec) ProtoReflect

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

func (*CrontabSpec) Reset

func (x *CrontabSpec) Reset()

func (*CrontabSpec) String

func (x *CrontabSpec) String() string

Database

type Database struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`

	State Database_State `protobuf:"varint,2,opt,name=state,proto3,enum=google.spanner.admin.database.v1.Database_State" json:"state,omitempty"`

	CreateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`

	RestoreInfo *RestoreInfo `protobuf:"bytes,4,opt,name=restore_info,json=restoreInfo,proto3" json:"restore_info,omitempty"`

	EncryptionConfig *EncryptionConfig `protobuf:"bytes,5,opt,name=encryption_config,json=encryptionConfig,proto3" json:"encryption_config,omitempty"`

	EncryptionInfo []*EncryptionInfo `protobuf:"bytes,8,rep,name=encryption_info,json=encryptionInfo,proto3" json:"encryption_info,omitempty"`

	VersionRetentionPeriod string "" /* 129 byte string literal not displayed */

	EarliestVersionTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=earliest_version_time,json=earliestVersionTime,proto3" json:"earliest_version_time,omitempty"`

	DefaultLeader string `protobuf:"bytes,9,opt,name=default_leader,json=defaultLeader,proto3" json:"default_leader,omitempty"`

	DatabaseDialect DatabaseDialect "" /* 162 byte string literal not displayed */

	EnableDropProtection bool `protobuf:"varint,11,opt,name=enable_drop_protection,json=enableDropProtection,proto3" json:"enable_drop_protection,omitempty"`

	Reconciling bool `protobuf:"varint,12,opt,name=reconciling,proto3" json:"reconciling,omitempty"`

}

A Cloud Spanner database.

func (*Database) Descriptor

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

Deprecated: Use Database.ProtoReflect.Descriptor instead.

func (*Database) GetCreateTime

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

func (*Database) GetDatabaseDialect

func (x *Database) GetDatabaseDialect() DatabaseDialect

func (*Database) GetDefaultLeader

func (x *Database) GetDefaultLeader() string

func (*Database) GetEarliestVersionTime

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

func (*Database) GetEnableDropProtection

func (x *Database) GetEnableDropProtection() bool

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) GetReconciling

func (x *Database) GetReconciling() bool

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

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 `

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.

func NewDatabaseAdminClient

func NewDatabaseAdminClient(cc grpc.ClientConnInterface) DatabaseAdminClient

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 `

DatabaseAdminServer is the server API for DatabaseAdmin service.

DatabaseDialect

type DatabaseDialect int32

Indicates the dialect type of a database.

DatabaseDialect_DATABASE_DIALECT_UNSPECIFIED, DatabaseDialect_GOOGLE_STANDARD_SQL, DatabaseDialect_POSTGRESQL

const (
	// Default value. This value will create a database with the
	// GOOGLE_STANDARD_SQL dialect.
	DatabaseDialect_DATABASE_DIALECT_UNSPECIFIED DatabaseDialect = 0
	// GoogleSQL supported SQL.
	DatabaseDialect_GOOGLE_STANDARD_SQL DatabaseDialect = 1
	// PostgreSQL supported SQL.
	DatabaseDialect_POSTGRESQL DatabaseDialect = 2
)

func (DatabaseDialect) Descriptor

func (DatabaseDialect) Descriptor() protoreflect.EnumDescriptor

func (DatabaseDialect) Enum

func (x DatabaseDialect) Enum() *DatabaseDialect

func (DatabaseDialect) EnumDescriptor

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

Deprecated: Use DatabaseDialect.Descriptor instead.

func (DatabaseDialect) Number

func (x DatabaseDialect) Number() protoreflect.EnumNumber

func (DatabaseDialect) String

func (x DatabaseDialect) String() string

func (DatabaseDialect) Type

func (DatabaseDialect) Type() protoreflect.EnumType

DatabaseRole

type DatabaseRole struct {

	// Required. The name of the database role. Values are of the form
	// `projects/

A Cloud Spanner database role.

func (*DatabaseRole) Descriptor

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

Deprecated: Use DatabaseRole.ProtoReflect.Descriptor instead.

func (*DatabaseRole) GetName

func (x *DatabaseRole) GetName() string

func (*DatabaseRole) ProtoMessage

func (*DatabaseRole) ProtoMessage()

func (*DatabaseRole) ProtoReflect

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

func (*DatabaseRole) Reset

func (x *DatabaseRole) Reset()

func (*DatabaseRole) String

func (x *DatabaseRole) String() string

Database_State

type Database_State int32

Indicates the current state of the database.

Database_STATE_UNSPECIFIED, Database_CREATING, Database_READY, Database_READY_OPTIMIZING

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) Descriptor() protoreflect.EnumDescriptor

func (Database_State) Enum

func (x Database_State) Enum() *Database_State

func (Database_State) EnumDescriptor

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

Deprecated: Use Database_State.Descriptor instead.

func (Database_State) Number

func (x Database_State) Number() protoreflect.EnumNumber

func (Database_State) String

func (x Database_State) String() string

func (Database_State) Type

func (Database_State) Type() protoreflect.EnumType

DdlStatementActionInfo

type DdlStatementActionInfo struct {

	// The action for the DDL statement, e.g. CREATE, ALTER, DROP, GRANT, etc.
	// This field is a non-empty string.
	Action string `protobuf:"bytes,1,opt,name=action,proto3" json:"action,omitempty"`
	// The entity type for the DDL statement, e.g. TABLE, INDEX, VIEW, etc.
	// This field can be empty string for some DDL statement,
	// e.g. for statement "ANALYZE", `entity_type` = "".
	EntityType string `protobuf:"bytes,2,opt,name=entity_type,json=entityType,proto3" json:"entity_type,omitempty"`
	// The entity name(s) being operated on the DDL statement.
	// E.g.
	// 1. For statement "CREATE TABLE t1(...)", `entity_names` = ["t1"].
	// 2. For statement "GRANT ROLE r1, r2 ...", `entity_names` = ["r1", "r2"].
	// 3. For statement "ANALYZE", `entity_names` = [].
	EntityNames []string `protobuf:"bytes,3,rep,name=entity_names,json=entityNames,proto3" json:"entity_names,omitempty"`
	// contains filtered or unexported fields
}

Action information extracted from a DDL statement. This proto is used to display the brief info of the DDL statement for the operation [UpdateDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.UpdateDatabaseDdl].

func (*DdlStatementActionInfo) Descriptor

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

Deprecated: Use DdlStatementActionInfo.ProtoReflect.Descriptor instead.

func (*DdlStatementActionInfo) GetAction

func (x *DdlStatementActionInfo) GetAction() string

func (*DdlStatementActionInfo) GetEntityNames

func (x *DdlStatementActionInfo) GetEntityNames() []string

func (*DdlStatementActionInfo) GetEntityType

func (x *DdlStatementActionInfo) GetEntityType() string

func (*DdlStatementActionInfo) ProtoMessage

func (*DdlStatementActionInfo) ProtoMessage()

func (*DdlStatementActionInfo) ProtoReflect

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

func (*DdlStatementActionInfo) Reset

func (x *DdlStatementActionInfo) Reset()

func (*DdlStatementActionInfo) String

func (x *DdlStatementActionInfo) String() string

DeleteBackupRequest

type DeleteBackupRequest struct {

	// Required. Name of the backup to delete.
	// Values are of the form
	// `projects/

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

func (*DeleteBackupRequest) Descriptor

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

DeleteBackupScheduleRequest

type DeleteBackupScheduleRequest struct {

	// Required. The name of the schedule to delete.
	// Values are of the form
	// `projects/

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

func (*DeleteBackupScheduleRequest) Descriptor

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

Deprecated: Use DeleteBackupScheduleRequest.ProtoReflect.Descriptor instead.

func (*DeleteBackupScheduleRequest) GetName

func (x *DeleteBackupScheduleRequest) GetName() string

func (*DeleteBackupScheduleRequest) ProtoMessage

func (*DeleteBackupScheduleRequest) ProtoMessage()

func (*DeleteBackupScheduleRequest) ProtoReflect

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

func (*DeleteBackupScheduleRequest) Reset

func (x *DeleteBackupScheduleRequest) Reset()

func (*DeleteBackupScheduleRequest) String

func (x *DeleteBackupScheduleRequest) String() string

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

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

EncryptionConfig

type EncryptionConfig struct {

	// The Cloud KMS key to be used for encrypting and decrypting
	// the database. Values are of the form
	// `projects/

Encryption configuration for a Cloud Spanner database.

func (*EncryptionConfig) Descriptor

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

Deprecated: Use EncryptionConfig.ProtoReflect.Descriptor instead.

func (*EncryptionConfig) GetKmsKeyName

func (x *EncryptionConfig) GetKmsKeyName() string

func (*EncryptionConfig) GetKmsKeyNames

func (x *EncryptionConfig) GetKmsKeyNames() []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

EncryptionInfo

type EncryptionInfo struct {
	EncryptionType EncryptionInfo_Type "" /* 162 byte string literal not displayed */

	EncryptionStatus *status.Status `protobuf:"bytes,4,opt,name=encryption_status,json=encryptionStatus,proto3" json:"encryption_status,omitempty"`

	KmsKeyVersion string `protobuf:"bytes,2,opt,name=kms_key_version,json=kmsKeyVersion,proto3" json:"kms_key_version,omitempty"`

}

Encryption information for a Cloud Spanner database or backup.

func (*EncryptionInfo) Descriptor

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

EncryptionInfo_Type

type EncryptionInfo_Type int32

Possible encryption types.

EncryptionInfo_TYPE_UNSPECIFIED, EncryptionInfo_GOOGLE_DEFAULT_ENCRYPTION, EncryptionInfo_CUSTOMER_MANAGED_ENCRYPTION

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) Descriptor() protoreflect.EnumDescriptor

func (EncryptionInfo_Type) Enum

func (x EncryptionInfo_Type) Enum() *EncryptionInfo_Type

func (EncryptionInfo_Type) EnumDescriptor

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

Deprecated: Use EncryptionInfo_Type.Descriptor instead.

func (EncryptionInfo_Type) Number

func (x EncryptionInfo_Type) Number() protoreflect.EnumNumber

func (EncryptionInfo_Type) String

func (x EncryptionInfo_Type) String() string

func (EncryptionInfo_Type) Type

func (EncryptionInfo_Type) Type() protoreflect.EnumType

FullBackupSpec

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

The specification for full backups. A full backup stores the entire contents of the database at a given version time.

func (*FullBackupSpec) Descriptor

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

Deprecated: Use FullBackupSpec.ProtoReflect.Descriptor instead.

func (*FullBackupSpec) ProtoMessage

func (*FullBackupSpec) ProtoMessage()

func (*FullBackupSpec) ProtoReflect

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

func (*FullBackupSpec) Reset

func (x *FullBackupSpec) Reset()

func (*FullBackupSpec) String

func (x *FullBackupSpec) String() string

GetBackupRequest

type GetBackupRequest struct {

	// Required. Name of the backup.
	// Values are of the form
	// `projects/

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

func (*GetBackupRequest) Descriptor

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

GetBackupScheduleRequest

type GetBackupScheduleRequest struct {

	// Required. The name of the schedule to retrieve.
	// Values are of the form
	// `projects/

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

func (*GetBackupScheduleRequest) Descriptor

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

Deprecated: Use GetBackupScheduleRequest.ProtoReflect.Descriptor instead.

func (*GetBackupScheduleRequest) GetName

func (x *GetBackupScheduleRequest) GetName() string

func (*GetBackupScheduleRequest) ProtoMessage

func (*GetBackupScheduleRequest) ProtoMessage()

func (*GetBackupScheduleRequest) ProtoReflect

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

func (*GetBackupScheduleRequest) Reset

func (x *GetBackupScheduleRequest) Reset()

func (*GetBackupScheduleRequest) String

func (x *GetBackupScheduleRequest) String() string

GetDatabaseDdlRequest

type GetDatabaseDdlRequest struct {

	// Required. The database whose schema we wish to get.
	// Values are of the form
	// `projects/

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

func (*GetDatabaseDdlRequest) Descriptor

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

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"`
	// Proto descriptors stored in the database.
	// Contains a protobuf-serialized
	// [google.protobuf.FileDescriptorSet](https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/descriptor.proto).
	// For more details, see protobuffer [self
	// description](https://developers.google.com/protocol-buffers/docs/techniques#self-description).
	ProtoDescriptors []byte `protobuf:"bytes,2,opt,name=proto_descriptors,json=protoDescriptors,proto3" json:"proto_descriptors,omitempty"`
	// contains filtered or unexported fields
}

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

func (*GetDatabaseDdlResponse) Descriptor

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

Deprecated: Use GetDatabaseDdlResponse.ProtoReflect.Descriptor instead.

func (*GetDatabaseDdlResponse) GetProtoDescriptors

func (x *GetDatabaseDdlResponse) GetProtoDescriptors() []byte

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

GetDatabaseRequest

type GetDatabaseRequest struct {

	// Required. The name of the requested database. Values are of the form
	// `projects/

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

func (*GetDatabaseRequest) Descriptor

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

IncrementalBackupSpec

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

The specification for incremental backup chains. An incremental backup stores the delta of changes between a previous backup and the database contents at a given version time. An incremental backup chain consists of a full backup and zero or more successive incremental backups. The first backup created for an incremental backup chain is always a full backup.

func (*IncrementalBackupSpec) Descriptor

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

Deprecated: Use IncrementalBackupSpec.ProtoReflect.Descriptor instead.

func (*IncrementalBackupSpec) ProtoMessage

func (*IncrementalBackupSpec) ProtoMessage()

func (*IncrementalBackupSpec) ProtoReflect

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

func (*IncrementalBackupSpec) Reset

func (x *IncrementalBackupSpec) Reset()

func (*IncrementalBackupSpec) String

func (x *IncrementalBackupSpec) String() string

ListBackupOperationsRequest

type ListBackupOperationsRequest struct {

	// Required. The instance of the backup operations. Values are of
	// the form `projects/

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

func (*ListBackupOperationsRequest) Descriptor

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 (x *ListBackupOperationsRequest) ProtoReflect() protoreflect.Message

func (*ListBackupOperationsRequest) Reset

func (x *ListBackupOperationsRequest) Reset()

func (*ListBackupOperationsRequest) String

func (x *ListBackupOperationsRequest) String() string

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. The operation's
	// [metadata][google.longrunning.Operation.metadata] field type
	// `metadata.type_url` describes the type of the metadata. Operations returned
	// include those that are pending or have completed/failed/canceled within the
	// last 7 days. Operations returned are ordered by
	// `operation.metadata.value.progress.start_time` in descending order starting
	// from the most recently started operation.
	Operations []*longrunningpb.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

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() []*longrunningpb.Operation

func (*ListBackupOperationsResponse) ProtoMessage

func (*ListBackupOperationsResponse) ProtoMessage()

func (*ListBackupOperationsResponse) ProtoReflect

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

func (*ListBackupOperationsResponse) Reset

func (x *ListBackupOperationsResponse) Reset()

func (*ListBackupOperationsResponse) String

func (x *ListBackupOperationsResponse) String() string

ListBackupSchedulesRequest

type ListBackupSchedulesRequest struct {

	// Required. Database is the parent resource whose backup schedules should be
	// listed. Values are of the form
	// projects/

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

func (*ListBackupSchedulesRequest) Descriptor

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

Deprecated: Use ListBackupSchedulesRequest.ProtoReflect.Descriptor instead.

func (*ListBackupSchedulesRequest) GetPageSize

func (x *ListBackupSchedulesRequest) GetPageSize() int32

func (*ListBackupSchedulesRequest) GetPageToken

func (x *ListBackupSchedulesRequest) GetPageToken() string

func (*ListBackupSchedulesRequest) GetParent

func (x *ListBackupSchedulesRequest) GetParent() string

func (*ListBackupSchedulesRequest) ProtoMessage

func (*ListBackupSchedulesRequest) ProtoMessage()

func (*ListBackupSchedulesRequest) ProtoReflect

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

func (*ListBackupSchedulesRequest) Reset

func (x *ListBackupSchedulesRequest) Reset()

func (*ListBackupSchedulesRequest) String

func (x *ListBackupSchedulesRequest) String() string

ListBackupSchedulesResponse

type ListBackupSchedulesResponse struct {

	// The list of backup schedules for a database.
	BackupSchedules []*BackupSchedule `protobuf:"bytes,1,rep,name=backup_schedules,json=backupSchedules,proto3" json:"backup_schedules,omitempty"`
	// `next_page_token` can be sent in a subsequent
	// [ListBackupSchedules][google.spanner.admin.database.v1.DatabaseAdmin.ListBackupSchedules]
	// call to fetch more of the schedules.
	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 [ListBackupSchedules][google.spanner.admin.database.v1.DatabaseAdmin.ListBackupSchedules].

func (*ListBackupSchedulesResponse) Descriptor

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

Deprecated: Use ListBackupSchedulesResponse.ProtoReflect.Descriptor instead.

func (*ListBackupSchedulesResponse) GetBackupSchedules

func (x *ListBackupSchedulesResponse) GetBackupSchedules() []*BackupSchedule

func (*ListBackupSchedulesResponse) GetNextPageToken

func (x *ListBackupSchedulesResponse) GetNextPageToken() string

func (*ListBackupSchedulesResponse) ProtoMessage

func (*ListBackupSchedulesResponse) ProtoMessage()

func (*ListBackupSchedulesResponse) ProtoReflect

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

func (*ListBackupSchedulesResponse) Reset

func (x *ListBackupSchedulesResponse) Reset()

func (*ListBackupSchedulesResponse) String

func (x *ListBackupSchedulesResponse) String() string

ListBackupsRequest

type ListBackupsRequest struct {

	// Required. The instance to list backups from.  Values are of the
	// form `projects/

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

func (*ListBackupsRequest) Descriptor

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

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

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

ListDatabaseOperationsRequest

type ListDatabaseOperationsRequest struct {

	// Required. The instance of the database operations.
	// Values are of the form `projects/

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

func (*ListDatabaseOperationsRequest) Descriptor

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 (x *ListDatabaseOperationsRequest) ProtoReflect() protoreflect.Message

func (*ListDatabaseOperationsRequest) Reset

func (x *ListDatabaseOperationsRequest) Reset()

func (*ListDatabaseOperationsRequest) String

func (x *ListDatabaseOperationsRequest) String() string

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 []*longrunningpb.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

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

Deprecated: Use ListDatabaseOperationsResponse.ProtoReflect.Descriptor instead.

func (*ListDatabaseOperationsResponse) GetNextPageToken

func (x *ListDatabaseOperationsResponse) GetNextPageToken() string

func (*ListDatabaseOperationsResponse) GetOperations

func (x *ListDatabaseOperationsResponse) GetOperations() []*longrunningpb.Operation

func (*ListDatabaseOperationsResponse) ProtoMessage

func (*ListDatabaseOperationsResponse) ProtoMessage()

func (*ListDatabaseOperationsResponse) ProtoReflect

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

func (*ListDatabaseOperationsResponse) Reset

func (x *ListDatabaseOperationsResponse) Reset()

func (*ListDatabaseOperationsResponse) String

func (x *ListDatabaseOperationsResponse) String() string

ListDatabaseRolesRequest

type ListDatabaseRolesRequest struct {

	// Required. The database whose roles should be listed.
	// Values are of the form
	// `projects/

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

func (*ListDatabaseRolesRequest) Descriptor

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

Deprecated: Use ListDatabaseRolesRequest.ProtoReflect.Descriptor instead.

func (*ListDatabaseRolesRequest) GetPageSize

func (x *ListDatabaseRolesRequest) GetPageSize() int32

func (*ListDatabaseRolesRequest) GetPageToken

func (x *ListDatabaseRolesRequest) GetPageToken() string

func (*ListDatabaseRolesRequest) GetParent

func (x *ListDatabaseRolesRequest) GetParent() string

func (*ListDatabaseRolesRequest) ProtoMessage

func (*ListDatabaseRolesRequest) ProtoMessage()

func (*ListDatabaseRolesRequest) ProtoReflect

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

func (*ListDatabaseRolesRequest) Reset

func (x *ListDatabaseRolesRequest) Reset()

func (*ListDatabaseRolesRequest) String

func (x *ListDatabaseRolesRequest) String() string

ListDatabaseRolesResponse

type ListDatabaseRolesResponse struct {

	// Database roles that matched the request.
	DatabaseRoles []*DatabaseRole `protobuf:"bytes,1,rep,name=database_roles,json=databaseRoles,proto3" json:"database_roles,omitempty"`
	// `next_page_token` can be sent in a subsequent
	// [ListDatabaseRoles][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabaseRoles]
	// call to fetch more of the matching roles.
	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 [ListDatabaseRoles][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabaseRoles].

func (*ListDatabaseRolesResponse) Descriptor

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

Deprecated: Use ListDatabaseRolesResponse.ProtoReflect.Descriptor instead.

func (*ListDatabaseRolesResponse) GetDatabaseRoles

func (x *ListDatabaseRolesResponse) GetDatabaseRoles() []*DatabaseRole

func (*ListDatabaseRolesResponse) GetNextPageToken

func (x *ListDatabaseRolesResponse) GetNextPageToken() string

func (*ListDatabaseRolesResponse) ProtoMessage

func (*ListDatabaseRolesResponse) ProtoMessage()

func (*ListDatabaseRolesResponse) ProtoReflect

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

func (*ListDatabaseRolesResponse) Reset

func (x *ListDatabaseRolesResponse) Reset()

func (*ListDatabaseRolesResponse) String

func (x *ListDatabaseRolesResponse) String() string

ListDatabasesRequest

type ListDatabasesRequest struct {

	// Required. The instance whose databases should be listed.
	// Values are of the form `projects/

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

func (*ListDatabasesRequest) Descriptor

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

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

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

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

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

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

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

Deprecated: Use OptimizeRestoredDatabaseMetadata.ProtoReflect.Descriptor instead.

func (*OptimizeRestoredDatabaseMetadata) GetName

func (x *OptimizeRestoredDatabaseMetadata) GetName() string

func (*OptimizeRestoredDatabaseMetadata) GetProgress

func (x *OptimizeRestoredDatabaseMetadata) GetProgress() *OperationProgress

func (*OptimizeRestoredDatabaseMetadata) ProtoMessage

func (*OptimizeRestoredDatabaseMetadata) ProtoMessage()

func (*OptimizeRestoredDatabaseMetadata) ProtoReflect

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

func (*OptimizeRestoredDatabaseMetadata) Reset

func (x *OptimizeRestoredDatabaseMetadata) Reset()

func (*OptimizeRestoredDatabaseMetadata) String

func (x *OptimizeRestoredDatabaseMetadata) String() string

RestoreDatabaseEncryptionConfig

type RestoreDatabaseEncryptionConfig struct {
	EncryptionType RestoreDatabaseEncryptionConfig_EncryptionType "" /* 189 byte string literal not displayed */

	KmsKeyName string `protobuf:"bytes,2,opt,name=kms_key_name,json=kmsKeyName,proto3" json:"kms_key_name,omitempty"`

	KmsKeyNames []string `protobuf:"bytes,3,rep,name=kms_key_names,json=kmsKeyNames,proto3" json:"kms_key_names,omitempty"`

}

Encryption configuration for the restored database.

func (*RestoreDatabaseEncryptionConfig) Descriptor

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

Deprecated: Use RestoreDatabaseEncryptionConfig.ProtoReflect.Descriptor instead.

func (*RestoreDatabaseEncryptionConfig) GetEncryptionType

func (x *RestoreDatabaseEncryptionConfig) GetEncryptionType() RestoreDatabaseEncryptionConfig_EncryptionType

func (*RestoreDatabaseEncryptionConfig) GetKmsKeyName

func (x *RestoreDatabaseEncryptionConfig) GetKmsKeyName() string

func (*RestoreDatabaseEncryptionConfig) GetKmsKeyNames

func (x *RestoreDatabaseEncryptionConfig) GetKmsKeyNames() []string

func (*RestoreDatabaseEncryptionConfig) ProtoMessage

func (*RestoreDatabaseEncryptionConfig) ProtoMessage()

func (*RestoreDatabaseEncryptionConfig) ProtoReflect

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

func (*RestoreDatabaseEncryptionConfig) Reset

func (x *RestoreDatabaseEncryptionConfig) Reset()

func (*RestoreDatabaseEncryptionConfig) String

func (x *RestoreDatabaseEncryptionConfig) String() string

RestoreDatabaseEncryptionConfig_EncryptionType

type RestoreDatabaseEncryptionConfig_EncryptionType int32

Encryption types for the database to be restored.

RestoreDatabaseEncryptionConfig_ENCRYPTION_TYPE_UNSPECIFIED, RestoreDatabaseEncryptionConfig_USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION, RestoreDatabaseEncryptionConfig_GOOGLE_DEFAULT_ENCRYPTION, RestoreDatabaseEncryptionConfig_CUSTOMER_MANAGED_ENCRYPTION

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) Descriptor() protoreflect.EnumDescriptor

func (RestoreDatabaseEncryptionConfig_EncryptionType) Enum

func (x RestoreDatabaseEncryptionConfig_EncryptionType) Enum() *RestoreDatabaseEncryptionConfig_EncryptionType

func (RestoreDatabaseEncryptionConfig_EncryptionType) EnumDescriptor

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

Deprecated: Use RestoreDatabaseEncryptionConfig_EncryptionType.Descriptor instead.

func (RestoreDatabaseEncryptionConfig_EncryptionType) Number

func (x RestoreDatabaseEncryptionConfig_EncryptionType) Number() protoreflect.EnumNumber

func (RestoreDatabaseEncryptionConfig_EncryptionType) String

func (x RestoreDatabaseEncryptionConfig_EncryptionType) String() string

func (RestoreDatabaseEncryptionConfig_EncryptionType) Type

func (RestoreDatabaseEncryptionConfig_EncryptionType) Type() protoreflect.EnumType

RestoreDatabaseMetadata

type RestoreDatabaseMetadata struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`

	SourceType RestoreSourceType "" /* 148 byte string literal not displayed */

	SourceInfo isRestoreDatabaseMetadata_SourceInfo `protobuf_oneof:"source_info"`

	Progress *OperationProgress `protobuf:"bytes,4,opt,name=progress,proto3" json:"progress,omitempty"`

	CancelTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=cancel_time,json=cancelTime,proto3" json:"cancel_time,omitempty"`

	OptimizeDatabaseOperationName string "" /* 152 byte string literal not displayed */

}

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

func (*RestoreDatabaseMetadata) Descriptor

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

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

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/

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

func (*RestoreDatabaseRequest) Descriptor

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

RestoreDatabaseRequest_Backup

type RestoreDatabaseRequest_Backup struct {
	// Name of the backup from which to restore.  Values are of the form
	// `projects/

RestoreInfo

type RestoreInfo struct {
	SourceType RestoreSourceType "" /* 148 byte string literal not displayed */

	SourceInfo isRestoreInfo_SourceInfo `protobuf_oneof:"source_info"`

}

Information about the database restore.

func (*RestoreInfo) Descriptor

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

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

RestoreSourceType

type RestoreSourceType int32

Indicates the type of the restore source.

RestoreSourceType_TYPE_UNSPECIFIED, RestoreSourceType_BACKUP

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) Descriptor() protoreflect.EnumDescriptor

func (RestoreSourceType) Enum

func (x RestoreSourceType) Enum() *RestoreSourceType

func (RestoreSourceType) EnumDescriptor

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

Deprecated: Use RestoreSourceType.Descriptor instead.

func (RestoreSourceType) Number

func (x RestoreSourceType) Number() protoreflect.EnumNumber

func (RestoreSourceType) String

func (x RestoreSourceType) String() string

func (RestoreSourceType) Type

func (RestoreSourceType) Type() protoreflect.EnumType

UnimplementedDatabaseAdminServer

type UnimplementedDatabaseAdminServer struct {
}

UnimplementedDatabaseAdminServer can be embedded to have forward compatible implementations.

func (*UnimplementedDatabaseAdminServer) CopyBackup

func (*UnimplementedDatabaseAdminServer) CopyBackup(context.Context, *CopyBackupRequest) (*longrunningpb.Operation, error)

func (*UnimplementedDatabaseAdminServer) CreateBackup

func (*UnimplementedDatabaseAdminServer) CreateBackup(context.Context, *CreateBackupRequest) (*longrunningpb.Operation, error)

func (*UnimplementedDatabaseAdminServer) CreateBackupSchedule

func (*UnimplementedDatabaseAdminServer) CreateBackupSchedule(context.Context, *CreateBackupScheduleRequest) (*BackupSchedule, error)

func (*UnimplementedDatabaseAdminServer) CreateDatabase

func (*UnimplementedDatabaseAdminServer) CreateDatabase(context.Context, *CreateDatabaseRequest) (*longrunningpb.Operation, error)

func (*UnimplementedDatabaseAdminServer) DeleteBackup

func (*UnimplementedDatabaseAdminServer) DeleteBackup(context.Context, *DeleteBackupRequest) (*emptypb.Empty, error)

func (*UnimplementedDatabaseAdminServer) DeleteBackupSchedule

func (*UnimplementedDatabaseAdminServer) DeleteBackupSchedule(context.Context, *DeleteBackupScheduleRequest) (*emptypb.Empty, error)

func (*UnimplementedDatabaseAdminServer) DropDatabase

func (*UnimplementedDatabaseAdminServer) DropDatabase(context.Context, *DropDatabaseRequest) (*emptypb.Empty, error)

func (*UnimplementedDatabaseAdminServer) GetBackup

func (*UnimplementedDatabaseAdminServer) GetBackup(context.Context, *GetBackupRequest) (*Backup, error)

func (*UnimplementedDatabaseAdminServer) GetBackupSchedule

func (*UnimplementedDatabaseAdminServer) GetBackupSchedule(context.Context, *GetBackupScheduleRequest) (*BackupSchedule, error)

func (*UnimplementedDatabaseAdminServer) GetDatabase

func (*UnimplementedDatabaseAdminServer) GetDatabase(context.Context, *GetDatabaseRequest) (*Database, error)

func (*UnimplementedDatabaseAdminServer) GetDatabaseDdl

func (*UnimplementedDatabaseAdminServer) GetDatabaseDdl(context.Context, *GetDatabaseDdlRequest) (*GetDatabaseDdlResponse, error)

func (*UnimplementedDatabaseAdminServer) GetIamPolicy

func (*UnimplementedDatabaseAdminServer) GetIamPolicy(context.Context, *iampb.GetIamPolicyRequest) (*iampb.Policy, error)

func (*UnimplementedDatabaseAdminServer) ListBackupOperations

func (*UnimplementedDatabaseAdminServer) ListBackupOperations(context.Context, *ListBackupOperationsRequest) (*ListBackupOperationsResponse, error)

func (*UnimplementedDatabaseAdminServer) ListBackupSchedules

func (*UnimplementedDatabaseAdminServer) ListBackupSchedules(context.Context, *ListBackupSchedulesRequest) (*ListBackupSchedulesResponse, error)

func (*UnimplementedDatabaseAdminServer) ListBackups

func (*UnimplementedDatabaseAdminServer) ListBackups(context.Context, *ListBackupsRequest) (*ListBackupsResponse, error)

func (*UnimplementedDatabaseAdminServer) ListDatabaseOperations

func (*UnimplementedDatabaseAdminServer) ListDatabaseOperations(context.Context, *ListDatabaseOperationsRequest) (*ListDatabaseOperationsResponse, error)

func (*UnimplementedDatabaseAdminServer) ListDatabaseRoles

func (*UnimplementedDatabaseAdminServer) ListDatabaseRoles(context.Context, *ListDatabaseRolesRequest) (*ListDatabaseRolesResponse, error)

func (*UnimplementedDatabaseAdminServer) ListDatabases

func (*UnimplementedDatabaseAdminServer) ListDatabases(context.Context, *ListDatabasesRequest) (*ListDatabasesResponse, error)

func (*UnimplementedDatabaseAdminServer) RestoreDatabase

func (*UnimplementedDatabaseAdminServer) RestoreDatabase(context.Context, *RestoreDatabaseRequest) (*longrunningpb.Operation, error)

func (*UnimplementedDatabaseAdminServer) SetIamPolicy

func (*UnimplementedDatabaseAdminServer) SetIamPolicy(context.Context, *iampb.SetIamPolicyRequest) (*iampb.Policy, error)

func (*UnimplementedDatabaseAdminServer) TestIamPermissions

func (*UnimplementedDatabaseAdminServer) TestIamPermissions(context.Context, *iampb.TestIamPermissionsRequest) (*iampb.TestIamPermissionsResponse, error)

func (*UnimplementedDatabaseAdminServer) UpdateBackup

func (*UnimplementedDatabaseAdminServer) UpdateBackup(context.Context, *UpdateBackupRequest) (*Backup, error)

func (*UnimplementedDatabaseAdminServer) UpdateBackupSchedule

func (*UnimplementedDatabaseAdminServer) UpdateBackupSchedule(context.Context, *UpdateBackupScheduleRequest) (*BackupSchedule, error)

func (*UnimplementedDatabaseAdminServer) UpdateDatabase

func (*UnimplementedDatabaseAdminServer) UpdateDatabase(context.Context, *UpdateDatabaseRequest) (*longrunningpb.Operation, error)

func (*UnimplementedDatabaseAdminServer) UpdateDatabaseDdl

func (*UnimplementedDatabaseAdminServer) UpdateDatabaseDdl(context.Context, *UpdateDatabaseDdlRequest) (*longrunningpb.Operation, error)

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

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

UpdateBackupScheduleRequest

type UpdateBackupScheduleRequest struct {

	// Required. The backup schedule to update. `backup_schedule.name`, and the
	// fields to be updated as specified by `update_mask` are required. Other
	// fields are ignored.
	BackupSchedule *BackupSchedule `protobuf:"bytes,1,opt,name=backup_schedule,json=backupSchedule,proto3" json:"backup_schedule,omitempty"`
	// Required. A mask specifying which fields in the BackupSchedule resource
	// should be updated. This mask is relative to the BackupSchedule resource,
	// not to the request message. The field mask must always be
	// specified; this prevents any future fields from being erased
	// accidentally.
	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 [UpdateBackupScheduleRequest][google.spanner.admin.database.v1.DatabaseAdmin.UpdateBackupSchedule].

func (*UpdateBackupScheduleRequest) Descriptor

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

Deprecated: Use UpdateBackupScheduleRequest.ProtoReflect.Descriptor instead.

func (*UpdateBackupScheduleRequest) GetBackupSchedule

func (x *UpdateBackupScheduleRequest) GetBackupSchedule() *BackupSchedule

func (*UpdateBackupScheduleRequest) GetUpdateMask

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

func (*UpdateBackupScheduleRequest) ProtoMessage

func (*UpdateBackupScheduleRequest) ProtoMessage()

func (*UpdateBackupScheduleRequest) ProtoReflect

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

func (*UpdateBackupScheduleRequest) Reset

func (x *UpdateBackupScheduleRequest) Reset()

func (*UpdateBackupScheduleRequest) String

func (x *UpdateBackupScheduleRequest) String() string

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. All DDL statements will have continuously updating progress,
	// and `progress[i]` is the operation progress for `statements[i]`. Also,
	// `progress[i]` will have start time and end time populated with commit
	// timestamp of operation, as well as a progress of 100% once the operation
	// has completed.
	Progress []*OperationProgress `protobuf:"bytes,5,rep,name=progress,proto3" json:"progress,omitempty"`
	// The brief action info for the DDL statements.
	// `actions[i]` is the brief info for `statements[i]`.
	Actions []*DdlStatementActionInfo `protobuf:"bytes,6,rep,name=actions,proto3" json:"actions,omitempty"`
	// contains filtered or unexported fields
}

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

func (*UpdateDatabaseDdlMetadata) Descriptor

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

Deprecated: Use UpdateDatabaseDdlMetadata.ProtoReflect.Descriptor instead.

func (*UpdateDatabaseDdlMetadata) GetActions

func (x *UpdateDatabaseDdlMetadata) GetActions() []*DdlStatementActionInfo

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 (x *UpdateDatabaseDdlMetadata) ProtoReflect() protoreflect.Message

func (*UpdateDatabaseDdlMetadata) Reset

func (x *UpdateDatabaseDdlMetadata) Reset()

func (*UpdateDatabaseDdlMetadata) String

func (x *UpdateDatabaseDdlMetadata) String() string

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]:
	// `

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

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) GetProtoDescriptors

func (x *UpdateDatabaseDdlRequest) GetProtoDescriptors() []byte

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

UpdateDatabaseMetadata

type UpdateDatabaseMetadata struct {

	// The request for
	// [UpdateDatabase][google.spanner.admin.database.v1.DatabaseAdmin.UpdateDatabase].
	Request *UpdateDatabaseRequest `protobuf:"bytes,1,opt,name=request,proto3" json:"request,omitempty"`
	// The progress of the
	// [UpdateDatabase][google.spanner.admin.database.v1.DatabaseAdmin.UpdateDatabase]
	// operation.
	Progress *OperationProgress `protobuf:"bytes,2,opt,name=progress,proto3" json:"progress,omitempty"`
	// The time at which this operation was cancelled. If set, this operation is
	// in the process of undoing itself (which is best-effort).
	CancelTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=cancel_time,json=cancelTime,proto3" json:"cancel_time,omitempty"`
	// contains filtered or unexported fields
}

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

func (*UpdateDatabaseMetadata) Descriptor

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

Deprecated: Use UpdateDatabaseMetadata.ProtoReflect.Descriptor instead.

func (*UpdateDatabaseMetadata) GetCancelTime

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

func (*UpdateDatabaseMetadata) GetProgress

func (x *UpdateDatabaseMetadata) GetProgress() *OperationProgress

func (*UpdateDatabaseMetadata) GetRequest

func (x *UpdateDatabaseMetadata) GetRequest() *UpdateDatabaseRequest

func (*UpdateDatabaseMetadata) ProtoMessage

func (*UpdateDatabaseMetadata) ProtoMessage()

func (*UpdateDatabaseMetadata) ProtoReflect

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

func (*UpdateDatabaseMetadata) Reset

func (x *UpdateDatabaseMetadata) Reset()

func (*UpdateDatabaseMetadata) String

func (x *UpdateDatabaseMetadata) String() string

UpdateDatabaseRequest

type UpdateDatabaseRequest struct {

	// Required. The database to update.
	// The `name` field of the database is of the form
	// `projects/

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

func (*UpdateDatabaseRequest) Descriptor

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

Deprecated: Use UpdateDatabaseRequest.ProtoReflect.Descriptor instead.

func (*UpdateDatabaseRequest) GetDatabase

func (x *UpdateDatabaseRequest) GetDatabase() *Database

func (*UpdateDatabaseRequest) GetUpdateMask

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

func (*UpdateDatabaseRequest) ProtoMessage

func (*UpdateDatabaseRequest) ProtoMessage()

func (*UpdateDatabaseRequest) ProtoReflect

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

func (*UpdateDatabaseRequest) Reset

func (x *UpdateDatabaseRequest) Reset()

func (*UpdateDatabaseRequest) String

func (x *UpdateDatabaseRequest) String() string