genproto: google.golang.org/genproto/googleapis/spanner/admin/instance/v1 Index | Files

package instance

import "google.golang.org/genproto/googleapis/spanner/admin/instance/v1"

Index

Package Files

spanner_instance_admin.pb.go

Variables

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.

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.

var File_google_spanner_admin_instance_v1_spanner_instance_admin_proto protoreflect.FileDescriptor

func RegisterInstanceAdminServer Uses

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

type CreateInstanceMetadata Uses

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 *timestamp.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 *timestamp.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 *timestamp.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 Uses

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

Deprecated: Use CreateInstanceMetadata.ProtoReflect.Descriptor instead.

func (*CreateInstanceMetadata) GetCancelTime Uses

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

func (*CreateInstanceMetadata) GetEndTime Uses

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

func (*CreateInstanceMetadata) GetInstance Uses

func (x *CreateInstanceMetadata) GetInstance() *Instance

func (*CreateInstanceMetadata) GetStartTime Uses

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

func (*CreateInstanceMetadata) ProtoMessage Uses

func (*CreateInstanceMetadata) ProtoMessage()

func (*CreateInstanceMetadata) ProtoReflect Uses

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

func (*CreateInstanceMetadata) Reset Uses

func (x *CreateInstanceMetadata) Reset()

func (*CreateInstanceMetadata) String Uses

func (x *CreateInstanceMetadata) String() string

type CreateInstanceRequest Uses

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 Uses

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

Deprecated: Use CreateInstanceRequest.ProtoReflect.Descriptor instead.

func (*CreateInstanceRequest) GetInstance Uses

func (x *CreateInstanceRequest) GetInstance() *Instance

func (*CreateInstanceRequest) GetInstanceId Uses

func (x *CreateInstanceRequest) GetInstanceId() string

func (*CreateInstanceRequest) GetParent Uses

func (x *CreateInstanceRequest) GetParent() string

func (*CreateInstanceRequest) ProtoMessage Uses

func (*CreateInstanceRequest) ProtoMessage()

func (*CreateInstanceRequest) ProtoReflect Uses

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

func (*CreateInstanceRequest) Reset Uses

func (x *CreateInstanceRequest) Reset()

func (*CreateInstanceRequest) String Uses

func (x *CreateInstanceRequest) String() string

type DeleteInstanceRequest Uses

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 Uses

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

Deprecated: Use DeleteInstanceRequest.ProtoReflect.Descriptor instead.

func (*DeleteInstanceRequest) GetName Uses

func (x *DeleteInstanceRequest) GetName() string

func (*DeleteInstanceRequest) ProtoMessage Uses

func (*DeleteInstanceRequest) ProtoMessage()

func (*DeleteInstanceRequest) ProtoReflect Uses

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

func (*DeleteInstanceRequest) Reset Uses

func (x *DeleteInstanceRequest) Reset()

func (*DeleteInstanceRequest) String Uses

func (x *DeleteInstanceRequest) String() string

type GetInstanceConfigRequest Uses

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 Uses

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

Deprecated: Use GetInstanceConfigRequest.ProtoReflect.Descriptor instead.

func (*GetInstanceConfigRequest) GetName Uses

func (x *GetInstanceConfigRequest) GetName() string

func (*GetInstanceConfigRequest) ProtoMessage Uses

func (*GetInstanceConfigRequest) ProtoMessage()

func (*GetInstanceConfigRequest) ProtoReflect Uses

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

func (*GetInstanceConfigRequest) Reset Uses

func (x *GetInstanceConfigRequest) Reset()

func (*GetInstanceConfigRequest) String Uses

func (x *GetInstanceConfigRequest) String() string

type GetInstanceRequest Uses

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 *field_mask.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 Uses

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

Deprecated: Use GetInstanceRequest.ProtoReflect.Descriptor instead.

func (*GetInstanceRequest) GetFieldMask Uses

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

func (*GetInstanceRequest) GetName Uses

func (x *GetInstanceRequest) GetName() string

func (*GetInstanceRequest) ProtoMessage Uses

func (*GetInstanceRequest) ProtoMessage()

func (*GetInstanceRequest) ProtoReflect Uses

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

func (*GetInstanceRequest) Reset Uses

func (x *GetInstanceRequest) Reset()

func (*GetInstanceRequest) String Uses

func (x *GetInstanceRequest) String() string

type Instance Uses

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 `protobuf:"bytes,7,rep,name=labels,proto3" json:"labels,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
    // 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 Uses

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

Deprecated: Use Instance.ProtoReflect.Descriptor instead.

func (*Instance) GetConfig Uses

func (x *Instance) GetConfig() string

func (*Instance) GetDisplayName Uses

func (x *Instance) GetDisplayName() string

func (*Instance) GetEndpointUris Uses

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

func (*Instance) GetLabels Uses

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

func (*Instance) GetName Uses

func (x *Instance) GetName() string

func (*Instance) GetNodeCount Uses

func (x *Instance) GetNodeCount() int32

func (*Instance) GetState Uses

func (x *Instance) GetState() Instance_State

func (*Instance) ProtoMessage Uses

func (*Instance) ProtoMessage()

func (*Instance) ProtoReflect Uses

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

func (*Instance) Reset Uses

func (x *Instance) Reset()

func (*Instance) String Uses

func (x *Instance) String() string

type InstanceAdminClient Uses

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) (*empty.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 Uses

func NewInstanceAdminClient(cc grpc.ClientConnInterface) InstanceAdminClient

type InstanceAdminServer Uses

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) (*empty.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 Uses

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 Uses

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

Deprecated: Use InstanceConfig.ProtoReflect.Descriptor instead.

func (*InstanceConfig) GetDisplayName Uses

func (x *InstanceConfig) GetDisplayName() string

func (*InstanceConfig) GetName Uses

func (x *InstanceConfig) GetName() string

func (*InstanceConfig) GetReplicas Uses

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

func (*InstanceConfig) ProtoMessage Uses

func (*InstanceConfig) ProtoMessage()

func (*InstanceConfig) ProtoReflect Uses

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

func (*InstanceConfig) Reset Uses

func (x *InstanceConfig) Reset()

func (*InstanceConfig) String Uses

func (x *InstanceConfig) String() string

type Instance_State Uses

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 Uses

func (Instance_State) Descriptor() protoreflect.EnumDescriptor

func (Instance_State) Enum Uses

func (x Instance_State) Enum() *Instance_State

func (Instance_State) EnumDescriptor Uses

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

Deprecated: Use Instance_State.Descriptor instead.

func (Instance_State) Number Uses

func (x Instance_State) Number() protoreflect.EnumNumber

func (Instance_State) String Uses

func (x Instance_State) String() string

func (Instance_State) Type Uses

func (Instance_State) Type() protoreflect.EnumType

type ListInstanceConfigsRequest Uses

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 Uses

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

Deprecated: Use ListInstanceConfigsRequest.ProtoReflect.Descriptor instead.

func (*ListInstanceConfigsRequest) GetPageSize Uses

func (x *ListInstanceConfigsRequest) GetPageSize() int32

func (*ListInstanceConfigsRequest) GetPageToken Uses

func (x *ListInstanceConfigsRequest) GetPageToken() string

func (*ListInstanceConfigsRequest) GetParent Uses

func (x *ListInstanceConfigsRequest) GetParent() string

func (*ListInstanceConfigsRequest) ProtoMessage Uses

func (*ListInstanceConfigsRequest) ProtoMessage()

func (*ListInstanceConfigsRequest) ProtoReflect Uses

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

func (*ListInstanceConfigsRequest) Reset Uses

func (x *ListInstanceConfigsRequest) Reset()

func (*ListInstanceConfigsRequest) String Uses

func (x *ListInstanceConfigsRequest) String() string

type ListInstanceConfigsResponse Uses

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 Uses

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

Deprecated: Use ListInstanceConfigsResponse.ProtoReflect.Descriptor instead.

func (*ListInstanceConfigsResponse) GetInstanceConfigs Uses

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

func (*ListInstanceConfigsResponse) GetNextPageToken Uses

func (x *ListInstanceConfigsResponse) GetNextPageToken() string

func (*ListInstanceConfigsResponse) ProtoMessage Uses

func (*ListInstanceConfigsResponse) ProtoMessage()

func (*ListInstanceConfigsResponse) ProtoReflect Uses

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

func (*ListInstanceConfigsResponse) Reset Uses

func (x *ListInstanceConfigsResponse) Reset()

func (*ListInstanceConfigsResponse) String Uses

func (x *ListInstanceConfigsResponse) String() string

type ListInstancesRequest Uses

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 Uses

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

Deprecated: Use ListInstancesRequest.ProtoReflect.Descriptor instead.

func (*ListInstancesRequest) GetFilter Uses

func (x *ListInstancesRequest) GetFilter() string

func (*ListInstancesRequest) GetPageSize Uses

func (x *ListInstancesRequest) GetPageSize() int32

func (*ListInstancesRequest) GetPageToken Uses

func (x *ListInstancesRequest) GetPageToken() string

func (*ListInstancesRequest) GetParent Uses

func (x *ListInstancesRequest) GetParent() string

func (*ListInstancesRequest) ProtoMessage Uses

func (*ListInstancesRequest) ProtoMessage()

func (*ListInstancesRequest) ProtoReflect Uses

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

func (*ListInstancesRequest) Reset Uses

func (x *ListInstancesRequest) Reset()

func (*ListInstancesRequest) String Uses

func (x *ListInstancesRequest) String() string

type ListInstancesResponse Uses

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 Uses

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

Deprecated: Use ListInstancesResponse.ProtoReflect.Descriptor instead.

func (*ListInstancesResponse) GetInstances Uses

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

func (*ListInstancesResponse) GetNextPageToken Uses

func (x *ListInstancesResponse) GetNextPageToken() string

func (*ListInstancesResponse) ProtoMessage Uses

func (*ListInstancesResponse) ProtoMessage()

func (*ListInstancesResponse) ProtoReflect Uses

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

func (*ListInstancesResponse) Reset Uses

func (x *ListInstancesResponse) Reset()

func (*ListInstancesResponse) String Uses

func (x *ListInstancesResponse) String() string

type ReplicaInfo Uses

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 `protobuf:"varint,3,opt,name=default_leader_location,json=defaultLeaderLocation,proto3" json:"default_leader_location,omitempty"`
    // contains filtered or unexported fields
}

func (*ReplicaInfo) Descriptor Uses

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

Deprecated: Use ReplicaInfo.ProtoReflect.Descriptor instead.

func (*ReplicaInfo) GetDefaultLeaderLocation Uses

func (x *ReplicaInfo) GetDefaultLeaderLocation() bool

func (*ReplicaInfo) GetLocation Uses

func (x *ReplicaInfo) GetLocation() string

func (*ReplicaInfo) GetType Uses

func (x *ReplicaInfo) GetType() ReplicaInfo_ReplicaType

func (*ReplicaInfo) ProtoMessage Uses

func (*ReplicaInfo) ProtoMessage()

func (*ReplicaInfo) ProtoReflect Uses

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

func (*ReplicaInfo) Reset Uses

func (x *ReplicaInfo) Reset()

func (*ReplicaInfo) String Uses

func (x *ReplicaInfo) String() string

type ReplicaInfo_ReplicaType Uses

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 Uses

func (ReplicaInfo_ReplicaType) Descriptor() protoreflect.EnumDescriptor

func (ReplicaInfo_ReplicaType) Enum Uses

func (x ReplicaInfo_ReplicaType) Enum() *ReplicaInfo_ReplicaType

func (ReplicaInfo_ReplicaType) EnumDescriptor Uses

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

Deprecated: Use ReplicaInfo_ReplicaType.Descriptor instead.

func (ReplicaInfo_ReplicaType) Number Uses

func (x ReplicaInfo_ReplicaType) Number() protoreflect.EnumNumber

func (ReplicaInfo_ReplicaType) String Uses

func (x ReplicaInfo_ReplicaType) String() string

func (ReplicaInfo_ReplicaType) Type Uses

func (ReplicaInfo_ReplicaType) Type() protoreflect.EnumType

type UnimplementedInstanceAdminServer Uses

type UnimplementedInstanceAdminServer struct {
}

UnimplementedInstanceAdminServer can be embedded to have forward compatible implementations.

func (*UnimplementedInstanceAdminServer) CreateInstance Uses

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

func (*UnimplementedInstanceAdminServer) DeleteInstance Uses

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

func (*UnimplementedInstanceAdminServer) GetIamPolicy Uses

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

func (*UnimplementedInstanceAdminServer) GetInstance Uses

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

func (*UnimplementedInstanceAdminServer) GetInstanceConfig Uses

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

func (*UnimplementedInstanceAdminServer) ListInstanceConfigs Uses

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

func (*UnimplementedInstanceAdminServer) ListInstances Uses

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

func (*UnimplementedInstanceAdminServer) SetIamPolicy Uses

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

func (*UnimplementedInstanceAdminServer) TestIamPermissions Uses

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

func (*UnimplementedInstanceAdminServer) UpdateInstance Uses

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

type UpdateInstanceMetadata Uses

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 *timestamp.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 *timestamp.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 *timestamp.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 Uses

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

Deprecated: Use UpdateInstanceMetadata.ProtoReflect.Descriptor instead.

func (*UpdateInstanceMetadata) GetCancelTime Uses

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

func (*UpdateInstanceMetadata) GetEndTime Uses

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

func (*UpdateInstanceMetadata) GetInstance Uses

func (x *UpdateInstanceMetadata) GetInstance() *Instance

func (*UpdateInstanceMetadata) GetStartTime Uses

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

func (*UpdateInstanceMetadata) ProtoMessage Uses

func (*UpdateInstanceMetadata) ProtoMessage()

func (*UpdateInstanceMetadata) ProtoReflect Uses

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

func (*UpdateInstanceMetadata) Reset Uses

func (x *UpdateInstanceMetadata) Reset()

func (*UpdateInstanceMetadata) String Uses

func (x *UpdateInstanceMetadata) String() string

type UpdateInstanceRequest Uses

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 *field_mask.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 Uses

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

Deprecated: Use UpdateInstanceRequest.ProtoReflect.Descriptor instead.

func (*UpdateInstanceRequest) GetFieldMask Uses

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

func (*UpdateInstanceRequest) GetInstance Uses

func (x *UpdateInstanceRequest) GetInstance() *Instance

func (*UpdateInstanceRequest) ProtoMessage Uses

func (*UpdateInstanceRequest) ProtoMessage()

func (*UpdateInstanceRequest) ProtoReflect Uses

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

func (*UpdateInstanceRequest) Reset Uses

func (x *UpdateInstanceRequest) Reset()

func (*UpdateInstanceRequest) String Uses

func (x *UpdateInstanceRequest) String() string

Package instance imports 15 packages (graph) and is imported by 5 packages. Updated 2020-08-13. Refresh now. Tools for package owners.