Returns the appProfiles Resource.
Returns the clusters Resource.
Returns the tables Resource.
create(parent, body=None, x__xgafv=None)
Create an instance within a project.
Delete an instance from a project.
Gets information about an instance.
getIamPolicy(resource, body=None, x__xgafv=None)
Gets the access control policy for an instance resource. Returns an empty
list(parent, pageToken=None, x__xgafv=None)
Lists information about instances in a project.
list_next(previous_request, previous_response)
Retrieves the next page of results.
partialUpdateInstance(name, body=None, updateMask=None, x__xgafv=None)
Partially updates an instance within a project. This method can modify all
setIamPolicy(resource, body=None, x__xgafv=None)
Sets the access control policy on an instance resource. Replaces any
testIamPermissions(resource, body=None, x__xgafv=None)
Returns permissions that the caller has on the specified instance resource.
update(name, body=None, x__xgafv=None)
Updates an instance within a project. This method updates only the display
create(parent, body=None, x__xgafv=None)
Create an instance within a project. Args: parent: string, Required. The unique name of the project in which to create the new instance. Values are of the form `projects/{project}`. (required) body: object, The request body. The object takes the form of: { # Request message for BigtableInstanceAdmin.CreateInstance. "instanceId": "A String", # Required. 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": { # Required. 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 four 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, # Required. 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/{project}/locations/{zone}`. "name": "A String", # Required. (`OutputOnly`) # The unique name of the cluster. Values are of the form # `projects/{project}/instances/{instance}/clusters/a-z*`. }, }, "parent": "A String", # Required. The unique name of the project in which to create the new instance. # Values are of the form `projects/{project}`. "instance": { # A collection of Bigtable Tables and # Required. 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. "displayName": "A String", # Required. 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. "state": "A String", # (`OutputOnly`) # The current state of the instance. "labels": { # Required. 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", }, "type": "A String", # Required. The type of the instance. Defaults to `PRODUCTION`. "name": "A String", # Required. (`OutputOnly`) # The unique name of the instance. Values are of the form # `projects/{project}/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. "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. }, "metadata": { # Service-specific metadata associated with the operation. It typically # contains progress information and common metadata such as create time. # Some services might not provide such metadata. Any method that returns a # long-running operation should document the metadata type, if any. "a_key": "", # Properties of the object. Contains field @type with type URL. }, "done": True or False, # If the value is `false`, it means the operation is still in progress. # If `true`, the operation is completed, and either `error` or `response` is # available. "name": "A String", # The server-assigned name, which is only unique within the same service that # originally returns it. If you use the default HTTP mapping, the # `name` should be a resource name ending with `operations/{unique_id}`. "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation. # different programming environments, including REST APIs and RPC APIs. It is # used by [gRPC](https://github.com/grpc). Each `Status` message contains # three pieces of data: error code, error message, and error details. # # You can find out more about this error model and how to work with it in the # [API Design Guide](https://cloud.google.com/apis/design/errors). "message": "A String", # A developer-facing error message, which should be in English. Any # user-facing error message should be localized and sent in the # google.rpc.Status.details field, or localized by the client. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of # message types for APIs to use. { "a_key": "", # Properties of the object. Contains field @type with type URL. }, ], }, }
delete(name, x__xgafv=None)
Delete an instance from a project. Args: name: string, Required. The unique name of the instance to be deleted. Values are of the form `projects/{project}/instances/{instance}`. (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, Required. The unique name of the requested instance. Values are of the form `projects/{project}/instances/{instance}`. (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. "displayName": "A String", # Required. 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. "state": "A String", # (`OutputOnly`) # The current state of the instance. "labels": { # Required. 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", }, "type": "A String", # Required. The type of the instance. Defaults to `PRODUCTION`. "name": "A String", # Required. (`OutputOnly`) # The unique name of the instance. Values are of the form # `projects/{project}/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. "options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to # `GetIamPolicy`. This field is only used by Cloud IAM. "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. }, } 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. # # Optionally, a `binding` can 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. # # **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/). "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. "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. }, ], "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. }, ], "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. "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`. "role": "A String", # Role that is assigned to `members`. # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. "members": [ # Specifies the identities requesting access for a Cloud Platform resource. # `members` can have the following values: # # * `allUsers`: A special identifier that represents anyone who is # on the internet; with or without a Google account. # # * `allAuthenticatedUsers`: A special identifier that represents anyone # who is authenticated with a Google account or a service account. # # * `user:{emailid}`: An email address that represents a specific Google # account. For example, `alice@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", ], "condition": { # Represents a textual expression in the Common Expression Language (CEL) # 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. # 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. "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. "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. "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. }, }, ], "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. }
list(parent, pageToken=None, x__xgafv=None)
Lists information about instances in a project. Args: parent: string, Required. The unique name of the project for which a list of instances is requested. Values are of the form `projects/{project}`. (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. "displayName": "A String", # Required. 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. "state": "A String", # (`OutputOnly`) # The current state of the instance. "labels": { # Required. 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", }, "type": "A String", # Required. The type of the instance. Defaults to `PRODUCTION`. "name": "A String", # Required. (`OutputOnly`) # The unique name of the instance. Values are of the form # `projects/{project}/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/<project>/locations/<zone_id>` "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=None, 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, Required. (`OutputOnly`) The unique name of the instance. Values are of the form `projects/{project}/instances/a-z+[a-z0-9]`. (required) body: object, The request body. 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. "displayName": "A String", # Required. 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. "state": "A String", # (`OutputOnly`) # The current state of the instance. "labels": { # Required. 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", }, "type": "A String", # Required. The type of the instance. Defaults to `PRODUCTION`. "name": "A String", # Required. (`OutputOnly`) # The unique name of the instance. Values are of the form # `projects/{project}/instances/a-z+[a-z0-9]`. } updateMask: string, Required. 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. "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. }, "metadata": { # Service-specific metadata associated with the operation. It typically # contains progress information and common metadata such as create time. # Some services might not provide such metadata. Any method that returns a # long-running operation should document the metadata type, if any. "a_key": "", # Properties of the object. Contains field @type with type URL. }, "done": True or False, # If the value is `false`, it means the operation is still in progress. # If `true`, the operation is completed, and either `error` or `response` is # available. "name": "A String", # The server-assigned name, which is only unique within the same service that # originally returns it. If you use the default HTTP mapping, the # `name` should be a resource name ending with `operations/{unique_id}`. "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation. # different programming environments, including REST APIs and RPC APIs. It is # used by [gRPC](https://github.com/grpc). Each `Status` message contains # three pieces of data: error code, error message, and error details. # # You can find out more about this error model and how to work with it in the # [API Design Guide](https://cloud.google.com/apis/design/errors). "message": "A String", # A developer-facing error message, which should be in English. Any # user-facing error message should be localized and sent in the # google.rpc.Status.details field, or localized by the client. "code": 42, # The status code, which should be an enum value of google.rpc.Code. "details": [ # A list of messages that carry the error details. There is a common set of # message types for APIs to use. { "a_key": "", # Properties of the object. Contains field @type with type URL. }, ], }, }
setIamPolicy(resource, body=None, 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. The object takes the form of: { # Request message for `SetIamPolicy` method. "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. # # Optionally, a `binding` can 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. # # **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/). "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. "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. }, ], "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. }, ], "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. "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`. "role": "A String", # Role that is assigned to `members`. # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. "members": [ # Specifies the identities requesting access for a Cloud Platform resource. # `members` can have the following values: # # * `allUsers`: A special identifier that represents anyone who is # on the internet; with or without a Google account. # # * `allAuthenticatedUsers`: A special identifier that represents anyone # who is authenticated with a Google account or a service account. # # * `user:{emailid}`: An email address that represents a specific Google # account. For example, `alice@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", ], "condition": { # Represents a textual expression in the Common Expression Language (CEL) # 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. # 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. "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. "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. "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. }, }, ], "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. }, "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: { # 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. # # Optionally, a `binding` can 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. # # **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/). "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. "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. }, ], "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. }, ], "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. "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`. "role": "A String", # Role that is assigned to `members`. # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. "members": [ # Specifies the identities requesting access for a Cloud Platform resource. # `members` can have the following values: # # * `allUsers`: A special identifier that represents anyone who is # on the internet; with or without a Google account. # # * `allAuthenticatedUsers`: A special identifier that represents anyone # who is authenticated with a Google account or a service account. # # * `user:{emailid}`: An email address that represents a specific Google # account. For example, `alice@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", ], "condition": { # Represents a textual expression in the Common Expression Language (CEL) # 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. # 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. "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. "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. "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. }, }, ], "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. }
testIamPermissions(resource, body=None, 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. 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=None, 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, Required. (`OutputOnly`) The unique name of the instance. Values are of the form `projects/{project}/instances/a-z+[a-z0-9]`. (required) body: object, The request body. 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. "displayName": "A String", # Required. 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. "state": "A String", # (`OutputOnly`) # The current state of the instance. "labels": { # Required. 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", }, "type": "A String", # Required. The type of the instance. Defaults to `PRODUCTION`. "name": "A String", # Required. (`OutputOnly`) # The unique name of the instance. Values are of the form # `projects/{project}/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. "displayName": "A String", # Required. 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. "state": "A String", # (`OutputOnly`) # The current state of the instance. "labels": { # Required. 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", }, "type": "A String", # Required. The type of the instance. Defaults to `PRODUCTION`. "name": "A String", # Required. (`OutputOnly`) # The unique name of the instance. Values are of the form # `projects/{project}/instances/a-z+[a-z0-9]`. }