# Cloud Bigtable Admin API . projects . instances

## Instance Methods

Returns the appProfiles Resource.

Returns the clusters Resource.

Returns the tables Resource.

Create an instance within a project.

Delete an instance from a project.

Gets information about an instance.

Gets the access control policy for an instance resource. Returns an empty

Lists information about instances in a project.

Retrieves the next page of results.

Partially updates an instance within a project. This method can modify all

Sets the access control policy on an instance resource. Replaces any

Returns permissions that the caller has on the specified instance resource.

Updates an instance within a project. This method updates only the display

### Method Details

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

    Create an instance within a project.

    Args:
      parent: string, The unique name of the project in which to create the new instance.
    Values are of the form `projects/`. (required)
      body: object, The request body. (required)
        The object takes the form of:

    { # Request message for BigtableInstanceAdmin.CreateInstance.
        "instanceId": "A String", # The ID to be used when referring to the new instance within its project,
            # e.g., just `myinstance` rather than
            # `projects/myproject/instances/myinstance`.
        "clusters": { # The clusters to be created within the instance, mapped by desired
            # cluster ID, e.g., just `mycluster` rather than
            # `projects/myproject/instances/myinstance/clusters/mycluster`.
            # Fields marked `OutputOnly` must be left blank.
            # Currently, at most two clusters can be specified.
          "a_key": { # A resizable group of nodes in a particular cloud location, capable
              # of serving all Tables in the parent
              # Instance.
            "defaultStorageType": "A String", # (`CreationOnly`)
                # The type of storage used by this cluster to serve its
                # parent instance's tables, unless explicitly overridden.
            "serveNodes": 42, # The number of nodes allocated to this cluster. More nodes enable higher
                # throughput and more consistent performance.
            "state": "A String", # (`OutputOnly`)
                # The current state of the cluster.
            "location": "A String", # (`CreationOnly`)
                # The location where this cluster's nodes and storage reside. For best
                # performance, clients should be located as close as possible to this
                # cluster. Currently only zones are supported, so values should be of the
                # form `projects//locations/`.
            "name": "A String", # (`OutputOnly`)
                # The unique name of the cluster. Values are of the form
                # `projects//instances//clusters/a-z*`.
          },
        },
        "parent": "A String", # The unique name of the project in which to create the new instance.
            # Values are of the form `projects/`.
        "instance": { # A collection of Bigtable Tables and # The instance to create.
            # Fields marked `OutputOnly` must be left blank.
            # the resources that serve them.
            # All tables in an instance are served from all
            # Clusters in the instance.
          "type": "A String", # The type of the instance. Defaults to `PRODUCTION`.
          "state": "A String", # (`OutputOnly`)
              # The current state of the instance.
          "labels": { # Labels are a flexible and lightweight mechanism for organizing cloud
              # resources into groups that reflect a customer's organizational needs and
              # deployment strategies. They can be used to filter resources and aggregate
              # metrics.
              #
              # * Label keys must be between 1 and 63 characters long and must conform to
              #   the regular expression: `\p{Ll}\p{Lo}{0,62}`.
              # * Label values must be between 0 and 63 characters long and must conform to
              #   the regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`.
              # * No more than 64 labels can be associated with a given resource.
              # * Keys and values must both be under 128 bytes.
            "a_key": "A String",
          },
          "displayName": "A String", # The descriptive name for this instance as it appears in UIs.
              # Can be changed at any time, but should be kept globally unique
              # to avoid confusion.
          "name": "A String", # (`OutputOnly`)
              # The unique name of the instance. Values are of the form
              # `projects//instances/a-z+[a-z0-9]`.
        },
      }

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

    Returns:
      An object of the form:

        { # This resource represents a long-running operation that is the result of a
          # network API call.
        "metadata": { # Service-specific metadata associated with the operation.  It typically
            # contains progress information and common metadata such as create time.
            # Some services might not provide such metadata.  Any method that returns a
            # long-running operation should document the metadata type, if any.
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
        "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). The error model is designed to be:
            #
            # - Simple to use and understand for most users
            # - Flexible enough to meet unexpected needs
            #
            # # Overview
            #
            # The `Status` message contains three pieces of data: error code, error
            # message, and error details. The error code should be an enum value of
            # google.rpc.Code, but it may accept additional error codes if needed.  The
            # error message should be a developer-facing English message that helps
            # developers *understand* and *resolve* the error. If a localized user-facing
            # error message is needed, put the localized message in the error details or
            # localize it in the client. The optional error details may contain arbitrary
            # information about the error. There is a predefined set of error detail types
            # in the package `google.rpc` that can be used for common error conditions.
            #
            # # Language mapping
            #
            # The `Status` message is the logical representation of the error model, but it
            # is not necessarily the actual wire format. When the `Status` message is
            # exposed in different client libraries and different wire protocols, it can be
            # mapped differently. For example, it will likely be mapped to some exceptions
            # in Java, but more likely mapped to some error codes in C.
            #
            # # Other uses
            #
            # The error model and the `Status` message can be used in a variety of
            # environments, either with or without APIs, to provide a
            # consistent developer experience across different environments.
            #
            # Example uses of this error model include:
            #
            # - Partial errors. If a service needs to return partial errors to the client,
            #     it may embed the `Status` in the normal response to indicate the partial
            #     errors.
            #
            # - Workflow errors. A typical workflow has multiple steps. Each step may
            #     have a `Status` message for error reporting.
            #
            # - Batch operations. If a client uses batch request and batch response, the
            #     `Status` message should be used directly inside batch response, one for
            #     each error sub-response.
            #
            # - Asynchronous operations. If an API call embeds asynchronous operation
            #     results in its response, the status of those operations should be
            #     represented directly using the `Status` message.
            #
            # - Logging. If some API errors are stored in logs, the message `Status` could
            #     be used directly after any stripping needed for security/privacy reasons.
          "message": "A String", # A developer-facing error message, which should be in English. Any
              # user-facing error message should be localized and sent in the
              # google.rpc.Status.details field, or localized by the client.
          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
          "details": [ # A list of messages that carry the error details.  There 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 have the format of `operations/some/unique/name`.
      }

`delete(name, x__xgafv=None)`

    Delete an instance from a project.

    Args:
      name: string, The unique name of the instance to be deleted.
    Values are of the form `projects//instances/`. (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 information about an instance.

    Args:
      name: string, The unique name of the requested instance. Values are of the form
    `projects//instances/`. (required)
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # A collection of Bigtable Tables and
          # the resources that serve them.
          # All tables in an instance are served from all
          # Clusters in the instance.
        "type": "A String", # The type of the instance. Defaults to `PRODUCTION`.
        "state": "A String", # (`OutputOnly`)
            # The current state of the instance.
        "labels": { # Labels are a flexible and lightweight mechanism for organizing cloud
            # resources into groups that reflect a customer's organizational needs and
            # deployment strategies. They can be used to filter resources and aggregate
            # metrics.
            #
            # * Label keys must be between 1 and 63 characters long and must conform to
            #   the regular expression: `\p{Ll}\p{Lo}{0,62}`.
            # * Label values must be between 0 and 63 characters long and must conform to
            #   the regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`.
            # * No more than 64 labels can be associated with a given resource.
            # * Keys and values must both be under 128 bytes.
          "a_key": "A String",
        },
        "displayName": "A String", # The descriptive name for this instance as it appears in UIs.
            # Can be changed at any time, but should be kept globally unique
            # to avoid confusion.
        "name": "A String", # (`OutputOnly`)
            # The unique name of the instance. Values are of the form
            # `projects//instances/a-z+[a-z0-9]`.
      }

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

    Gets the access control policy for an instance resource. Returns an empty
    policy if an instance exists but 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.
      }

      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).
        "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`.
            "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"
              "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.
              "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.
              "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.
              "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.
            },
            "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",
            ],
          },
        ],
        "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.
        "version": 42, # Deprecated.
      }

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

    Lists information about instances in a project.

    Args:
      parent: string, The unique name of the project for which a list of instances is requested.
    Values are of the form `projects/`. (required)
      pageToken: string, DEPRECATED: This field is unused and ignored.
      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 BigtableInstanceAdmin.ListInstances.
        "nextPageToken": "A String", # DEPRECATED: This field is unused and ignored.
        "instances": [ # The list of requested instances.
          { # A collection of Bigtable Tables and
              # the resources that serve them.
              # All tables in an instance are served from all
              # Clusters in the instance.
            "type": "A String", # The type of the instance. Defaults to `PRODUCTION`.
            "state": "A String", # (`OutputOnly`)
                # The current state of the instance.
            "labels": { # Labels are a flexible and lightweight mechanism for organizing cloud
                # resources into groups that reflect a customer's organizational needs and
                # deployment strategies. They can be used to filter resources and aggregate
                # metrics.
                #
                # * Label keys must be between 1 and 63 characters long and must conform to
                #   the regular expression: `\p{Ll}\p{Lo}{0,62}`.
                # * Label values must be between 0 and 63 characters long and must conform to
                #   the regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`.
                # * No more than 64 labels can be associated with a given resource.
                # * Keys and values must both be under 128 bytes.
              "a_key": "A String",
            },
            "displayName": "A String", # The descriptive name for this instance as it appears in UIs.
                # Can be changed at any time, but should be kept globally unique
                # to avoid confusion.
            "name": "A String", # (`OutputOnly`)
                # The unique name of the instance. Values are of the form
                # `projects//instances/a-z+[a-z0-9]`.
          },
        ],
        "failedLocations": [ # Locations from which Instance information could not be retrieved,
            # due to an outage or some other transient condition.
            # Instances whose Clusters are all in one of the failed locations
            # may be missing from `instances`, and Instances with at least one
            # Cluster in a failed location may only have partial information returned.
            # Values are of the form `projects//locations/`
          "A String",
        ],
      }

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

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

    Partially updates an instance within a project. This method can modify all
    fields of an Instance and is the preferred way to update an Instance.

    Args:
      name: string, (`OutputOnly`)
    The unique name of the instance. Values are of the form
    `projects//instances/a-z+[a-z0-9]`. (required)
      body: object, The request body. (required)
        The object takes the form of:

    { # A collection of Bigtable Tables and
        # the resources that serve them.
        # All tables in an instance are served from all
        # Clusters in the instance.
      "type": "A String", # The type of the instance. Defaults to `PRODUCTION`.
      "state": "A String", # (`OutputOnly`)
          # The current state of the instance.
      "labels": { # Labels are a flexible and lightweight mechanism for organizing cloud
          # resources into groups that reflect a customer's organizational needs and
          # deployment strategies. They can be used to filter resources and aggregate
          # metrics.
          #
          # * Label keys must be between 1 and 63 characters long and must conform to
          #   the regular expression: `\p{Ll}\p{Lo}{0,62}`.
          # * Label values must be between 0 and 63 characters long and must conform to
          #   the regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`.
          # * No more than 64 labels can be associated with a given resource.
          # * Keys and values must both be under 128 bytes.
        "a_key": "A String",
      },
      "displayName": "A String", # The descriptive name for this instance as it appears in UIs.
          # Can be changed at any time, but should be kept globally unique
          # to avoid confusion.
      "name": "A String", # (`OutputOnly`)
          # The unique name of the instance. Values are of the form
          # `projects//instances/a-z+[a-z0-9]`.
    }

      updateMask: string, The subset of Instance fields which should be replaced.
    Must be explicitly set.
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # This resource represents a long-running operation that is the result of a
          # network API call.
        "metadata": { # Service-specific metadata associated with the operation.  It typically
            # contains progress information and common metadata such as create time.
            # Some services might not provide such metadata.  Any method that returns a
            # long-running operation should document the metadata type, if any.
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
        "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). The error model is designed to be:
            #
            # - Simple to use and understand for most users
            # - Flexible enough to meet unexpected needs
            #
            # # Overview
            #
            # The `Status` message contains three pieces of data: error code, error
            # message, and error details. The error code should be an enum value of
            # google.rpc.Code, but it may accept additional error codes if needed.  The
            # error message should be a developer-facing English message that helps
            # developers *understand* and *resolve* the error. If a localized user-facing
            # error message is needed, put the localized message in the error details or
            # localize it in the client. The optional error details may contain arbitrary
            # information about the error. There is a predefined set of error detail types
            # in the package `google.rpc` that can be used for common error conditions.
            #
            # # Language mapping
            #
            # The `Status` message is the logical representation of the error model, but it
            # is not necessarily the actual wire format. When the `Status` message is
            # exposed in different client libraries and different wire protocols, it can be
            # mapped differently. For example, it will likely be mapped to some exceptions
            # in Java, but more likely mapped to some error codes in C.
            #
            # # Other uses
            #
            # The error model and the `Status` message can be used in a variety of
            # environments, either with or without APIs, to provide a
            # consistent developer experience across different environments.
            #
            # Example uses of this error model include:
            #
            # - Partial errors. If a service needs to return partial errors to the client,
            #     it may embed the `Status` in the normal response to indicate the partial
            #     errors.
            #
            # - Workflow errors. A typical workflow has multiple steps. Each step may
            #     have a `Status` message for error reporting.
            #
            # - Batch operations. If a client uses batch request and batch response, the
            #     `Status` message should be used directly inside batch response, one for
            #     each error sub-response.
            #
            # - Asynchronous operations. If an API call embeds asynchronous operation
            #     results in its response, the status of those operations should be
            #     represented directly using the `Status` message.
            #
            # - Logging. If some API errors are stored in logs, the message `Status` could
            #     be used directly after any stripping needed for security/privacy reasons.
          "message": "A String", # A developer-facing error message, which should be in English. Any
              # user-facing error message should be localized and sent in the
              # google.rpc.Status.details field, or localized by the client.
          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
          "details": [ # A list of messages that carry the error details.  There 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 have the format of `operations/some/unique/name`.
      }

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

    Sets the access control policy on an instance 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).
          "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`.
              "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"
                "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.
                "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.
                "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.
                "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.
              },
              "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",
              ],
            },
          ],
          "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.
          "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).
        "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`.
            "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"
              "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.
              "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.
              "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.
              "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.
            },
            "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",
            ],
          },
        ],
        "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.
        "version": 42, # Deprecated.
      }

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

    Returns permissions that the caller has on the specified instance resource.

    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",
        ],
      }

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

    Updates an instance within a project. This method updates only the display
    name and type for an Instance. To update other Instance properties, such as
    labels, use PartialUpdateInstance.

    Args:
      name: string, (`OutputOnly`)
    The unique name of the instance. Values are of the form
    `projects//instances/a-z+[a-z0-9]`. (required)
      body: object, The request body. (required)
        The object takes the form of:

    { # A collection of Bigtable Tables and
        # the resources that serve them.
        # All tables in an instance are served from all
        # Clusters in the instance.
      "type": "A String", # The type of the instance. Defaults to `PRODUCTION`.
      "state": "A String", # (`OutputOnly`)
          # The current state of the instance.
      "labels": { # Labels are a flexible and lightweight mechanism for organizing cloud
          # resources into groups that reflect a customer's organizational needs and
          # deployment strategies. They can be used to filter resources and aggregate
          # metrics.
          #
          # * Label keys must be between 1 and 63 characters long and must conform to
          #   the regular expression: `\p{Ll}\p{Lo}{0,62}`.
          # * Label values must be between 0 and 63 characters long and must conform to
          #   the regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`.
          # * No more than 64 labels can be associated with a given resource.
          # * Keys and values must both be under 128 bytes.
        "a_key": "A String",
      },
      "displayName": "A String", # The descriptive name for this instance as it appears in UIs.
          # Can be changed at any time, but should be kept globally unique
          # to avoid confusion.
      "name": "A String", # (`OutputOnly`)
          # The unique name of the instance. Values are of the form
          # `projects//instances/a-z+[a-z0-9]`.
    }

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

    Returns:
      An object of the form:

        { # A collection of Bigtable Tables and
          # the resources that serve them.
          # All tables in an instance are served from all
          # Clusters in the instance.
        "type": "A String", # The type of the instance. Defaults to `PRODUCTION`.
        "state": "A String", # (`OutputOnly`)
            # The current state of the instance.
        "labels": { # Labels are a flexible and lightweight mechanism for organizing cloud
            # resources into groups that reflect a customer's organizational needs and
            # deployment strategies. They can be used to filter resources and aggregate
            # metrics.
            #
            # * Label keys must be between 1 and 63 characters long and must conform to
            #   the regular expression: `\p{Ll}\p{Lo}{0,62}`.
            # * Label values must be between 0 and 63 characters long and must conform to
            #   the regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`.
            # * No more than 64 labels can be associated with a given resource.
            # * Keys and values must both be under 128 bytes.
          "a_key": "A String",
        },
        "displayName": "A String", # The descriptive name for this instance as it appears in UIs.
            # Can be changed at any time, but should be kept globally unique
            # to avoid confusion.
        "name": "A String", # (`OutputOnly`)
            # The unique name of the instance. Values are of the form
            # `projects//instances/a-z+[a-z0-9]`.
      }