Type Members

1.  final case class CreateInstanceMetadata(instance: Option[Instance] = _root_.scala.None, startTime: Option[Timestamp] = _root_.scala.None, cancelTime: Option[Timestamp] = _root_.scala.None, endTime: Option[Timestamp] = _root_.scala.None, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[CreateInstanceMetadata] with Product with Serializable

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

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

   instance

   The instance being created.

   startTime

   The time at which the [CreateInstance][google.spanner.admin.instance.v1.InstanceAdmin.CreateInstance] request was received.

   cancelTime

   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.

   endTime

   The time at which this operation failed or was completed successfully.

   Annotations

   @SerialVersionUID()

2.  final case class CreateInstanceRequest(parent: String = "", instanceId: String = "", instance: Option[Instance] = _root_.scala.None, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[CreateInstanceRequest] with Product with Serializable

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

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

   parent

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

   instanceId

   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.

   instance

   Required. The instance to create. The name may be omitted, but if specified must be <parent>/instances/<instance_id>.

   Annotations

   @SerialVersionUID()

3.  final class DefaultInstanceAdminClient extends InstanceAdminClient
4.  final case class DeleteInstanceRequest(name: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[DeleteInstanceRequest] with Product with Serializable

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

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

   name

   Required. The name of the instance to be deleted. Values are of the form projects/<project>/instances/<instance>

   Annotations

   @SerialVersionUID()

5.  final case class GetInstanceConfigRequest(name: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[GetInstanceConfigRequest] with Product with Serializable

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

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

   name

   Required. The name of the requested instance configuration. Values are of the form projects/<project>/instanceConfigs/<config>.

   Annotations

   @SerialVersionUID()

6.  final case class GetInstanceRequest(name: String = "", fieldMask: Option[FieldMask] = _root_.scala.None, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[GetInstanceRequest] with Product with Serializable

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

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

   name

   Required. The name of the requested instance. Values are of the form projects/<project>/instances/<instance>.

   fieldMask

   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.

   Annotations

   @SerialVersionUID()

7.  final case class Instance(name: String = "", config: String = "", displayName: String = "", nodeCount: Int = 0, state: State = ..., labels: Map[String, String] = ..., endpointUris: Seq[String] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[Instance] with Product with Serializable

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

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

   name

   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.

   config

   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].

   displayName

   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.

   nodeCount

   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.

   state

   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.

   labels

   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.

   endpointUris

   Deprecated. This field is not populated.

   Annotations

   @SerialVersionUID()

8.  trait InstanceAdmin extends AnyRef

   Cloud Spanner Instance Admin API The Cloud Spanner Instance Admin API can be used to create, delete, modify and list instances.

   Cloud Spanner Instance Admin API The Cloud Spanner Instance Admin API can be used to create, delete, modify and list instances. Instances are dedicated Cloud Spanner serving and storage resources to be used by Cloud Spanner databases. Each instance has a "configuration", which dictates where the serving resources for the Cloud Spanner instance are located (e.g., US-central, Europe). Configurations are created by Google based on resource availability. Cloud Spanner billing is based on the instances that exist and their sizes. After an instance exists, there are no additional per-database or per-operation charges for use of the instance (though there may be additional network bandwidth charges). Instances offer isolation: problems with databases in one instance will not affect other instances. However, within an instance databases can affect each other. For example, if one database in an instance receives a lot of requests and consumes most of the instance resources, fewer resources are available for other databases in that instance, and their performance may suffer.

9.  trait InstanceAdminClient extends InstanceAdmin with InstanceAdminClientPowerApi with AkkaGrpcClient
10.  trait InstanceAdminClientPowerApi extends AnyRef
11.  final case class InstanceConfig(name: String = "", displayName: String = "", replicas: Seq[ReplicaInfo] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[InstanceConfig] with Product with Serializable

    A possible configuration for a Cloud Spanner instance.

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

    name

    A unique identifier for the instance configuration. Values are of the form projects/<project>/instanceConfigs/[a-z][-a-z0-9]*

    displayName

    The name of this instance configuration as it appears in UIs.

    replicas

    The geographic placement of nodes in this instance configuration and their replication properties.

    Annotations

    @SerialVersionUID()

12.  final case class ListInstanceConfigsRequest(parent: String = "", pageSize: Int = 0, pageToken: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[ListInstanceConfigsRequest] with Product with Serializable

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

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

    parent

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

    pageSize

    Number of instance configurations to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.

    pageToken

    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].

    Annotations

    @SerialVersionUID()

13.  final case class ListInstanceConfigsResponse(instanceConfigs: Seq[InstanceConfig] = _root_.scala.Seq.empty, nextPageToken: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[ListInstanceConfigsResponse] with Product with Serializable

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

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

    instanceConfigs

    The list of requested instance configurations.

    nextPageToken

    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.

    Annotations

    @SerialVersionUID()

14.  final case class ListInstancesRequest(parent: String = "", pageSize: Int = 0, pageToken: String = "", filter: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[ListInstancesRequest] with Product with Serializable

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

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

    parent

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

    pageSize

    Number of instances to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.

    pageToken

    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].

    filter

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

    Annotations

    @SerialVersionUID()

15.  final case class ListInstancesResponse(instances: Seq[Instance] = _root_.scala.Seq.empty, nextPageToken: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[ListInstancesResponse] with Product with Serializable

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

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

    instances

    The list of requested instances.

    nextPageToken

    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.

    Annotations

    @SerialVersionUID()

16.  final case class ReplicaInfo(location: String = "", type: ReplicaType = ..., defaultLeaderLocation: Boolean = false, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[ReplicaInfo] with Product with Serializable
    location

    The location of the serving resources, e.g. "us-central1".

    type

    The type of replica.

    defaultLeaderLocation

    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.

    Annotations

    @SerialVersionUID()

17.  final case class UpdateInstanceMetadata(instance: Option[Instance] = _root_.scala.None, startTime: Option[Timestamp] = _root_.scala.None, cancelTime: Option[Timestamp] = _root_.scala.None, endTime: Option[Timestamp] = _root_.scala.None, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[UpdateInstanceMetadata] with Product with Serializable

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

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

    instance

    The desired end state of the update.

    startTime

    The time at which [UpdateInstance][google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstance] request was received.

    cancelTime

    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.

    endTime

    The time at which this operation failed or was completed successfully.

    Annotations

    @SerialVersionUID()

18.  final case class UpdateInstanceRequest(instance: Option[Instance] = _root_.scala.None, fieldMask: Option[FieldMask] = _root_.scala.None, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[UpdateInstanceRequest] with Product with Serializable

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

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

    instance

    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.

    fieldMask

    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.

    Annotations

    @SerialVersionUID()