Returns the operations Resource.
Returns the sessions Resource.
create(parent, body, x__xgafv=None)
Creates a new Cloud Spanner database and starts to prepare it for serving.
dropDatabase(database, x__xgafv=None)
Drops (aka deletes) a Cloud Spanner database.
Gets the state of a Cloud Spanner database.
getDdl(database, x__xgafv=None)
Returns the schema of a Cloud Spanner database as a list of formatted
getIamPolicy(resource, body, x__xgafv=None)
Gets the access control policy for a database resource. Returns an empty
list(parent, pageToken=None, x__xgafv=None, pageSize=None)
Lists Cloud Spanner databases.
list_next(previous_request, previous_response)
Retrieves the next page of results.
setIamPolicy(resource, body, x__xgafv=None)
Sets the access control policy on a database resource. Replaces any
testIamPermissions(resource, body, x__xgafv=None)
Returns permissions that the caller has on the specified database resource.
updateDdl(database, body, x__xgafv=None)
Updates the schema of a Cloud Spanner database by
create(parent, body, x__xgafv=None)
Creates a new Cloud Spanner database and starts to prepare it for serving. The returned long-running operation will have a name of the format `/operations/ ` and can be used to track preparation of the database. The metadata field type is CreateDatabaseMetadata. The response field type is Database, if successful. Args: parent: string, Required. The name of the instance that will serve the new database. Values are of the form `projects/ /instances/ `. (required) body: object, The request body. (required) The object takes the form of: { # The request for CreateDatabase. "extraStatements": [ # An optional list of DDL statements to run inside the newly created # database. Statements can create tables, indexes, etc. These # statements execute atomically with the creation of the database: # if there is an error in any statement, the database is not created. "A String", ], "createStatement": "A String", # Required. A `CREATE DATABASE` statement, which specifies the ID of the # new database. The database ID must conform to the regular expression # `a-z*[a-z0-9]` and be between 2 and 30 characters in length. # If the database ID is a reserved word or if it contains a hyphen, the # database ID must be enclosed in backticks (`` ` ``). } x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # This resource represents a long-running operation that is the result of a # network API call. "metadata": { # Service-specific metadata associated with the operation. It typically # contains progress information and common metadata such as create time. # Some services might not provide such metadata. Any method that returns a # long-running operation should document the metadata type, if any. "a_key": "", # Properties of the object. Contains field @type with type URL. }, "done": True or False, # If the value is `false`, it means the operation is still in progress. # If true, the operation is completed, and either `error` or `response` is # available. "response": { # The normal response of the operation in case of success. If the original # method returns no data on success, such as `Delete`, the response is # `google.protobuf.Empty`. If the original method is standard # `Get`/`Create`/`Update`, the response should be the resource. For other # methods, the response should have the type `XxxResponse`, where `Xxx` # is the original method name. For example, if the original method name # is `TakeSnapshot()`, the inferred response type is # `TakeSnapshotResponse`. "a_key": "", # Properties of the object. Contains field @type with type URL. }, "name": "A String", # The server-assigned name, which is only unique within the same service that # originally returns it. If you use the default HTTP mapping, the # `name` should have the format of `operations/some/unique/name`. "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation. # programming environments, including REST APIs and RPC APIs. It is used by # [gRPC](https://github.com/grpc). The error model is designed to be: # # - Simple to use and understand for most users # - Flexible enough to meet unexpected needs # # # Overview # # The `Status` message contains three pieces of data: error code, error message, # and error details. The error code should be an enum value of # google.rpc.Code, but it may accept additional error codes if needed. The # error message should be a developer-facing English message that helps # developers *understand* and *resolve* the error. If a localized user-facing # error message is needed, put the localized message in the error details or # localize it in the client. The optional error details may contain arbitrary # information about the error. There is a predefined set of error detail types # in the package `google.rpc` which can be used for common error conditions. # # # Language mapping # # The `Status` message is the logical representation of the error model, but it # is not necessarily the actual wire format. When the `Status` message is # exposed in different client libraries and different wire protocols, it can be # mapped differently. For example, it will likely be mapped to some exceptions # in Java, but more likely mapped to some error codes in C. # # # Other uses # # The error model and the `Status` message can be used in a variety of # environments, either with or without APIs, to provide a # consistent developer experience across different environments. # # Example uses of this error model include: # # - Partial errors. If a service needs to return partial errors to the client, # it may embed the `Status` in the normal response to indicate the partial # errors. # # - Workflow errors. A typical workflow has multiple steps. Each step may # have a `Status` message for error reporting purpose. # # - Batch operations. If a client uses batch request and batch response, the # `Status` message should be used directly inside batch response, one for # each error sub-response. # # - Asynchronous operations. If an API call embeds asynchronous operation # results in its response, the status of those operations should be # represented directly using the `Status` message. # # - Logging. If some API errors are stored in logs, the message `Status` could # be used directly after any stripping needed for security/privacy reasons. "message": "A String", # A developer-facing error message, which should be in English. Any # user-facing error message should be localized and sent in the # google.rpc.Status.details field, or localized by the client. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There will be a # common set of message types for APIs to use. { "a_key": "", # Properties of the object. Contains field @type with type URL. }, ], }, }
dropDatabase(database, x__xgafv=None)
Drops (aka deletes) a Cloud Spanner database.
Args:
database: string, Required. The database to be dropped. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated
# empty messages in your APIs. A typical example is to use it as the request
# or the response type of an API method. For instance:
#
# service Foo {
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
# }
#
# The JSON representation for `Empty` is empty JSON object `{}`.
}
get(name, x__xgafv=None)
Gets the state of a Cloud Spanner database. Args: name: string, Required. The name of the requested database. Values are of the form `projects//instances/ /databases/ `. (required) x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # A Cloud Spanner database. "state": "A String", # Output only. The current database state. "name": "A String", # Required. The name of the database. Values are of the form # `projects/ /instances/ /databases/ `, # where ` ` is as specified in the `CREATE DATABASE` # statement. This name can be passed to other API methods to # identify the database. }
getDdl(database, x__xgafv=None)
Returns the schema of a Cloud Spanner database as a list of formatted
DDL statements. This method does not show pending schema updates, those may
be queried using the Operations API.
Args:
database: string, Required. The database whose schema we wish to get. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response for GetDatabaseDdl.
"statements": [ # A list of formatted DDL statements defining the schema of the database
# specified in the request.
"A String",
],
}
getIamPolicy(resource, body, x__xgafv=None)
Gets the access control policy for a database resource. Returns an empty policy if a database exists but does not have a policy set. Authorization requires `spanner.databases.getIamPolicy` permission on resource. Args: resource: string, REQUIRED: The Cloud Spanner resource for which the policy is being retrieved. The format is `projects//instances/ ` for instance resources and `projects/ /instances/ /databases/ ` for database resources. (required) body: object, The request body. (required) The object takes the form of: { # Request message for `GetIamPolicy` method. } x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # 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 of `bindings`. A `Binding` binds a list of # `members` to a `role`, where the members can be user accounts, Google groups, # Google domains, and service accounts. A `role` is a named list of permissions # defined by IAM. # # **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"] # } # ] # } # # For a description of IAM and its features, see the # [IAM developer's guide](https://cloud.google.com/iam). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. { # Specifies the audit configuration for a service. # The configuration determines which permission types are logged, and what # identities, if any, are exempted from logging. # An AuditConifg must have one or more AuditLogConfigs. # # If there are AuditConfigs for both `allServices` and a specific service, # the union of the two AuditConfigs is used for that service: the log_types # specified in each AuditConfig are enabled, and the exempted_members in each # AuditConfig are exempted. # # Example Policy with multiple AuditConfigs: # # { # "audit_configs": [ # { # "service": "allServices" # "audit_log_configs": [ # { # "log_type": "DATA_READ", # "exempted_members": [ # "user:foo@gmail.com" # ] # }, # { # "log_type": "DATA_WRITE", # }, # { # "log_type": "ADMIN_READ", # } # ] # }, # { # "service": "fooservice.googleapis.com" # "audit_log_configs": [ # { # "log_type": "DATA_READ", # }, # { # "log_type": "DATA_WRITE", # "exempted_members": [ # "user:bar@gmail.com" # ] # } # ] # } # ] # } # # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ # logging. It also exempts foo@gmail.com from DATA_READ logging, and # bar@gmail.com from DATA_WRITE logging. "exemptedMembers": [ "A String", ], "auditLogConfigs": [ # The configuration for logging of each type of permission. # Next ID: 4 { # Provides the configuration for logging a type of permissions. # Example: # # { # "audit_log_configs": [ # { # "log_type": "DATA_READ", # "exempted_members": [ # "user:foo@gmail.com" # ] # }, # { # "log_type": "DATA_WRITE", # } # ] # } # # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting # foo@gmail.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of # permission. # Follows the same format of Binding.members. "A String", ], "logType": "A String", # The log type that this config enables. }, ], "service": "A String", # Specifies a service that will be enabled for audit logging. # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. # `allServices` is a special value that covers all services. }, ], "rules": [ # If more than one rule is specified, the rules are applied in the following # manner: # - All matching LOG rules are always applied. # - If any DENY/DENY_WITH_LOG rule matches, permission is denied. # Logging will be applied if one or more matching rule requires logging. # - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is # granted. # Logging will be applied if one or more matching rule requires logging. # - Otherwise, if no rule applies, permission is denied. { # A rule to be applied in a Policy. "notIn": [ # If one or more 'not_in' clauses are specified, the rule matches # if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries. # The format for in and not_in entries is the same as for members in a # Binding (see google/iam/v1/policy.proto). "A String", ], "description": "A String", # Human-readable description of the rule. "in": [ # If one or more 'in' clauses are specified, the rule matches if # the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries. "A String", ], "action": "A String", # Required "conditions": [ # Additional restrictions that must be met { # A condition to be met. "iam": "A String", # Trusted attributes supplied by the IAM system. "svc": "A String", # Trusted attributes discharged by the service. "value": "A String", # DEPRECATED. Use 'values' instead. "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses # the IAM system for access control. "values": [ # The objects of the condition. This is mutually exclusive with 'value'. "A String", ], "op": "A String", # An operator to apply the subject with. }, ], "logConfig": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries # that match the LOG action. { # Specifies what kind of log the caller must write "counter": { # Options for counters # Counter options. "field": "A String", # The field value to attribute. "metric": "A String", # The metric to update. }, "dataAccess": { # Write a Data Access (Gin) log # Data access options. }, "cloudAudit": { # Write a Cloud Audit log # Cloud audit options. }, }, ], "permissions": [ # A permission is a string of form ' . . ' # (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, # and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs. "A String", ], }, ], "version": 42, # Version of the `Policy`. The default version is 0. "etag": "A String", # `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 the `etag` in the # read-modify-write cycle to perform policy updates in order to avoid race # conditions: An `etag` is returned in the response to `getIamPolicy`, and # systems are expected to put that etag in the request to `setIamPolicy` to # ensure that their change will be applied to the same version of the policy. # # If no `etag` is provided in the call to `setIamPolicy`, then the existing # policy is overwritten blindly. "bindings": [ # Associates a list of `members` to a `role`. # Multiple `bindings` must not be specified for the same `role`. # `bindings` with no members will result in an error. { # Associates `members` with a `role`. "role": "A String", # Role that is assigned to `members`. # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. # Required "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` or `joe@example.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}`: A Google Apps domain name that represents all the # users of that domain. For example, `google.com` or `example.com`. # "A String", ], }, ], "iamOwned": True or False, }
list(parent, pageToken=None, x__xgafv=None, pageSize=None)
Lists Cloud Spanner databases. Args: parent: string, Required. The instance whose databases should be listed. Values are of the form `projects//instances/ `. (required) pageToken: string, If non-empty, `page_token` should contain a next_page_token from a previous ListDatabasesResponse. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format pageSize: integer, Number of databases to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size. Returns: An object of the form: { # The response for ListDatabases. "nextPageToken": "A String", # `next_page_token` can be sent in a subsequent # ListDatabases call to fetch more # of the matching databases. "databases": [ # Databases that matched the request. { # A Cloud Spanner database. "state": "A String", # Output only. The current database state. "name": "A String", # Required. The name of the database. Values are of the form # `projects/ /instances/ /databases/ `, # where ` ` is as specified in the `CREATE DATABASE` # statement. This name can be passed to other API methods to # identify the database. }, ], }
list_next(previous_request, previous_response)
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
setIamPolicy(resource, body, x__xgafv=None)
Sets the access control policy on a database resource. Replaces any existing policy. Authorization requires `spanner.databases.setIamPolicy` permission on resource. Args: resource: string, REQUIRED: The Cloud Spanner resource for which the policy is being set. The format is `projects//instances/ ` for instance resources and `projects/ /instances/ /databases/ ` for databases resources. (required) body: object, The request body. (required) The object takes the form of: { # Request message for `SetIamPolicy` method. "policy": { # Defines an Identity and Access Management (IAM) policy. It is used to # 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. # specify access control policies for Cloud Platform resources. # # # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of # `members` to a `role`, where the members can be user accounts, Google groups, # Google domains, and service accounts. A `role` is a named list of permissions # defined by IAM. # # **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"] # } # ] # } # # For a description of IAM and its features, see the # [IAM developer's guide](https://cloud.google.com/iam). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. { # Specifies the audit configuration for a service. # The configuration determines which permission types are logged, and what # identities, if any, are exempted from logging. # An AuditConifg must have one or more AuditLogConfigs. # # If there are AuditConfigs for both `allServices` and a specific service, # the union of the two AuditConfigs is used for that service: the log_types # specified in each AuditConfig are enabled, and the exempted_members in each # AuditConfig are exempted. # # Example Policy with multiple AuditConfigs: # # { # "audit_configs": [ # { # "service": "allServices" # "audit_log_configs": [ # { # "log_type": "DATA_READ", # "exempted_members": [ # "user:foo@gmail.com" # ] # }, # { # "log_type": "DATA_WRITE", # }, # { # "log_type": "ADMIN_READ", # } # ] # }, # { # "service": "fooservice.googleapis.com" # "audit_log_configs": [ # { # "log_type": "DATA_READ", # }, # { # "log_type": "DATA_WRITE", # "exempted_members": [ # "user:bar@gmail.com" # ] # } # ] # } # ] # } # # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ # logging. It also exempts foo@gmail.com from DATA_READ logging, and # bar@gmail.com from DATA_WRITE logging. "exemptedMembers": [ "A String", ], "auditLogConfigs": [ # The configuration for logging of each type of permission. # Next ID: 4 { # Provides the configuration for logging a type of permissions. # Example: # # { # "audit_log_configs": [ # { # "log_type": "DATA_READ", # "exempted_members": [ # "user:foo@gmail.com" # ] # }, # { # "log_type": "DATA_WRITE", # } # ] # } # # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting # foo@gmail.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of # permission. # Follows the same format of Binding.members. "A String", ], "logType": "A String", # The log type that this config enables. }, ], "service": "A String", # Specifies a service that will be enabled for audit logging. # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. # `allServices` is a special value that covers all services. }, ], "rules": [ # If more than one rule is specified, the rules are applied in the following # manner: # - All matching LOG rules are always applied. # - If any DENY/DENY_WITH_LOG rule matches, permission is denied. # Logging will be applied if one or more matching rule requires logging. # - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is # granted. # Logging will be applied if one or more matching rule requires logging. # - Otherwise, if no rule applies, permission is denied. { # A rule to be applied in a Policy. "notIn": [ # If one or more 'not_in' clauses are specified, the rule matches # if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries. # The format for in and not_in entries is the same as for members in a # Binding (see google/iam/v1/policy.proto). "A String", ], "description": "A String", # Human-readable description of the rule. "in": [ # If one or more 'in' clauses are specified, the rule matches if # the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries. "A String", ], "action": "A String", # Required "conditions": [ # Additional restrictions that must be met { # A condition to be met. "iam": "A String", # Trusted attributes supplied by the IAM system. "svc": "A String", # Trusted attributes discharged by the service. "value": "A String", # DEPRECATED. Use 'values' instead. "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses # the IAM system for access control. "values": [ # The objects of the condition. This is mutually exclusive with 'value'. "A String", ], "op": "A String", # An operator to apply the subject with. }, ], "logConfig": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries # that match the LOG action. { # Specifies what kind of log the caller must write "counter": { # Options for counters # Counter options. "field": "A String", # The field value to attribute. "metric": "A String", # The metric to update. }, "dataAccess": { # Write a Data Access (Gin) log # Data access options. }, "cloudAudit": { # Write a Cloud Audit log # Cloud audit options. }, }, ], "permissions": [ # A permission is a string of form ' . . ' # (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, # and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs. "A String", ], }, ], "version": 42, # Version of the `Policy`. The default version is 0. "etag": "A String", # `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 the `etag` in the # read-modify-write cycle to perform policy updates in order to avoid race # conditions: An `etag` is returned in the response to `getIamPolicy`, and # systems are expected to put that etag in the request to `setIamPolicy` to # ensure that their change will be applied to the same version of the policy. # # If no `etag` is provided in the call to `setIamPolicy`, then the existing # policy is overwritten blindly. "bindings": [ # Associates a list of `members` to a `role`. # Multiple `bindings` must not be specified for the same `role`. # `bindings` with no members will result in an error. { # Associates `members` with a `role`. "role": "A String", # Role that is assigned to `members`. # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. # Required "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` or `joe@example.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}`: A Google Apps domain name that represents all the # users of that domain. For example, `google.com` or `example.com`. # "A String", ], }, ], "iamOwned": True or False, }, "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only # the fields in the mask will be modified. If no mask is provided, the # following default mask is used: # paths: "bindings, etag" # This field is only used by Cloud IAM. } x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # 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 of `bindings`. A `Binding` binds a list of # `members` to a `role`, where the members can be user accounts, Google groups, # Google domains, and service accounts. A `role` is a named list of permissions # defined by IAM. # # **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"] # } # ] # } # # For a description of IAM and its features, see the # [IAM developer's guide](https://cloud.google.com/iam). "auditConfigs": [ # Specifies cloud audit logging configuration for this policy. { # Specifies the audit configuration for a service. # The configuration determines which permission types are logged, and what # identities, if any, are exempted from logging. # An AuditConifg must have one or more AuditLogConfigs. # # If there are AuditConfigs for both `allServices` and a specific service, # the union of the two AuditConfigs is used for that service: the log_types # specified in each AuditConfig are enabled, and the exempted_members in each # AuditConfig are exempted. # # Example Policy with multiple AuditConfigs: # # { # "audit_configs": [ # { # "service": "allServices" # "audit_log_configs": [ # { # "log_type": "DATA_READ", # "exempted_members": [ # "user:foo@gmail.com" # ] # }, # { # "log_type": "DATA_WRITE", # }, # { # "log_type": "ADMIN_READ", # } # ] # }, # { # "service": "fooservice.googleapis.com" # "audit_log_configs": [ # { # "log_type": "DATA_READ", # }, # { # "log_type": "DATA_WRITE", # "exempted_members": [ # "user:bar@gmail.com" # ] # } # ] # } # ] # } # # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ # logging. It also exempts foo@gmail.com from DATA_READ logging, and # bar@gmail.com from DATA_WRITE logging. "exemptedMembers": [ "A String", ], "auditLogConfigs": [ # The configuration for logging of each type of permission. # Next ID: 4 { # Provides the configuration for logging a type of permissions. # Example: # # { # "audit_log_configs": [ # { # "log_type": "DATA_READ", # "exempted_members": [ # "user:foo@gmail.com" # ] # }, # { # "log_type": "DATA_WRITE", # } # ] # } # # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting # foo@gmail.com from DATA_READ logging. "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of # permission. # Follows the same format of Binding.members. "A String", ], "logType": "A String", # The log type that this config enables. }, ], "service": "A String", # Specifies a service that will be enabled for audit logging. # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. # `allServices` is a special value that covers all services. }, ], "rules": [ # If more than one rule is specified, the rules are applied in the following # manner: # - All matching LOG rules are always applied. # - If any DENY/DENY_WITH_LOG rule matches, permission is denied. # Logging will be applied if one or more matching rule requires logging. # - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is # granted. # Logging will be applied if one or more matching rule requires logging. # - Otherwise, if no rule applies, permission is denied. { # A rule to be applied in a Policy. "notIn": [ # If one or more 'not_in' clauses are specified, the rule matches # if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries. # The format for in and not_in entries is the same as for members in a # Binding (see google/iam/v1/policy.proto). "A String", ], "description": "A String", # Human-readable description of the rule. "in": [ # If one or more 'in' clauses are specified, the rule matches if # the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries. "A String", ], "action": "A String", # Required "conditions": [ # Additional restrictions that must be met { # A condition to be met. "iam": "A String", # Trusted attributes supplied by the IAM system. "svc": "A String", # Trusted attributes discharged by the service. "value": "A String", # DEPRECATED. Use 'values' instead. "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses # the IAM system for access control. "values": [ # The objects of the condition. This is mutually exclusive with 'value'. "A String", ], "op": "A String", # An operator to apply the subject with. }, ], "logConfig": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries # that match the LOG action. { # Specifies what kind of log the caller must write "counter": { # Options for counters # Counter options. "field": "A String", # The field value to attribute. "metric": "A String", # The metric to update. }, "dataAccess": { # Write a Data Access (Gin) log # Data access options. }, "cloudAudit": { # Write a Cloud Audit log # Cloud audit options. }, }, ], "permissions": [ # A permission is a string of form ' . . ' # (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, # and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs. "A String", ], }, ], "version": 42, # Version of the `Policy`. The default version is 0. "etag": "A String", # `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 the `etag` in the # read-modify-write cycle to perform policy updates in order to avoid race # conditions: An `etag` is returned in the response to `getIamPolicy`, and # systems are expected to put that etag in the request to `setIamPolicy` to # ensure that their change will be applied to the same version of the policy. # # If no `etag` is provided in the call to `setIamPolicy`, then the existing # policy is overwritten blindly. "bindings": [ # Associates a list of `members` to a `role`. # Multiple `bindings` must not be specified for the same `role`. # `bindings` with no members will result in an error. { # Associates `members` with a `role`. "role": "A String", # Role that is assigned to `members`. # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. # Required "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` or `joe@example.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}`: A Google Apps domain name that represents all the # users of that domain. For example, `google.com` or `example.com`. # "A String", ], }, ], "iamOwned": True or False, }
testIamPermissions(resource, body, x__xgafv=None)
Returns permissions that the caller has on the specified database resource. Attempting this RPC on a non-existent Cloud Spanner database will result in a NOT_FOUND error if the user has `spanner.databases.list` permission on the containing Cloud Spanner instance. Otherwise returns an empty set of permissions. Args: resource: string, REQUIRED: The Cloud Spanner resource for which permissions are being tested. The format is `projects//instances/ ` for instance resources and `projects/ /instances/ /databases/ ` for database resources. (required) body: object, The request body. (required) The object takes the form of: { # Request message for `TestIamPermissions` method. "permissions": [ # REQUIRED: The set of permissions to check for 'resource'. # Permissions with wildcards (such as '*', 'spanner.*', 'spanner.instances.*') are not allowed. "A String", ], } x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # Response message for `TestIamPermissions` method. "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is # allowed. "A String", ], }
updateDdl(database, body, x__xgafv=None)
Updates the schema of a Cloud Spanner database by creating/altering/dropping tables, columns, indexes, etc. The returned long-running operation will have a name of the format `/operations/ ` and can be used to track execution of the schema change(s). The metadata field type is UpdateDatabaseDdlMetadata. The operation has no response. Args: database: string, Required. The database to update. (required) body: object, The request body. (required) The object takes the form of: { # Enqueues the given DDL statements to be applied, in order but not # necessarily all at once, to the database schema at some point (or # points) in the future. The server checks that the statements # are executable (syntactically valid, name tables that exist, etc.) # before enqueueing them, but they may still fail upon # later execution (e.g., if a statement from another batch of # statements is applied first and it conflicts in some way, or if # there is some data-related problem like a `NULL` value in a column to # which `NOT NULL` would be added). If a statement fails, all # subsequent statements in the batch are automatically cancelled. # # Each batch of statements is assigned a name which can be used with # the Operations API to monitor # progress. See the # operation_id field for more # details. "statements": [ # DDL statements to be applied to the database. "A String", ], "operationId": "A String", # If empty, the new update request is assigned an # automatically-generated operation ID. Otherwise, `operation_id` # is used to construct the name of the resulting # Operation. # # Specifying an explicit operation ID simplifies determining # whether the statements were executed in the event that the # UpdateDatabaseDdl call is replayed, # or the return value is otherwise lost: the database and # `operation_id` fields can be combined to form the # name of the resulting # longrunning.Operation: ` /operations/ `. # # `operation_id` should be unique within the database, and must be # a valid identifier: `a-z*`. Note that # automatically-generated operation IDs always begin with an # underscore. If the named operation already exists, # UpdateDatabaseDdl returns # `ALREADY_EXISTS`. } x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # This resource represents a long-running operation that is the result of a # network API call. "metadata": { # Service-specific metadata associated with the operation. It typically # contains progress information and common metadata such as create time. # Some services might not provide such metadata. Any method that returns a # long-running operation should document the metadata type, if any. "a_key": "", # Properties of the object. Contains field @type with type URL. }, "done": True or False, # If the value is `false`, it means the operation is still in progress. # If true, the operation is completed, and either `error` or `response` is # available. "response": { # The normal response of the operation in case of success. If the original # method returns no data on success, such as `Delete`, the response is # `google.protobuf.Empty`. If the original method is standard # `Get`/`Create`/`Update`, the response should be the resource. For other # methods, the response should have the type `XxxResponse`, where `Xxx` # is the original method name. For example, if the original method name # is `TakeSnapshot()`, the inferred response type is # `TakeSnapshotResponse`. "a_key": "", # Properties of the object. Contains field @type with type URL. }, "name": "A String", # The server-assigned name, which is only unique within the same service that # originally returns it. If you use the default HTTP mapping, the # `name` should have the format of `operations/some/unique/name`. "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation. # programming environments, including REST APIs and RPC APIs. It is used by # [gRPC](https://github.com/grpc). The error model is designed to be: # # - Simple to use and understand for most users # - Flexible enough to meet unexpected needs # # # Overview # # The `Status` message contains three pieces of data: error code, error message, # and error details. The error code should be an enum value of # google.rpc.Code, but it may accept additional error codes if needed. The # error message should be a developer-facing English message that helps # developers *understand* and *resolve* the error. If a localized user-facing # error message is needed, put the localized message in the error details or # localize it in the client. The optional error details may contain arbitrary # information about the error. There is a predefined set of error detail types # in the package `google.rpc` which can be used for common error conditions. # # # Language mapping # # The `Status` message is the logical representation of the error model, but it # is not necessarily the actual wire format. When the `Status` message is # exposed in different client libraries and different wire protocols, it can be # mapped differently. For example, it will likely be mapped to some exceptions # in Java, but more likely mapped to some error codes in C. # # # Other uses # # The error model and the `Status` message can be used in a variety of # environments, either with or without APIs, to provide a # consistent developer experience across different environments. # # Example uses of this error model include: # # - Partial errors. If a service needs to return partial errors to the client, # it may embed the `Status` in the normal response to indicate the partial # errors. # # - Workflow errors. A typical workflow has multiple steps. Each step may # have a `Status` message for error reporting purpose. # # - Batch operations. If a client uses batch request and batch response, the # `Status` message should be used directly inside batch response, one for # each error sub-response. # # - Asynchronous operations. If an API call embeds asynchronous operation # results in its response, the status of those operations should be # represented directly using the `Status` message. # # - Logging. If some API errors are stored in logs, the message `Status` could # be used directly after any stripping needed for security/privacy reasons. "message": "A String", # A developer-facing error message, which should be in English. Any # user-facing error message should be localized and sent in the # google.rpc.Status.details field, or localized by the client. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There will be a # common set of message types for APIs to use. { "a_key": "", # Properties of the object. Contains field @type with type URL. }, ], }, }