As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

Types for Google Cloud Spanner Admin Instance v1 API

class google.cloud.spanner_admin_instance_v1.types.CreateInstanceMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

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

instance

The instance being created.

Type

google.cloud.spanner_admin_instance_v1.types.Instance

start_time

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

Type

google.protobuf.timestamp_pb2.Timestamp

cancel_time

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.

Type

google.protobuf.timestamp_pb2.Timestamp

end_time

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

Type

google.protobuf.timestamp_pb2.Timestamp

class google.cloud.spanner_admin_instance_v1.types.CreateInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

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

Type

str

instance_id

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.

Type

str

instance

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

Type

google.cloud.spanner_admin_instance_v1.types.Instance

class google.cloud.spanner_admin_instance_v1.types.DeleteInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

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>

Type

str

class google.cloud.spanner_admin_instance_v1.types.GetInstanceConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

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

Type

str

class google.cloud.spanner_admin_instance_v1.types.GetInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

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

Type

str

field_mask

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.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.cloud.spanner_admin_instance_v1.types.Instance(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

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.

Type

str

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

Type

str

display_name

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.

Type

str

node_count

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 for more information about nodes.

Type

int

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.

Type

google.cloud.spanner_admin_instance_v1.types.Instance.State

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.

Type

Sequence[google.cloud.spanner_admin_instance_v1.types.Instance.LabelsEntry]

endpoint_uris

Deprecated. This field is not populated.

Type

Sequence[str]

class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class State(value)[source]

Bases: proto.enums.Enum

Indicates the current state of the instance.

CREATING = 1
READY = 2
STATE_UNSPECIFIED = 0
class google.cloud.spanner_admin_instance_v1.types.InstanceConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

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

Type

str

display_name

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

Type

str

replicas

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

Type

Sequence[google.cloud.spanner_admin_instance_v1.types.ReplicaInfo]

class google.cloud.spanner_admin_instance_v1.types.ListInstanceConfigsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

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

Type

str

page_size

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

Type

int

page_token

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

Type

str

class google.cloud.spanner_admin_instance_v1.types.ListInstanceConfigsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

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

instance_configs

The list of requested instance configurations.

Type

Sequence[google.cloud.spanner_admin_instance_v1.types.InstanceConfig]

next_page_token

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.

Type

str

property raw_page
class google.cloud.spanner_admin_instance_v1.types.ListInstancesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

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

Type

str

page_size

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

Type

int

page_token

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

Type

str

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

Type

str

class google.cloud.spanner_admin_instance_v1.types.ListInstancesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

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

instances

The list of requested instances.

Type

Sequence[google.cloud.spanner_admin_instance_v1.types.Instance]

next_page_token

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.

Type

str

property raw_page
class google.cloud.spanner_admin_instance_v1.types.ReplicaInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

location

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

Type

str

type_

The type of replica.

Type

google.cloud.spanner_admin_instance_v1.types.ReplicaInfo.ReplicaType

default_leader_location

If true, this location is designated as the default leader location where leader replicas are placed. See the region types documentation for more details.

Type

bool

class ReplicaType(value)[source]

Bases: proto.enums.Enum

Indicates the type of replica. See the replica types documentation for more details.

READ_ONLY = 2
READ_WRITE = 1
TYPE_UNSPECIFIED = 0
WITNESS = 3
class google.cloud.spanner_admin_instance_v1.types.UpdateInstanceMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

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

instance

The desired end state of the update.

Type

google.cloud.spanner_admin_instance_v1.types.Instance

start_time

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

Type

google.protobuf.timestamp_pb2.Timestamp

cancel_time

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.

Type

google.protobuf.timestamp_pb2.Timestamp

end_time

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

Type

google.protobuf.timestamp_pb2.Timestamp

class google.cloud.spanner_admin_instance_v1.types.UpdateInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

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.

Type

google.cloud.spanner_admin_instance_v1.types.Instance

field_mask

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.

Type

google.protobuf.field_mask_pb2.FieldMask