instance

package
v0.0.0-...-6cb3ea0 Latest Latest
Warning

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

 Go to latest Published: Jun 7, 2021 License: Apache-2.0 Imports: 15 Imported by: 0

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 (
	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_spanner_instance_admin_proto protoreflect.FileDescriptor

Functions

func RegisterInstanceAdminServer 

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

Types

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 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"`
	// Required. The number of nodes allocated to this 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/instances#node_count)
	// for more information about nodes.
	NodeCount int32 `protobuf:"varint,5,opt,name=node_count,json=nodeCount,proto3" json:"node_count,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]*[a-z0-9])?`.
	//  * Label values must be between 0 and 63 characters long and must conform
	//    to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.
	//  * 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"`
	// 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) GetConfig 

func (x *Instance) GetConfig() string

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

func (x *Instance) GetState() Instance_State

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)
	// 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) (*longrunning.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
	// resource [name][google.spanner.admin.instance.v1.Instance.name].
	UpdateInstance(ctx context.Context, in *UpdateInstanceRequest, opts ...grpc.CallOption) (*longrunning.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 *v1.SetIamPolicyRequest, opts ...grpc.CallOption) (*v1.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 *v1.GetIamPolicyRequest, opts ...grpc.CallOption) (*v1.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 *v1.TestIamPermissionsRequest, opts ...grpc.CallOption) (*v1.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.

func NewInstanceAdminClient 

func NewInstanceAdminClient(cc grpc.ClientConnInterface) InstanceAdminClient

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)
	// 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) (*longrunning.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
	// resource [name][google.spanner.admin.instance.v1.Instance.name].
	UpdateInstance(context.Context, *UpdateInstanceRequest) (*longrunning.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, *v1.SetIamPolicyRequest) (*v1.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, *v1.GetIamPolicyRequest) (*v1.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, *v1.TestIamPermissionsRequest) (*v1.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"`
	// 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"`
	// 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) GetDisplayName 

func (x *InstanceConfig) GetDisplayName() string

func (*InstanceConfig) GetName 

func (x *InstanceConfig) GetName() string

func (*InstanceConfig) GetReplicas 

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

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

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 (x Instance_State) Number() protoreflect.EnumNumber

func (Instance_State) String 

func (x Instance_State) String() string

func (Instance_State) Type 

func (Instance_State) Type() protoreflect.EnumType

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

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

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

func (ReplicaInfo_ReplicaType) Enum 

func (x ReplicaInfo_ReplicaType) Enum() *ReplicaInfo_ReplicaType

func (ReplicaInfo_ReplicaType) EnumDescriptor deprecated 

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

Deprecated: Use ReplicaInfo_ReplicaType.Descriptor instead.

func (ReplicaInfo_ReplicaType) Number 

func (x ReplicaInfo_ReplicaType) Number() protoreflect.EnumNumber

func (ReplicaInfo_ReplicaType) String 

func (x ReplicaInfo_ReplicaType) String() string

func (ReplicaInfo_ReplicaType) Type 

func (ReplicaInfo_ReplicaType) Type() protoreflect.EnumType

type UnimplementedInstanceAdminServer 

type UnimplementedInstanceAdminServer struct {
}

UnimplementedInstanceAdminServer can be embedded to have forward compatible implementations.

func (*UnimplementedInstanceAdminServer) CreateInstance 

func (*UnimplementedInstanceAdminServer) CreateInstance(context.Context, *CreateInstanceRequest) (*longrunning.Operation, error)

func (*UnimplementedInstanceAdminServer) DeleteInstance 

func (*UnimplementedInstanceAdminServer) DeleteInstance(context.Context, *DeleteInstanceRequest) (*emptypb.Empty, error)

func (*UnimplementedInstanceAdminServer) GetIamPolicy 

func (*UnimplementedInstanceAdminServer) GetIamPolicy(context.Context, *v1.GetIamPolicyRequest) (*v1.Policy, error)

func (*UnimplementedInstanceAdminServer) GetInstance 

func (*UnimplementedInstanceAdminServer) GetInstance(context.Context, *GetInstanceRequest) (*Instance, error)

func (*UnimplementedInstanceAdminServer) GetInstanceConfig 

func (*UnimplementedInstanceAdminServer) GetInstanceConfig(context.Context, *GetInstanceConfigRequest) (*InstanceConfig, error)

func (*UnimplementedInstanceAdminServer) ListInstanceConfigs 

func (*UnimplementedInstanceAdminServer) ListInstanceConfigs(context.Context, *ListInstanceConfigsRequest) (*ListInstanceConfigsResponse, error)

func (*UnimplementedInstanceAdminServer) ListInstances 

func (*UnimplementedInstanceAdminServer) ListInstances(context.Context, *ListInstancesRequest) (*ListInstancesResponse, error)

func (*UnimplementedInstanceAdminServer) SetIamPolicy 

func (*UnimplementedInstanceAdminServer) SetIamPolicy(context.Context, *v1.SetIamPolicyRequest) (*v1.Policy, error)

func (*UnimplementedInstanceAdminServer) TestIamPermissions 

func (*UnimplementedInstanceAdminServer) TestIamPermissions(context.Context, *v1.TestIamPermissionsRequest) (*v1.TestIamPermissionsResponse, error)

func (*UnimplementedInstanceAdminServer) UpdateInstance 

func (*UnimplementedInstanceAdminServer) UpdateInstance(context.Context, *UpdateInstanceRequest) (*longrunning.Operation, error)

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.