Spanner Admin Instance Client Types#
-
class
google.cloud.spanner_admin_instance_v1.types.
Any
# -
type_url
# Field google.protobuf.Any.type_url
-
value
# Field google.protobuf.Any.value
-
-
class
google.cloud.spanner_admin_instance_v1.types.
AuditConfigDelta
# One delta entry for AuditConfig. Each individual change (only one exempted_member in each entry) to a AuditConfig will be a separate entry.
-
action
# The action that was performed on an audit configuration in a policy. Required
-
service
# Specifies a service that was configured for Cloud Audit Logging. For example,
storage.googleapis.com
,cloudsql.googleapis.com
.allServices
is a special value that covers all services. Required
-
exempted_member
# A single identity that is exempted from “data access” audit logging for the
service
specified above. Follows the same format of Binding.members.
-
log_type
# Specifies the log_type that was be enabled. ADMIN_ACTIVITY is always enabled, and cannot be configured. Required
-
action
Field google.iam.v1.AuditConfigDelta.action
-
exempted_member
Field google.iam.v1.AuditConfigDelta.exempted_member
-
log_type
Field google.iam.v1.AuditConfigDelta.log_type
-
service
Field google.iam.v1.AuditConfigDelta.service
-
-
class
google.cloud.spanner_admin_instance_v1.types.
AuditData
# Audit log information specific to Cloud IAM. This message is serialized as an
Any
type in theServiceData
message of anAuditLog
message.-
policy_delta
# Policy delta between the original policy and the newly set policy.
-
policy_delta
Field google.iam.v1.logging.AuditData.policy_delta
-
-
class
google.cloud.spanner_admin_instance_v1.types.
Binding
# Associates
members
with arole
.-
role
# Role that is assigned to
members
. For example,roles/viewer
,roles/editor
, orroles/owner
.
-
members
# Specifies the identities requesting access for a Cloud Platform resource.
members
can have the following values: -allUsers
: A special identifier that represents anyone who is on the internet; with or without a Google account. -allAuthenticatedUsers
: A special identifier that represents anyone who is authenticated with a Google account or a service account. -user:{emailid}
: An email address that represents a specific Google account. For example,alice@gmail.com
. -serviceAccount:{emailid}
: An email address that represents a service account. For example,my-other- app@appspot.gserviceaccount.com
. -group:{emailid}
: An email address that represents a Google group. For example,admins@example.com
. -domain:{domain}
: The G Suite domain (primary) that represents all the users of that domain. For example,google.com
orexample.com
.
-
condition
# The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently.
-
condition
Field google.iam.v1.Binding.condition
-
members
Field google.iam.v1.Binding.members
-
role
Field google.iam.v1.Binding.role
-
-
class
google.cloud.spanner_admin_instance_v1.types.
BindingDelta
# One delta entry for Binding. Each individual change (only one member in each entry) to a binding will be a separate entry.
-
action
# The action that was performed on a Binding. Required
-
role
# Role that is assigned to
members
. For example,roles/viewer
,roles/editor
, orroles/owner
. Required
-
member
# A single identity requesting access for a Cloud Platform resource. Follows the same format of Binding.members. Required
-
condition
# Unimplemented. The condition that is associated with this binding. This field is logged only for Cloud Audit Logging.
-
action
Field google.iam.v1.BindingDelta.action
-
condition
Field google.iam.v1.BindingDelta.condition
-
member
Field google.iam.v1.BindingDelta.member
-
role
Field google.iam.v1.BindingDelta.role
-
-
class
google.cloud.spanner_admin_instance_v1.types.
CancelOperationRequest
# -
name
# Field google.longrunning.CancelOperationRequest.name
-
-
class
google.cloud.spanner_admin_instance_v1.types.
CreateInstanceMetadata
# Metadata type for the operation returned by [CreateInstance][google.spanner.admin.instance.v1.InstanceAdmin.CreateInstance].
-
instance
# The instance being created.
-
start_time
# The time at which the [CreateInstance][google.spanner.admin.in stance.v1.InstanceAdmin.CreateInstance] request was received.
-
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.
-
end_time
# The time at which this operation failed or was completed successfully.
-
cancel_time
Field google.spanner.admin.instance.v1.CreateInstanceMetadata.cancel_time
-
end_time
Field google.spanner.admin.instance.v1.CreateInstanceMetadata.end_time
-
instance
Field google.spanner.admin.instance.v1.CreateInstanceMetadata.instance
-
start_time
Field google.spanner.admin.instance.v1.CreateInstanceMetadata.start_time
-
-
class
google.cloud.spanner_admin_instance_v1.types.
CreateInstanceRequest
# 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>
.
-
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 6 and 30 characters in length.
-
instance
# Required. The instance to create. The name may be omitted, but if specified must be
<parent>/instances/<instance_id>
.
-
instance
Field google.spanner.admin.instance.v1.CreateInstanceRequest.instance
-
instance_id
Field google.spanner.admin.instance.v1.CreateInstanceRequest.instance_id
-
parent
Field google.spanner.admin.instance.v1.CreateInstanceRequest.parent
-
-
class
google.cloud.spanner_admin_instance_v1.types.
CustomHttpPattern
# -
kind
# Field google.api.CustomHttpPattern.kind
-
path
# Field google.api.CustomHttpPattern.path
-
-
class
google.cloud.spanner_admin_instance_v1.types.
DeleteInstanceRequest
# 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>
-
name
Field google.spanner.admin.instance.v1.DeleteInstanceRequest.name
-
-
class
google.cloud.spanner_admin_instance_v1.types.
DeleteOperationRequest
# -
name
# Field google.longrunning.DeleteOperationRequest.name
-
-
class
google.cloud.spanner_admin_instance_v1.types.
DescriptorProto
# -
class
ExtensionRange
# -
end
# Field google.protobuf.DescriptorProto.ExtensionRange.end
-
options
# Field google.protobuf.DescriptorProto.ExtensionRange.options
-
start
# Field google.protobuf.DescriptorProto.ExtensionRange.start
-
-
class
ReservedRange
# -
end
# Field google.protobuf.DescriptorProto.ReservedRange.end
-
start
# Field google.protobuf.DescriptorProto.ReservedRange.start
-
-
enum_type
# Field google.protobuf.DescriptorProto.enum_type
-
extension
# Field google.protobuf.DescriptorProto.extension
-
extension_range
# Field google.protobuf.DescriptorProto.extension_range
-
field
# Field google.protobuf.DescriptorProto.field
-
name
# Field google.protobuf.DescriptorProto.name
-
nested_type
# Field google.protobuf.DescriptorProto.nested_type
-
oneof_decl
# Field google.protobuf.DescriptorProto.oneof_decl
-
options
# Field google.protobuf.DescriptorProto.options
-
reserved_name
# Field google.protobuf.DescriptorProto.reserved_name
-
reserved_range
# Field google.protobuf.DescriptorProto.reserved_range
-
class
-
class
google.cloud.spanner_admin_instance_v1.types.
Empty
#
-
class
google.cloud.spanner_admin_instance_v1.types.
EnumDescriptorProto
# -
class
EnumReservedRange
# -
end
# Field google.protobuf.EnumDescriptorProto.EnumReservedRange.end
-
start
# Field google.protobuf.EnumDescriptorProto.EnumReservedRange.start
-
-
name
# Field google.protobuf.EnumDescriptorProto.name
-
options
# Field google.protobuf.EnumDescriptorProto.options
-
reserved_name
# Field google.protobuf.EnumDescriptorProto.reserved_name
-
reserved_range
# Field google.protobuf.EnumDescriptorProto.reserved_range
-
value
# Field google.protobuf.EnumDescriptorProto.value
-
class
-
class
google.cloud.spanner_admin_instance_v1.types.
EnumOptions
# -
allow_alias
# Field google.protobuf.EnumOptions.allow_alias
-
deprecated
# Field google.protobuf.EnumOptions.deprecated
-
uninterpreted_option
# Field google.protobuf.EnumOptions.uninterpreted_option
-
-
class
google.cloud.spanner_admin_instance_v1.types.
EnumValueDescriptorProto
# -
name
# Field google.protobuf.EnumValueDescriptorProto.name
-
number
# Field google.protobuf.EnumValueDescriptorProto.number
-
options
# Field google.protobuf.EnumValueDescriptorProto.options
-
-
class
google.cloud.spanner_admin_instance_v1.types.
EnumValueOptions
# -
deprecated
# Field google.protobuf.EnumValueOptions.deprecated
-
uninterpreted_option
# Field google.protobuf.EnumValueOptions.uninterpreted_option
-
-
class
google.cloud.spanner_admin_instance_v1.types.
ExtensionRangeOptions
# -
uninterpreted_option
# Field google.protobuf.ExtensionRangeOptions.uninterpreted_option
-
-
class
google.cloud.spanner_admin_instance_v1.types.
FieldDescriptorProto
# -
default_value
# Field google.protobuf.FieldDescriptorProto.default_value
-
extendee
# Field google.protobuf.FieldDescriptorProto.extendee
-
json_name
# Field google.protobuf.FieldDescriptorProto.json_name
-
label
# Field google.protobuf.FieldDescriptorProto.label
-
name
# Field google.protobuf.FieldDescriptorProto.name
-
number
# Field google.protobuf.FieldDescriptorProto.number
-
oneof_index
# Field google.protobuf.FieldDescriptorProto.oneof_index
-
options
# Field google.protobuf.FieldDescriptorProto.options
-
type
# Field google.protobuf.FieldDescriptorProto.type
-
type_name
# Field google.protobuf.FieldDescriptorProto.type_name
-
-
class
google.cloud.spanner_admin_instance_v1.types.
FieldMask
# -
paths
# Field google.protobuf.FieldMask.paths
-
-
class
google.cloud.spanner_admin_instance_v1.types.
FieldOptions
# -
ctype
# Field google.protobuf.FieldOptions.ctype
-
deprecated
# Field google.protobuf.FieldOptions.deprecated
-
jstype
# Field google.protobuf.FieldOptions.jstype
-
lazy
# Field google.protobuf.FieldOptions.lazy
-
packed
# Field google.protobuf.FieldOptions.packed
-
uninterpreted_option
# Field google.protobuf.FieldOptions.uninterpreted_option
-
weak
# Field google.protobuf.FieldOptions.weak
-
-
class
google.cloud.spanner_admin_instance_v1.types.
FileDescriptorProto
# -
dependency
# Field google.protobuf.FileDescriptorProto.dependency
-
enum_type
# Field google.protobuf.FileDescriptorProto.enum_type
-
extension
# Field google.protobuf.FileDescriptorProto.extension
-
message_type
# Field google.protobuf.FileDescriptorProto.message_type
-
name
# Field google.protobuf.FileDescriptorProto.name
-
options
# Field google.protobuf.FileDescriptorProto.options
-
package
# Field google.protobuf.FileDescriptorProto.package
-
public_dependency
# Field google.protobuf.FileDescriptorProto.public_dependency
-
service
# Field google.protobuf.FileDescriptorProto.service
-
source_code_info
# Field google.protobuf.FileDescriptorProto.source_code_info
-
syntax
# Field google.protobuf.FileDescriptorProto.syntax
-
weak_dependency
# Field google.protobuf.FileDescriptorProto.weak_dependency
-
-
class
google.cloud.spanner_admin_instance_v1.types.
FileDescriptorSet
# -
file
# Field google.protobuf.FileDescriptorSet.file
-
-
class
google.cloud.spanner_admin_instance_v1.types.
FileOptions
# -
cc_enable_arenas
# Field google.protobuf.FileOptions.cc_enable_arenas
-
cc_generic_services
# Field google.protobuf.FileOptions.cc_generic_services
-
csharp_namespace
# Field google.protobuf.FileOptions.csharp_namespace
-
deprecated
# Field google.protobuf.FileOptions.deprecated
-
go_package
# Field google.protobuf.FileOptions.go_package
-
java_generate_equals_and_hash
# Field google.protobuf.FileOptions.java_generate_equals_and_hash
-
java_generic_services
# Field google.protobuf.FileOptions.java_generic_services
-
java_multiple_files
# Field google.protobuf.FileOptions.java_multiple_files
-
java_outer_classname
# Field google.protobuf.FileOptions.java_outer_classname
-
java_package
# Field google.protobuf.FileOptions.java_package
-
java_string_check_utf8
# Field google.protobuf.FileOptions.java_string_check_utf8
-
objc_class_prefix
# Field google.protobuf.FileOptions.objc_class_prefix
-
optimize_for
# Field google.protobuf.FileOptions.optimize_for
-
php_class_prefix
# Field google.protobuf.FileOptions.php_class_prefix
-
php_generic_services
# Field google.protobuf.FileOptions.php_generic_services
-
php_metadata_namespace
# Field google.protobuf.FileOptions.php_metadata_namespace
-
php_namespace
# Field google.protobuf.FileOptions.php_namespace
-
py_generic_services
# Field google.protobuf.FileOptions.py_generic_services
-
ruby_package
# Field google.protobuf.FileOptions.ruby_package
-
swift_prefix
# Field google.protobuf.FileOptions.swift_prefix
-
uninterpreted_option
# Field google.protobuf.FileOptions.uninterpreted_option
-
-
class
google.cloud.spanner_admin_instance_v1.types.
GeneratedCodeInfo
# -
class
Annotation
# -
begin
# Field google.protobuf.GeneratedCodeInfo.Annotation.begin
-
end
# Field google.protobuf.GeneratedCodeInfo.Annotation.end
-
path
# Field google.protobuf.GeneratedCodeInfo.Annotation.path
-
source_file
# Field google.protobuf.GeneratedCodeInfo.Annotation.source_file
-
-
annotation
# Field google.protobuf.GeneratedCodeInfo.annotation
-
class
-
class
google.cloud.spanner_admin_instance_v1.types.
GetIamPolicyRequest
# Request message for
GetIamPolicy
method.-
resource
# REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
-
options
# OPTIONAL: A
GetPolicyOptions
object for specifying options toGetIamPolicy
. This field is only used by Cloud IAM.
-
options
Field google.iam.v1.GetIamPolicyRequest.options
-
resource
Field google.iam.v1.GetIamPolicyRequest.resource
-
-
class
google.cloud.spanner_admin_instance_v1.types.
GetInstanceConfigRequest
# 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>
.
-
name
Field google.spanner.admin.instance.v1.GetInstanceConfigRequest.name
-
-
class
google.cloud.spanner_admin_instance_v1.types.
GetInstanceRequest
# 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>
.
-
name
Field google.spanner.admin.instance.v1.GetInstanceRequest.name
-
-
class
google.cloud.spanner_admin_instance_v1.types.
GetOperationRequest
# -
name
# Field google.longrunning.GetOperationRequest.name
-
-
class
google.cloud.spanner_admin_instance_v1.types.
Http
# -
fully_decode_reserved_expansion
# Field google.api.Http.fully_decode_reserved_expansion
-
rules
# Field google.api.Http.rules
-
-
class
google.cloud.spanner_admin_instance_v1.types.
HttpRule
# -
additional_bindings
# Field google.api.HttpRule.additional_bindings
-
body
# Field google.api.HttpRule.body
-
custom
# Field google.api.HttpRule.custom
-
delete
# Field google.api.HttpRule.delete
-
get
# Field google.api.HttpRule.get
-
patch
# Field google.api.HttpRule.patch
-
post
# Field google.api.HttpRule.post
-
put
# Field google.api.HttpRule.put
-
response_body
# Field google.api.HttpRule.response_body
-
selector
# Field google.api.HttpRule.selector
-
-
class
google.cloud.spanner_admin_instance_v1.types.
Instance
# 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 6 and 30 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.Instanc eConfig] and [ListInstanceConfigs][google.spanner.admin.instan ce.v1.InstanceAdmin.ListInstanceConfigs].
-
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.
-
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.
-
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.InstanceAdmi n.UpdateInstance], the state must be either omitted or set toREADY
.
-
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.
-
class
LabelsEntry
# -
key
# Field google.spanner.admin.instance.v1.Instance.LabelsEntry.key
-
value
# Field google.spanner.admin.instance.v1.Instance.LabelsEntry.value
-
-
config
Field google.spanner.admin.instance.v1.Instance.config
-
display_name
Field google.spanner.admin.instance.v1.Instance.display_name
-
labels
Field google.spanner.admin.instance.v1.Instance.labels
-
name
Field google.spanner.admin.instance.v1.Instance.name
-
node_count
Field google.spanner.admin.instance.v1.Instance.node_count
-
state
Field google.spanner.admin.instance.v1.Instance.state
-
-
class
google.cloud.spanner_admin_instance_v1.types.
InstanceConfig
# 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]*
-
display_name
# The name of this instance configuration as it appears in UIs.
-
display_name
Field google.spanner.admin.instance.v1.InstanceConfig.display_name
-
name
Field google.spanner.admin.instance.v1.InstanceConfig.name
-
-
class
google.cloud.spanner_admin_instance_v1.types.
ListInstanceConfigsRequest
# 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>
.
-
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.
-
page_token
# If non-empty,
page_token
should contain a [next_page_tok en][google.spanner.admin.instance.v1.ListInstanceConfigsRespon se.next_page_token] from a previous [ListInstanceConfigsResp onse][google.spanner.admin.instance.v1.ListInstanceConfigsResp onse].
-
page_size
Field google.spanner.admin.instance.v1.ListInstanceConfigsRequest.page_size
-
page_token
Field google.spanner.admin.instance.v1.ListInstanceConfigsRequest.page_token
-
parent
Field google.spanner.admin.instance.v1.ListInstanceConfigsRequest.parent
-
-
class
google.cloud.spanner_admin_instance_v1.types.
ListInstanceConfigsResponse
# The response for [ListInstanceConfigs][google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigs].
-
instance_configs
# The list of requested instance configurations.
-
next_page_token
# next_page_token
can be sent in a subsequent [ListInstanceC onfigs][google.spanner.admin.instance.v1.InstanceAdmin.ListIns tanceConfigs] call to fetch more of the matching instance configurations.
-
instance_configs
Field google.spanner.admin.instance.v1.ListInstanceConfigsResponse.instance_configs
-
next_page_token
Field google.spanner.admin.instance.v1.ListInstanceConfigsResponse.next_page_token
-
-
class
google.cloud.spanner_admin_instance_v1.types.
ListInstancesRequest
# 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>
.
-
page_size
# Number of instances to be returned in the response. If 0 or less, defaults to the server’s maximum allowed page size.
-
page_token
# If non-empty,
page_token
should contain a [next_page_tok en][google.spanner.admin.instance.v1.ListInstancesResponse.nex t_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”.
-
filter
Field google.spanner.admin.instance.v1.ListInstancesRequest.filter
-
page_size
Field google.spanner.admin.instance.v1.ListInstancesRequest.page_size
-
page_token
Field google.spanner.admin.instance.v1.ListInstancesRequest.page_token
-
parent
Field google.spanner.admin.instance.v1.ListInstancesRequest.parent
-
-
class
google.cloud.spanner_admin_instance_v1.types.
ListInstancesResponse
# The response for [ListInstances][google.spanner.admin.instance.v1.InstanceAdmin.ListInstances].
-
instances
# The list of requested instances.
-
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.
-
instances
Field google.spanner.admin.instance.v1.ListInstancesResponse.instances
-
next_page_token
Field google.spanner.admin.instance.v1.ListInstancesResponse.next_page_token
-
-
class
google.cloud.spanner_admin_instance_v1.types.
ListOperationsRequest
# -
filter
# Field google.longrunning.ListOperationsRequest.filter
-
name
# Field google.longrunning.ListOperationsRequest.name
-
page_size
# Field google.longrunning.ListOperationsRequest.page_size
-
page_token
# Field google.longrunning.ListOperationsRequest.page_token
-
-
class
google.cloud.spanner_admin_instance_v1.types.
ListOperationsResponse
# -
next_page_token
# Field google.longrunning.ListOperationsResponse.next_page_token
-
operations
# Field google.longrunning.ListOperationsResponse.operations
-
-
class
google.cloud.spanner_admin_instance_v1.types.
MessageOptions
# -
deprecated
# Field google.protobuf.MessageOptions.deprecated
-
map_entry
# Field google.protobuf.MessageOptions.map_entry
-
message_set_wire_format
# Field google.protobuf.MessageOptions.message_set_wire_format
-
no_standard_descriptor_accessor
# Field google.protobuf.MessageOptions.no_standard_descriptor_accessor
-
uninterpreted_option
# Field google.protobuf.MessageOptions.uninterpreted_option
-
-
class
google.cloud.spanner_admin_instance_v1.types.
MethodDescriptorProto
# -
client_streaming
# Field google.protobuf.MethodDescriptorProto.client_streaming
-
input_type
# Field google.protobuf.MethodDescriptorProto.input_type
-
name
# Field google.protobuf.MethodDescriptorProto.name
-
options
# Field google.protobuf.MethodDescriptorProto.options
-
output_type
# Field google.protobuf.MethodDescriptorProto.output_type
-
server_streaming
# Field google.protobuf.MethodDescriptorProto.server_streaming
-
-
class
google.cloud.spanner_admin_instance_v1.types.
MethodOptions
# -
deprecated
# Field google.protobuf.MethodOptions.deprecated
-
idempotency_level
# Field google.protobuf.MethodOptions.idempotency_level
-
uninterpreted_option
# Field google.protobuf.MethodOptions.uninterpreted_option
-
-
class
google.cloud.spanner_admin_instance_v1.types.
OneofDescriptorProto
# -
name
# Field google.protobuf.OneofDescriptorProto.name
-
options
# Field google.protobuf.OneofDescriptorProto.options
-
-
class
google.cloud.spanner_admin_instance_v1.types.
OneofOptions
# -
uninterpreted_option
# Field google.protobuf.OneofOptions.uninterpreted_option
-
-
class
google.cloud.spanner_admin_instance_v1.types.
Operation
# -
deserialize
()# Creates new method instance from given serialized data.
-
done
# Field google.longrunning.Operation.done
-
error
# Field google.longrunning.Operation.error
-
metadata
# Field google.longrunning.Operation.metadata
-
name
# Field google.longrunning.Operation.name
-
response
# Field google.longrunning.Operation.response
-
-
class
google.cloud.spanner_admin_instance_v1.types.
OperationInfo
# -
metadata_type
# Field google.longrunning.OperationInfo.metadata_type
-
response_type
# Field google.longrunning.OperationInfo.response_type
-
-
class
google.cloud.spanner_admin_instance_v1.types.
Policy
# Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.
A
Policy
consists of a list ofbindings
. Abinding
binds a list ofmembers
to arole
, where the members can be user accounts, Google groups, Google domains, and service accounts. Arole
is a named list of permissions defined by IAM.JSON Example
{ "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] }
YAML Example
bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer
For a description of IAM and its features, see the IAM developer’s guide.
-
version
# Deprecated.
-
bindings
# Associates a list of
members
to arole
.bindings
with no members will result in an error.
-
etag
# etag
is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of theetag
in the read-modify-write cycle to perform policy updates in order to avoid race conditions: Anetag
is returned in the response togetIamPolicy
, and systems are expected to put that etag in the request tosetIamPolicy
to ensure that their change will be applied to the same version of the policy. If noetag
is provided in the call tosetIamPolicy
, then the existing policy is overwritten blindly.
-
bindings
Field google.iam.v1.Policy.bindings
-
etag
Field google.iam.v1.Policy.etag
-
version
Field google.iam.v1.Policy.version
-
-
class
google.cloud.spanner_admin_instance_v1.types.
PolicyDelta
# The difference delta between two policies.
-
binding_deltas
# The delta for Bindings between two policies.
-
audit_config_deltas
# The delta for AuditConfigs between two policies.
-
audit_config_deltas
Field google.iam.v1.PolicyDelta.audit_config_deltas
-
binding_deltas
Field google.iam.v1.PolicyDelta.binding_deltas
-
-
class
google.cloud.spanner_admin_instance_v1.types.
ServiceDescriptorProto
# -
method
# Field google.protobuf.ServiceDescriptorProto.method
-
name
# Field google.protobuf.ServiceDescriptorProto.name
-
options
# Field google.protobuf.ServiceDescriptorProto.options
-
-
class
google.cloud.spanner_admin_instance_v1.types.
ServiceOptions
# -
deprecated
# Field google.protobuf.ServiceOptions.deprecated
-
uninterpreted_option
# Field google.protobuf.ServiceOptions.uninterpreted_option
-
-
class
google.cloud.spanner_admin_instance_v1.types.
SetIamPolicyRequest
# Request message for
SetIamPolicy
method.-
resource
# REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
-
policy
# REQUIRED: The complete policy to be applied to the
resource
. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
-
policy
Field google.iam.v1.SetIamPolicyRequest.policy
-
resource
Field google.iam.v1.SetIamPolicyRequest.resource
-
-
class
google.cloud.spanner_admin_instance_v1.types.
SourceCodeInfo
# -
class
Location
# -
leading_comments
# Field google.protobuf.SourceCodeInfo.Location.leading_comments
-
leading_detached_comments
# Field google.protobuf.SourceCodeInfo.Location.leading_detached_comments
-
path
# Field google.protobuf.SourceCodeInfo.Location.path
-
span
# Field google.protobuf.SourceCodeInfo.Location.span
-
trailing_comments
# Field google.protobuf.SourceCodeInfo.Location.trailing_comments
-
-
location
# Field google.protobuf.SourceCodeInfo.location
-
class
-
class
google.cloud.spanner_admin_instance_v1.types.
Status
# -
code
# Field google.rpc.Status.code
-
details
# Field google.rpc.Status.details
-
message
# Field google.rpc.Status.message
-
-
class
google.cloud.spanner_admin_instance_v1.types.
TestIamPermissionsRequest
# Request message for
TestIamPermissions
method.-
resource
# REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
-
permissions
# The set of permissions to check for the
resource
. Permissions with wildcards (such as ‘*’ or ’storage.*’) are not allowed. For more information see IAM Overview.
-
permissions
Field google.iam.v1.TestIamPermissionsRequest.permissions
-
resource
Field google.iam.v1.TestIamPermissionsRequest.resource
-
-
class
google.cloud.spanner_admin_instance_v1.types.
TestIamPermissionsResponse
# Response message for
TestIamPermissions
method.-
permissions
# A subset of
TestPermissionsRequest.permissions
that the caller is allowed.
-
permissions
Field google.iam.v1.TestIamPermissionsResponse.permissions
-
-
class
google.cloud.spanner_admin_instance_v1.types.
Timestamp
# -
nanos
# Field google.protobuf.Timestamp.nanos
-
seconds
# Field google.protobuf.Timestamp.seconds
-
-
class
google.cloud.spanner_admin_instance_v1.types.
UninterpretedOption
# -
class
NamePart
# -
is_extension
# Field google.protobuf.UninterpretedOption.NamePart.is_extension
-
name_part
# Field google.protobuf.UninterpretedOption.NamePart.name_part
-
-
aggregate_value
# Field google.protobuf.UninterpretedOption.aggregate_value
-
double_value
# Field google.protobuf.UninterpretedOption.double_value
-
identifier_value
# Field google.protobuf.UninterpretedOption.identifier_value
-
name
# Field google.protobuf.UninterpretedOption.name
-
negative_int_value
# Field google.protobuf.UninterpretedOption.negative_int_value
-
positive_int_value
# Field google.protobuf.UninterpretedOption.positive_int_value
-
string_value
# Field google.protobuf.UninterpretedOption.string_value
-
class
-
class
google.cloud.spanner_admin_instance_v1.types.
UpdateInstanceMetadata
# Metadata type for the operation returned by [UpdateInstance][google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstance].
-
instance
# The desired end state of the update.
-
start_time
# The time at which [UpdateInstance][google.spanner.admin.instan ce.v1.InstanceAdmin.UpdateInstance] request was received.
-
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.
-
end_time
# The time at which this operation failed or was completed successfully.
-
cancel_time
Field google.spanner.admin.instance.v1.UpdateInstanceMetadata.cancel_time
-
end_time
Field google.spanner.admin.instance.v1.UpdateInstanceMetadata.end_time
-
instance
Field google.spanner.admin.instance.v1.UpdateInstanceMetadata.instance
-
start_time
Field google.spanner.admin.instance.v1.UpdateInstanceMetadata.start_time
-
-
class
google.cloud.spanner_admin_instance_v1.types.
UpdateInstanceRequest
# 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 [][goog le.spanner.admin.instance.v1.UpdateInstanceRequest.field_mask ] need be included.
-
field_mask
# Required. A mask specifying which fields in [][google.spanner. admin.instance.v1.UpdateInstanceRequest.instance] should be updated. The field mask must always be specified; this prevents any future fields in [][google.spanner.admin.instance.v1.Instance] from being erased accidentally by clients that do not know about them.
-
field_mask
Field google.spanner.admin.instance.v1.UpdateInstanceRequest.field_mask
-
instance
Field google.spanner.admin.instance.v1.UpdateInstanceRequest.instance
-