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

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,
	}
)

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,
	}
)

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,
	}
)

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,
	}
)

var File_google_spanner_admin_instance_v1_common_proto protoreflect.FileDescriptor

var File_google_spanner_admin_instance_v1_spanner_instance_admin_proto protoreflect.FileDescriptor

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

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
}

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

func (x *AutoscalingConfig) GetAutoscalingLimits() *AutoscalingConfig_AutoscalingLimits

func (x *AutoscalingConfig) GetAutoscalingTargets() *AutoscalingConfig_AutoscalingTargets

func (*AutoscalingConfig) ProtoMessage()

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

func (x *AutoscalingConfig) Reset()

func (x *AutoscalingConfig) String() string

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
}

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

func (m *AutoscalingConfig_AutoscalingLimits) GetMaxLimit() isAutoscalingConfig_AutoscalingLimits_MaxLimit

func (x *AutoscalingConfig_AutoscalingLimits) GetMaxNodes() int32

func (x *AutoscalingConfig_AutoscalingLimits) GetMaxProcessingUnits() int32

func (m *AutoscalingConfig_AutoscalingLimits) GetMinLimit() isAutoscalingConfig_AutoscalingLimits_MinLimit

func (x *AutoscalingConfig_AutoscalingLimits) GetMinNodes() int32

func (x *AutoscalingConfig_AutoscalingLimits) GetMinProcessingUnits() int32

func (*AutoscalingConfig_AutoscalingLimits) ProtoMessage()

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

func (x *AutoscalingConfig_AutoscalingLimits) Reset()

func (x *AutoscalingConfig_AutoscalingLimits) String() string

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 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 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 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 struct {
	HighPriorityCpuUtilizationPercent int32 "" /* 167 byte string literal not displayed */

	StorageUtilizationPercent int32 "" /* 139 byte string literal not displayed */

}

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

func (x *AutoscalingConfig_AutoscalingTargets) GetHighPriorityCpuUtilizationPercent() int32

func (x *AutoscalingConfig_AutoscalingTargets) GetStorageUtilizationPercent() int32

func (*AutoscalingConfig_AutoscalingTargets) ProtoMessage()

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

func (x *AutoscalingConfig_AutoscalingTargets) Reset()

func (x *AutoscalingConfig_AutoscalingTargets) String() string

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
}

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

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

func (x *CreateInstanceConfigMetadata) GetInstanceConfig() *InstanceConfig

func (x *CreateInstanceConfigMetadata) GetProgress() *OperationProgress

func (*CreateInstanceConfigMetadata) ProtoMessage()

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

func (x *CreateInstanceConfigMetadata) Reset()

func (x *CreateInstanceConfigMetadata) String() string

type CreateInstanceConfigRequest struct {

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

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

func (x *CreateInstanceConfigRequest) GetInstanceConfig() *InstanceConfig

func (x *CreateInstanceConfigRequest) GetInstanceConfigId() string

func (x *CreateInstanceConfigRequest) GetParent() string

func (x *CreateInstanceConfigRequest) GetValidateOnly() bool

func (*CreateInstanceConfigRequest) ProtoMessage()

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

func (x *CreateInstanceConfigRequest) Reset()

func (x *CreateInstanceConfigRequest) String() string

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
}

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

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

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

func (x *CreateInstanceMetadata) GetInstance() *Instance

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

func (*CreateInstanceMetadata) ProtoMessage()

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

func (x *CreateInstanceMetadata) Reset()

func (x *CreateInstanceMetadata) String() string

type CreateInstanceRequest struct {

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

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

func (x *CreateInstanceRequest) GetInstance() *Instance

func (x *CreateInstanceRequest) GetInstanceId() string

func (x *CreateInstanceRequest) GetParent() string

func (*CreateInstanceRequest) ProtoMessage()

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

func (x *CreateInstanceRequest) Reset()

func (x *CreateInstanceRequest) String() string

type DeleteInstanceConfigRequest struct {

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

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

func (x *DeleteInstanceConfigRequest) GetEtag() string

func (x *DeleteInstanceConfigRequest) GetName() string

func (x *DeleteInstanceConfigRequest) GetValidateOnly() bool

func (*DeleteInstanceConfigRequest) ProtoMessage()

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

func (x *DeleteInstanceConfigRequest) Reset()

func (x *DeleteInstanceConfigRequest) String() string

type DeleteInstanceRequest struct {

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

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

func (x *DeleteInstanceRequest) GetName() string

func (*DeleteInstanceRequest) ProtoMessage()

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

func (x *DeleteInstanceRequest) Reset()

func (x *DeleteInstanceRequest) String() string

type GetInstanceConfigRequest struct {

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

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

func (x *GetInstanceConfigRequest) GetName() string

func (*GetInstanceConfigRequest) ProtoMessage()

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

func (x *GetInstanceConfigRequest) Reset()

func (x *GetInstanceConfigRequest) String() string

type GetInstanceRequest struct {

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

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

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

func (x *GetInstanceRequest) GetName() string

func (*GetInstanceRequest) ProtoMessage()

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

func (x *GetInstanceRequest) Reset()

func (x *GetInstanceRequest) String() string

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

	AutoscalingConfig *AutoscalingConfig `protobuf:"bytes,17,opt,name=autoscaling_config,json=autoscalingConfig,proto3" json:"autoscaling_config,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"`

}

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

func (x *Instance) GetAutoscalingConfig() *AutoscalingConfig

func (x *Instance) GetConfig() string

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

func (x *Instance) GetDisplayName() string

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

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

func (x *Instance) GetName() string

func (x *Instance) GetNodeCount() int32

func (x *Instance) GetProcessingUnits() int32

func (x *Instance) GetState() Instance_State

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

func (*Instance) ProtoMessage()

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

func (x *Instance) Reset()

func (x *Instance) String() string

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

func NewInstanceAdminClient(cc grpc.ClientConnInterface) InstanceAdminClient

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

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

}

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

func (x *InstanceConfig) GetBaseConfig() string

func (x *InstanceConfig) GetConfigType() InstanceConfig_Type

func (x *InstanceConfig) GetDisplayName() string

func (x *InstanceConfig) GetEtag() string

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

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

func (x *InstanceConfig) GetName() string

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

func (x *InstanceConfig) GetReconciling() bool

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

func (x *InstanceConfig) GetState() InstanceConfig_State

func (*InstanceConfig) ProtoMessage()

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

func (x *InstanceConfig) Reset()

func (x *InstanceConfig) String() string

type InstanceConfig_State int32

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

func (x InstanceConfig_State) Enum() *