database

package
v0.0.0-...-e165f0f Latest Latest
Warning

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

Go to latest
Published: Sep 1, 2020 License: Apache-2.0 Imports: 13 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var Backup_State_name = map[int32]string{
	0: "STATE_UNSPECIFIED",
	1: "CREATING",
	2: "READY",
}
View Source
var Backup_State_value = map[string]int32{
	"STATE_UNSPECIFIED": 0,
	"CREATING":          1,
	"READY":             2,
}
View Source
var Database_State_name = map[int32]string{
	0: "STATE_UNSPECIFIED",
	1: "CREATING",
	2: "READY",
	3: "READY_OPTIMIZING",
}
View Source
var Database_State_value = map[string]int32{
	"STATE_UNSPECIFIED": 0,
	"CREATING":          1,
	"READY":             2,
	"READY_OPTIMIZING":  3,
}
View Source
var RestoreSourceType_name = map[int32]string{
	0: "TYPE_UNSPECIFIED",
	1: "BACKUP",
}
View Source
var RestoreSourceType_value = map[string]int32{
	"TYPE_UNSPECIFIED": 0,
	"BACKUP":           1,
}

Functions

func RegisterDatabaseAdminServer

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

Types

type Backup

type Backup struct {
	// Required for the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] operation.
	// Name of the database from which this backup was
	// created. This needs to be in the same instance as the backup.
	// Values are of the form
	// `projects/<project>/instances/<instance>/databases/<database>`.
	Database string `protobuf:"bytes,2,opt,name=database,proto3" json:"database,omitempty"`
	// Required for the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup]
	// operation. The expiration time of the backup, with microseconds
	// granularity that must be at least 6 hours and at most 366 days
	// from the time the CreateBackup request is processed. Once the `expire_time`
	// has passed, the backup is eligible to be automatically deleted by Cloud
	// Spanner to free the resources used by the backup.
	ExpireTime *timestamp.Timestamp `protobuf:"bytes,3,opt,name=expire_time,json=expireTime,proto3" json:"expire_time,omitempty"`
	// Output only for the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] operation.
	// Required for the [UpdateBackup][google.spanner.admin.database.v1.DatabaseAdmin.UpdateBackup] operation.
	//
	// A globally unique identifier for the backup which cannot be
	// changed. Values are of the form
	// `projects/<project>/instances/<instance>/backups/[a-z][a-z0-9_\-]*[a-z0-9]`
	// The final segment of the name must be between 2 and 60 characters
	// in length.
	//
	// The backup is stored in the location(s) specified in the instance
	// configuration of the instance containing the backup, identified
	// by the prefix of the backup name of the form
	// `projects/<project>/instances/<instance>`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Output only. The backup will contain an externally consistent
	// copy of the database at the timestamp specified by
	// `create_time`. `create_time` is approximately the time the
	// [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] request is received.
	CreateTime *timestamp.Timestamp `protobuf:"bytes,4,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Size of the backup in bytes.
	SizeBytes int64 `protobuf:"varint,5,opt,name=size_bytes,json=sizeBytes,proto3" json:"size_bytes,omitempty"`
	// Output only. The current state of the backup.
	State Backup_State `protobuf:"varint,6,opt,name=state,proto3,enum=google.spanner.admin.database.v1.Backup_State" json:"state,omitempty"`
	// Output only. The names of the restored databases that reference the backup.
	// The database names are of
	// the form `projects/<project>/instances/<instance>/databases/<database>`.
	// Referencing databases may exist in different instances. The existence of
	// any referencing database prevents the backup from being deleted. When a
	// restored database from the backup enters the `READY` state, the reference
	// to the backup is removed.
	ReferencingDatabases []string `protobuf:"bytes,7,rep,name=referencing_databases,json=referencingDatabases,proto3" json:"referencing_databases,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

A backup of a Cloud Spanner database.

func (*Backup) Descriptor

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

func (*Backup) GetCreateTime

func (m *Backup) GetCreateTime() *timestamp.Timestamp

func (*Backup) GetDatabase

func (m *Backup) GetDatabase() string

func (*Backup) GetExpireTime

func (m *Backup) GetExpireTime() *timestamp.Timestamp

func (*Backup) GetName

func (m *Backup) GetName() string

func (*Backup) GetReferencingDatabases

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

func (*Backup) GetSizeBytes

func (m *Backup) GetSizeBytes() int64

func (*Backup) GetState

func (m *Backup) GetState() Backup_State

func (*Backup) ProtoMessage

func (*Backup) ProtoMessage()

func (*Backup) Reset

func (m *Backup) Reset()

func (*Backup) String

func (m *Backup) String() string

func (*Backup) XXX_DiscardUnknown

func (m *Backup) XXX_DiscardUnknown()

func (*Backup) XXX_Marshal

func (m *Backup) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Backup) XXX_Merge

func (m *Backup) XXX_Merge(src proto.Message)

func (*Backup) XXX_Size

func (m *Backup) XXX_Size() int

func (*Backup) XXX_Unmarshal

func (m *Backup) XXX_Unmarshal(b []byte) error

type BackupInfo

type BackupInfo struct {
	// Name of the backup.
	Backup string `protobuf:"bytes,1,opt,name=backup,proto3" json:"backup,omitempty"`
	// The backup contains an externally consistent copy of `source_database` at
	// the timestamp specified by `create_time`.
	CreateTime *timestamp.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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Information about a backup.

func (*BackupInfo) Descriptor

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

func (*BackupInfo) GetBackup

func (m *BackupInfo) GetBackup() string

func (*BackupInfo) GetCreateTime

func (m *BackupInfo) GetCreateTime() *timestamp.Timestamp

func (*BackupInfo) GetSourceDatabase

func (m *BackupInfo) GetSourceDatabase() string

func (*BackupInfo) ProtoMessage

func (*BackupInfo) ProtoMessage()

func (*BackupInfo) Reset

func (m *BackupInfo) Reset()

func (*BackupInfo) String

func (m *BackupInfo) String() string

func (*BackupInfo) XXX_DiscardUnknown

func (m *BackupInfo) XXX_DiscardUnknown()

func (*BackupInfo) XXX_Marshal

func (m *BackupInfo) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*BackupInfo) XXX_Merge

func (m *BackupInfo) XXX_Merge(src proto.Message)

func (*BackupInfo) XXX_Size

func (m *BackupInfo) XXX_Size() int

func (*BackupInfo) XXX_Unmarshal

func (m *BackupInfo) XXX_Unmarshal(b []byte) error

type Backup_State

type Backup_State int32

Indicates the current state of the backup.

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

func (Backup_State) EnumDescriptor

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

func (Backup_State) String

func (x Backup_State) String() string

type CreateBackupMetadata

type CreateBackupMetadata struct {
	// The name of the backup being created.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The name of the database the backup is created from.
	Database string `protobuf:"bytes,2,opt,name=database,proto3" json:"database,omitempty"`
	// The progress of the
	// [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] operation.
	Progress *OperationProgress `protobuf:"bytes,3,opt,name=progress,proto3" json:"progress,omitempty"`
	// The time at which cancellation of this operation was received.
	// [Operations.CancelOperation][google.longrunning.Operations.CancelOperation]
	// starts asynchronous cancellation on a long-running operation. The server
	// makes a best effort to cancel the operation, but success is not guaranteed.
	// Clients can use
	// [Operations.GetOperation][google.longrunning.Operations.GetOperation] or
	// other methods to check whether the cancellation succeeded or whether the
	// operation completed despite cancellation. On successful cancellation,
	// the operation is not deleted; instead, it becomes an operation with
	// an [Operation.error][] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1,
	// corresponding to `Code.CANCELLED`.
	CancelTime           *timestamp.Timestamp `protobuf:"bytes,4,opt,name=cancel_time,json=cancelTime,proto3" json:"cancel_time,omitempty"`
	XXX_NoUnkeyedLiteral struct{}             `json:"-"`
	XXX_unrecognized     []byte               `json:"-"`
	XXX_sizecache        int32                `json:"-"`
}

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

func (*CreateBackupMetadata) Descriptor

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

func (*CreateBackupMetadata) GetCancelTime

func (m *CreateBackupMetadata) GetCancelTime() *timestamp.Timestamp

func (*CreateBackupMetadata) GetDatabase

func (m *CreateBackupMetadata) GetDatabase() string

func (*CreateBackupMetadata) GetName

func (m *CreateBackupMetadata) GetName() string

func (*CreateBackupMetadata) GetProgress

func (m *CreateBackupMetadata) GetProgress() *OperationProgress

func (*CreateBackupMetadata) ProtoMessage

func (*CreateBackupMetadata) ProtoMessage()

func (*CreateBackupMetadata) Reset

func (m *CreateBackupMetadata) Reset()

func (*CreateBackupMetadata) String

func (m *CreateBackupMetadata) String() string

func (*CreateBackupMetadata) XXX_DiscardUnknown

func (m *CreateBackupMetadata) XXX_DiscardUnknown()

func (*CreateBackupMetadata) XXX_Marshal

func (m *CreateBackupMetadata) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*CreateBackupMetadata) XXX_Merge

func (m *CreateBackupMetadata) XXX_Merge(src proto.Message)

func (*CreateBackupMetadata) XXX_Size

func (m *CreateBackupMetadata) XXX_Size() int

func (*CreateBackupMetadata) XXX_Unmarshal

func (m *CreateBackupMetadata) XXX_Unmarshal(b []byte) error

type CreateBackupRequest

type CreateBackupRequest struct {
	// Required. The name of the instance in which the backup will be
	// created. This must be the same instance that contains the database the
	// backup will be created from. The backup will be stored in the
	// location(s) specified in the instance configuration of this
	// instance. Values are of the form
	// `projects/<project>/instances/<instance>`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The id of the backup to be created. The `backup_id` appended to
	// `parent` forms the full backup name of the form
	// `projects/<project>/instances/<instance>/backups/<backup_id>`.
	BackupId string `protobuf:"bytes,2,opt,name=backup_id,json=backupId,proto3" json:"backup_id,omitempty"`
	// Required. The backup to create.
	Backup               *Backup  `protobuf:"bytes,3,opt,name=backup,proto3" json:"backup,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

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

func (*CreateBackupRequest) Descriptor

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

func (*CreateBackupRequest) GetBackup

func (m *CreateBackupRequest) GetBackup() *Backup

func (*CreateBackupRequest) GetBackupId

func (m *CreateBackupRequest) GetBackupId() string

func (*CreateBackupRequest) GetParent

func (m *CreateBackupRequest) GetParent() string

func (*CreateBackupRequest) ProtoMessage

func (*CreateBackupRequest) ProtoMessage()

func (*CreateBackupRequest) Reset

func (m *CreateBackupRequest) Reset()

func (*CreateBackupRequest) String

func (m *CreateBackupRequest) String() string

func (*CreateBackupRequest) XXX_DiscardUnknown

func (m *CreateBackupRequest) XXX_DiscardUnknown()

func (*CreateBackupRequest) XXX_Marshal

func (m *CreateBackupRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*CreateBackupRequest) XXX_Merge

func (m *CreateBackupRequest) XXX_Merge(src proto.Message)

func (*CreateBackupRequest) XXX_Size

func (m *CreateBackupRequest) XXX_Size() int

func (*CreateBackupRequest) XXX_Unmarshal

func (m *CreateBackupRequest) XXX_Unmarshal(b []byte) error

type CreateDatabaseMetadata

type CreateDatabaseMetadata struct {
	// The database being created.
	Database             string   `protobuf:"bytes,1,opt,name=database,proto3" json:"database,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

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

func (*CreateDatabaseMetadata) Descriptor

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

func (*CreateDatabaseMetadata) GetDatabase

func (m *CreateDatabaseMetadata) GetDatabase() string

func (*CreateDatabaseMetadata) ProtoMessage

func (*CreateDatabaseMetadata) ProtoMessage()

func (*CreateDatabaseMetadata) Reset

func (m *CreateDatabaseMetadata) Reset()

func (*CreateDatabaseMetadata) String

func (m *CreateDatabaseMetadata) String() string

func (*CreateDatabaseMetadata) XXX_DiscardUnknown

func (m *CreateDatabaseMetadata) XXX_DiscardUnknown()

func (*CreateDatabaseMetadata) XXX_Marshal

func (m *CreateDatabaseMetadata) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*CreateDatabaseMetadata) XXX_Merge

func (m *CreateDatabaseMetadata) XXX_Merge(src proto.Message)

func (*CreateDatabaseMetadata) XXX_Size

func (m *CreateDatabaseMetadata) XXX_Size() int

func (*CreateDatabaseMetadata) XXX_Unmarshal

func (m *CreateDatabaseMetadata) XXX_Unmarshal(b []byte) error

type CreateDatabaseRequest

type CreateDatabaseRequest struct {
	// Required. The name of the instance that will serve the new database.
	// Values are of the form `projects/<project>/instances/<instance>`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. A `CREATE DATABASE` statement, which specifies the ID of the
	// new database.  The database ID must conform to the regular expression
	// `[a-z][a-z0-9_\-]*[a-z0-9]` and be between 2 and 30 characters in length.
	// If the database ID is a reserved word or if it contains a hyphen, the
	// database ID must be enclosed in backticks (“ ` “).
	CreateStatement string `protobuf:"bytes,2,opt,name=create_statement,json=createStatement,proto3" json:"create_statement,omitempty"`
	// Optional. A list of DDL statements to run inside the newly created
	// database. Statements can create tables, indexes, etc. These
	// statements execute atomically with the creation of the database:
	// if there is an error in any statement, the database is not created.
	ExtraStatements      []string `protobuf:"bytes,3,rep,name=extra_statements,json=extraStatements,proto3" json:"extra_statements,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

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

func (*CreateDatabaseRequest) Descriptor

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

func (*CreateDatabaseRequest) GetCreateStatement

func (m *CreateDatabaseRequest) GetCreateStatement() string

func (*CreateDatabaseRequest) GetExtraStatements

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

func (*CreateDatabaseRequest) GetParent

func (m *CreateDatabaseRequest) GetParent() string

func (*CreateDatabaseRequest) ProtoMessage

func (*CreateDatabaseRequest) ProtoMessage()

func (*CreateDatabaseRequest) Reset

func (m *CreateDatabaseRequest) Reset()

func (*CreateDatabaseRequest) String

func (m *CreateDatabaseRequest) String() string

func (*CreateDatabaseRequest) XXX_DiscardUnknown

func (m *CreateDatabaseRequest) XXX_DiscardUnknown()

func (*CreateDatabaseRequest) XXX_Marshal

func (m *CreateDatabaseRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*CreateDatabaseRequest) XXX_Merge

func (m *CreateDatabaseRequest) XXX_Merge(src proto.Message)

func (*CreateDatabaseRequest) XXX_Size

func (m *CreateDatabaseRequest) XXX_Size() int

func (*CreateDatabaseRequest) XXX_Unmarshal

func (m *CreateDatabaseRequest) XXX_Unmarshal(b []byte) error

type Database

type Database struct {
	// Required. The name of the database. Values are of the form
	// `projects/<project>/instances/<instance>/databases/<database>`,
	// where `<database>` is as specified in the `CREATE DATABASE`
	// statement. This name can be passed to other API methods to
	// identify the database.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Output only. The current database state.
	State Database_State `protobuf:"varint,2,opt,name=state,proto3,enum=google.spanner.admin.database.v1.Database_State" json:"state,omitempty"`
	// Output only. If exists, the time at which the database creation started.
	CreateTime *timestamp.Timestamp `protobuf:"bytes,3,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Applicable only for restored databases. Contains information
	// about the restore source.
	RestoreInfo          *RestoreInfo `protobuf:"bytes,4,opt,name=restore_info,json=restoreInfo,proto3" json:"restore_info,omitempty"`
	XXX_NoUnkeyedLiteral struct{}     `json:"-"`
	XXX_unrecognized     []byte       `json:"-"`
	XXX_sizecache        int32        `json:"-"`
}

A Cloud Spanner database.

func (*Database) Descriptor

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

func (*Database) GetCreateTime

func (m *Database) GetCreateTime() *timestamp.Timestamp

func (*Database) GetName

func (m *Database) GetName() string

func (*Database) GetRestoreInfo

func (m *Database) GetRestoreInfo() *RestoreInfo

func (*Database) GetState

func (m *Database) GetState() Database_State

func (*Database) ProtoMessage

func (*Database) ProtoMessage()

func (*Database) Reset

func (m *Database) Reset()

func (*Database) String

func (m *Database) String() string

func (*Database) XXX_DiscardUnknown

func (m *Database) XXX_DiscardUnknown()

func (*Database) XXX_Marshal

func (m *Database) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Database) XXX_Merge

func (m *Database) XXX_Merge(src proto.Message)

func (*Database) XXX_Size

func (m *Database) XXX_Size() int

func (*Database) XXX_Unmarshal

func (m *Database) XXX_Unmarshal(b []byte) error

type DatabaseAdminClient

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

DatabaseAdminClient is the client API for DatabaseAdmin service.

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

type DatabaseAdminServer

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

DatabaseAdminServer is the server API for DatabaseAdmin service.

type Database_State

type Database_State int32

Indicates the current state of the database.

const (
	// Not specified.
	Database_STATE_UNSPECIFIED Database_State = 0
	// The database is still being created. Operations on the database may fail
	// with `FAILED_PRECONDITION` in this state.
	Database_CREATING Database_State = 1
	// The database is fully created and ready for use.
	Database_READY Database_State = 2
	// The database is fully created and ready for use, but is still
	// being optimized for performance and cannot handle full load.
	//
	// In this state, the database still references the backup
	// it was restore from, preventing the backup
	// from being deleted. When optimizations are complete, the full performance
	// of the database will be restored, and the database will transition to
	// `READY` state.
	Database_READY_OPTIMIZING Database_State = 3
)

func (Database_State) EnumDescriptor

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

func (Database_State) String

func (x Database_State) String() string

type DeleteBackupRequest

type DeleteBackupRequest struct {
	// Required. Name of the backup to delete.
	// Values are of the form
	// `projects/<project>/instances/<instance>/backups/<backup>`.
	Name                 string   `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

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

func (*DeleteBackupRequest) Descriptor

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

func (*DeleteBackupRequest) GetName

func (m *DeleteBackupRequest) GetName() string

func (*DeleteBackupRequest) ProtoMessage

func (*DeleteBackupRequest) ProtoMessage()

func (*DeleteBackupRequest) Reset

func (m *DeleteBackupRequest) Reset()

func (*DeleteBackupRequest) String

func (m *DeleteBackupRequest) String() string

func (*DeleteBackupRequest) XXX_DiscardUnknown

func (m *DeleteBackupRequest) XXX_DiscardUnknown()

func (*DeleteBackupRequest) XXX_Marshal

func (m *DeleteBackupRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*DeleteBackupRequest) XXX_Merge

func (m *DeleteBackupRequest) XXX_Merge(src proto.Message)

func (*DeleteBackupRequest) XXX_Size

func (m *DeleteBackupRequest) XXX_Size() int

func (*DeleteBackupRequest) XXX_Unmarshal

func (m *DeleteBackupRequest) XXX_Unmarshal(b []byte) error

type DropDatabaseRequest

type DropDatabaseRequest struct {
	// Required. The database to be dropped.
	Database             string   `protobuf:"bytes,1,opt,name=database,proto3" json:"database,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

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

func (*DropDatabaseRequest) Descriptor

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

func (*DropDatabaseRequest) GetDatabase

func (m *DropDatabaseRequest) GetDatabase() string

func (*DropDatabaseRequest) ProtoMessage

func (*DropDatabaseRequest) ProtoMessage()

func (*DropDatabaseRequest) Reset

func (m *DropDatabaseRequest) Reset()

func (*DropDatabaseRequest) String

func (m *DropDatabaseRequest) String() string

func (*DropDatabaseRequest) XXX_DiscardUnknown

func (m *DropDatabaseRequest) XXX_DiscardUnknown()

func (*DropDatabaseRequest) XXX_Marshal

func (m *DropDatabaseRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*DropDatabaseRequest) XXX_Merge

func (m *DropDatabaseRequest) XXX_Merge(src proto.Message)

func (*DropDatabaseRequest) XXX_Size

func (m *DropDatabaseRequest) XXX_Size() int

func (*DropDatabaseRequest) XXX_Unmarshal

func (m *DropDatabaseRequest) XXX_Unmarshal(b []byte) error

type GetBackupRequest

type GetBackupRequest struct {
	// Required. Name of the backup.
	// Values are of the form
	// `projects/<project>/instances/<instance>/backups/<backup>`.
	Name                 string   `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

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

func (*GetBackupRequest) Descriptor

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

func (*GetBackupRequest) GetName

func (m *GetBackupRequest) GetName() string

func (*GetBackupRequest) ProtoMessage

func (*GetBackupRequest) ProtoMessage()

func (*GetBackupRequest) Reset

func (m *GetBackupRequest) Reset()

func (*GetBackupRequest) String

func (m *GetBackupRequest) String() string

func (*GetBackupRequest) XXX_DiscardUnknown

func (m *GetBackupRequest) XXX_DiscardUnknown()

func (*GetBackupRequest) XXX_Marshal

func (m *GetBackupRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*GetBackupRequest) XXX_Merge

func (m *GetBackupRequest) XXX_Merge(src proto.Message)

func (*GetBackupRequest) XXX_Size

func (m *GetBackupRequest) XXX_Size() int

func (*GetBackupRequest) XXX_Unmarshal

func (m *GetBackupRequest) XXX_Unmarshal(b []byte) error

type GetDatabaseDdlRequest

type GetDatabaseDdlRequest struct {
	// Required. The database whose schema we wish to get.
	Database             string   `protobuf:"bytes,1,opt,name=database,proto3" json:"database,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

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

func (*GetDatabaseDdlRequest) Descriptor

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

func (*GetDatabaseDdlRequest) GetDatabase

func (m *GetDatabaseDdlRequest) GetDatabase() string

func (*GetDatabaseDdlRequest) ProtoMessage

func (*GetDatabaseDdlRequest) ProtoMessage()

func (*GetDatabaseDdlRequest) Reset

func (m *GetDatabaseDdlRequest) Reset()

func (*GetDatabaseDdlRequest) String

func (m *GetDatabaseDdlRequest) String() string

func (*GetDatabaseDdlRequest) XXX_DiscardUnknown

func (m *GetDatabaseDdlRequest) XXX_DiscardUnknown()

func (*GetDatabaseDdlRequest) XXX_Marshal

func (m *GetDatabaseDdlRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*GetDatabaseDdlRequest) XXX_Merge

func (m *GetDatabaseDdlRequest) XXX_Merge(src proto.Message)

func (*GetDatabaseDdlRequest) XXX_Size

func (m *GetDatabaseDdlRequest) XXX_Size() int

func (*GetDatabaseDdlRequest) XXX_Unmarshal

func (m *GetDatabaseDdlRequest) XXX_Unmarshal(b []byte) error

type GetDatabaseDdlResponse

type GetDatabaseDdlResponse struct {
	// A list of formatted DDL statements defining the schema of the database
	// specified in the request.
	Statements           []string `protobuf:"bytes,1,rep,name=statements,proto3" json:"statements,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

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

func (*GetDatabaseDdlResponse) Descriptor

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

func (*GetDatabaseDdlResponse) GetStatements

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

func (*GetDatabaseDdlResponse) ProtoMessage

func (*GetDatabaseDdlResponse) ProtoMessage()

func (*GetDatabaseDdlResponse) Reset

func (m *GetDatabaseDdlResponse) Reset()

func (*GetDatabaseDdlResponse) String

func (m *GetDatabaseDdlResponse) String() string

func (*GetDatabaseDdlResponse) XXX_DiscardUnknown

func (m *GetDatabaseDdlResponse) XXX_DiscardUnknown()

func (*GetDatabaseDdlResponse) XXX_Marshal

func (m *GetDatabaseDdlResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*GetDatabaseDdlResponse) XXX_Merge

func (m *GetDatabaseDdlResponse) XXX_Merge(src proto.Message)

func (*GetDatabaseDdlResponse) XXX_Size

func (m *GetDatabaseDdlResponse) XXX_Size() int

func (*GetDatabaseDdlResponse) XXX_Unmarshal

func (m *GetDatabaseDdlResponse) XXX_Unmarshal(b []byte) error

type GetDatabaseRequest

type GetDatabaseRequest struct {
	// Required. The name of the requested database. Values are of the form
	// `projects/<project>/instances/<instance>/databases/<database>`.
	Name                 string   `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

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

func (*GetDatabaseRequest) Descriptor

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

func (*GetDatabaseRequest) GetName

func (m *GetDatabaseRequest) GetName() string

func (*GetDatabaseRequest) ProtoMessage

func (*GetDatabaseRequest) ProtoMessage()

func (*GetDatabaseRequest) Reset

func (m *GetDatabaseRequest) Reset()

func (*GetDatabaseRequest) String

func (m *GetDatabaseRequest) String() string

func (*GetDatabaseRequest) XXX_DiscardUnknown

func (m *GetDatabaseRequest) XXX_DiscardUnknown()

func (*GetDatabaseRequest) XXX_Marshal

func (m *GetDatabaseRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*GetDatabaseRequest) XXX_Merge

func (m *GetDatabaseRequest) XXX_Merge(src proto.Message)

func (*GetDatabaseRequest) XXX_Size

func (m *GetDatabaseRequest) XXX_Size() int

func (*GetDatabaseRequest) XXX_Unmarshal

func (m *GetDatabaseRequest) XXX_Unmarshal(b []byte) error

type ListBackupOperationsRequest

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

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

func (*ListBackupOperationsRequest) Descriptor

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

func (*ListBackupOperationsRequest) GetFilter

func (m *ListBackupOperationsRequest) GetFilter() string

func (*ListBackupOperationsRequest) GetPageSize

func (m *ListBackupOperationsRequest) GetPageSize() int32

func (*ListBackupOperationsRequest) GetPageToken

func (m *ListBackupOperationsRequest) GetPageToken() string

func (*ListBackupOperationsRequest) GetParent

func (m *ListBackupOperationsRequest) GetParent() string

func (*ListBackupOperationsRequest) ProtoMessage

func (*ListBackupOperationsRequest) ProtoMessage()

func (*ListBackupOperationsRequest) Reset

func (m *ListBackupOperationsRequest) Reset()

func (*ListBackupOperationsRequest) String

func (m *ListBackupOperationsRequest) String() string

func (*ListBackupOperationsRequest) XXX_DiscardUnknown

func (m *ListBackupOperationsRequest) XXX_DiscardUnknown()

func (*ListBackupOperationsRequest) XXX_Marshal

func (m *ListBackupOperationsRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ListBackupOperationsRequest) XXX_Merge

func (m *ListBackupOperationsRequest) XXX_Merge(src proto.Message)

func (*ListBackupOperationsRequest) XXX_Size

func (m *ListBackupOperationsRequest) XXX_Size() int

func (*ListBackupOperationsRequest) XXX_Unmarshal

func (m *ListBackupOperationsRequest) XXX_Unmarshal(b []byte) error

type ListBackupOperationsResponse

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

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

func (*ListBackupOperationsResponse) Descriptor

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

func (*ListBackupOperationsResponse) GetNextPageToken

func (m *ListBackupOperationsResponse) GetNextPageToken() string

func (*ListBackupOperationsResponse) GetOperations

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

func (*ListBackupOperationsResponse) ProtoMessage

func (*ListBackupOperationsResponse) ProtoMessage()

func (*ListBackupOperationsResponse) Reset

func (m *ListBackupOperationsResponse) Reset()

func (*ListBackupOperationsResponse) String

func (*ListBackupOperationsResponse) XXX_DiscardUnknown

func (m *ListBackupOperationsResponse) XXX_DiscardUnknown()

func (*ListBackupOperationsResponse) XXX_Marshal

func (m *ListBackupOperationsResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ListBackupOperationsResponse) XXX_Merge

func (m *ListBackupOperationsResponse) XXX_Merge(src proto.Message)

func (*ListBackupOperationsResponse) XXX_Size

func (m *ListBackupOperationsResponse) XXX_Size() int

func (*ListBackupOperationsResponse) XXX_Unmarshal

func (m *ListBackupOperationsResponse) XXX_Unmarshal(b []byte) error

type ListBackupsRequest

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

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

func (*ListBackupsRequest) Descriptor

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

func (*ListBackupsRequest) GetFilter

func (m *ListBackupsRequest) GetFilter() string

func (*ListBackupsRequest) GetPageSize

func (m *ListBackupsRequest) GetPageSize() int32

func (*ListBackupsRequest) GetPageToken

func (m *ListBackupsRequest) GetPageToken() string

func (*ListBackupsRequest) GetParent

func (m *ListBackupsRequest) GetParent() string

func (*ListBackupsRequest) ProtoMessage

func (*ListBackupsRequest) ProtoMessage()

func (*ListBackupsRequest) Reset

func (m *ListBackupsRequest) Reset()

func (*ListBackupsRequest) String

func (m *ListBackupsRequest) String() string

func (*ListBackupsRequest) XXX_DiscardUnknown

func (m *ListBackupsRequest) XXX_DiscardUnknown()

func (*ListBackupsRequest) XXX_Marshal

func (m *ListBackupsRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ListBackupsRequest) XXX_Merge

func (m *ListBackupsRequest) XXX_Merge(src proto.Message)

func (*ListBackupsRequest) XXX_Size

func (m *ListBackupsRequest) XXX_Size() int

func (*ListBackupsRequest) XXX_Unmarshal

func (m *ListBackupsRequest) XXX_Unmarshal(b []byte) error

type ListBackupsResponse

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

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

func (*ListBackupsResponse) Descriptor

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

func (*ListBackupsResponse) GetBackups

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

func (*ListBackupsResponse) GetNextPageToken

func (m *ListBackupsResponse) GetNextPageToken() string

func (*ListBackupsResponse) ProtoMessage

func (*ListBackupsResponse) ProtoMessage()

func (*ListBackupsResponse) Reset

func (m *ListBackupsResponse) Reset()

func (*ListBackupsResponse) String

func (m *ListBackupsResponse) String() string

func (*ListBackupsResponse) XXX_DiscardUnknown

func (m *ListBackupsResponse) XXX_DiscardUnknown()

func (*ListBackupsResponse) XXX_Marshal

func (m *ListBackupsResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ListBackupsResponse) XXX_Merge

func (m *ListBackupsResponse) XXX_Merge(src proto.Message)

func (*ListBackupsResponse) XXX_Size

func (m *ListBackupsResponse) XXX_Size() int

func (*ListBackupsResponse) XXX_Unmarshal

func (m *ListBackupsResponse) XXX_Unmarshal(b []byte) error

type ListDatabaseOperationsRequest

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

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

func (*ListDatabaseOperationsRequest) Descriptor

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

func (*ListDatabaseOperationsRequest) GetFilter

func (m *ListDatabaseOperationsRequest) GetFilter() string

func (*ListDatabaseOperationsRequest) GetPageSize

func (m *ListDatabaseOperationsRequest) GetPageSize() int32

func (*ListDatabaseOperationsRequest) GetPageToken

func (m *ListDatabaseOperationsRequest) GetPageToken() string

func (*ListDatabaseOperationsRequest) GetParent

func (m *ListDatabaseOperationsRequest) GetParent() string

func (*ListDatabaseOperationsRequest) ProtoMessage

func (*ListDatabaseOperationsRequest) ProtoMessage()

func (*ListDatabaseOperationsRequest) Reset

func (m *ListDatabaseOperationsRequest) Reset()

func (*ListDatabaseOperationsRequest) String

func (*ListDatabaseOperationsRequest) XXX_DiscardUnknown

func (m *ListDatabaseOperationsRequest) XXX_DiscardUnknown()

func (*ListDatabaseOperationsRequest) XXX_Marshal

func (m *ListDatabaseOperationsRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ListDatabaseOperationsRequest) XXX_Merge

func (m *ListDatabaseOperationsRequest) XXX_Merge(src proto.Message)

func (*ListDatabaseOperationsRequest) XXX_Size

func (m *ListDatabaseOperationsRequest) XXX_Size() int

func (*ListDatabaseOperationsRequest) XXX_Unmarshal

func (m *ListDatabaseOperationsRequest) XXX_Unmarshal(b []byte) error

type ListDatabaseOperationsResponse

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

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

func (*ListDatabaseOperationsResponse) Descriptor

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

func (*ListDatabaseOperationsResponse) GetNextPageToken

func (m *ListDatabaseOperationsResponse) GetNextPageToken() string

func (*ListDatabaseOperationsResponse) GetOperations

func (*ListDatabaseOperationsResponse) ProtoMessage

func (*ListDatabaseOperationsResponse) ProtoMessage()

func (*ListDatabaseOperationsResponse) Reset

func (m *ListDatabaseOperationsResponse) Reset()

func (*ListDatabaseOperationsResponse) String

func (*ListDatabaseOperationsResponse) XXX_DiscardUnknown

func (m *ListDatabaseOperationsResponse) XXX_DiscardUnknown()

func (*ListDatabaseOperationsResponse) XXX_Marshal

func (m *ListDatabaseOperationsResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ListDatabaseOperationsResponse) XXX_Merge

func (m *ListDatabaseOperationsResponse) XXX_Merge(src proto.Message)

func (*ListDatabaseOperationsResponse) XXX_Size

func (m *ListDatabaseOperationsResponse) XXX_Size() int

func (*ListDatabaseOperationsResponse) XXX_Unmarshal

func (m *ListDatabaseOperationsResponse) XXX_Unmarshal(b []byte) error

type ListDatabasesRequest

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

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

func (*ListDatabasesRequest) Descriptor

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

func (*ListDatabasesRequest) GetPageSize

func (m *ListDatabasesRequest) GetPageSize() int32

func (*ListDatabasesRequest) GetPageToken

func (m *ListDatabasesRequest) GetPageToken() string

func (*ListDatabasesRequest) GetParent

func (m *ListDatabasesRequest) GetParent() string

func (*ListDatabasesRequest) ProtoMessage

func (*ListDatabasesRequest) ProtoMessage()

func (*ListDatabasesRequest) Reset

func (m *ListDatabasesRequest) Reset()

func (*ListDatabasesRequest) String

func (m *ListDatabasesRequest) String() string

func (*ListDatabasesRequest) XXX_DiscardUnknown

func (m *ListDatabasesRequest) XXX_DiscardUnknown()

func (*ListDatabasesRequest) XXX_Marshal

func (m *ListDatabasesRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ListDatabasesRequest) XXX_Merge

func (m *ListDatabasesRequest) XXX_Merge(src proto.Message)

func (*ListDatabasesRequest) XXX_Size

func (m *ListDatabasesRequest) XXX_Size() int

func (*ListDatabasesRequest) XXX_Unmarshal

func (m *ListDatabasesRequest) XXX_Unmarshal(b []byte) error

type ListDatabasesResponse

type ListDatabasesResponse struct {
	// Databases that matched the request.
	Databases []*Database `protobuf:"bytes,1,rep,name=databases,proto3" json:"databases,omitempty"`
	// `next_page_token` can be sent in a subsequent
	// [ListDatabases][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabases] call to fetch more
	// of the matching databases.
	NextPageToken        string   `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

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

func (*ListDatabasesResponse) Descriptor

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

func (*ListDatabasesResponse) GetDatabases

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

func (*ListDatabasesResponse) GetNextPageToken

func (m *ListDatabasesResponse) GetNextPageToken() string

func (*ListDatabasesResponse) ProtoMessage

func (*ListDatabasesResponse) ProtoMessage()

func (*ListDatabasesResponse) Reset

func (m *ListDatabasesResponse) Reset()

func (*ListDatabasesResponse) String

func (m *ListDatabasesResponse) String() string

func (*ListDatabasesResponse) XXX_DiscardUnknown

func (m *ListDatabasesResponse) XXX_DiscardUnknown()

func (*ListDatabasesResponse) XXX_Marshal

func (m *ListDatabasesResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ListDatabasesResponse) XXX_Merge

func (m *ListDatabasesResponse) XXX_Merge(src proto.Message)

func (*ListDatabasesResponse) XXX_Size

func (m *ListDatabasesResponse) XXX_Size() int

func (*ListDatabasesResponse) XXX_Unmarshal

func (m *ListDatabasesResponse) XXX_Unmarshal(b []byte) error

type OperationProgress

type OperationProgress struct {
	// Percent completion of the operation.
	// Values are between 0 and 100 inclusive.
	ProgressPercent int32 `protobuf:"varint,1,opt,name=progress_percent,json=progressPercent,proto3" json:"progress_percent,omitempty"`
	// Time the request was received.
	StartTime *timestamp.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              *timestamp.Timestamp `protobuf:"bytes,3,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
	XXX_NoUnkeyedLiteral struct{}             `json:"-"`
	XXX_unrecognized     []byte               `json:"-"`
	XXX_sizecache        int32                `json:"-"`
}

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

func (*OperationProgress) Descriptor

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

func (*OperationProgress) GetEndTime

func (m *OperationProgress) GetEndTime() *timestamp.Timestamp

func (*OperationProgress) GetProgressPercent

func (m *OperationProgress) GetProgressPercent() int32

func (*OperationProgress) GetStartTime

func (m *OperationProgress) GetStartTime() *timestamp.Timestamp

func (*OperationProgress) ProtoMessage

func (*OperationProgress) ProtoMessage()

func (*OperationProgress) Reset

func (m *OperationProgress) Reset()

func (*OperationProgress) String

func (m *OperationProgress) String() string

func (*OperationProgress) XXX_DiscardUnknown

func (m *OperationProgress) XXX_DiscardUnknown()

func (*OperationProgress) XXX_Marshal

func (m *OperationProgress) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*OperationProgress) XXX_Merge

func (m *OperationProgress) XXX_Merge(src proto.Message)

func (*OperationProgress) XXX_Size

func (m *OperationProgress) XXX_Size() int

func (*OperationProgress) XXX_Unmarshal

func (m *OperationProgress) XXX_Unmarshal(b []byte) error

type OptimizeRestoredDatabaseMetadata

type OptimizeRestoredDatabaseMetadata struct {
	// Name of the restored database being optimized.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The progress of the post-restore optimizations.
	Progress             *OperationProgress `protobuf:"bytes,2,opt,name=progress,proto3" json:"progress,omitempty"`
	XXX_NoUnkeyedLiteral struct{}           `json:"-"`
	XXX_unrecognized     []byte             `json:"-"`
	XXX_sizecache        int32              `json:"-"`
}

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)

func (*OptimizeRestoredDatabaseMetadata) GetName

func (*OptimizeRestoredDatabaseMetadata) GetProgress

func (*OptimizeRestoredDatabaseMetadata) ProtoMessage

func (*OptimizeRestoredDatabaseMetadata) ProtoMessage()

func (*OptimizeRestoredDatabaseMetadata) Reset

func (*OptimizeRestoredDatabaseMetadata) String

func (*OptimizeRestoredDatabaseMetadata) XXX_DiscardUnknown

func (m *OptimizeRestoredDatabaseMetadata) XXX_DiscardUnknown()

func (*OptimizeRestoredDatabaseMetadata) XXX_Marshal

func (m *OptimizeRestoredDatabaseMetadata) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*OptimizeRestoredDatabaseMetadata) XXX_Merge

func (*OptimizeRestoredDatabaseMetadata) XXX_Size

func (m *OptimizeRestoredDatabaseMetadata) XXX_Size() int

func (*OptimizeRestoredDatabaseMetadata) XXX_Unmarshal

func (m *OptimizeRestoredDatabaseMetadata) XXX_Unmarshal(b []byte) error

type RestoreDatabaseMetadata

type RestoreDatabaseMetadata struct {
	// Name of the database being created and restored to.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The type of the restore source.
	SourceType RestoreSourceType `` /* 148-byte string literal not displayed */
	// Information about the source used to restore the database, as specified by
	// `source` in [RestoreDatabaseRequest][google.spanner.admin.database.v1.RestoreDatabaseRequest].
	//
	// Types that are valid to be assigned to SourceInfo:
	//	*RestoreDatabaseMetadata_BackupInfo
	SourceInfo isRestoreDatabaseMetadata_SourceInfo `protobuf_oneof:"source_info"`
	// The progress of the
	// [RestoreDatabase][google.spanner.admin.database.v1.DatabaseAdmin.RestoreDatabase]
	// operation.
	Progress *OperationProgress `protobuf:"bytes,4,opt,name=progress,proto3" json:"progress,omitempty"`
	// The time at which cancellation of this operation was received.
	// [Operations.CancelOperation][google.longrunning.Operations.CancelOperation]
	// starts asynchronous cancellation on a long-running operation. The server
	// makes a best effort to cancel the operation, but success is not guaranteed.
	// Clients can use
	// [Operations.GetOperation][google.longrunning.Operations.GetOperation] or
	// other methods to check whether the cancellation succeeded or whether the
	// operation completed despite cancellation. On successful cancellation,
	// the operation is not deleted; instead, it becomes an operation with
	// an [Operation.error][google.longrunning.Operation.error] value with a
	// [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`.
	CancelTime *timestamp.Timestamp `protobuf:"bytes,5,opt,name=cancel_time,json=cancelTime,proto3" json:"cancel_time,omitempty"`
	// If exists, the name of the long-running operation that will be used to
	// track the post-restore optimization process to optimize the performance of
	// the restored database, and remove the dependency on the restore source.
	// The name is of the form
	// `projects/<project>/instances/<instance>/databases/<database>/operations/<operation>`
	// where the <database> is the name of database being created and restored to.
	// The metadata type of the  long-running operation is
	// [OptimizeRestoredDatabaseMetadata][google.spanner.admin.database.v1.OptimizeRestoredDatabaseMetadata]. This long-running operation will be
	// automatically created by the system after the RestoreDatabase long-running
	// operation completes successfully. This operation will not be created if the
	// restore was not successful.
	OptimizeDatabaseOperationName string   `` /* 152-byte string literal not displayed */
	XXX_NoUnkeyedLiteral          struct{} `json:"-"`
	XXX_unrecognized              []byte   `json:"-"`
	XXX_sizecache                 int32    `json:"-"`
}

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)

func (*RestoreDatabaseMetadata) GetBackupInfo

func (m *RestoreDatabaseMetadata) GetBackupInfo() *BackupInfo

func (*RestoreDatabaseMetadata) GetCancelTime

func (m *RestoreDatabaseMetadata) GetCancelTime() *timestamp.Timestamp

func (*RestoreDatabaseMetadata) GetName

func (m *RestoreDatabaseMetadata) GetName() string

func (*RestoreDatabaseMetadata) GetOptimizeDatabaseOperationName

func (m *RestoreDatabaseMetadata) GetOptimizeDatabaseOperationName() string

func (*RestoreDatabaseMetadata) GetProgress

func (m *RestoreDatabaseMetadata) GetProgress() *OperationProgress

func (*RestoreDatabaseMetadata) GetSourceInfo

func (m *RestoreDatabaseMetadata) GetSourceInfo() isRestoreDatabaseMetadata_SourceInfo

func (*RestoreDatabaseMetadata) GetSourceType

func (m *RestoreDatabaseMetadata) GetSourceType() RestoreSourceType

func (*RestoreDatabaseMetadata) ProtoMessage

func (*RestoreDatabaseMetadata) ProtoMessage()

func (*RestoreDatabaseMetadata) Reset

func (m *RestoreDatabaseMetadata) Reset()

func (*RestoreDatabaseMetadata) String

func (m *RestoreDatabaseMetadata) String() string

func (*RestoreDatabaseMetadata) XXX_DiscardUnknown

func (m *RestoreDatabaseMetadata) XXX_DiscardUnknown()

func (*RestoreDatabaseMetadata) XXX_Marshal

func (m *RestoreDatabaseMetadata) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*RestoreDatabaseMetadata) XXX_Merge

func (m *RestoreDatabaseMetadata) XXX_Merge(src proto.Message)

func (*RestoreDatabaseMetadata) XXX_OneofWrappers

func (*RestoreDatabaseMetadata) XXX_OneofWrappers() []interface{}

XXX_OneofWrappers is for the internal use of the proto package.

func (*RestoreDatabaseMetadata) XXX_Size

func (m *RestoreDatabaseMetadata) XXX_Size() int

func (*RestoreDatabaseMetadata) XXX_Unmarshal

func (m *RestoreDatabaseMetadata) XXX_Unmarshal(b []byte) error

type RestoreDatabaseMetadata_BackupInfo

type RestoreDatabaseMetadata_BackupInfo struct {
	BackupInfo *BackupInfo `protobuf:"bytes,3,opt,name=backup_info,json=backupInfo,proto3,oneof"`
}

type RestoreDatabaseRequest

type RestoreDatabaseRequest struct {
	// Required. The name of the instance in which to create the
	// restored database. This instance must be in the same project and
	// have the same instance configuration as the instance containing
	// the source backup. Values are of the form
	// `projects/<project>/instances/<instance>`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The id of the database to create and restore to. This
	// database must not already exist. The `database_id` appended to
	// `parent` forms the full database name of the form
	// `projects/<project>/instances/<instance>/databases/<database_id>`.
	DatabaseId string `protobuf:"bytes,2,opt,name=database_id,json=databaseId,proto3" json:"database_id,omitempty"`
	// Required. The source from which to restore.
	//
	// Types that are valid to be assigned to Source:
	//	*RestoreDatabaseRequest_Backup
	Source               isRestoreDatabaseRequest_Source `protobuf_oneof:"source"`
	XXX_NoUnkeyedLiteral struct{}                        `json:"-"`
	XXX_unrecognized     []byte                          `json:"-"`
	XXX_sizecache        int32                           `json:"-"`
}

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

func (*RestoreDatabaseRequest) Descriptor

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

func (*RestoreDatabaseRequest) GetBackup

func (m *RestoreDatabaseRequest) GetBackup() string

func (*RestoreDatabaseRequest) GetDatabaseId

func (m *RestoreDatabaseRequest) GetDatabaseId() string

func (*RestoreDatabaseRequest) GetParent

func (m *RestoreDatabaseRequest) GetParent() string

func (*RestoreDatabaseRequest) GetSource

func (m *RestoreDatabaseRequest) GetSource() isRestoreDatabaseRequest_Source

func (*RestoreDatabaseRequest) ProtoMessage

func (*RestoreDatabaseRequest) ProtoMessage()

func (*RestoreDatabaseRequest) Reset

func (m *RestoreDatabaseRequest) Reset()

func (*RestoreDatabaseRequest) String

func (m *RestoreDatabaseRequest) String() string

func (*RestoreDatabaseRequest) XXX_DiscardUnknown

func (m *RestoreDatabaseRequest) XXX_DiscardUnknown()

func (*RestoreDatabaseRequest) XXX_Marshal

func (m *RestoreDatabaseRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*RestoreDatabaseRequest) XXX_Merge

func (m *RestoreDatabaseRequest) XXX_Merge(src proto.Message)

func (*RestoreDatabaseRequest) XXX_OneofWrappers

func (*RestoreDatabaseRequest) XXX_OneofWrappers() []interface{}

XXX_OneofWrappers is for the internal use of the proto package.

func (*RestoreDatabaseRequest) XXX_Size

func (m *RestoreDatabaseRequest) XXX_Size() int

func (*RestoreDatabaseRequest) XXX_Unmarshal

func (m *RestoreDatabaseRequest) XXX_Unmarshal(b []byte) error

type RestoreDatabaseRequest_Backup

type RestoreDatabaseRequest_Backup struct {
	Backup string `protobuf:"bytes,3,opt,name=backup,proto3,oneof"`
}

type RestoreInfo

type RestoreInfo struct {
	// The type of the restore source.
	SourceType RestoreSourceType `` /* 148-byte string literal not displayed */
	// Information about the source used to restore the database.
	//
	// Types that are valid to be assigned to SourceInfo:
	//	*RestoreInfo_BackupInfo
	SourceInfo           isRestoreInfo_SourceInfo `protobuf_oneof:"source_info"`
	XXX_NoUnkeyedLiteral struct{}                 `json:"-"`
	XXX_unrecognized     []byte                   `json:"-"`
	XXX_sizecache        int32                    `json:"-"`
}

Information about the database restore.

func (*RestoreInfo) Descriptor

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

func (*RestoreInfo) GetBackupInfo

func (m *RestoreInfo) GetBackupInfo() *BackupInfo

func (*RestoreInfo) GetSourceInfo

func (m *RestoreInfo) GetSourceInfo() isRestoreInfo_SourceInfo

func (*RestoreInfo) GetSourceType

func (m *RestoreInfo) GetSourceType() RestoreSourceType

func (*RestoreInfo) ProtoMessage

func (*RestoreInfo) ProtoMessage()

func (*RestoreInfo) Reset

func (m *RestoreInfo) Reset()

func (*RestoreInfo) String

func (m *RestoreInfo) String() string

func (*RestoreInfo) XXX_DiscardUnknown

func (m *RestoreInfo) XXX_DiscardUnknown()

func (*RestoreInfo) XXX_Marshal

func (m *RestoreInfo) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*RestoreInfo) XXX_Merge

func (m *RestoreInfo) XXX_Merge(src proto.Message)

func (*RestoreInfo) XXX_OneofWrappers

func (*RestoreInfo) XXX_OneofWrappers() []interface{}

XXX_OneofWrappers is for the internal use of the proto package.

func (*RestoreInfo) XXX_Size

func (m *RestoreInfo) XXX_Size() int

func (*RestoreInfo) XXX_Unmarshal

func (m *RestoreInfo) XXX_Unmarshal(b []byte) error

type RestoreInfo_BackupInfo

type RestoreInfo_BackupInfo struct {
	BackupInfo *BackupInfo `protobuf:"bytes,2,opt,name=backup_info,json=backupInfo,proto3,oneof"`
}

type RestoreSourceType

type RestoreSourceType int32

Indicates the type of the restore source.

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

func (RestoreSourceType) EnumDescriptor

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

func (RestoreSourceType) String

func (x RestoreSourceType) String() string

type UnimplementedDatabaseAdminServer

type UnimplementedDatabaseAdminServer struct {
}

UnimplementedDatabaseAdminServer can be embedded to have forward compatible implementations.

func (*UnimplementedDatabaseAdminServer) CreateBackup

func (*UnimplementedDatabaseAdminServer) CreateDatabase

func (*UnimplementedDatabaseAdminServer) DeleteBackup

func (*UnimplementedDatabaseAdminServer) DropDatabase

func (*UnimplementedDatabaseAdminServer) GetBackup

func (*UnimplementedDatabaseAdminServer) GetDatabase

func (*UnimplementedDatabaseAdminServer) GetDatabaseDdl

func (*UnimplementedDatabaseAdminServer) GetIamPolicy

func (*UnimplementedDatabaseAdminServer) ListBackupOperations

func (*UnimplementedDatabaseAdminServer) ListBackups

func (*UnimplementedDatabaseAdminServer) ListDatabaseOperations

func (*UnimplementedDatabaseAdminServer) ListDatabases

func (*UnimplementedDatabaseAdminServer) RestoreDatabase

func (*UnimplementedDatabaseAdminServer) SetIamPolicy

func (*UnimplementedDatabaseAdminServer) TestIamPermissions

func (*UnimplementedDatabaseAdminServer) UpdateBackup

func (*UnimplementedDatabaseAdminServer) UpdateDatabaseDdl

type UpdateBackupRequest

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

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

func (*UpdateBackupRequest) Descriptor

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

func (*UpdateBackupRequest) GetBackup

func (m *UpdateBackupRequest) GetBackup() *Backup

func (*UpdateBackupRequest) GetUpdateMask

func (m *UpdateBackupRequest) GetUpdateMask() *field_mask.FieldMask

func (*UpdateBackupRequest) ProtoMessage

func (*UpdateBackupRequest) ProtoMessage()

func (*UpdateBackupRequest) Reset

func (m *UpdateBackupRequest) Reset()

func (*UpdateBackupRequest) String

func (m *UpdateBackupRequest) String() string

func (*UpdateBackupRequest) XXX_DiscardUnknown

func (m *UpdateBackupRequest) XXX_DiscardUnknown()

func (*UpdateBackupRequest) XXX_Marshal

func (m *UpdateBackupRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*UpdateBackupRequest) XXX_Merge

func (m *UpdateBackupRequest) XXX_Merge(src proto.Message)

func (*UpdateBackupRequest) XXX_Size

func (m *UpdateBackupRequest) XXX_Size() int

func (*UpdateBackupRequest) XXX_Unmarshal

func (m *UpdateBackupRequest) XXX_Unmarshal(b []byte) error

type UpdateDatabaseDdlMetadata

type UpdateDatabaseDdlMetadata struct {
	// The database being modified.
	Database string `protobuf:"bytes,1,opt,name=database,proto3" json:"database,omitempty"`
	// For an update this list contains all the statements. For an
	// individual statement, this list contains only that statement.
	Statements []string `protobuf:"bytes,2,rep,name=statements,proto3" json:"statements,omitempty"`
	// Reports the commit timestamps of all statements that have
	// succeeded so far, where `commit_timestamps[i]` is the commit
	// timestamp for the statement `statements[i]`.
	CommitTimestamps     []*timestamp.Timestamp `protobuf:"bytes,3,rep,name=commit_timestamps,json=commitTimestamps,proto3" json:"commit_timestamps,omitempty"`
	XXX_NoUnkeyedLiteral struct{}               `json:"-"`
	XXX_unrecognized     []byte                 `json:"-"`
	XXX_sizecache        int32                  `json:"-"`
}

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

func (*UpdateDatabaseDdlMetadata) Descriptor

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

func (*UpdateDatabaseDdlMetadata) GetCommitTimestamps

func (m *UpdateDatabaseDdlMetadata) GetCommitTimestamps() []*timestamp.Timestamp

func (*UpdateDatabaseDdlMetadata) GetDatabase

func (m *UpdateDatabaseDdlMetadata) GetDatabase() string

func (*UpdateDatabaseDdlMetadata) GetStatements

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

func (*UpdateDatabaseDdlMetadata) ProtoMessage

func (*UpdateDatabaseDdlMetadata) ProtoMessage()

func (*UpdateDatabaseDdlMetadata) Reset

func (m *UpdateDatabaseDdlMetadata) Reset()

func (*UpdateDatabaseDdlMetadata) String

func (m *UpdateDatabaseDdlMetadata) String() string

func (*UpdateDatabaseDdlMetadata) XXX_DiscardUnknown

func (m *UpdateDatabaseDdlMetadata) XXX_DiscardUnknown()

func (*UpdateDatabaseDdlMetadata) XXX_Marshal

func (m *UpdateDatabaseDdlMetadata) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*UpdateDatabaseDdlMetadata) XXX_Merge

func (m *UpdateDatabaseDdlMetadata) XXX_Merge(src proto.Message)

func (*UpdateDatabaseDdlMetadata) XXX_Size

func (m *UpdateDatabaseDdlMetadata) XXX_Size() int

func (*UpdateDatabaseDdlMetadata) XXX_Unmarshal

func (m *UpdateDatabaseDdlMetadata) XXX_Unmarshal(b []byte) error

type UpdateDatabaseDdlRequest

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

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)

func (*UpdateDatabaseDdlRequest) GetDatabase

func (m *UpdateDatabaseDdlRequest) GetDatabase() string

func (*UpdateDatabaseDdlRequest) GetOperationId

func (m *UpdateDatabaseDdlRequest) GetOperationId() string

func (*UpdateDatabaseDdlRequest) GetStatements

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

func (*UpdateDatabaseDdlRequest) ProtoMessage

func (*UpdateDatabaseDdlRequest) ProtoMessage()

func (*UpdateDatabaseDdlRequest) Reset

func (m *UpdateDatabaseDdlRequest) Reset()

func (*UpdateDatabaseDdlRequest) String

func (m *UpdateDatabaseDdlRequest) String() string

func (*UpdateDatabaseDdlRequest) XXX_DiscardUnknown

func (m *UpdateDatabaseDdlRequest) XXX_DiscardUnknown()

func (*UpdateDatabaseDdlRequest) XXX_Marshal

func (m *UpdateDatabaseDdlRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*UpdateDatabaseDdlRequest) XXX_Merge

func (m *UpdateDatabaseDdlRequest) XXX_Merge(src proto.Message)

func (*UpdateDatabaseDdlRequest) XXX_Size

func (m *UpdateDatabaseDdlRequest) XXX_Size() int

func (*UpdateDatabaseDdlRequest) XXX_Unmarshal

func (m *UpdateDatabaseDdlRequest) XXX_Unmarshal(b []byte) error

Jump to

Keyboard shortcuts

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