instancepb

package
v1.57.0 Latest Latest
Warning

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

Go to latest
Published: Feb 13, 2024 License: Apache-2.0 Imports: 14 Imported by: 17

Documentation

Index

Constants

This section is empty.

Variables

View Source
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.

View Source
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.

View Source
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.

View Source
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.

View Source
var File_google_spanner_admin_instance_v1_common_proto protoreflect.FileDescriptor
View Source
var File_google_spanner_admin_instance_v1_spanner_instance_admin_proto protoreflect.FileDescriptor

Functions

func RegisterInstanceAdminServer

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

Types

type AutoscalingConfig added in v1.51.0

type AutoscalingConfig struct {

	// Required. Autoscaling limits for an instance.
	AutoscalingLimits *AutoscalingConfig_AutoscalingLimits `protobuf:"bytes,1,opt,name=autoscaling_limits,json=autoscalingLimits,proto3" json:"autoscaling_limits,omitempty"`
	// Required. The autoscaling targets for an instance.
	AutoscalingTargets *AutoscalingConfig_AutoscalingTargets `protobuf:"bytes,2,opt,name=autoscaling_targets,json=autoscalingTargets,proto3" json:"autoscaling_targets,omitempty"`
	// contains filtered or unexported fields
}

Autoscaling config for an instance.

func (*AutoscalingConfig) Descriptor deprecated added in v1.51.0

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

Deprecated: Use AutoscalingConfig.ProtoReflect.Descriptor instead.

func (*AutoscalingConfig) GetAutoscalingLimits added in v1.51.0

func (x *AutoscalingConfig) GetAutoscalingLimits() *AutoscalingConfig_AutoscalingLimits

func (*AutoscalingConfig) GetAutoscalingTargets added in v1.51.0

func (x *AutoscalingConfig) GetAutoscalingTargets() *AutoscalingConfig_AutoscalingTargets

func (*AutoscalingConfig) ProtoMessage added in v1.51.0

func (*AutoscalingConfig) ProtoMessage()

func (*AutoscalingConfig) ProtoReflect added in v1.51.0

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

func (*AutoscalingConfig) Reset added in v1.51.0

func (x *AutoscalingConfig) Reset()

func (*AutoscalingConfig) String added in v1.51.0

func (x *AutoscalingConfig) String() string

type AutoscalingConfig_AutoscalingLimits added in v1.51.0

type AutoscalingConfig_AutoscalingLimits struct {

	// The minimum compute capacity for the instance.
	//
	// Types that are assignable to MinLimit:
	//
	//	*AutoscalingConfig_AutoscalingLimits_MinNodes
	//	*AutoscalingConfig_AutoscalingLimits_MinProcessingUnits
	MinLimit isAutoscalingConfig_AutoscalingLimits_MinLimit `protobuf_oneof:"min_limit"`
	// The maximum compute capacity for the instance. The maximum compute
	// capacity should be less than or equal to 10X the minimum compute
	// capacity.
	//
	// Types that are assignable to MaxLimit:
	//
	//	*AutoscalingConfig_AutoscalingLimits_MaxNodes
	//	*AutoscalingConfig_AutoscalingLimits_MaxProcessingUnits
	MaxLimit isAutoscalingConfig_AutoscalingLimits_MaxLimit `protobuf_oneof:"max_limit"`
	// contains filtered or unexported fields
}

The autoscaling limits for the instance. Users can define the minimum and maximum compute capacity allocated to the instance, and the autoscaler will only scale within that range. Users can either use nodes or processing units to specify the limits, but should use the same unit to set both the min_limit and max_limit.

func (*AutoscalingConfig_AutoscalingLimits) Descriptor deprecated added in v1.51.0

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

Deprecated: Use AutoscalingConfig_AutoscalingLimits.ProtoReflect.Descriptor instead.

func (*AutoscalingConfig_AutoscalingLimits) GetMaxLimit added in v1.51.0

func (m *AutoscalingConfig_AutoscalingLimits) GetMaxLimit() isAutoscalingConfig_AutoscalingLimits_MaxLimit

func (*AutoscalingConfig_AutoscalingLimits) GetMaxNodes added in v1.51.0

func (x *AutoscalingConfig_AutoscalingLimits) GetMaxNodes() int32

func (*AutoscalingConfig_AutoscalingLimits) GetMaxProcessingUnits added in v1.51.0

func (x *AutoscalingConfig_AutoscalingLimits) GetMaxProcessingUnits() int32

func (*AutoscalingConfig_AutoscalingLimits) GetMinLimit added in v1.51.0

func (m *AutoscalingConfig_AutoscalingLimits) GetMinLimit() isAutoscalingConfig_AutoscalingLimits_MinLimit

func (*AutoscalingConfig_AutoscalingLimits) GetMinNodes added in v1.51.0

func (x *AutoscalingConfig_AutoscalingLimits) GetMinNodes() int32

func (*AutoscalingConfig_AutoscalingLimits) GetMinProcessingUnits added in v1.51.0

func (x *AutoscalingConfig_AutoscalingLimits) GetMinProcessingUnits() int32

func (*AutoscalingConfig_AutoscalingLimits) ProtoMessage added in v1.51.0

func (*AutoscalingConfig_AutoscalingLimits) ProtoMessage()

func (*AutoscalingConfig_AutoscalingLimits) ProtoReflect added in v1.51.0

func (*AutoscalingConfig_AutoscalingLimits) Reset added in v1.51.0

func (*AutoscalingConfig_AutoscalingLimits) String added in v1.51.0

type AutoscalingConfig_AutoscalingLimits_MaxNodes added in v1.51.0

type AutoscalingConfig_AutoscalingLimits_MaxNodes struct {
	// Maximum number of nodes allocated to the instance. If set, this number
	// should be greater than or equal to min_nodes.
	MaxNodes int32 `protobuf:"varint,3,opt,name=max_nodes,json=maxNodes,proto3,oneof"`
}

type AutoscalingConfig_AutoscalingLimits_MaxProcessingUnits added in v1.51.0

type AutoscalingConfig_AutoscalingLimits_MaxProcessingUnits struct {
	// Maximum number of processing units allocated to the instance. If set,
	// this number should be multiples of 1000 and be greater than or equal to
	// min_processing_units.
	MaxProcessingUnits int32 `protobuf:"varint,4,opt,name=max_processing_units,json=maxProcessingUnits,proto3,oneof"`
}

type AutoscalingConfig_AutoscalingLimits_MinNodes added in v1.51.0

type AutoscalingConfig_AutoscalingLimits_MinNodes struct {
	// Minimum number of nodes allocated to the instance. If set, this number
	// should be greater than or equal to 1.
	MinNodes int32 `protobuf:"varint,1,opt,name=min_nodes,json=minNodes,proto3,oneof"`
}

type AutoscalingConfig_AutoscalingLimits_MinProcessingUnits added in v1.51.0

type AutoscalingConfig_AutoscalingLimits_MinProcessingUnits struct {
	// Minimum number of processing units allocated to the instance. If set,
	// this number should be multiples of 1000.
	MinProcessingUnits int32 `protobuf:"varint,2,opt,name=min_processing_units,json=minProcessingUnits,proto3,oneof"`
}

type AutoscalingConfig_AutoscalingTargets added in v1.51.0

type AutoscalingConfig_AutoscalingTargets struct {

	// Required. The target high priority cpu utilization percentage that the
	// autoscaler should be trying to achieve for the instance. This number is
	// on a scale from 0 (no utilization) to 100 (full utilization). The valid
	// range is [10, 90] inclusive.
	HighPriorityCpuUtilizationPercent int32 `` /* 167-byte string literal not displayed */
	// Required. The target storage utilization percentage that the autoscaler
	// should be trying to achieve for the instance. This number is on a scale
	// from 0 (no utilization) to 100 (full utilization). The valid range is
	// [10, 100] inclusive.
	StorageUtilizationPercent int32 `` /* 139-byte string literal not displayed */
	// contains filtered or unexported fields
}

The autoscaling targets for an instance.

func (*AutoscalingConfig_AutoscalingTargets) Descriptor deprecated added in v1.51.0

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

Deprecated: Use AutoscalingConfig_AutoscalingTargets.ProtoReflect.Descriptor instead.

func (*AutoscalingConfig_AutoscalingTargets) GetHighPriorityCpuUtilizationPercent added in v1.51.0

func (x *AutoscalingConfig_AutoscalingTargets) GetHighPriorityCpuUtilizationPercent() int32

func (*AutoscalingConfig_AutoscalingTargets) GetStorageUtilizationPercent added in v1.51.0

func (x *AutoscalingConfig_AutoscalingTargets) GetStorageUtilizationPercent() int32

func (*AutoscalingConfig_AutoscalingTargets) ProtoMessage added in v1.51.0

func (*AutoscalingConfig_AutoscalingTargets) ProtoMessage()

func (*AutoscalingConfig_AutoscalingTargets) ProtoReflect added in v1.51.0

func (*AutoscalingConfig_AutoscalingTargets) Reset added in v1.51.0

func (*AutoscalingConfig_AutoscalingTargets) String added in v1.51.0

type 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 deprecated

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

type CreateInstanceConfigRequest

type CreateInstanceConfigRequest struct {

	// Required. The name of the project in which to create the instance config.
	// Values are of the form `projects/<project>`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The ID of the instance config to create.  Valid identifiers are
	// of the form `custom-[-a-z0-9]*[a-z0-9]` and must be between 2 and 64
	// characters in length. The `custom-` prefix is required to avoid name
	// conflicts with Google managed configurations.
	InstanceConfigId string `protobuf:"bytes,2,opt,name=instance_config_id,json=instanceConfigId,proto3" json:"instance_config_id,omitempty"`
	// Required. The InstanceConfig proto of the configuration to create.
	// instance_config.name must be
	// `<parent>/instanceConfigs/<instance_config_id>`.
	// instance_config.base_config must be a Google managed configuration name,
	// e.g. <parent>/instanceConfigs/us-east1, <parent>/instanceConfigs/nam3.
	InstanceConfig *InstanceConfig `protobuf:"bytes,3,opt,name=instance_config,json=instanceConfig,proto3" json:"instance_config,omitempty"`
	// An option to validate, but not actually execute, a request,
	// and provide the same response.
	ValidateOnly bool `protobuf:"varint,4,opt,name=validate_only,json=validateOnly,proto3" json:"validate_only,omitempty"`
	// contains filtered or unexported fields
}

The request for CreateInstanceConfigRequest[InstanceAdmin.CreateInstanceConfigRequest].

func (*CreateInstanceConfigRequest) Descriptor deprecated

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

type 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 deprecated

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

type CreateInstanceRequest

type CreateInstanceRequest struct {

	// Required. The name of the project in which to create the instance. Values
	// are of the form `projects/<project>`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The ID of the instance to create.  Valid identifiers are of the
	// form `[a-z][-a-z0-9]*[a-z0-9]` and must be between 2 and 64 characters in
	// length.
	InstanceId string `protobuf:"bytes,2,opt,name=instance_id,json=instanceId,proto3" json:"instance_id,omitempty"`
	// Required. The instance to create.  The name may be omitted, but if
	// specified must be `<parent>/instances/<instance_id>`.
	Instance *Instance `protobuf:"bytes,3,opt,name=instance,proto3" json:"instance,omitempty"`
	// contains filtered or unexported fields
}

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

func (*CreateInstanceRequest) Descriptor deprecated

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

type DeleteInstanceConfigRequest

type DeleteInstanceConfigRequest struct {

	// Required. The name of the instance configuration to be deleted.
	// Values are of the form
	// `projects/<project>/instanceConfigs/<instance_config>`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Used for optimistic concurrency control as a way to help prevent
	// simultaneous deletes of an instance config from overwriting each
	// other. If not empty, the API
	// only deletes the instance config when the etag provided matches the current
	// status of the requested instance config. Otherwise, deletes the instance
	// config without checking the current status of the requested instance
	// config.
	Etag string `protobuf:"bytes,2,opt,name=etag,proto3" json:"etag,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 DeleteInstanceConfigRequest[InstanceAdmin.DeleteInstanceConfigRequest].

func (*DeleteInstanceConfigRequest) Descriptor deprecated

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

type DeleteInstanceRequest

type DeleteInstanceRequest struct {

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

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

func (*DeleteInstanceRequest) Descriptor deprecated

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

type GetInstanceConfigRequest

type GetInstanceConfigRequest struct {

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

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

func (*GetInstanceConfigRequest) Descriptor deprecated

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

type GetInstanceRequest

type GetInstanceRequest struct {

	// Required. The name of the requested instance. Values are of the form
	// `projects/<project>/instances/<instance>`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// If field_mask is present, specifies the subset of
	// [Instance][google.spanner.admin.instance.v1.Instance] fields that should be
	// returned. If absent, all
	// [Instance][google.spanner.admin.instance.v1.Instance] fields are returned.
	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 [GetInstance][google.spanner.admin.instance.v1.InstanceAdmin.GetInstance].

func (*GetInstanceRequest) Descriptor deprecated

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

type Instance

type Instance struct {

	// Required. A unique identifier for the instance, which cannot be changed
	// after the instance is created. Values are of the form
	// `projects/<project>/instances/[a-z][-a-z0-9]*[a-z0-9]`. The final
	// segment of the name must be between 2 and 64 characters in length.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. The name of the instance's configuration. Values are of the form
	// `projects/<project>/instanceConfigs/<configuration>`. See
	// also [InstanceConfig][google.spanner.admin.instance.v1.InstanceConfig] and
	// [ListInstanceConfigs][google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigs].
	Config string `protobuf:"bytes,2,opt,name=config,proto3" json:"config,omitempty"`
	// Required. The descriptive name for this instance as it appears in UIs.
	// Must be unique per project and between 4 and 30 characters in length.
	DisplayName string `protobuf:"bytes,3,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// The number of nodes allocated to this instance. At most one of either
	// node_count or processing_units should be present in the message.
	//
	// Users can set the node_count field to specify the target number of nodes
	// allocated to the instance.
	//
	// This may be zero in API responses for instances that are not yet in state
	// `READY`.
	//
	// See [the
	// documentation](https://cloud.google.com/spanner/docs/compute-capacity)
	// for more information about nodes and processing units.
	NodeCount int32 `protobuf:"varint,5,opt,name=node_count,json=nodeCount,proto3" json:"node_count,omitempty"`
	// The number of processing units allocated to this instance. At most one of
	// processing_units or node_count should be present in the message.
	//
	// Users can set the processing_units field to specify the target number of
	// processing units allocated to the instance.
	//
	// This may be zero in API responses for instances that are not yet in state
	// `READY`.
	//
	// See [the
	// documentation](https://cloud.google.com/spanner/docs/compute-capacity)
	// for more information about nodes and processing units.
	ProcessingUnits int32 `protobuf:"varint,9,opt,name=processing_units,json=processingUnits,proto3" json:"processing_units,omitempty"`
	// Optional. The autoscaling configuration. Autoscaling is enabled if this
	// field is set. When autoscaling is enabled, node_count and processing_units
	// are treated as OUTPUT_ONLY fields and reflect the current compute capacity
	// allocated to the instance.
	AutoscalingConfig *AutoscalingConfig `protobuf:"bytes,17,opt,name=autoscaling_config,json=autoscalingConfig,proto3" json:"autoscaling_config,omitempty"`
	// Output only. The current instance state. For
	// [CreateInstance][google.spanner.admin.instance.v1.InstanceAdmin.CreateInstance],
	// the state must be either omitted or set to `CREATING`. For
	// [UpdateInstance][google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstance],
	// the state must be either omitted or set to `READY`.
	State Instance_State `protobuf:"varint,6,opt,name=state,proto3,enum=google.spanner.admin.instance.v1.Instance_State" json:"state,omitempty"`
	// Cloud Labels are a flexible and lightweight mechanism for organizing cloud
	// resources into groups that reflect a customer's organizational needs and
	// deployment strategies. Cloud Labels can be used to filter collections of
	// resources. They can be used to control how resource metrics are aggregated.
	// And they can be used as arguments to policy management rules (e.g. route,
	// firewall, load balancing, etc.).
	//
	//   - Label keys must be between 1 and 63 characters long and must conform to
	//     the following regular expression: `[a-z][a-z0-9_-]{0,62}`.
	//   - Label values must be between 0 and 63 characters long and must conform
	//     to the regular expression `[a-z0-9_-]{0,63}`.
	//   - No more than 64 labels can be associated with a given resource.
	//
	// See https://goo.gl/xmQnxf for more information on and examples of labels.
	//
	// If you plan to use labels in your own code, please note that additional
	// characters may be allowed in the future. And so you are advised to use an
	// internal label representation, such as JSON, which doesn't rely upon
	// specific characters being disallowed.  For example, representing labels
	// as the string:  name + "_" + value  would prove problematic if we were to
	// allow "_" in a future release.
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// Deprecated. This field is not populated.
	EndpointUris []string `protobuf:"bytes,8,rep,name=endpoint_uris,json=endpointUris,proto3" json:"endpoint_uris,omitempty"`
	// Output only. The time at which the instance was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,11,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. The time at which the instance was most recently updated.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,12,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// contains filtered or unexported fields
}

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

func (*Instance) Descriptor deprecated

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

Deprecated: Use Instance.ProtoReflect.Descriptor instead.

func (*Instance) GetAutoscalingConfig added in v1.51.0

func (x *Instance) GetAutoscalingConfig() *AutoscalingConfig

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

type 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
	// `<instance_config_name>/operations/<operation_id>` and can be used to track
	// creation of the instance config. The
	// [metadata][google.longrunning.Operation.metadata] field type is
	// [CreateInstanceConfigMetadata][google.spanner.admin.instance.v1.CreateInstanceConfigMetadata].
	// The [response][google.longrunning.Operation.response] field type is
	// [InstanceConfig][google.spanner.admin.instance.v1.InstanceConfig], if
	// successful.
	//
	// Authorization requires `spanner.instanceConfigs.create` permission on
	// the resource
	// [parent][google.spanner.admin.instance.v1.CreateInstanceConfigRequest.parent].
	CreateInstanceConfig(ctx context.Context, in *CreateInstanceConfigRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Updates an instance config. The returned
	// [long-running operation][google.longrunning.Operation] can be used to track
	// the progress of updating the instance. If the named instance config does
	// not exist, returns `NOT_FOUND`.
	//
	// Only user managed configurations can be updated.
	//
	// Immediately after the request returns:
	//
	//   - The instance config's
	//     [reconciling][google.spanner.admin.instance.v1.InstanceConfig.reconciling]
	//     field is set to true.
	//
	// While the operation is pending:
	//
	//   - Cancelling the operation sets its metadata's
	//     [cancel_time][google.spanner.admin.instance.v1.UpdateInstanceConfigMetadata.cancel_time].
	//     The operation is guaranteed to succeed at undoing all changes, after
	//     which point it terminates with a `CANCELLED` status.
	//   - All other attempts to modify the instance config are rejected.
	//   - Reading the instance config via the API continues to give the
	//     pre-request values.
	//
	// Upon completion of the returned operation:
	//
	//   - Creating instances using the instance configuration uses the new
	//     values.
	//   - The instance config's new values are readable via the API.
	//   - The instance config's
	//     [reconciling][google.spanner.admin.instance.v1.InstanceConfig.reconciling]
	//     field becomes false.
	//
	// The returned [long-running operation][google.longrunning.Operation] will
	// have a name of the format
	// `<instance_config_name>/operations/<operation_id>` and can be used to track
	// the instance config modification.  The
	// [metadata][google.longrunning.Operation.metadata] field type is
	// [UpdateInstanceConfigMetadata][google.spanner.admin.instance.v1.UpdateInstanceConfigMetadata].
	// The [response][google.longrunning.Operation.response] field type is
	// [InstanceConfig][google.spanner.admin.instance.v1.InstanceConfig], if
	// successful.
	//
	// Authorization requires `spanner.instanceConfigs.update` permission on
	// the resource [name][google.spanner.admin.instance.v1.InstanceConfig.name].
	UpdateInstanceConfig(ctx context.Context, in *UpdateInstanceConfigRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Deletes the instance config. Deletion is only allowed when no
	// instances are using the configuration. If any instances are using
	// the config, returns `FAILED_PRECONDITION`.
	//
	// Only user managed configurations can be deleted.
	//
	// Authorization requires `spanner.instanceConfigs.delete` permission on
	// the resource [name][google.spanner.admin.instance.v1.InstanceConfig.name].
	DeleteInstanceConfig(ctx context.Context, in *DeleteInstanceConfigRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Lists the user-managed instance config [long-running
	// operations][google.longrunning.Operation] in the given project. An instance
	// config operation has a name of the form
	// `projects/<project>/instanceConfigs/<instance_config>/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.start_time` in descending order starting
	// from the most recently started operation.
	ListInstanceConfigOperations(ctx context.Context, in *ListInstanceConfigOperationsRequest, opts ...grpc.CallOption) (*ListInstanceConfigOperationsResponse, error)
	// Lists all instances in the given project.
	ListInstances(ctx context.Context, in *ListInstancesRequest, opts ...grpc.CallOption) (*ListInstancesResponse, error)
	// Gets information about a particular instance.
	GetInstance(ctx context.Context, in *GetInstanceRequest, opts ...grpc.CallOption) (*Instance, error)
	// Creates an instance and begins preparing it to begin serving. The
	// returned [long-running operation][google.longrunning.Operation]
	// can be used to track the progress of preparing the new
	// instance. The instance name is assigned by the caller. If the
	// named instance already exists, `CreateInstance` returns
	// `ALREADY_EXISTS`.
	//
	// Immediately upon completion of this request:
	//
	//   - The instance is readable via the API, with all requested attributes
	//     but no allocated resources. Its state is `CREATING`.
	//
	// Until completion of the returned operation:
	//
	//   - Cancelling the operation renders the instance immediately unreadable
	//     via the API.
	//   - The instance can be deleted.
	//   - All other attempts to modify the instance are rejected.
	//
	// Upon completion of the returned operation:
	//
	//   - Billing for all successfully-allocated resources begins (some types
	//     may have lower than the requested levels).
	//   - Databases can be created in the instance.
	//   - The instance's allocated resource levels are readable via the API.
	//   - The instance's state becomes `READY`.
	//
	// The returned [long-running operation][google.longrunning.Operation] will
	// have a name of the format `<instance_name>/operations/<operation_id>` and
	// can be used to track creation of the instance.  The
	// [metadata][google.longrunning.Operation.metadata] field type is
	// [CreateInstanceMetadata][google.spanner.admin.instance.v1.CreateInstanceMetadata].
	// The [response][google.longrunning.Operation.response] field type is
	// [Instance][google.spanner.admin.instance.v1.Instance], if successful.
	CreateInstance(ctx context.Context, in *CreateInstanceRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Updates an instance, and begins allocating or releasing resources
	// as requested. The returned [long-running
	// operation][google.longrunning.Operation] can be used to track the
	// progress of updating the instance. If the named instance does not
	// exist, returns `NOT_FOUND`.
	//
	// Immediately upon completion of this request:
	//
	//   - For resource types for which a decrease in the instance's allocation
	//     has been requested, billing is based on the newly-requested level.
	//
	// Until completion of the returned operation:
	//
	//   - Cancelling the operation sets its metadata's
	//     [cancel_time][google.spanner.admin.instance.v1.UpdateInstanceMetadata.cancel_time],
	//     and begins restoring resources to their pre-request values. The
	//     operation is guaranteed to succeed at undoing all resource changes,
	//     after which point it terminates with a `CANCELLED` status.
	//   - All other attempts to modify the instance are rejected.
	//   - Reading the instance via the API continues to give the pre-request
	//     resource levels.
	//
	// Upon completion of the returned operation:
	//
	//   - Billing begins for all successfully-allocated resources (some types
	//     may have lower than the requested levels).
	//   - All newly-reserved resources are available for serving the instance's
	//     tables.
	//   - The instance's new resource levels are readable via the API.
	//
	// The returned [long-running operation][google.longrunning.Operation] will
	// have a name of the format `<instance_name>/operations/<operation_id>` and
	// can be used to track the instance modification.  The
	// [metadata][google.longrunning.Operation.metadata] field type is
	// [UpdateInstanceMetadata][google.spanner.admin.instance.v1.UpdateInstanceMetadata].
	// The [response][google.longrunning.Operation.response] field type is
	// [Instance][google.spanner.admin.instance.v1.Instance], if successful.
	//
	// Authorization requires `spanner.instances.update` permission on
	// the resource [name][google.spanner.admin.instance.v1.Instance.name].
	UpdateInstance(ctx context.Context, in *UpdateInstanceRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Deletes an instance.
	//
	// Immediately upon completion of the request:
	//
	//   - Billing ceases for all of the instance's reserved resources.
	//
	// Soon afterward:
	//
	//   - The instance and *all of its databases* immediately and
	//     irrevocably disappear from the API. All data in the databases
	//     is permanently deleted.
	DeleteInstance(ctx context.Context, in *DeleteInstanceRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Sets the access control policy on an instance resource. Replaces any
	// existing policy.
	//
	// Authorization requires `spanner.instances.setIamPolicy` on
	// [resource][google.iam.v1.SetIamPolicyRequest.resource].
	SetIamPolicy(ctx context.Context, in *iampb.SetIamPolicyRequest, opts ...grpc.CallOption) (*iampb.Policy, error)
	// Gets the access control policy for an instance resource. Returns an empty
	// policy if an instance exists but does not have a policy set.
	//
	// Authorization requires `spanner.instances.getIamPolicy` on
	// [resource][google.iam.v1.GetIamPolicyRequest.resource].
	GetIamPolicy(ctx context.Context, in *iampb.GetIamPolicyRequest, opts ...grpc.CallOption) (*iampb.Policy, error)
	// Returns permissions that the caller has on the specified instance resource.
	//
	// Attempting this RPC on a non-existent Cloud Spanner instance resource will
	// result in a NOT_FOUND error if the user has `spanner.instances.list`
	// permission on the containing Google Cloud Project. Otherwise returns an
	// empty set of permissions.
	TestIamPermissions(ctx context.Context, in *iampb.TestIamPermissionsRequest, opts ...grpc.CallOption) (*iampb.TestIamPermissionsResponse, error)
}

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.

type 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
	// `<instance_config_name>/operations/<operation_id>` and can be used to track
	// creation of the instance config. The
	// [metadata][google.longrunning.Operation.metadata] field type is
	// [CreateInstanceConfigMetadata][google.spanner.admin.instance.v1.CreateInstanceConfigMetadata].
	// The [response][google.longrunning.Operation.response] field type is
	// [InstanceConfig][google.spanner.admin.instance.v1.InstanceConfig], if
	// successful.
	//
	// Authorization requires `spanner.instanceConfigs.create` permission on
	// the resource
	// [parent][google.spanner.admin.instance.v1.CreateInstanceConfigRequest.parent].
	CreateInstanceConfig(context.Context, *CreateInstanceConfigRequest) (*longrunningpb.Operation, error)
	// Updates an instance config. The returned
	// [long-running operation][google.longrunning.Operation] can be used to track
	// the progress of updating the instance. If the named instance config does
	// not exist, returns `NOT_FOUND`.
	//
	// Only user managed configurations can be updated.
	//
	// Immediately after the request returns:
	//
	//   - The instance config's
	//     [reconciling][google.spanner.admin.instance.v1.InstanceConfig.reconciling]
	//     field is set to true.
	//
	// While the operation is pending:
	//
	//   - Cancelling the operation sets its metadata's
	//     [cancel_time][google.spanner.admin.instance.v1.UpdateInstanceConfigMetadata.cancel_time].
	//     The operation is guaranteed to succeed at undoing all changes, after
	//     which point it terminates with a `CANCELLED` status.
	//   - All other attempts to modify the instance config are rejected.
	//   - Reading the instance config via the API continues to give the
	//     pre-request values.
	//
	// Upon completion of the returned operation:
	//
	//   - Creating instances using the instance configuration uses the new
	//     values.
	//   - The instance config's new values are readable via the API.
	//   - The instance config's
	//     [reconciling][google.spanner.admin.instance.v1.InstanceConfig.reconciling]
	//     field becomes false.
	//
	// The returned [long-running operation][google.longrunning.Operation] will
	// have a name of the format
	// `<instance_config_name>/operations/<operation_id>` and can be used to track
	// the instance config modification.  The
	// [metadata][google.longrunning.Operation.metadata] field type is
	// [UpdateInstanceConfigMetadata][google.spanner.admin.instance.v1.UpdateInstanceConfigMetadata].
	// The [response][google.longrunning.Operation.response] field type is
	// [InstanceConfig][google.spanner.admin.instance.v1.InstanceConfig], if
	// successful.
	//
	// Authorization requires `spanner.instanceConfigs.update` permission on
	// the resource [name][google.spanner.admin.instance.v1.InstanceConfig.name].
	UpdateInstanceConfig(context.Context, *UpdateInstanceConfigRequest) (*longrunningpb.Operation, error)
	// Deletes the instance config. Deletion is only allowed when no
	// instances are using the configuration. If any instances are using
	// the config, returns `FAILED_PRECONDITION`.
	//
	// Only user managed configurations can be deleted.
	//
	// Authorization requires `spanner.instanceConfigs.delete` permission on
	// the resource [name][google.spanner.admin.instance.v1.InstanceConfig.name].
	DeleteInstanceConfig(context.Context, *DeleteInstanceConfigRequest) (*emptypb.Empty, error)
	// Lists the user-managed instance config [long-running
	// operations][google.longrunning.Operation] in the given project. An instance
	// config operation has a name of the form
	// `projects/<project>/instanceConfigs/<instance_config>/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.start_time` in descending order starting
	// from the most recently started operation.
	ListInstanceConfigOperations(context.Context, *ListInstanceConfigOperationsRequest) (*ListInstanceConfigOperationsResponse, error)
	// Lists all instances in the given project.
	ListInstances(context.Context, *ListInstancesRequest) (*ListInstancesResponse, error)
	// Gets information about a particular instance.
	GetInstance(context.Context, *GetInstanceRequest) (*Instance, error)
	// Creates an instance and begins preparing it to begin serving. The
	// returned [long-running operation][google.longrunning.Operation]
	// can be used to track the progress of preparing the new
	// instance. The instance name is assigned by the caller. If the
	// named instance already exists, `CreateInstance` returns
	// `ALREADY_EXISTS`.
	//
	// Immediately upon completion of this request:
	//
	//   - The instance is readable via the API, with all requested attributes
	//     but no allocated resources. Its state is `CREATING`.
	//
	// Until completion of the returned operation:
	//
	//   - Cancelling the operation renders the instance immediately unreadable
	//     via the API.
	//   - The instance can be deleted.
	//   - All other attempts to modify the instance are rejected.
	//
	// Upon completion of the returned operation:
	//
	//   - Billing for all successfully-allocated resources begins (some types
	//     may have lower than the requested levels).
	//   - Databases can be created in the instance.
	//   - The instance's allocated resource levels are readable via the API.
	//   - The instance's state becomes `READY`.
	//
	// The returned [long-running operation][google.longrunning.Operation] will
	// have a name of the format `<instance_name>/operations/<operation_id>` and
	// can be used to track creation of the instance.  The
	// [metadata][google.longrunning.Operation.metadata] field type is
	// [CreateInstanceMetadata][google.spanner.admin.instance.v1.CreateInstanceMetadata].
	// The [response][google.longrunning.Operation.response] field type is
	// [Instance][google.spanner.admin.instance.v1.Instance], if successful.
	CreateInstance(context.Context, *CreateInstanceRequest) (*longrunningpb.Operation, error)
	// Updates an instance, and begins allocating or releasing resources
	// as requested. The returned [long-running
	// operation][google.longrunning.Operation] can be used to track the
	// progress of updating the instance. If the named instance does not
	// exist, returns `NOT_FOUND`.
	//
	// Immediately upon completion of this request:
	//
	//   - For resource types for which a decrease in the instance's allocation
	//     has been requested, billing is based on the newly-requested level.
	//
	// Until completion of the returned operation:
	//
	//   - Cancelling the operation sets its metadata's
	//     [cancel_time][google.spanner.admin.instance.v1.UpdateInstanceMetadata.cancel_time],
	//     and begins restoring resources to their pre-request values. The
	//     operation is guaranteed to succeed at undoing all resource changes,
	//     after which point it terminates with a `CANCELLED` status.
	//   - All other attempts to modify the instance are rejected.
	//   - Reading the instance via the API continues to give the pre-request
	//     resource levels.
	//
	// Upon completion of the returned operation:
	//
	//   - Billing begins for all successfully-allocated resources (some types
	//     may have lower than the requested levels).
	//   - All newly-reserved resources are available for serving the instance's
	//     tables.
	//   - The instance's new resource levels are readable via the API.
	//
	// The returned [long-running operation][google.longrunning.Operation] will
	// have a name of the format `<instance_name>/operations/<operation_id>` and
	// can be used to track the instance modification.  The
	// [metadata][google.longrunning.Operation.metadata] field type is
	// [UpdateInstanceMetadata][google.spanner.admin.instance.v1.UpdateInstanceMetadata].
	// The [response][google.longrunning.Operation.response] field type is
	// [Instance][google.spanner.admin.instance.v1.Instance], if successful.
	//
	// Authorization requires `spanner.instances.update` permission on
	// the resource [name][google.spanner.admin.instance.v1.Instance.name].
	UpdateInstance(context.Context, *UpdateInstanceRequest) (*longrunningpb.Operation, error)
	// Deletes an instance.
	//
	// Immediately upon completion of the request:
	//
	//   - Billing ceases for all of the instance's reserved resources.
	//
	// Soon afterward:
	//
	//   - The instance and *all of its databases* immediately and
	//     irrevocably disappear from the API. All data in the databases
	//     is permanently deleted.
	DeleteInstance(context.Context, *DeleteInstanceRequest) (*emptypb.Empty, error)
	// Sets the access control policy on an instance resource. Replaces any
	// existing policy.
	//
	// Authorization requires `spanner.instances.setIamPolicy` on
	// [resource][google.iam.v1.SetIamPolicyRequest.resource].
	SetIamPolicy(context.Context, *iampb.SetIamPolicyRequest) (*iampb.Policy, error)
	// Gets the access control policy for an instance resource. Returns an empty
	// policy if an instance exists but does not have a policy set.
	//
	// Authorization requires `spanner.instances.getIamPolicy` on
	// [resource][google.iam.v1.GetIamPolicyRequest.resource].
	GetIamPolicy(context.Context, *iampb.GetIamPolicyRequest) (*iampb.Policy, error)
	// Returns permissions that the caller has on the specified instance resource.
	//
	// Attempting this RPC on a non-existent Cloud Spanner instance resource will
	// result in a NOT_FOUND error if the user has `spanner.instances.list`
	// permission on the containing Google Cloud Project. Otherwise returns an
	// empty set of permissions.
	TestIamPermissions(context.Context, *iampb.TestIamPermissionsRequest) (*iampb.TestIamPermissionsResponse, error)
}

InstanceAdminServer is the server API for InstanceAdmin service.

type InstanceConfig

type InstanceConfig struct {

	// A unique identifier for the instance configuration.  Values
	// are of the form
	// `projects/<project>/instanceConfigs/[a-z][-a-z0-9]*`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The name of this instance configuration as it appears in UIs.
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Output only. Whether this instance config is a Google or User Managed
	// Configuration.
	ConfigType InstanceConfig_Type `` /* 150-byte string literal not displayed */
	// The geographic placement of nodes in this instance configuration and their
	// replication properties.
	Replicas []*ReplicaInfo `protobuf:"bytes,3,rep,name=replicas,proto3" json:"replicas,omitempty"`
	// Output only. The available optional replicas to choose from for user
	// managed configurations. Populated for Google managed configurations.
	OptionalReplicas []*ReplicaInfo `protobuf:"bytes,6,rep,name=optional_replicas,json=optionalReplicas,proto3" json:"optional_replicas,omitempty"`
	// Base configuration name, e.g. projects/<project_name>/instanceConfigs/nam3,
	// based on which this configuration is created. Only set for user managed
	// configurations. `base_config` must refer to a configuration of type
	// GOOGLE_MANAGED in the same project as this configuration.
	BaseConfig string `protobuf:"bytes,7,opt,name=base_config,json=baseConfig,proto3" json:"base_config,omitempty"`
	// Cloud Labels are a flexible and lightweight mechanism for organizing cloud
	// resources into groups that reflect a customer's organizational needs and
	// deployment strategies. Cloud Labels can be used to filter collections of
	// resources. They can be used to control how resource metrics are aggregated.
	// And they can be used as arguments to policy management rules (e.g. route,
	// firewall, load balancing, etc.).
	//
	//   - Label keys must be between 1 and 63 characters long and must conform to
	//     the following regular expression: `[a-z][a-z0-9_-]{0,62}`.
	//   - Label values must be between 0 and 63 characters long and must conform
	//     to the regular expression `[a-z0-9_-]{0,63}`.
	//   - No more than 64 labels can be associated with a given resource.
	//
	// See https://goo.gl/xmQnxf for more information on and examples of labels.
	//
	// If you plan to use labels in your own code, please note that additional
	// characters may be allowed in the future. Therefore, you are advised to use
	// an internal label representation, such as JSON, which doesn't rely upon
	// specific characters being disallowed.  For example, representing labels
	// as the string:  name + "_" + value  would prove problematic if we were to
	// allow "_" in a future release.
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// etag is used for optimistic concurrency control as a way
	// to help prevent simultaneous updates of a instance config from overwriting
	// each other. It is strongly suggested that systems make use of the etag in
	// the read-modify-write cycle to perform instance config updates in order to
	// avoid race conditions: An etag is returned in the response which contains
	// instance configs, and systems are expected to put that etag in the request
	// to update instance config to ensure that their change will be applied to
	// the same version of the instance config.
	// If no etag is provided in the call to update instance config, then the
	// existing instance config is overwritten blindly.
	Etag string `protobuf:"bytes,9,opt,name=etag,proto3" json:"etag,omitempty"`
	// Allowed values of the "default_leader" schema option for databases in
	// instances that use this instance configuration.
	LeaderOptions []string `protobuf:"bytes,4,rep,name=leader_options,json=leaderOptions,proto3" json:"leader_options,omitempty"`
	// Output only. If true, the instance config is being created or updated. If
	// false, there are no ongoing operations for the instance config.
	Reconciling bool `protobuf:"varint,10,opt,name=reconciling,proto3" json:"reconciling,omitempty"`
	// Output only. The current instance config state.
	State InstanceConfig_State `protobuf:"varint,11,opt,name=state,proto3,enum=google.spanner.admin.instance.v1.InstanceConfig_State" json:"state,omitempty"`
	// contains filtered or unexported fields
}

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

func (*InstanceConfig) Descriptor deprecated

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

type InstanceConfig_State

type InstanceConfig_State int32

Indicates the current state of the instance config.

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 deprecated

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

type InstanceConfig_Type

type InstanceConfig_Type int32

The type of this configuration.

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 deprecated

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

type Instance_State

type Instance_State int32

Indicates the current state of the instance.

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 deprecated

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

type ListInstanceConfigOperationsRequest

type ListInstanceConfigOperationsRequest struct {

	// Required. The project of the instance config operations.
	// Values are of the form `projects/<project>`.
	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
	//     [CreateInstanceConfigMetadata][google.spanner.admin.instance.v1.CreateInstanceConfigMetadata]
	//     is
	//     `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstanceConfigMetadata`.
	//   - `metadata.<field_name>` - any field in metadata.value.
	//     `metadata.@type` must be specified first, if filtering on metadata
	//     fields.
	//   - `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.instance.v1.CreateInstanceConfigMetadata)
	//     AND` \
	//     `(metadata.instance_config.name:custom-config) AND` \
	//     `(metadata.progress.start_time < \"2021-03-28T14:50:00Z\") AND` \
	//     `(error:*)` - Return operations where:
	//   - The operation's metadata type is
	//     [CreateInstanceConfigMetadata][google.spanner.admin.instance.v1.CreateInstanceConfigMetadata].
	//   - The instance config name contains "custom-config".
	//   - The operation started before 2021-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.instance.v1.ListInstanceConfigOperationsResponse.next_page_token]
	// from a previous
	// [ListInstanceConfigOperationsResponse][google.spanner.admin.instance.v1.ListInstanceConfigOperationsResponse]
	// to the same `parent` and with the same `filter`.
	PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

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

func (*ListInstanceConfigOperationsRequest) Descriptor deprecated

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

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

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

type 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/<project>`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Number of instance configurations to be returned in the response. If 0 or
	// less, defaults to the server's maximum allowed page size.
	PageSize int32 `protobuf:"varint,2,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.instance.v1.ListInstanceConfigsResponse.next_page_token]
	// from a previous
	// [ListInstanceConfigsResponse][google.spanner.admin.instance.v1.ListInstanceConfigsResponse].
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

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

func (*ListInstanceConfigsRequest) Descriptor deprecated

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

type 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 deprecated

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

type ListInstancesRequest

type ListInstancesRequest struct {

	// Required. The name of the project for which a list of instances is
	// requested. Values are of the form `projects/<project>`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Number of instances to be returned in the response. If 0 or less, defaults
	// to the server's maximum allowed page size.
	PageSize int32 `protobuf:"varint,2,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.instance.v1.ListInstancesResponse.next_page_token]
	// from a previous
	// [ListInstancesResponse][google.spanner.admin.instance.v1.ListInstancesResponse].
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// An expression for filtering the results of the request. Filter rules are
	// case insensitive. The fields eligible for filtering are:
	//
	//   - `name`
	//   - `display_name`
	//   - `labels.key` where key is the name of a label
	//
	// Some examples of using filters are:
	//
	//   - `name:*` --> The instance has a name.
	//   - `name:Howl` --> The instance's name contains the string "howl".
	//   - `name:HOWL` --> Equivalent to above.
	//   - `NAME:howl` --> Equivalent to above.
	//   - `labels.env:*` --> The instance has the label "env".
	//   - `labels.env:dev` --> The instance has the label "env" and the value of
	//     the label contains the string "dev".
	//   - `name:howl labels.env:dev` --> The instance's name contains "howl" and
	//     it has the label "env" with its value
	//     containing "dev".
	Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
	// contains filtered or unexported fields
}

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

func (*ListInstancesRequest) Descriptor deprecated

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

type 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 deprecated

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

type OperationProgress

type OperationProgress struct {

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

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

func (*OperationProgress) Descriptor deprecated

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

Deprecated: Use OperationProgress.ProtoReflect.Descriptor instead.

func (*OperationProgress) GetEndTime

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

func (*OperationProgress) GetProgressPercent

func (x *OperationProgress) GetProgressPercent() int32

func (*OperationProgress) GetStartTime

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

func (*OperationProgress) ProtoMessage

func (*OperationProgress) ProtoMessage()

func (*OperationProgress) ProtoReflect

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

func (*OperationProgress) Reset

func (x *OperationProgress) Reset()

func (*OperationProgress) String

func (x *OperationProgress) String() string

type ReplicaInfo

type ReplicaInfo struct {

	// The location of the serving resources, e.g. "us-central1".
	Location string `protobuf:"bytes,1,opt,name=location,proto3" json:"location,omitempty"`
	// The type of replica.
	Type ReplicaInfo_ReplicaType `protobuf:"varint,2,opt,name=type,proto3,enum=google.spanner.admin.instance.v1.ReplicaInfo_ReplicaType" json:"type,omitempty"`
	// If true, this location is designated as the default leader location where
	// leader replicas are placed. See the [region types
	// documentation](https://cloud.google.com/spanner/docs/instances#region_types)
	// for more details.
	DefaultLeaderLocation bool `` /* 127-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*ReplicaInfo) Descriptor deprecated

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

type ReplicaInfo_ReplicaType

type ReplicaInfo_ReplicaType int32

Indicates the type of replica. See the [replica types documentation](https://cloud.google.com/spanner/docs/replication#replica_types) for more details.

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 deprecated

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

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

func (*UnimplementedInstanceAdminServer) ListInstances

func (*UnimplementedInstanceAdminServer) SetIamPolicy

func (*UnimplementedInstanceAdminServer) UpdateInstance

func (*UnimplementedInstanceAdminServer) UpdateInstanceConfig

type 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 deprecated

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

type 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 deprecated

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

type 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 deprecated

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

type 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 deprecated

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

Jump to

Keyboard shortcuts

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