Package cloud.google.com/go/spanner/admin/instance/apiv1/instancepb (v1.41.0)

Variables

ReplicaInfo_ReplicaType_name, ReplicaInfo_ReplicaType_value

var (
	ReplicaInfo_ReplicaType_name = map[int32]string{
		0: "TYPE_UNSPECIFIED",
		1: "READ_WRITE",
		2: "READ_ONLY",
		3: "WITNESS",
	}
	ReplicaInfo_ReplicaType_value = map[string]int32{
		"TYPE_UNSPECIFIED": 0,
		"READ_WRITE":       1,
		"READ_ONLY":        2,
		"WITNESS":          3,
	}
)

Enum value maps for ReplicaInfo_ReplicaType.

InstanceConfig_Type_name, InstanceConfig_Type_value

var (
	InstanceConfig_Type_name = map[int32]string{
		0: "TYPE_UNSPECIFIED",
		1: "GOOGLE_MANAGED",
		2: "USER_MANAGED",
	}
	InstanceConfig_Type_value = map[string]int32{
		"TYPE_UNSPECIFIED": 0,
		"GOOGLE_MANAGED":   1,
		"USER_MANAGED":     2,
	}
)

Enum value maps for InstanceConfig_Type.

InstanceConfig_State_name, InstanceConfig_State_value

var (
	InstanceConfig_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "CREATING",
		2: "READY",
	}
	InstanceConfig_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"CREATING":          1,
		"READY":             2,
	}
)

Enum value maps for InstanceConfig_State.

Instance_State_name, Instance_State_value

var (
	Instance_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "CREATING",
		2: "READY",
	}
	Instance_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"CREATING":          1,
		"READY":             2,
	}
)

Enum value maps for Instance_State.

File_google_spanner_admin_instance_v1_common_proto

var File_google_spanner_admin_instance_v1_common_proto protoreflect.FileDescriptor

File_google_spanner_admin_instance_v1_spanner_instance_admin_proto

var File_google_spanner_admin_instance_v1_spanner_instance_admin_proto protoreflect.FileDescriptor

Functions

func RegisterInstanceAdminServer

func RegisterInstanceAdminServer(s *grpc.Server, srv InstanceAdminServer)

CreateInstanceConfigMetadata

type CreateInstanceConfigMetadata struct {

	// The target instance config end state.
	InstanceConfig *InstanceConfig `protobuf:"bytes,1,opt,name=instance_config,json=instanceConfig,proto3" json:"instance_config,omitempty"`
	// The progress of the
	// [CreateInstanceConfig][google.spanner.admin.instance.v1.InstanceAdmin.CreateInstanceConfig]
	// operation.
	Progress *OperationProgress `protobuf:"bytes,2,opt,name=progress,proto3" json:"progress,omitempty"`
	// The time at which this operation was cancelled.
	CancelTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=cancel_time,json=cancelTime,proto3" json:"cancel_time,omitempty"`
	// contains filtered or unexported fields
}

Metadata type for the operation returned by [CreateInstanceConfig][google.spanner.admin.instance.v1.InstanceAdmin.CreateInstanceConfig].

func (*CreateInstanceConfigMetadata) Descriptor

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

Deprecated: Use CreateInstanceConfigMetadata.ProtoReflect.Descriptor instead.

func (*CreateInstanceConfigMetadata) GetCancelTime

func (*CreateInstanceConfigMetadata) GetInstanceConfig

func (x *CreateInstanceConfigMetadata) GetInstanceConfig() *InstanceConfig

func (*CreateInstanceConfigMetadata) GetProgress

func (*CreateInstanceConfigMetadata) ProtoMessage

func (*CreateInstanceConfigMetadata) ProtoMessage()

func (*CreateInstanceConfigMetadata) ProtoReflect

func (*CreateInstanceConfigMetadata) Reset

func (x *CreateInstanceConfigMetadata) Reset()

func (*CreateInstanceConfigMetadata) String

CreateInstanceConfigRequest

type CreateInstanceConfigRequest struct {

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

The request for [CreateInstanceConfigRequest][InstanceAdmin.CreateInstanceConfigRequest].

func (*CreateInstanceConfigRequest) Descriptor

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

Deprecated: Use CreateInstanceConfigRequest.ProtoReflect.Descriptor instead.

func (*CreateInstanceConfigRequest) GetInstanceConfig

func (x *CreateInstanceConfigRequest) GetInstanceConfig() *InstanceConfig

func (*CreateInstanceConfigRequest) GetInstanceConfigId

func (x *CreateInstanceConfigRequest) GetInstanceConfigId() string

func (*CreateInstanceConfigRequest) GetParent

func (x *CreateInstanceConfigRequest) GetParent() string

func (*CreateInstanceConfigRequest) GetValidateOnly

func (x *CreateInstanceConfigRequest) GetValidateOnly() bool

func (*CreateInstanceConfigRequest) ProtoMessage

func (*CreateInstanceConfigRequest) ProtoMessage()

func (*CreateInstanceConfigRequest) ProtoReflect

func (*CreateInstanceConfigRequest) Reset

func (x *CreateInstanceConfigRequest) Reset()

func (*CreateInstanceConfigRequest) String

func (x *CreateInstanceConfigRequest) String() string

CreateInstanceMetadata

type CreateInstanceMetadata struct {

	// The instance being created.
	Instance *Instance `protobuf:"bytes,1,opt,name=instance,proto3" json:"instance,omitempty"`
	// The time at which the
	// [CreateInstance][google.spanner.admin.instance.v1.InstanceAdmin.CreateInstance]
	// request was received.
	StartTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
	// The time at which this operation was cancelled. If set, this operation is
	// in the process of undoing itself (which is guaranteed to succeed) and
	// cannot be cancelled again.
	CancelTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=cancel_time,json=cancelTime,proto3" json:"cancel_time,omitempty"`
	// The time at which this operation failed or was completed successfully.
	EndTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
	// contains filtered or unexported fields
}

Metadata type for the operation returned by [CreateInstance][google.spanner.admin.instance.v1.InstanceAdmin.CreateInstance].

func (*CreateInstanceMetadata) Descriptor

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

Deprecated: Use CreateInstanceMetadata.ProtoReflect.Descriptor instead.

func (*CreateInstanceMetadata) GetCancelTime

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

func (*CreateInstanceMetadata) GetEndTime

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

func (*CreateInstanceMetadata) GetInstance

func (x *CreateInstanceMetadata) GetInstance() *Instance

func (*CreateInstanceMetadata) GetStartTime

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

func (*CreateInstanceMetadata) ProtoMessage

func (*CreateInstanceMetadata) ProtoMessage()

func (*CreateInstanceMetadata) ProtoReflect

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

func (*CreateInstanceMetadata) Reset

func (x *CreateInstanceMetadata) Reset()

func (*CreateInstanceMetadata) String

func (x *CreateInstanceMetadata) String() string

CreateInstanceRequest

type CreateInstanceRequest struct {

	// Required. The name of the project in which to create the instance. Values
	// are of the form `projects/

The request for [CreateInstance][google.spanner.admin.instance.v1.InstanceAdmin.CreateInstance].

func (*CreateInstanceRequest) Descriptor

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

Deprecated: Use CreateInstanceRequest.ProtoReflect.Descriptor instead.

func (*CreateInstanceRequest) GetInstance

func (x *CreateInstanceRequest) GetInstance() *Instance

func (*CreateInstanceRequest) GetInstanceId

func (x *CreateInstanceRequest) GetInstanceId() string

func (*CreateInstanceRequest) GetParent

func (x *CreateInstanceRequest) GetParent() string

func (*CreateInstanceRequest) ProtoMessage

func (*CreateInstanceRequest) ProtoMessage()

func (*CreateInstanceRequest) ProtoReflect

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

func (*CreateInstanceRequest) Reset

func (x *CreateInstanceRequest) Reset()

func (*CreateInstanceRequest) String

func (x *CreateInstanceRequest) String() string

DeleteInstanceConfigRequest

type DeleteInstanceConfigRequest struct {

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

The request for [DeleteInstanceConfigRequest][InstanceAdmin.DeleteInstanceConfigRequest].

func (*DeleteInstanceConfigRequest) Descriptor

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

Deprecated: Use DeleteInstanceConfigRequest.ProtoReflect.Descriptor instead.

func (*DeleteInstanceConfigRequest) GetEtag

func (x *DeleteInstanceConfigRequest) GetEtag() string

func (*DeleteInstanceConfigRequest) GetName

func (x *DeleteInstanceConfigRequest) GetName() string

func (*DeleteInstanceConfigRequest) GetValidateOnly

func (x *DeleteInstanceConfigRequest) GetValidateOnly() bool

func (*DeleteInstanceConfigRequest) ProtoMessage

func (*DeleteInstanceConfigRequest) ProtoMessage()

func (*DeleteInstanceConfigRequest) ProtoReflect

func (*DeleteInstanceConfigRequest) Reset

func (x *DeleteInstanceConfigRequest) Reset()

func (*DeleteInstanceConfigRequest) String

func (x *DeleteInstanceConfigRequest) String() string

DeleteInstanceRequest

type DeleteInstanceRequest struct {

	// Required. The name of the instance to be deleted. Values are of the form
	// `projects/

The request for [DeleteInstance][google.spanner.admin.instance.v1.InstanceAdmin.DeleteInstance].

func (*DeleteInstanceRequest) Descriptor

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

Deprecated: Use DeleteInstanceRequest.ProtoReflect.Descriptor instead.

func (*DeleteInstanceRequest) GetName

func (x *DeleteInstanceRequest) GetName() string

func (*DeleteInstanceRequest) ProtoMessage

func (*DeleteInstanceRequest) ProtoMessage()

func (*DeleteInstanceRequest) ProtoReflect

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

func (*DeleteInstanceRequest) Reset

func (x *DeleteInstanceRequest) Reset()

func (*DeleteInstanceRequest) String

func (x *DeleteInstanceRequest) String() string

GetInstanceConfigRequest

type GetInstanceConfigRequest struct {

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

The request for [GetInstanceConfigRequest][google.spanner.admin.instance.v1.InstanceAdmin.GetInstanceConfig].

func (*GetInstanceConfigRequest) Descriptor

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

Deprecated: Use GetInstanceConfigRequest.ProtoReflect.Descriptor instead.

func (*GetInstanceConfigRequest) GetName

func (x *GetInstanceConfigRequest) GetName() string

func (*GetInstanceConfigRequest) ProtoMessage

func (*GetInstanceConfigRequest) ProtoMessage()

func (*GetInstanceConfigRequest) ProtoReflect

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

func (*GetInstanceConfigRequest) Reset

func (x *GetInstanceConfigRequest) Reset()

func (*GetInstanceConfigRequest) String

func (x *GetInstanceConfigRequest) String() string

GetInstanceRequest

type GetInstanceRequest struct {

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

The request for [GetInstance][google.spanner.admin.instance.v1.InstanceAdmin.GetInstance].

func (*GetInstanceRequest) Descriptor

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

Deprecated: Use GetInstanceRequest.ProtoReflect.Descriptor instead.

func (*GetInstanceRequest) GetFieldMask

func (x *GetInstanceRequest) GetFieldMask() *fieldmaskpb.FieldMask

func (*GetInstanceRequest) GetName

func (x *GetInstanceRequest) GetName() string

func (*GetInstanceRequest) ProtoMessage

func (*GetInstanceRequest) ProtoMessage()

func (*GetInstanceRequest) ProtoReflect

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

func (*GetInstanceRequest) Reset

func (x *GetInstanceRequest) Reset()

func (*GetInstanceRequest) String

func (x *GetInstanceRequest) String() string

Instance

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

	Config string `protobuf:"bytes,2,opt,name=config,proto3" json:"config,omitempty"`

	DisplayName string `protobuf:"bytes,3,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`

	NodeCount int32 `protobuf:"varint,5,opt,name=node_count,json=nodeCount,proto3" json:"node_count,omitempty"`

	ProcessingUnits int32 `protobuf:"varint,9,opt,name=processing_units,json=processingUnits,proto3" json:"processing_units,omitempty"`

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

	Labels map[string]string "" /* 153 byte string literal not displayed */

	EndpointUris []string `protobuf:"bytes,8,rep,name=endpoint_uris,json=endpointUris,proto3" json:"endpoint_uris,omitempty"`

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

	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,12,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`

}

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

func (*Instance) Descriptor

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

Deprecated: Use Instance.ProtoReflect.Descriptor instead.

func (*Instance) GetConfig

func (x *Instance) GetConfig() string

func (*Instance) GetCreateTime

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

func (*Instance) GetDisplayName

func (x *Instance) GetDisplayName() string

func (*Instance) GetEndpointUris

func (x *Instance) GetEndpointUris() []string

func (*Instance) GetLabels

func (x *Instance) GetLabels() map[string]string

func (*Instance) GetName

func (x *Instance) GetName() string

func (*Instance) GetNodeCount

func (x *Instance) GetNodeCount() int32

func (*Instance) GetProcessingUnits

func (x *Instance) GetProcessingUnits() int32

func (*Instance) GetState

func (x *Instance) GetState() Instance_State

func (*Instance) GetUpdateTime

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

func (*Instance) ProtoMessage

func (*Instance) ProtoMessage()

func (*Instance) ProtoReflect

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

func (*Instance) Reset

func (x *Instance) Reset()

func (*Instance) String

func (x *Instance) String() string

InstanceAdminClient

type InstanceAdminClient interface {
	// Lists the supported instance configurations for a given project.
	ListInstanceConfigs(ctx context.Context, in *ListInstanceConfigsRequest, opts ...grpc.CallOption) (*ListInstanceConfigsResponse, error)
	// Gets information about a particular instance configuration.
	GetInstanceConfig(ctx context.Context, in *GetInstanceConfigRequest, opts ...grpc.CallOption) (*InstanceConfig, error)
	// Creates an instance config and begins preparing it to be used. The
	// returned [long-running operation][google.longrunning.Operation]
	// can be used to track the progress of preparing the new
	// instance config. The instance config name is assigned by the caller. If the
	// named instance config already exists, `CreateInstanceConfig` returns
	// `ALREADY_EXISTS`.
	//
	// Immediately after the request returns:
	//
	//   - The instance config is readable via the API, with all requested
	//     attributes. The instance config's
	//     [reconciling][google.spanner.admin.instance.v1.InstanceConfig.reconciling]
	//     field is set to true. Its state is `CREATING`.
	//
	// While the operation is pending:
	//
	//   - Cancelling the operation renders the instance config immediately
	//     unreadable via the API.
	//   - Except for deleting the creating resource, all other attempts to modify
	//     the instance config are rejected.
	//
	// Upon completion of the returned operation:
	//
	//   - Instances can be created using the instance configuration.
	//   - The instance config's
	//     [reconciling][google.spanner.admin.instance.v1.InstanceConfig.reconciling]
	//     field becomes false. Its state becomes `READY`.
	//
	// The returned [long-running operation][google.longrunning.Operation] will
	// have a name of the format
	// `

InstanceAdminClient is the client API for InstanceAdmin service.

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

func NewInstanceAdminClient

func NewInstanceAdminClient(cc grpc.ClientConnInterface) InstanceAdminClient

InstanceAdminServer

type InstanceAdminServer interface {
	// Lists the supported instance configurations for a given project.
	ListInstanceConfigs(context.Context, *ListInstanceConfigsRequest) (*ListInstanceConfigsResponse, error)
	// Gets information about a particular instance configuration.
	GetInstanceConfig(context.Context, *GetInstanceConfigRequest) (*InstanceConfig, error)
	// Creates an instance config and begins preparing it to be used. The
	// returned [long-running operation][google.longrunning.Operation]
	// can be used to track the progress of preparing the new
	// instance config. The instance config name is assigned by the caller. If the
	// named instance config already exists, `CreateInstanceConfig` returns
	// `ALREADY_EXISTS`.
	//
	// Immediately after the request returns:
	//
	//   - The instance config is readable via the API, with all requested
	//     attributes. The instance config's
	//     [reconciling][google.spanner.admin.instance.v1.InstanceConfig.reconciling]
	//     field is set to true. Its state is `CREATING`.
	//
	// While the operation is pending:
	//
	//   - Cancelling the operation renders the instance config immediately
	//     unreadable via the API.
	//   - Except for deleting the creating resource, all other attempts to modify
	//     the instance config are rejected.
	//
	// Upon completion of the returned operation:
	//
	//   - Instances can be created using the instance configuration.
	//   - The instance config's
	//     [reconciling][google.spanner.admin.instance.v1.InstanceConfig.reconciling]
	//     field becomes false. Its state becomes `READY`.
	//
	// The returned [long-running operation][google.longrunning.Operation] will
	// have a name of the format
	// `

InstanceAdminServer is the server API for InstanceAdmin service.

InstanceConfig

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

	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`

	ConfigType InstanceConfig_Type "" /* 150 byte string literal not displayed */

	Replicas []*ReplicaInfo `protobuf:"bytes,3,rep,name=replicas,proto3" json:"replicas,omitempty"`

	OptionalReplicas []*ReplicaInfo `protobuf:"bytes,6,rep,name=optional_replicas,json=optionalReplicas,proto3" json:"optional_replicas,omitempty"`

	BaseConfig string `protobuf:"bytes,7,opt,name=base_config,json=baseConfig,proto3" json:"base_config,omitempty"`

	Labels map[string]string "" /* 153 byte string literal not displayed */

	Etag string `protobuf:"bytes,9,opt,name=etag,proto3" json:"etag,omitempty"`

	LeaderOptions []string `protobuf:"bytes,4,rep,name=leader_options,json=leaderOptions,proto3" json:"leader_options,omitempty"`

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

	State InstanceConfig_State `protobuf:"varint,11,opt,name=state,proto3,enum=google.spanner.admin.instance.v1.InstanceConfig_State" json:"state,omitempty"`

}

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

func (*InstanceConfig) Descriptor

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

Deprecated: Use InstanceConfig.ProtoReflect.Descriptor instead.

func (*InstanceConfig) GetBaseConfig

func (x *InstanceConfig) GetBaseConfig() string

func (*InstanceConfig) GetConfigType

func (x *InstanceConfig) GetConfigType() InstanceConfig_Type

func (*InstanceConfig) GetDisplayName

func (x *InstanceConfig) GetDisplayName() string

func (*InstanceConfig) GetEtag

func (x *InstanceConfig) GetEtag() string

func (*InstanceConfig) GetLabels

func (x *InstanceConfig) GetLabels() map[string]string

func (*InstanceConfig) GetLeaderOptions

func (x *InstanceConfig) GetLeaderOptions() []string

func (*InstanceConfig) GetName

func (x *InstanceConfig) GetName() string

func (*InstanceConfig) GetOptionalReplicas

func (x *InstanceConfig) GetOptionalReplicas() []*ReplicaInfo

func (*InstanceConfig) GetReconciling

func (x *InstanceConfig) GetReconciling() bool

func (*InstanceConfig) GetReplicas

func (x *InstanceConfig) GetReplicas() []*ReplicaInfo

func (*InstanceConfig) GetState

func (x *InstanceConfig) GetState() InstanceConfig_State

func (*InstanceConfig) ProtoMessage

func (*InstanceConfig) ProtoMessage()

func (*InstanceConfig) ProtoReflect

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

func (*InstanceConfig) Reset

func (x *InstanceConfig) Reset()

func (*InstanceConfig) String

func (x *InstanceConfig) String() string

InstanceConfig_State

type InstanceConfig_State int32

Indicates the current state of the instance config.

InstanceConfig_STATE_UNSPECIFIED, InstanceConfig_CREATING, InstanceConfig_READY

const (
	// Not specified.
	InstanceConfig_STATE_UNSPECIFIED InstanceConfig_State = 0
	// The instance config is still being created.
	InstanceConfig_CREATING InstanceConfig_State = 1
	// The instance config is fully created and ready to be used to create
	// instances.
	InstanceConfig_READY InstanceConfig_State = 2
)

func (InstanceConfig_State) Descriptor

func (InstanceConfig_State) Enum

func (InstanceConfig_State) EnumDescriptor

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

Deprecated: Use InstanceConfig_State.Descriptor instead.

func (InstanceConfig_State) Number

func (InstanceConfig_State) String

func (x InstanceConfig_State) String() string

func (InstanceConfig_State) Type

InstanceConfig_Type

type InstanceConfig_Type int32

The type of this configuration.

InstanceConfig_TYPE_UNSPECIFIED, InstanceConfig_GOOGLE_MANAGED, InstanceConfig_USER_MANAGED

const (
	// Unspecified.
	InstanceConfig_TYPE_UNSPECIFIED InstanceConfig_Type = 0
	// Google managed configuration.
	InstanceConfig_GOOGLE_MANAGED InstanceConfig_Type = 1
	// User managed configuration.
	InstanceConfig_USER_MANAGED InstanceConfig_Type = 2
)

func (InstanceConfig_Type) Descriptor

func (InstanceConfig_Type) Enum

func (InstanceConfig_Type) EnumDescriptor

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

Deprecated: Use InstanceConfig_Type.Descriptor instead.

func (InstanceConfig_Type) Number

func (InstanceConfig_Type) String

func (x InstanceConfig_Type) String() string

func (InstanceConfig_Type) Type

Instance_State

type Instance_State int32

Indicates the current state of the instance.

Instance_STATE_UNSPECIFIED, Instance_CREATING, Instance_READY

const (
	// Not specified.
	Instance_STATE_UNSPECIFIED Instance_State = 0
	// The instance is still being created. Resources may not be
	// available yet, and operations such as database creation may not
	// work.
	Instance_CREATING Instance_State = 1
	// The instance is fully created and ready to do work such as
	// creating databases.
	Instance_READY Instance_State = 2
)

func (Instance_State) Descriptor

func (Instance_State) Enum

func (x Instance_State) Enum() *Instance_State

func (Instance_State) EnumDescriptor

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

Deprecated: Use Instance_State.Descriptor instead.

func (Instance_State) Number

func (Instance_State) String

func (x Instance_State) String() string

func (Instance_State) Type

ListInstanceConfigOperationsRequest

type ListInstanceConfigOperationsRequest struct {

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

The request for [ListInstanceConfigOperations][google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigOperations].

func (*ListInstanceConfigOperationsRequest) Descriptor

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

Deprecated: Use ListInstanceConfigOperationsRequest.ProtoReflect.Descriptor instead.

func (*ListInstanceConfigOperationsRequest) GetFilter

func (*ListInstanceConfigOperationsRequest) GetPageSize

func (x *ListInstanceConfigOperationsRequest) GetPageSize() int32

func (*ListInstanceConfigOperationsRequest) GetPageToken

func (x *ListInstanceConfigOperationsRequest) GetPageToken() string

func (*ListInstanceConfigOperationsRequest) GetParent

func (*ListInstanceConfigOperationsRequest) ProtoMessage

func (*ListInstanceConfigOperationsRequest) ProtoMessage()

func (*ListInstanceConfigOperationsRequest) ProtoReflect

func (*ListInstanceConfigOperationsRequest) Reset

func (*ListInstanceConfigOperationsRequest) String

ListInstanceConfigOperationsResponse

type ListInstanceConfigOperationsResponse struct {

	// The list of matching instance config [long-running
	// operations][google.longrunning.Operation]. Each operation's name will be
	// prefixed by the instance config'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
	// [ListInstanceConfigOperations][google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigOperations]
	// call to fetch more of the matching metadata.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

The response for [ListInstanceConfigOperations][google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigOperations].

func (*ListInstanceConfigOperationsResponse) Descriptor

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

Deprecated: Use ListInstanceConfigOperationsResponse.ProtoReflect.Descriptor instead.

func (*ListInstanceConfigOperationsResponse) GetNextPageToken

func (x *ListInstanceConfigOperationsResponse) GetNextPageToken() string

func (*ListInstanceConfigOperationsResponse) GetOperations

func (*ListInstanceConfigOperationsResponse) ProtoMessage

func (*ListInstanceConfigOperationsResponse) ProtoMessage()

func (*ListInstanceConfigOperationsResponse) ProtoReflect

func (*ListInstanceConfigOperationsResponse) Reset

func (*ListInstanceConfigOperationsResponse) String

ListInstanceConfigsRequest

type ListInstanceConfigsRequest struct {

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

The request for [ListInstanceConfigs][google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigs].

func (*ListInstanceConfigsRequest) Descriptor

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

Deprecated: Use ListInstanceConfigsRequest.ProtoReflect.Descriptor instead.

func (*ListInstanceConfigsRequest) GetPageSize

func (x *ListInstanceConfigsRequest) GetPageSize() int32

func (*ListInstanceConfigsRequest) GetPageToken

func (x *ListInstanceConfigsRequest) GetPageToken() string

func (*ListInstanceConfigsRequest) GetParent

func (x *ListInstanceConfigsRequest) GetParent() string

func (*ListInstanceConfigsRequest) ProtoMessage

func (*ListInstanceConfigsRequest) ProtoMessage()

func (*ListInstanceConfigsRequest) ProtoReflect

func (*ListInstanceConfigsRequest) Reset

func (x *ListInstanceConfigsRequest) Reset()

func (*ListInstanceConfigsRequest) String

func (x *ListInstanceConfigsRequest) String() string

ListInstanceConfigsResponse

type ListInstanceConfigsResponse struct {

	// The list of requested instance configurations.
	InstanceConfigs []*InstanceConfig `protobuf:"bytes,1,rep,name=instance_configs,json=instanceConfigs,proto3" json:"instance_configs,omitempty"`
	// `next_page_token` can be sent in a subsequent
	// [ListInstanceConfigs][google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigs]
	// call to fetch more of the matching instance configurations.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

The response for [ListInstanceConfigs][google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigs].

func (*ListInstanceConfigsResponse) Descriptor

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

Deprecated: Use ListInstanceConfigsResponse.ProtoReflect.Descriptor instead.

func (*ListInstanceConfigsResponse) GetInstanceConfigs

func (x *ListInstanceConfigsResponse) GetInstanceConfigs() []*InstanceConfig

func (*ListInstanceConfigsResponse) GetNextPageToken

func (x *ListInstanceConfigsResponse) GetNextPageToken() string

func (*ListInstanceConfigsResponse) ProtoMessage

func (*ListInstanceConfigsResponse) ProtoMessage()

func (*ListInstanceConfigsResponse) ProtoReflect

func (*ListInstanceConfigsResponse) Reset

func (x *ListInstanceConfigsResponse) Reset()

func (*ListInstanceConfigsResponse) String

func (x *ListInstanceConfigsResponse) String() string

ListInstancesRequest

type ListInstancesRequest struct {

	// Required. The name of the project for which a list of instances is
	// requested. Values are of the form `projects/

The request for [ListInstances][google.spanner.admin.instance.v1.InstanceAdmin.ListInstances].

func (*ListInstancesRequest) Descriptor

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

Deprecated: Use ListInstancesRequest.ProtoReflect.Descriptor instead.

func (*ListInstancesRequest) GetFilter

func (x *ListInstancesRequest) GetFilter() string

func (*ListInstancesRequest) GetPageSize

func (x *ListInstancesRequest) GetPageSize() int32

func (*ListInstancesRequest) GetPageToken

func (x *ListInstancesRequest) GetPageToken() string

func (*ListInstancesRequest) GetParent

func (x *ListInstancesRequest) GetParent() string

func (*ListInstancesRequest) ProtoMessage

func (*ListInstancesRequest) ProtoMessage()

func (*ListInstancesRequest) ProtoReflect

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

func (*ListInstancesRequest) Reset

func (x *ListInstancesRequest) Reset()

func (*ListInstancesRequest) String

func (x *ListInstancesRequest) String() string

ListInstancesResponse

type ListInstancesResponse struct {

	// The list of requested instances.
	Instances []*Instance `protobuf:"bytes,1,rep,name=instances,proto3" json:"instances,omitempty"`
	// `next_page_token` can be sent in a subsequent
	// [ListInstances][google.spanner.admin.instance.v1.InstanceAdmin.ListInstances]
	// call to fetch more of the matching instances.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

The response for [ListInstances][google.spanner.admin.instance.v1.InstanceAdmin.ListInstances].

func (*ListInstancesResponse) Descriptor

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

Deprecated: Use ListInstancesResponse.ProtoReflect.Descriptor instead.

func (*ListInstancesResponse) GetInstances

func (x *ListInstancesResponse) GetInstances() []*Instance

func (*ListInstancesResponse) GetNextPageToken

func (x *ListInstancesResponse) GetNextPageToken() string

func (*ListInstancesResponse) ProtoMessage

func (*ListInstancesResponse) ProtoMessage()

func (*ListInstancesResponse) ProtoReflect

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

func (*ListInstancesResponse) Reset

func (x *ListInstancesResponse) Reset()

func (*ListInstancesResponse) String

func (x *ListInstancesResponse) String() string

OperationProgress

type OperationProgress struct {

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

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

func (*OperationProgress) Descriptor

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

Deprecated: Use OperationProgress.ProtoReflect.Descriptor instead.

func (*OperationProgress) GetEndTime

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

func (*OperationProgress) GetProgressPercent

func (x *OperationProgress) GetProgressPercent() int32

func (*OperationProgress) GetStartTime

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

func (*OperationProgress) ProtoMessage

func (*OperationProgress) ProtoMessage()

func (*OperationProgress) ProtoReflect

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

func (*OperationProgress) Reset

func (x *OperationProgress) Reset()

func (*OperationProgress) String

func (x *OperationProgress) String() string

ReplicaInfo

type ReplicaInfo struct {
	Location string `protobuf:"bytes,1,opt,name=location,proto3" json:"location,omitempty"`

	Type ReplicaInfo_ReplicaType `protobuf:"varint,2,opt,name=type,proto3,enum=google.spanner.admin.instance.v1.ReplicaInfo_ReplicaType" json:"type,omitempty"`

	DefaultLeaderLocation bool "" /* 127 byte string literal not displayed */

}

func (*ReplicaInfo) Descriptor

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

Deprecated: Use ReplicaInfo.ProtoReflect.Descriptor instead.

func (*ReplicaInfo) GetDefaultLeaderLocation

func (x *ReplicaInfo) GetDefaultLeaderLocation() bool

func (*ReplicaInfo) GetLocation

func (x *ReplicaInfo) GetLocation() string

func (*ReplicaInfo) GetType

func (x *ReplicaInfo) GetType() ReplicaInfo_ReplicaType

func (*ReplicaInfo) ProtoMessage

func (*ReplicaInfo) ProtoMessage()

func (*ReplicaInfo) ProtoReflect

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

func (*ReplicaInfo) Reset

func (x *ReplicaInfo) Reset()

func (*ReplicaInfo) String

func (x *ReplicaInfo) String() string

ReplicaInfo_ReplicaType

type ReplicaInfo_ReplicaType int32

Indicates the type of replica. See the replica types documentation for more details.

ReplicaInfo_TYPE_UNSPECIFIED, ReplicaInfo_READ_WRITE, ReplicaInfo_READ_ONLY, ReplicaInfo_WITNESS

const (
	// Not specified.
	ReplicaInfo_TYPE_UNSPECIFIED ReplicaInfo_ReplicaType = 0
	// Read-write replicas support both reads and writes. These replicas:
	//
	// * Maintain a full copy of your data.
	// * Serve reads.
	// * Can vote whether to commit a write.
	// * Participate in leadership election.
	// * Are eligible to become a leader.
	ReplicaInfo_READ_WRITE ReplicaInfo_ReplicaType = 1
	// Read-only replicas only support reads (not writes). Read-only replicas:
	//
	// * Maintain a full copy of your data.
	// * Serve reads.
	// * Do not participate in voting to commit writes.
	// * Are not eligible to become a leader.
	ReplicaInfo_READ_ONLY ReplicaInfo_ReplicaType = 2
	// Witness replicas don't support reads but do participate in voting to
	// commit writes. Witness replicas:
	//
	// * Do not maintain a full copy of data.
	// * Do not serve reads.
	// * Vote whether to commit writes.
	// * Participate in leader election but are not eligible to become leader.
	ReplicaInfo_WITNESS ReplicaInfo_ReplicaType = 3
)

func (ReplicaInfo_ReplicaType) Descriptor

func (ReplicaInfo_ReplicaType) Enum

func (ReplicaInfo_ReplicaType) EnumDescriptor

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

Deprecated: Use ReplicaInfo_ReplicaType.Descriptor instead.

func (ReplicaInfo_ReplicaType) Number

func (ReplicaInfo_ReplicaType) String

func (x ReplicaInfo_ReplicaType) String() string

func (ReplicaInfo_ReplicaType) Type

UnimplementedInstanceAdminServer

type UnimplementedInstanceAdminServer struct {
}

UnimplementedInstanceAdminServer can be embedded to have forward compatible implementations.

func (*UnimplementedInstanceAdminServer) CreateInstance

func (*UnimplementedInstanceAdminServer) CreateInstanceConfig

func (*UnimplementedInstanceAdminServer) DeleteInstance

func (*UnimplementedInstanceAdminServer) DeleteInstanceConfig

func (*UnimplementedInstanceAdminServer) GetIamPolicy

func (*UnimplementedInstanceAdminServer) GetInstance

func (*UnimplementedInstanceAdminServer) GetInstanceConfig

func (*UnimplementedInstanceAdminServer) ListInstanceConfigOperations

func (*UnimplementedInstanceAdminServer) ListInstanceConfigs

func (*UnimplementedInstanceAdminServer) ListInstances

func (*UnimplementedInstanceAdminServer) SetIamPolicy

func (*UnimplementedInstanceAdminServer) TestIamPermissions

func (*UnimplementedInstanceAdminServer) UpdateInstance

func (*UnimplementedInstanceAdminServer) UpdateInstanceConfig

UpdateInstanceConfigMetadata

type UpdateInstanceConfigMetadata struct {

	// The desired instance config after updating.
	InstanceConfig *InstanceConfig `protobuf:"bytes,1,opt,name=instance_config,json=instanceConfig,proto3" json:"instance_config,omitempty"`
	// The progress of the
	// [UpdateInstanceConfig][google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstanceConfig]
	// operation.
	Progress *OperationProgress `protobuf:"bytes,2,opt,name=progress,proto3" json:"progress,omitempty"`
	// The time at which this operation was cancelled.
	CancelTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=cancel_time,json=cancelTime,proto3" json:"cancel_time,omitempty"`
	// contains filtered or unexported fields
}

Metadata type for the operation returned by [UpdateInstanceConfig][google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstanceConfig].

func (*UpdateInstanceConfigMetadata) Descriptor

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

Deprecated: Use UpdateInstanceConfigMetadata.ProtoReflect.Descriptor instead.

func (*UpdateInstanceConfigMetadata) GetCancelTime

func (*UpdateInstanceConfigMetadata) GetInstanceConfig

func (x *UpdateInstanceConfigMetadata) GetInstanceConfig() *InstanceConfig

func (*UpdateInstanceConfigMetadata) GetProgress

func (*UpdateInstanceConfigMetadata) ProtoMessage

func (*UpdateInstanceConfigMetadata) ProtoMessage()

func (*UpdateInstanceConfigMetadata) ProtoReflect

func (*UpdateInstanceConfigMetadata) Reset

func (x *UpdateInstanceConfigMetadata) Reset()

func (*UpdateInstanceConfigMetadata) String

UpdateInstanceConfigRequest

type UpdateInstanceConfigRequest struct {

	// Required. The user instance config to update, which must always include the
	// instance config name. Otherwise, only fields mentioned in
	// [update_mask][google.spanner.admin.instance.v1.UpdateInstanceConfigRequest.update_mask]
	// need be included. To prevent conflicts of concurrent updates,
	// [etag][google.spanner.admin.instance.v1.InstanceConfig.reconciling] can
	// be used.
	InstanceConfig *InstanceConfig `protobuf:"bytes,1,opt,name=instance_config,json=instanceConfig,proto3" json:"instance_config,omitempty"`
	// Required. A mask specifying which fields in
	// [InstanceConfig][google.spanner.admin.instance.v1.InstanceConfig] should be
	// updated. The field mask must always be specified; this prevents any future
	// fields in [InstanceConfig][google.spanner.admin.instance.v1.InstanceConfig]
	// from being erased accidentally by clients that do not know about them. Only
	// display_name and labels can be updated.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// An option to validate, but not actually execute, a request,
	// and provide the same response.
	ValidateOnly bool `protobuf:"varint,3,opt,name=validate_only,json=validateOnly,proto3" json:"validate_only,omitempty"`
	// contains filtered or unexported fields
}

The request for [UpdateInstanceConfigRequest][InstanceAdmin.UpdateInstanceConfigRequest].

func (*UpdateInstanceConfigRequest) Descriptor

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

Deprecated: Use UpdateInstanceConfigRequest.ProtoReflect.Descriptor instead.

func (*UpdateInstanceConfigRequest) GetInstanceConfig

func (x *UpdateInstanceConfigRequest) GetInstanceConfig() *InstanceConfig

func (*UpdateInstanceConfigRequest) GetUpdateMask

func (*UpdateInstanceConfigRequest) GetValidateOnly

func (x *UpdateInstanceConfigRequest) GetValidateOnly() bool

func (*UpdateInstanceConfigRequest) ProtoMessage

func (*UpdateInstanceConfigRequest) ProtoMessage()

func (*UpdateInstanceConfigRequest) ProtoReflect

func (*UpdateInstanceConfigRequest) Reset

func (x *UpdateInstanceConfigRequest) Reset()

func (*UpdateInstanceConfigRequest) String

func (x *UpdateInstanceConfigRequest) String() string

UpdateInstanceMetadata

type UpdateInstanceMetadata struct {

	// The desired end state of the update.
	Instance *Instance `protobuf:"bytes,1,opt,name=instance,proto3" json:"instance,omitempty"`
	// The time at which
	// [UpdateInstance][google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstance]
	// request was received.
	StartTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
	// The time at which this operation was cancelled. If set, this operation is
	// in the process of undoing itself (which is guaranteed to succeed) and
	// cannot be cancelled again.
	CancelTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=cancel_time,json=cancelTime,proto3" json:"cancel_time,omitempty"`
	// The time at which this operation failed or was completed successfully.
	EndTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
	// contains filtered or unexported fields
}

Metadata type for the operation returned by [UpdateInstance][google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstance].

func (*UpdateInstanceMetadata) Descriptor

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

Deprecated: Use UpdateInstanceMetadata.ProtoReflect.Descriptor instead.

func (*UpdateInstanceMetadata) GetCancelTime

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

func (*UpdateInstanceMetadata) GetEndTime

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

func (*UpdateInstanceMetadata) GetInstance

func (x *UpdateInstanceMetadata) GetInstance() *Instance

func (*UpdateInstanceMetadata) GetStartTime

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

func (*UpdateInstanceMetadata) ProtoMessage

func (*UpdateInstanceMetadata) ProtoMessage()

func (*UpdateInstanceMetadata) ProtoReflect

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

func (*UpdateInstanceMetadata) Reset

func (x *UpdateInstanceMetadata) Reset()

func (*UpdateInstanceMetadata) String

func (x *UpdateInstanceMetadata) String() string

UpdateInstanceRequest

type UpdateInstanceRequest struct {

	// Required. The instance to update, which must always include the instance
	// name.  Otherwise, only fields mentioned in
	// [field_mask][google.spanner.admin.instance.v1.UpdateInstanceRequest.field_mask]
	// need be included.
	Instance *Instance `protobuf:"bytes,1,opt,name=instance,proto3" json:"instance,omitempty"`
	// Required. A mask specifying which fields in
	// [Instance][google.spanner.admin.instance.v1.Instance] should be updated.
	// The field mask must always be specified; this prevents any future fields in
	// [Instance][google.spanner.admin.instance.v1.Instance] from being erased
	// accidentally by clients that do not know about them.
	FieldMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=field_mask,json=fieldMask,proto3" json:"field_mask,omitempty"`
	// contains filtered or unexported fields
}

The request for [UpdateInstance][google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstance].

func (*UpdateInstanceRequest) Descriptor

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

Deprecated: Use UpdateInstanceRequest.ProtoReflect.Descriptor instead.

func (*UpdateInstanceRequest) GetFieldMask

func (x *UpdateInstanceRequest) GetFieldMask() *fieldmaskpb.FieldMask

func (*UpdateInstanceRequest) GetInstance

func (x *UpdateInstanceRequest) GetInstance() *Instance

func (*UpdateInstanceRequest) ProtoMessage

func (*UpdateInstanceRequest) ProtoMessage()

func (*UpdateInstanceRequest) ProtoReflect

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

func (*UpdateInstanceRequest) Reset

func (x *UpdateInstanceRequest) Reset()

func (*UpdateInstanceRequest) String

func (x *UpdateInstanceRequest) String() string