# BigQuery Connection API . projects . locations . connections

## Instance Methods

Creates a new connection.

Deletes connection and associated credential.

Returns specified connection.

Gets the access control policy for a resource.

Returns a list of connections in the given project.

Retrieves the next page of results.

Updates the specified connection. For security reasons, also resets

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

Returns permissions that a caller has on the specified resource.

Sets the credential for the specified connection.

### Method Details

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

    Creates a new connection.

    Args:
      parent: string, Required. Parent resource name.
    Must be in the format `projects/{project_id}/locations/{location_id}` (required)
      body: object, The request body.
        The object takes the form of:

    { # Configuration parameters to establish connection with an external data
        # source, except the credential attributes.
      "creationTime": "A String", # Output only. The creation timestamp of the connection.
      "name": "A String", # The resource name of the connection in the form of:
          # `projects/{project_id}/locations/{location_id}/connections/{connection_id}`
      "cloudSql": { # Connection properties specific to the Cloud SQL. # Cloud SQL properties.
        "database": "A String", # Database name.
        "instanceId": "A String", # Cloud SQL instance ID in the form `project:location:instance`.
        "type": "A String", # Type of the Cloud SQL database.
        "credential": { # Credential info for the Cloud SQL. # Input only. Cloud SQL credential.
          "password": "A String", # The password for the credential.
          "username": "A String", # The username for the credential.
        },
      },
      "hasCredential": True or False, # Output only. True, if credential is configured for this connection.
      "friendlyName": "A String", # User provided display name for the connection.
      "lastModifiedTime": "A String", # Output only. The last update timestamp of the connection.
      "description": "A String", # User provided description.
    }

      connectionId: string, Optional. Connection id that should be assigned to the created connection.
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # Configuration parameters to establish connection with an external data
          # source, except the credential attributes.
        "creationTime": "A String", # Output only. The creation timestamp of the connection.
        "name": "A String", # The resource name of the connection in the form of:
            # `projects/{project_id}/locations/{location_id}/connections/{connection_id}`
        "cloudSql": { # Connection properties specific to the Cloud SQL. # Cloud SQL properties.
          "database": "A String", # Database name.
          "instanceId": "A String", # Cloud SQL instance ID in the form `project:location:instance`.
          "type": "A String", # Type of the Cloud SQL database.
          "credential": { # Credential info for the Cloud SQL. # Input only. Cloud SQL credential.
            "password": "A String", # The password for the credential.
            "username": "A String", # The username for the credential.
          },
        },
        "hasCredential": True or False, # Output only. True, if credential is configured for this connection.
        "friendlyName": "A String", # User provided display name for the connection.
        "lastModifiedTime": "A String", # Output only. The last update timestamp of the connection.
        "description": "A String", # User provided description.
      }

`delete(name, x__xgafv=None)`

    Deletes connection and associated credential.

    Args:
      name: string, Required. Name of the deleted connection, for example:
    `projects/{project_id}/locations/{location_id}/connections/{connection_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)`

    Returns specified connection.

    Args:
      name: string, Required. Name of the requested connection, for example:
    `projects/{project_id}/locations/{location_id}/connections/{connection_id}` (required)
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # Configuration parameters to establish connection with an external data
          # source, except the credential attributes.
        "creationTime": "A String", # Output only. The creation timestamp of the connection.
        "name": "A String", # The resource name of the connection in the form of:
            # `projects/{project_id}/locations/{location_id}/connections/{connection_id}`
        "cloudSql": { # Connection properties specific to the Cloud SQL. # Cloud SQL properties.
          "database": "A String", # Database name.
          "instanceId": "A String", # Cloud SQL instance ID in the form `project:location:instance`.
          "type": "A String", # Type of the Cloud SQL database.
          "credential": { # Credential info for the Cloud SQL. # Input only. Cloud SQL credential.
            "password": "A String", # The password for the credential.
            "username": "A String", # The username for the credential.
          },
        },
        "hasCredential": True or False, # Output only. True, if credential is configured for this connection.
        "friendlyName": "A String", # User provided display name for the connection.
        "lastModifiedTime": "A String", # Output only. The last update timestamp of the connection.
        "description": "A String", # User provided description.
      }

`getIamPolicy(resource, body=None, 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)
      body: object, The request body.
        The object takes the form of:

    { # Request message for `GetIamPolicy` method.
        "options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to
            # `GetIamPolicy`.
          "requestedPolicyVersion": 42, # Optional. The policy format version to be returned.
              #
              # Valid values are 0, 1, and 3. Requests specifying an invalid value will be
              # rejected.
              #
              # Requests for policies with any conditional bindings must specify version 3.
              # Policies without any conditional bindings may specify any valid value or
              # leave the field unset.
              #
              # To learn which resources support conditions in their IAM policies, see the
              # [IAM
              # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
        },
      }

      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # An Identity and Access Management (IAM) policy, which specifies access
          # controls for Google Cloud resources.
          #
          #
          # A `Policy` is a collection of `bindings`. A `binding` binds one or more
          # `members` to a single `role`. Members can be user accounts, service accounts,
          # Google groups, and domains (such as G Suite). A `role` is a named list of
          # permissions; each `role` can be an IAM predefined role or a user-created
          # custom role.
          #
          # For some types of Google Cloud resources, a `binding` can also specify a
          # `condition`, which is a logical expression that allows access to a resource
          # only if the expression evaluates to `true`. A condition can add constraints
          # based on attributes of the request, the resource, or both. To learn which
          # resources support conditions in their IAM policies, see the
          # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
          #
          # **JSON example:**
          #
          #     {
          #       "bindings": [
          #         {
          #           "role": "roles/resourcemanager.organizationAdmin",
          #           "members": [
          #             "user:mike@example.com",
          #             "group:admins@example.com",
          #             "domain:google.com",
          #             "serviceAccount:my-project-id@appspot.gserviceaccount.com"
          #           ]
          #         },
          #         {
          #           "role": "roles/resourcemanager.organizationViewer",
          #           "members": [
          #             "user:eve@example.com"
          #           ],
          #           "condition": {
          #             "title": "expirable access",
          #             "description": "Does not grant access after Sep 2020",
          #             "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
          #           }
          #         }
          #       ],
          #       "etag": "BwWWja0YfJA=",
          #       "version": 3
          #     }
          #
          # **YAML example:**
          #
          #     bindings:
          #     - members:
          #       - user:mike@example.com
          #       - group:admins@example.com
          #       - domain:google.com
          #       - serviceAccount:my-project-id@appspot.gserviceaccount.com
          #       role: roles/resourcemanager.organizationAdmin
          #     - members:
          #       - user:eve@example.com
          #       role: roles/resourcemanager.organizationViewer
          #       condition:
          #         title: expirable access
          #         description: Does not grant access after Sep 2020
          #         expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
          #     - etag: BwWWja0YfJA=
          #     - version: 3
          #
          # For a description of IAM and its features, see the
          # [IAM documentation](https://cloud.google.com/iam/docs/).
        "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.
            #
            # **Important:** If you use IAM Conditions, you must include the `etag` field
            # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
            # you to overwrite a version `3` policy with a version `1` policy, and all of
            # the conditions in the version `3` policy are lost.
        "version": 42, # Specifies the format of the policy.
            #
            # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
            # are rejected.
            #
            # Any operation that affects conditional role bindings must specify version
            # `3`. This requirement applies to the following operations:
            #
            # * Getting a policy that includes a conditional role binding
            # * Adding a conditional role binding to a policy
            # * Changing a conditional role binding in a policy
            # * Removing any role binding, with or without a condition, from a policy
            #   that includes conditions
            #
            # **Important:** If you use IAM Conditions, you must include the `etag` field
            # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
            # you to overwrite a version `3` policy with a version `1` policy, and all of
            # the conditions in the version `3` policy are lost.
            #
            # If a policy does not include any conditions, operations on that policy may
            # specify any valid version or leave the field unset.
            #
            # To learn which resources support conditions in their IAM policies, see the
            # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
        "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:jose@example.com"
              #               ]
              #             },
              #             {
              #               "log_type": "DATA_WRITE"
              #             },
              #             {
              #               "log_type": "ADMIN_READ"
              #             }
              #           ]
              #         },
              #         {
              #           "service": "sampleservice.googleapis.com",
              #           "audit_log_configs": [
              #             {
              #               "log_type": "DATA_READ"
              #             },
              #             {
              #               "log_type": "DATA_WRITE",
              #               "exempted_members": [
              #                 "user:aliya@example.com"
              #               ]
              #             }
              #           ]
              #         }
              #       ]
              #     }
              #
              # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
              # logging. It also exempts jose@example.com from DATA_READ logging, and
              # aliya@example.com from DATA_WRITE logging.
            "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.
            "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:jose@example.com"
                  #           ]
                  #         },
                  #         {
                  #           "log_type": "DATA_WRITE"
                  #         }
                  #       ]
                  #     }
                  #
                  # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
                  # jose@example.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.
              },
            ],
          },
        ],
        "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
            # `condition` that determines how and when the `bindings` are applied. Each
            # of the `bindings` must contain at least one member.
          { # Associates `members` with a `role`.
            "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
                #
                # If the condition evaluates to `true`, then this binding applies to the
                # current request.
                #
                # If the condition evaluates to `false`, then this binding does not apply to
                # the current request. However, a different role binding might grant the same
                # role to one or more of the members in this binding.
                #
                # To learn which resources support conditions in their IAM policies, see the
                # [IAM
                # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
                # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
                # are documented at https://github.com/google/cel-spec.
                #
                # Example (Comparison):
                #
                #     title: "Summary size limit"
                #     description: "Determines if a summary is less than 100 chars"
                #     expression: "document.summary.size() < 100"
                #
                # Example (Equality):
                #
                #     title: "Requestor is owner"
                #     description: "Determines if requestor is the document owner"
                #     expression: "document.owner == request.auth.claims.email"
                #
                # Example (Logic):
                #
                #     title: "Public documents"
                #     description: "Determine whether the document should be publicly visible"
                #     expression: "document.type != 'private' && document.type != 'internal'"
                #
                # Example (Data Manipulation):
                #
                #     title: "Notification string"
                #     description: "Create a notification string with a timestamp."
                #     expression: "'New message received at ' + string(document.create_time)"
                #
                # The exact variables and functions that may be referenced within an expression
                # are determined by the service that evaluates it. See the service
                # documentation for additional information.
              "title": "A String", # 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.
              "location": "A String", # Optional. String indicating the location of the expression for error
                  # reporting, e.g. a file name and a position in the file.
              "description": "A String", # Optional. Description of the expression. This is a longer text which
                  # describes the expression, e.g. when hovered over it in a UI.
              "expression": "A String", # Textual representation of an expression in Common Expression Language
                  # syntax.
            },
            "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@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`.
                #
                # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
                #    identifier) representing a user that has been recently deleted. For
                #    example, `alice@example.com?uid=123456789012345678901`. If the user is
                #    recovered, this value reverts to `user:{emailid}` and the recovered user
                #    retains the role in the binding.
                #
                # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
                #    unique identifier) representing a service account that has been recently
                #    deleted. For example,
                #    `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
                #    If the service account is undeleted, this value reverts to
                #    `serviceAccount:{emailid}` and the undeleted service account retains the
                #    role in the binding.
                #
                # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
                #    identifier) representing a Google group that has been recently
                #    deleted. For example, `admins@example.com?uid=123456789012345678901`. If
                #    the group is recovered, this value reverts to `group:{emailid}` and the
                #    recovered group retains the role in the binding.
                #
                #
                # * `domain:{domain}`: The G Suite domain (primary) that represents all the
                #    users of that domain. For example, `google.com` or `example.com`.
                #
              "A String",
            ],
            "role": "A String", # Role that is assigned to `members`.
                # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
          },
        ],
      }

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

    Returns a list of connections in the given project.

    Args:
      parent: string, Required. Parent resource name.
    Must be in the form: `projects/{project_id}/locations/{location_id}` (required)
      pageToken: string, Page token.
      maxResults: integer, Required. Maximum number of results per page.
      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 ConnectionService.ListConnections.
        "nextPageToken": "A String", # Next page token.
        "connections": [ # List of connections.
          { # Configuration parameters to establish connection with an external data
              # source, except the credential attributes.
            "creationTime": "A String", # Output only. The creation timestamp of the connection.
            "name": "A String", # The resource name of the connection in the form of:
                # `projects/{project_id}/locations/{location_id}/connections/{connection_id}`
            "cloudSql": { # Connection properties specific to the Cloud SQL. # Cloud SQL properties.
              "database": "A String", # Database name.
              "instanceId": "A String", # Cloud SQL instance ID in the form `project:location:instance`.
              "type": "A String", # Type of the Cloud SQL database.
              "credential": { # Credential info for the Cloud SQL. # Input only. Cloud SQL credential.
                "password": "A String", # The password for the credential.
                "username": "A String", # The username for the credential.
              },
            },
            "hasCredential": True or False, # Output only. True, if credential is configured for this connection.
            "friendlyName": "A String", # User provided display name for the connection.
            "lastModifiedTime": "A String", # Output only. The last update timestamp of the connection.
            "description": "A String", # User provided description.
          },
        ],
      }

`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=None, updateMask=None, x__xgafv=None)`

    Updates the specified connection. For security reasons, also resets
    credential if connection properties are in the update field mask.

    Args:
      name: string, Required. Name of the connection to update, for example:
    `projects/{project_id}/locations/{location_id}/connections/{connection_id}` (required)
      body: object, The request body.
        The object takes the form of:

    { # Configuration parameters to establish connection with an external data
        # source, except the credential attributes.
      "creationTime": "A String", # Output only. The creation timestamp of the connection.
      "name": "A String", # The resource name of the connection in the form of:
          # `projects/{project_id}/locations/{location_id}/connections/{connection_id}`
      "cloudSql": { # Connection properties specific to the Cloud SQL. # Cloud SQL properties.
        "database": "A String", # Database name.
        "instanceId": "A String", # Cloud SQL instance ID in the form `project:location:instance`.
        "type": "A String", # Type of the Cloud SQL database.
        "credential": { # Credential info for the Cloud SQL. # Input only. Cloud SQL credential.
          "password": "A String", # The password for the credential.
          "username": "A String", # The username for the credential.
        },
      },
      "hasCredential": True or False, # Output only. True, if credential is configured for this connection.
      "friendlyName": "A String", # User provided display name for the connection.
      "lastModifiedTime": "A String", # Output only. The last update timestamp of the connection.
      "description": "A String", # User provided description.
    }

      updateMask: string, Required. Update mask for the connection fields to be updated.
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # Configuration parameters to establish connection with an external data
          # source, except the credential attributes.
        "creationTime": "A String", # Output only. The creation timestamp of the connection.
        "name": "A String", # The resource name of the connection in the form of:
            # `projects/{project_id}/locations/{location_id}/connections/{connection_id}`
        "cloudSql": { # Connection properties specific to the Cloud SQL. # Cloud SQL properties.
          "database": "A String", # Database name.
          "instanceId": "A String", # Cloud SQL instance ID in the form `project:location:instance`.
          "type": "A String", # Type of the Cloud SQL database.
          "credential": { # Credential info for the Cloud SQL. # Input only. Cloud SQL credential.
            "password": "A String", # The password for the credential.
            "username": "A String", # The username for the credential.
          },
        },
        "hasCredential": True or False, # Output only. True, if credential is configured for this connection.
        "friendlyName": "A String", # User provided display name for the connection.
        "lastModifiedTime": "A String", # Output only. The last update timestamp of the connection.
        "description": "A String", # User provided description.
      }

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

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

    Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

    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.
        The object takes the form of:

    { # Request message for `SetIamPolicy` method.
        "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"`
        "policy": { # An Identity and Access Management (IAM) policy, which specifies access # 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.
            # controls for Google Cloud resources.
            #
            #
            # A `Policy` is a collection of `bindings`. A `binding` binds one or more
            # `members` to a single `role`. Members can be user accounts, service accounts,
            # Google groups, and domains (such as G Suite). A `role` is a named list of
            # permissions; each `role` can be an IAM predefined role or a user-created
            # custom role.
            #
            # For some types of Google Cloud resources, a `binding` can also specify a
            # `condition`, which is a logical expression that allows access to a resource
            # only if the expression evaluates to `true`. A condition can add constraints
            # based on attributes of the request, the resource, or both. To learn which
            # resources support conditions in their IAM policies, see the
            # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
            #
            # **JSON example:**
            #
            #     {
            #       "bindings": [
            #         {
            #           "role": "roles/resourcemanager.organizationAdmin",
            #           "members": [
            #             "user:mike@example.com",
            #             "group:admins@example.com",
            #             "domain:google.com",
            #             "serviceAccount:my-project-id@appspot.gserviceaccount.com"
            #           ]
            #         },
            #         {
            #           "role": "roles/resourcemanager.organizationViewer",
            #           "members": [
            #             "user:eve@example.com"
            #           ],
            #           "condition": {
            #             "title": "expirable access",
            #             "description": "Does not grant access after Sep 2020",
            #             "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
            #           }
            #         }
            #       ],
            #       "etag": "BwWWja0YfJA=",
            #       "version": 3
            #     }
            #
            # **YAML example:**
            #
            #     bindings:
            #     - members:
            #       - user:mike@example.com
            #       - group:admins@example.com
            #       - domain:google.com
            #       - serviceAccount:my-project-id@appspot.gserviceaccount.com
            #       role: roles/resourcemanager.organizationAdmin
            #     - members:
            #       - user:eve@example.com
            #       role: roles/resourcemanager.organizationViewer
            #       condition:
            #         title: expirable access
            #         description: Does not grant access after Sep 2020
            #         expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
            #     - etag: BwWWja0YfJA=
            #     - version: 3
            #
            # For a description of IAM and its features, see the
            # [IAM documentation](https://cloud.google.com/iam/docs/).
          "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.
              #
              # **Important:** If you use IAM Conditions, you must include the `etag` field
              # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
              # you to overwrite a version `3` policy with a version `1` policy, and all of
              # the conditions in the version `3` policy are lost.
          "version": 42, # Specifies the format of the policy.
              #
              # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
              # are rejected.
              #
              # Any operation that affects conditional role bindings must specify version
              # `3`. This requirement applies to the following operations:
              #
              # * Getting a policy that includes a conditional role binding
              # * Adding a conditional role binding to a policy
              # * Changing a conditional role binding in a policy
              # * Removing any role binding, with or without a condition, from a policy
              #   that includes conditions
              #
              # **Important:** If you use IAM Conditions, you must include the `etag` field
              # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
              # you to overwrite a version `3` policy with a version `1` policy, and all of
              # the conditions in the version `3` policy are lost.
              #
              # If a policy does not include any conditions, operations on that policy may
              # specify any valid version or leave the field unset.
              #
              # To learn which resources support conditions in their IAM policies, see the
              # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
          "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:jose@example.com"
                #               ]
                #             },
                #             {
                #               "log_type": "DATA_WRITE"
                #             },
                #             {
                #               "log_type": "ADMIN_READ"
                #             }
                #           ]
                #         },
                #         {
                #           "service": "sampleservice.googleapis.com",
                #           "audit_log_configs": [
                #             {
                #               "log_type": "DATA_READ"
                #             },
                #             {
                #               "log_type": "DATA_WRITE",
                #               "exempted_members": [
                #                 "user:aliya@example.com"
                #               ]
                #             }
                #           ]
                #         }
                #       ]
                #     }
                #
                # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
                # logging. It also exempts jose@example.com from DATA_READ logging, and
                # aliya@example.com from DATA_WRITE logging.
              "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.
              "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:jose@example.com"
                    #           ]
                    #         },
                    #         {
                    #           "log_type": "DATA_WRITE"
                    #         }
                    #       ]
                    #     }
                    #
                    # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
                    # jose@example.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.
                },
              ],
            },
          ],
          "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
              # `condition` that determines how and when the `bindings` are applied. Each
              # of the `bindings` must contain at least one member.
            { # Associates `members` with a `role`.
              "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
                  #
                  # If the condition evaluates to `true`, then this binding applies to the
                  # current request.
                  #
                  # If the condition evaluates to `false`, then this binding does not apply to
                  # the current request. However, a different role binding might grant the same
                  # role to one or more of the members in this binding.
                  #
                  # To learn which resources support conditions in their IAM policies, see the
                  # [IAM
                  # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
                  # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
                  # are documented at https://github.com/google/cel-spec.
                  #
                  # Example (Comparison):
                  #
                  #     title: "Summary size limit"
                  #     description: "Determines if a summary is less than 100 chars"
                  #     expression: "document.summary.size() < 100"
                  #
                  # Example (Equality):
                  #
                  #     title: "Requestor is owner"
                  #     description: "Determines if requestor is the document owner"
                  #     expression: "document.owner == request.auth.claims.email"
                  #
                  # Example (Logic):
                  #
                  #     title: "Public documents"
                  #     description: "Determine whether the document should be publicly visible"
                  #     expression: "document.type != 'private' && document.type != 'internal'"
                  #
                  # Example (Data Manipulation):
                  #
                  #     title: "Notification string"
                  #     description: "Create a notification string with a timestamp."
                  #     expression: "'New message received at ' + string(document.create_time)"
                  #
                  # The exact variables and functions that may be referenced within an expression
                  # are determined by the service that evaluates it. See the service
                  # documentation for additional information.
                "title": "A String", # 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.
                "location": "A String", # Optional. String indicating the location of the expression for error
                    # reporting, e.g. a file name and a position in the file.
                "description": "A String", # Optional. Description of the expression. This is a longer text which
                    # describes the expression, e.g. when hovered over it in a UI.
                "expression": "A String", # Textual representation of an expression in Common Expression Language
                    # syntax.
              },
              "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@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`.
                  #
                  # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
                  #    identifier) representing a user that has been recently deleted. For
                  #    example, `alice@example.com?uid=123456789012345678901`. If the user is
                  #    recovered, this value reverts to `user:{emailid}` and the recovered user
                  #    retains the role in the binding.
                  #
                  # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
                  #    unique identifier) representing a service account that has been recently
                  #    deleted. For example,
                  #    `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
                  #    If the service account is undeleted, this value reverts to
                  #    `serviceAccount:{emailid}` and the undeleted service account retains the
                  #    role in the binding.
                  #
                  # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
                  #    identifier) representing a Google group that has been recently
                  #    deleted. For example, `admins@example.com?uid=123456789012345678901`. If
                  #    the group is recovered, this value reverts to `group:{emailid}` and the
                  #    recovered group retains the role in the binding.
                  #
                  #
                  # * `domain:{domain}`: The G Suite domain (primary) that represents all the
                  #    users of that domain. For example, `google.com` or `example.com`.
                  #
                "A String",
              ],
              "role": "A String", # Role that is assigned to `members`.
                  # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
            },
          ],
        },
      }

      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # An Identity and Access Management (IAM) policy, which specifies access
          # controls for Google Cloud resources.
          #
          #
          # A `Policy` is a collection of `bindings`. A `binding` binds one or more
          # `members` to a single `role`. Members can be user accounts, service accounts,
          # Google groups, and domains (such as G Suite). A `role` is a named list of
          # permissions; each `role` can be an IAM predefined role or a user-created
          # custom role.
          #
          # For some types of Google Cloud resources, a `binding` can also specify a
          # `condition`, which is a logical expression that allows access to a resource
          # only if the expression evaluates to `true`. A condition can add constraints
          # based on attributes of the request, the resource, or both. To learn which
          # resources support conditions in their IAM policies, see the
          # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
          #
          # **JSON example:**
          #
          #     {
          #       "bindings": [
          #         {
          #           "role": "roles/resourcemanager.organizationAdmin",
          #           "members": [
          #             "user:mike@example.com",
          #             "group:admins@example.com",
          #             "domain:google.com",
          #             "serviceAccount:my-project-id@appspot.gserviceaccount.com"
          #           ]
          #         },
          #         {
          #           "role": "roles/resourcemanager.organizationViewer",
          #           "members": [
          #             "user:eve@example.com"
          #           ],
          #           "condition": {
          #             "title": "expirable access",
          #             "description": "Does not grant access after Sep 2020",
          #             "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
          #           }
          #         }
          #       ],
          #       "etag": "BwWWja0YfJA=",
          #       "version": 3
          #     }
          #
          # **YAML example:**
          #
          #     bindings:
          #     - members:
          #       - user:mike@example.com
          #       - group:admins@example.com
          #       - domain:google.com
          #       - serviceAccount:my-project-id@appspot.gserviceaccount.com
          #       role: roles/resourcemanager.organizationAdmin
          #     - members:
          #       - user:eve@example.com
          #       role: roles/resourcemanager.organizationViewer
          #       condition:
          #         title: expirable access
          #         description: Does not grant access after Sep 2020
          #         expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
          #     - etag: BwWWja0YfJA=
          #     - version: 3
          #
          # For a description of IAM and its features, see the
          # [IAM documentation](https://cloud.google.com/iam/docs/).
        "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.
            #
            # **Important:** If you use IAM Conditions, you must include the `etag` field
            # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
            # you to overwrite a version `3` policy with a version `1` policy, and all of
            # the conditions in the version `3` policy are lost.
        "version": 42, # Specifies the format of the policy.
            #
            # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
            # are rejected.
            #
            # Any operation that affects conditional role bindings must specify version
            # `3`. This requirement applies to the following operations:
            #
            # * Getting a policy that includes a conditional role binding
            # * Adding a conditional role binding to a policy
            # * Changing a conditional role binding in a policy
            # * Removing any role binding, with or without a condition, from a policy
            #   that includes conditions
            #
            # **Important:** If you use IAM Conditions, you must include the `etag` field
            # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
            # you to overwrite a version `3` policy with a version `1` policy, and all of
            # the conditions in the version `3` policy are lost.
            #
            # If a policy does not include any conditions, operations on that policy may
            # specify any valid version or leave the field unset.
            #
            # To learn which resources support conditions in their IAM policies, see the
            # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
        "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:jose@example.com"
              #               ]
              #             },
              #             {
              #               "log_type": "DATA_WRITE"
              #             },
              #             {
              #               "log_type": "ADMIN_READ"
              #             }
              #           ]
              #         },
              #         {
              #           "service": "sampleservice.googleapis.com",
              #           "audit_log_configs": [
              #             {
              #               "log_type": "DATA_READ"
              #             },
              #             {
              #               "log_type": "DATA_WRITE",
              #               "exempted_members": [
              #                 "user:aliya@example.com"
              #               ]
              #             }
              #           ]
              #         }
              #       ]
              #     }
              #
              # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
              # logging. It also exempts jose@example.com from DATA_READ logging, and
              # aliya@example.com from DATA_WRITE logging.
            "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.
            "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:jose@example.com"
                  #           ]
                  #         },
                  #         {
                  #           "log_type": "DATA_WRITE"
                  #         }
                  #       ]
                  #     }
                  #
                  # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
                  # jose@example.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.
              },
            ],
          },
        ],
        "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
            # `condition` that determines how and when the `bindings` are applied. Each
            # of the `bindings` must contain at least one member.
          { # Associates `members` with a `role`.
            "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
                #
                # If the condition evaluates to `true`, then this binding applies to the
                # current request.
                #
                # If the condition evaluates to `false`, then this binding does not apply to
                # the current request. However, a different role binding might grant the same
                # role to one or more of the members in this binding.
                #
                # To learn which resources support conditions in their IAM policies, see the
                # [IAM
                # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
                # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
                # are documented at https://github.com/google/cel-spec.
                #
                # Example (Comparison):
                #
                #     title: "Summary size limit"
                #     description: "Determines if a summary is less than 100 chars"
                #     expression: "document.summary.size() < 100"
                #
                # Example (Equality):
                #
                #     title: "Requestor is owner"
                #     description: "Determines if requestor is the document owner"
                #     expression: "document.owner == request.auth.claims.email"
                #
                # Example (Logic):
                #
                #     title: "Public documents"
                #     description: "Determine whether the document should be publicly visible"
                #     expression: "document.type != 'private' && document.type != 'internal'"
                #
                # Example (Data Manipulation):
                #
                #     title: "Notification string"
                #     description: "Create a notification string with a timestamp."
                #     expression: "'New message received at ' + string(document.create_time)"
                #
                # The exact variables and functions that may be referenced within an expression
                # are determined by the service that evaluates it. See the service
                # documentation for additional information.
              "title": "A String", # 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.
              "location": "A String", # Optional. String indicating the location of the expression for error
                  # reporting, e.g. a file name and a position in the file.
              "description": "A String", # Optional. Description of the expression. This is a longer text which
                  # describes the expression, e.g. when hovered over it in a UI.
              "expression": "A String", # Textual representation of an expression in Common Expression Language
                  # syntax.
            },
            "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@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`.
                #
                # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
                #    identifier) representing a user that has been recently deleted. For
                #    example, `alice@example.com?uid=123456789012345678901`. If the user is
                #    recovered, this value reverts to `user:{emailid}` and the recovered user
                #    retains the role in the binding.
                #
                # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
                #    unique identifier) representing a service account that has been recently
                #    deleted. For example,
                #    `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
                #    If the service account is undeleted, this value reverts to
                #    `serviceAccount:{emailid}` and the undeleted service account retains the
                #    role in the binding.
                #
                # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
                #    identifier) representing a Google group that has been recently
                #    deleted. For example, `admins@example.com?uid=123456789012345678901`. If
                #    the group is recovered, this value reverts to `group:{emailid}` and the
                #    recovered group retains the role in the binding.
                #
                #
                # * `domain:{domain}`: The G Suite domain (primary) that represents all the
                #    users of that domain. For example, `google.com` or `example.com`.
                #
              "A String",
            ],
            "role": "A String", # Role that is assigned to `members`.
                # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
          },
        ],
      }

`testIamPermissions(resource, body=None, 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.
        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",
        ],
      }

`updateCredential(name, body=None, x__xgafv=None)`

    Sets the credential for the specified connection.

    Args:
      name: string, Required. Name of the connection, for example:
    `projects/{project_id}/locations/{location_id}/connections/{connection_id}/credential` (required)
      body: object, The request body.
        The object takes the form of:

    { # Credential to use with a connection.
        "cloudSql": { # Credential info for the Cloud SQL. # Credential for Cloud SQL database.
          "password": "A String", # The password for the credential.
          "username": "A String", # The username for the credential.
        },
      }

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