# Cloud Healthcare API . projects . locations . datasets

## Instance Methods

Returns the dicomStores Resource.

Returns the fhirStores Resource.

Returns the hl7V2Stores Resource.

Returns the operations Resource.

Creates a new health dataset. Results are returned through the

Creates a new dataset containing de-identified data from the source

Deletes the specified health dataset and all data contained in the dataset.

Gets any metadata associated with a dataset.

Gets the access control policy for a resource.

Lists the health datasets in the current project.

Retrieves the next page of results.

Updates dataset metadata.

Sets the access control policy on the specified resource. Replaces any

Returns permissions that a caller has on the specified resource.

### Method Details

`create(parent, body, x__xgafv=None, datasetId=None)`

    Creates a new health dataset. Results are returned through the
    Operation interface which returns either an
    `Operation.response` which contains a Dataset or
    `Operation.error`. The metadata
    field type is OperationMetadata.
    A Google Cloud Platform project can contain up to 500 datasets across all
    regions.

    Args:
      parent: string, The name of the project in which the dataset should be created (e.g.,
    `projects/{project_id}/locations/{location_id}`). (required)
      body: object, The request body. (required)
        The object takes the form of:

    { # A message representing a health dataset.
        #
        # A health dataset represents a collection of healthcare data pertaining to one
        # or more patients. This may include multiple modalities of healthcare data,
        # such as electronic medical records or medical imaging data.
      "timeZone": "A String", # The default timezone used by this dataset. Must be a either a valid IANA
          # time zone name such as "America/New_York" or empty, which defaults to UTC.
          # This is used for parsing times in resources (e.g., HL7 messages) where no
          # explicit timezone is specified.
      "name": "A String", # Output only. Resource name of the dataset, of the form
          # `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`.
    }

      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format
      datasetId: string, The ID of the dataset that is being created.
    The string must match the following regex: `[\p{L}\p{N}_\-\.]{1,256}`.

    Returns:
      An object of the form:

        { # This resource represents a long-running operation that is the result of a
          # network API call.
        "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
            # different programming environments, including REST APIs and RPC APIs. It is
            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
            # three pieces of data: error code, error message, and error details.
            #
            # You can find out more about this error model and how to work with it in the
            # [API Design Guide](https://cloud.google.com/apis/design/errors).
          "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 is a common set of
              # message types for APIs to use.
            {
              "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 be a resource name ending with `operations/{unique_id}`.
        "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.
        },
      }

`deidentify(sourceDataset, body, x__xgafv=None)`

    Creates a new dataset containing de-identified data from the source
    dataset. The metadata field type
    is OperationMetadata.
    If the request is successful, the
    response field type is
    DeidentifySummary.
    If errors occur,
    details field type is
    DeidentifyErrorDetails.

    Args:
      sourceDataset: string, Source dataset resource name. (e.g.,
    `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`). (required)
      body: object, The request body. (required)
        The object takes the form of:

    { # Redacts identifying information from the specified dataset.
        "destinationDataset": "A String", # The name of the dataset resource to create and write the redacted data to
            # (e.g.,
            #
            #  * The destination dataset must not exist.
            #  * The destination dataset must be in the same project as the source
            #    dataset. De-identifying data across multiple projects is not supported.
        "config": { # Configures de-id options specific to different types of content. # Deidentify configuration.
            # Each submessage customizes the handling of an
            # https://tools.ietf.org/html/rfc6838 media type or subtype. Configs are
            # applied in a nested manner at runtime.
          "text": { # Configures de-identification of text wherever it is found in the
              # source_dataset.
            "transformations": [ # The transformations to apply to the detected data.
              { # A transformation to apply to text that is identified as a specific
                  # info_type.
                "characterMaskConfig": { # Mask a string by replacing its characters with a fixed character. # Config for character mask.
                  "maskingCharacter": "A String", # Character to mask the sensitive values. If not supplied, defaults to "*".
                },
                "redactConfig": { # Define how to redact sensitive values. Default behaviour is erase, # Config for text redaction.
                    # e.g. "My name is Jake." becomes "My name is ."
                },
                "replaceWithInfoTypeConfig": { # When using the INSPECT_AND_TRANSFORM action, each match is replaced with # Config for replace with InfoType.
                    # the name of the info_type. For example, "My name is Jake" becomes "My name is
                    # [PERSON_NAME]." The TRANSFORM action is equivalent to redacting.
                },
                "cryptoHashConfig": { # Pseudonymization method that generates surrogates via cryptographic hashing. # Config for crypto hash.
                    # Uses SHA-256.
                    # Outputs a base64-encoded representation of the hashed output
                    # (for example, `L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=`).
                  "cryptoKey": "A String", # An AES 128/192/256 bit key. Causes the hash to be computed based on this
                      # key. A default key is generated for each DeidentifyDataset operation and is
                      # used wherever crypto_key is not specified.
                },
                "infoTypes": [ # InfoTypes to apply this transformation to. If this is not specified, the
                    # transformation applies to any info_type.
                  "A String",
                ],
                "dateShiftConfig": { # Shift a date forward or backward in time by a random amount which is # Config for date shift.
                    # consistent for a given patient and crypto key combination.
                  "cryptoKey": "A String", # An AES 128/192/256 bit key. Causes the shift to be computed based on this
                      # key and the patient ID. A default key is generated for each
                      # DeidentifyDataset operation and is used wherever crypto_key is not
                      # specified.
                },
              },
            ],
          },
          "image": { # Specifies how de-identification of image pixel should be handled. # Configures de-identification of image pixels wherever they are found in the
              # source_dataset.
            "textRedactionMode": "A String", # Determines how to redact text from image.
          },
          "fhir": { # Specifies how de-identification of a FHIR store should be handled. # Configures de-id of application/FHIR content.
            "fieldMetadataList": [ # Specifies FHIR paths to match and how to transform them. Any field that
                # is not matched by a FieldMetadata will be passed through to the output
                # dataset unmodified. All extensions are removed in the output.
              { # Specifies FHIR paths to match, and how to handle de-identification of
                  # matching fields.
                "action": "A String", # Deidentify action for one field.
                "paths": [ # List of paths to FHIR fields to be redacted. Each path is a
                    # period-separated list where each component is either a field name or
                    # FHIR type name, for example: Patient, HumanName.
                    # For "choice" types (those defined in the FHIR spec with the form:
                    # field[x]) we use two separate components. e.g. "deceasedAge.unit" is
                    # matched by "Deceased.Age.unit".
                    # Supported types are: AdministrativeGenderCode, Code, Date, DateTime,
                    # Decimal, HumanName, Id, LanguageCode, Markdown, MimeTypeCode, Oid,
                    # String, Uri, Uuid, Xhtml.
                  "A String",
                ],
              },
            ],
          },
          "dicom": { # Specifies the parameters needed for de-identification of DICOM stores. # Configures de-id of application/DICOM content.
            "filterProfile": "A String", # Tag filtering profile that determines which tags to keep/remove.
            "removeList": { # List of tags to be filtered. # List of tags to remove. Keep all other tags.
              "tags": [ # Tags to be filtered. Tags must be DICOM Data Elements, File Meta
                  # Elements, or Directory Structuring Elements, as defined at:
                  # http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,.
                  # They may be provided by "Keyword" or "Tag". For example "PatientID",
                  # "00100010".
                "A String",
              ],
            },
            "keepList": { # List of tags to be filtered. # List of tags to keep. Remove all other tags.
              "tags": [ # Tags to be filtered. Tags must be DICOM Data Elements, File Meta
                  # Elements, or Directory Structuring Elements, as defined at:
                  # http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,.
                  # They may be provided by "Keyword" or "Tag". For example "PatientID",
                  # "00100010".
                "A String",
              ],
            },
          },
        },
      }

      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.
        "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
            # different programming environments, including REST APIs and RPC APIs. It is
            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
            # three pieces of data: error code, error message, and error details.
            #
            # You can find out more about this error model and how to work with it in the
            # [API Design Guide](https://cloud.google.com/apis/design/errors).
          "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 is a common set of
              # message types for APIs to use.
            {
              "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 be a resource name ending with `operations/{unique_id}`.
        "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.
        },
      }

`delete(name, x__xgafv=None)`

    Deletes the specified health dataset and all data contained in the dataset.
    Deleting a dataset does not affect the sources from which the dataset was
    imported (if any).

    Args:
      name: string, The name of the dataset to delete (e.g.,
    `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`). (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 any metadata associated with a dataset.

    Args:
      name: string, The name of the dataset to read (e.g.,
    `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`). (required)
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # A message representing a health dataset.
          #
          # A health dataset represents a collection of healthcare data pertaining to one
          # or more patients. This may include multiple modalities of healthcare data,
          # such as electronic medical records or medical imaging data.
        "timeZone": "A String", # The default timezone used by this dataset. Must be a either a valid IANA
            # time zone name such as "America/New_York" or empty, which defaults to UTC.
            # This is used for parsing times in resources (e.g., HL7 messages) where no
            # explicit timezone is specified.
        "name": "A String", # Output only. Resource name of the dataset, of the form
            # `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`.
      }

`getIamPolicy(resource, x__xgafv=None)`

    Gets the access control policy for a resource.
    Returns an empty policy if the resource exists and does not have a policy
    set.

    Args:
      resource: string, REQUIRED: The resource for which the policy is being requested.
    See the operation documentation for the appropriate value for this field. (required)
      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.
          #
          # **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](https://cloud.google.com/iam/docs).
        "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 AuditConfig 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
              # AuditLogConfig 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.
            "auditLogConfigs": [ # The configuration for logging of each type of permission.
              { # 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.
          },
        ],
        "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`.
            # `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`.
            "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` or `example.com`.
                #
              "A String",
            ],
            "condition": { # Represents an expression text. Example: # 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.
                #
                #     title: "User account presence"
                #     description: "Determines whether the request has a user account"
                #     expression: "size(request.user) > 0"
              "location": "A String", # An optional string indicating the location of the expression for error
                  # reporting, e.g. a file name and a position in the file.
              "expression": "A String", # Textual representation of an expression in
                  # Common Expression Language syntax.
                  #
                  # The application context of the containing message determines which
                  # well-known feature set of CEL is supported.
              "description": "A String", # An optional description of the expression. This is a longer text which
                  # describes the expression, e.g. when hovered over it in a UI.
              "title": "A String", # An optional title for the expression, i.e. a short string describing
                  # its purpose. This can be used e.g. in UIs which allow to enter the
                  # expression.
            },
          },
        ],
        "version": 42, # Deprecated.
      }

`list(parent, pageToken=None, x__xgafv=None, pageSize=None)`

    Lists the health datasets in the current project.

    Args:
      parent: string, The name of the project whose datasets should be listed (e.g.,
    `projects/{project_id}/locations/{location_id}`). (required)
      pageToken: string, The next_page_token value returned from a previous List request, if any.
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format
      pageSize: integer, The maximum number of items to return. Capped to 100 if not specified.
    May not be larger than 1000.

    Returns:
      An object of the form:

        { # Lists the available datasets.
        "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
            # more results in the list.
        "datasets": [ # The first page of datasets.
          { # A message representing a health dataset.
              #
              # A health dataset represents a collection of healthcare data pertaining to one
              # or more patients. This may include multiple modalities of healthcare data,
              # such as electronic medical records or medical imaging data.
            "timeZone": "A String", # The default timezone used by this dataset. Must be a either a valid IANA
                # time zone name such as "America/New_York" or empty, which defaults to UTC.
                # This is used for parsing times in resources (e.g., HL7 messages) where no
                # explicit timezone is specified.
            "name": "A String", # Output only. Resource name of the dataset, of the form
                # `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`.
          },
        ],
      }

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

`patch(name, body, updateMask=None, x__xgafv=None)`

    Updates dataset metadata.

    Args:
      name: string, Output only. Resource name of the dataset, of the form
    `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`. (required)
      body: object, The request body. (required)
        The object takes the form of:

    { # A message representing a health dataset.
        #
        # A health dataset represents a collection of healthcare data pertaining to one
        # or more patients. This may include multiple modalities of healthcare data,
        # such as electronic medical records or medical imaging data.
      "timeZone": "A String", # The default timezone used by this dataset. Must be a either a valid IANA
          # time zone name such as "America/New_York" or empty, which defaults to UTC.
          # This is used for parsing times in resources (e.g., HL7 messages) where no
          # explicit timezone is specified.
      "name": "A String", # Output only. Resource name of the dataset, of the form
          # `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`.
    }

      updateMask: string, The update mask applies to the resource. For the `FieldMask` definition,
    see
    https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # A message representing a health dataset.
          #
          # A health dataset represents a collection of healthcare data pertaining to one
          # or more patients. This may include multiple modalities of healthcare data,
          # such as electronic medical records or medical imaging data.
        "timeZone": "A String", # The default timezone used by this dataset. Must be a either a valid IANA
            # time zone name such as "America/New_York" or empty, which defaults to UTC.
            # This is used for parsing times in resources (e.g., HL7 messages) where no
            # explicit timezone is specified.
        "name": "A String", # Output only. Resource name of the dataset, of the form
            # `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`.
      }

`setIamPolicy(resource, body, x__xgafv=None)`

    Sets the access control policy on the specified resource. Replaces any
    existing policy.

    Args:
      resource: string, REQUIRED: The resource for which the policy is being specified.
    See the operation documentation for the appropriate value for this field. (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.
            #
            # **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](https://cloud.google.com/iam/docs).
          "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 AuditConfig 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
                # AuditLogConfig 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.
              "auditLogConfigs": [ # The configuration for logging of each type of permission.
                { # 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.
            },
          ],
          "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`.
              # `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`.
              "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` or `example.com`.
                  #
                "A String",
              ],
              "condition": { # Represents an expression text. Example: # 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.
                  #
                  #     title: "User account presence"
                  #     description: "Determines whether the request has a user account"
                  #     expression: "size(request.user) > 0"
                "location": "A String", # An optional string indicating the location of the expression for error
                    # reporting, e.g. a file name and a position in the file.
                "expression": "A String", # Textual representation of an expression in
                    # Common Expression Language syntax.
                    #
                    # The application context of the containing message determines which
                    # well-known feature set of CEL is supported.
                "description": "A String", # An optional description of the expression. This is a longer text which
                    # describes the expression, e.g. when hovered over it in a UI.
                "title": "A String", # An optional title for the expression, i.e. a short string describing
                    # its purpose. This can be used e.g. in UIs which allow to enter the
                    # expression.
              },
            },
          ],
          "version": 42, # Deprecated.
        },
        "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.
          #
          # **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](https://cloud.google.com/iam/docs).
        "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 AuditConfig 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
              # AuditLogConfig 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.
            "auditLogConfigs": [ # The configuration for logging of each type of permission.
              { # 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.
          },
        ],
        "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`.
            # `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`.
            "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` or `example.com`.
                #
              "A String",
            ],
            "condition": { # Represents an expression text. Example: # 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.
                #
                #     title: "User account presence"
                #     description: "Determines whether the request has a user account"
                #     expression: "size(request.user) > 0"
              "location": "A String", # An optional string indicating the location of the expression for error
                  # reporting, e.g. a file name and a position in the file.
              "expression": "A String", # Textual representation of an expression in
                  # Common Expression Language syntax.
                  #
                  # The application context of the containing message determines which
                  # well-known feature set of CEL is supported.
              "description": "A String", # An optional description of the expression. This is a longer text which
                  # describes the expression, e.g. when hovered over it in a UI.
              "title": "A String", # An optional title for the expression, i.e. a short string describing
                  # its purpose. This can be used e.g. in UIs which allow to enter the
                  # expression.
            },
          },
        ],
        "version": 42, # Deprecated.
      }

`testIamPermissions(resource, body, x__xgafv=None)`

    Returns permissions that a caller has on the specified resource.
    If the resource does not exist, this will return an empty set of
    permissions, not a NOT_FOUND error.

    Note: This operation is designed to be used for building permission-aware
    UIs and command-line tools, not for authorization checking. This operation
    may "fail open" without warning.

    Args:
      resource: string, REQUIRED: The resource for which the policy detail is being requested.
    See the operation documentation for the appropriate value for this field. (required)
      body: object, The request body. (required)
        The object takes the form of:

    { # Request message for `TestIamPermissions` method.
        "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](https://cloud.google.com/iam/docs/overview#permissions).
          "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",
        ],
      }