Module types (1.18.0)

API documentation for spanner_admin_instance_v1.types module.

Classes

Any

API documentation for spanner_admin_instance_v1.types.Any class.

AuditConfig

API documentation for spanner_admin_instance_v1.types.AuditConfig class.

AuditConfigDelta

API documentation for spanner_admin_instance_v1.types.AuditConfigDelta class.

AuditData

API documentation for spanner_admin_instance_v1.types.AuditData class.

AuditLogConfig

API documentation for spanner_admin_instance_v1.types.AuditLogConfig class.

Binding

API documentation for spanner_admin_instance_v1.types.Binding class.

BindingDelta

API documentation for spanner_admin_instance_v1.types.BindingDelta class.

CancelOperationRequest

API documentation for spanner_admin_instance_v1.types.CancelOperationRequest class.

CreateInstanceMetadata

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

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

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

CreateInstanceRequest

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

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.

CustomHttpPattern

API documentation for spanner_admin_instance_v1.types.CustomHttpPattern class.

DeleteInstanceRequest

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

DeleteOperationRequest

API documentation for spanner_admin_instance_v1.types.DeleteOperationRequest class.

DescriptorProto

API documentation for spanner_admin_instance_v1.types.DescriptorProto class.

Empty

API documentation for spanner_admin_instance_v1.types.Empty class.

EnumDescriptorProto

API documentation for spanner_admin_instance_v1.types.EnumDescriptorProto class.

EnumOptions

API documentation for spanner_admin_instance_v1.types.EnumOptions class.

EnumValueDescriptorProto

API documentation for spanner_admin_instance_v1.types.EnumValueDescriptorProto class.

EnumValueOptions

API documentation for spanner_admin_instance_v1.types.EnumValueOptions class.

ExtensionRangeOptions

API documentation for spanner_admin_instance_v1.types.ExtensionRangeOptions class.

FieldDescriptorProto

API documentation for spanner_admin_instance_v1.types.FieldDescriptorProto class.

FieldMask

API documentation for spanner_admin_instance_v1.types.FieldMask class.

FieldOptions

API documentation for spanner_admin_instance_v1.types.FieldOptions class.

FileDescriptorProto

API documentation for spanner_admin_instance_v1.types.FileDescriptorProto class.

FileDescriptorSet

API documentation for spanner_admin_instance_v1.types.FileDescriptorSet class.

FileOptions

API documentation for spanner_admin_instance_v1.types.FileOptions class.

GeneratedCodeInfo

API documentation for spanner_admin_instance_v1.types.GeneratedCodeInfo class.

GetIamPolicyRequest

API documentation for spanner_admin_instance_v1.types.GetIamPolicyRequest class.

GetInstanceConfigRequest

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

GetInstanceRequest

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

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.

GetOperationRequest

API documentation for spanner_admin_instance_v1.types.GetOperationRequest class.

Http

API documentation for spanner_admin_instance_v1.types.Http class.

HttpRule

API documentation for spanner_admin_instance_v1.types.HttpRule class.

Instance

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

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.Instanc eConfig] and [ListInstanceConfigs][google.spanner.admin.instan ce.v1.InstanceAdmin.ListInstanceConfigs].

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.

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.

InstanceConfig

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

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

ListInstanceConfigsRequest

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

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

ListInstanceConfigsResponse

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

\ next_page_token can be sent in a subsequent [ListInstanc eConfigs][google.spanner.admin.instance.v1.InstanceAdmin.ListI nstanceConfigs] call to fetch more of the matching instance configurations.

ListInstancesRequest

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

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

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

ListInstancesResponse

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

\ next_page_token can be sent in a subsequent [ListInstanc es][google.spanner.admin.instance.v1.InstanceAdmin.ListInstanc es] call to fetch more of the matching instances.

ListOperationsRequest

API documentation for spanner_admin_instance_v1.types.ListOperationsRequest class.

ListOperationsResponse

API documentation for spanner_admin_instance_v1.types.ListOperationsResponse class.

MessageOptions

API documentation for spanner_admin_instance_v1.types.MessageOptions class.

MethodDescriptorProto

API documentation for spanner_admin_instance_v1.types.MethodDescriptorProto class.

MethodOptions

API documentation for spanner_admin_instance_v1.types.MethodOptions class.

OneofDescriptorProto

API documentation for spanner_admin_instance_v1.types.OneofDescriptorProto class.

OneofOptions

API documentation for spanner_admin_instance_v1.types.OneofOptions class.

Operation

API documentation for spanner_admin_instance_v1.types.Operation class.

OperationInfo

API documentation for spanner_admin_instance_v1.types.OperationInfo class.

Policy

API documentation for spanner_admin_instance_v1.types.Policy class.

PolicyDelta

API documentation for spanner_admin_instance_v1.types.PolicyDelta class.

ReplicaInfo

Protocol buffer.

The type of replica.

ServiceDescriptorProto

API documentation for spanner_admin_instance_v1.types.ServiceDescriptorProto class.

ServiceOptions

API documentation for spanner_admin_instance_v1.types.ServiceOptions class.

SetIamPolicyRequest

API documentation for spanner_admin_instance_v1.types.SetIamPolicyRequest class.

SourceCodeInfo

API documentation for spanner_admin_instance_v1.types.SourceCodeInfo class.

Status

API documentation for spanner_admin_instance_v1.types.Status class.

TestIamPermissionsRequest

API documentation for spanner_admin_instance_v1.types.TestIamPermissionsRequest class.

TestIamPermissionsResponse

API documentation for spanner_admin_instance_v1.types.TestIamPermissionsResponse class.

Timestamp

API documentation for spanner_admin_instance_v1.types.Timestamp class.

UninterpretedOption

API documentation for spanner_admin_instance_v1.types.UninterpretedOption class.

UpdateInstanceMetadata

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

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

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

UpdateInstanceRequest

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

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.

WaitOperationRequest

API documentation for spanner_admin_instance_v1.types.WaitOperationRequest class.