Regen docs (#364)
diff --git a/docs/dyn/cloudkms_v1beta1.projects.locations.keyRings.html b/docs/dyn/cloudkms_v1beta1.projects.locations.keyRings.html
new file mode 100644
index 0000000..3059083
--- /dev/null
+++ b/docs/dyn/cloudkms_v1beta1.projects.locations.keyRings.html
@@ -0,0 +1,1019 @@
+<html><body>
+<style>
+
+body, h1, h2, h3, div, span, p, pre, a {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-weight: inherit;
+ font-style: inherit;
+ font-size: 100%;
+ font-family: inherit;
+ vertical-align: baseline;
+}
+
+body {
+ font-size: 13px;
+ padding: 1em;
+}
+
+h1 {
+ font-size: 26px;
+ margin-bottom: 1em;
+}
+
+h2 {
+ font-size: 24px;
+ margin-bottom: 1em;
+}
+
+h3 {
+ font-size: 20px;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+pre, code {
+ line-height: 1.5;
+ font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
+}
+
+pre {
+ margin-top: 0.5em;
+}
+
+h1, h2, h3, p {
+ font-family: Arial, sans serif;
+}
+
+h1, h2, h3 {
+ border-bottom: solid #CCC 1px;
+}
+
+.toc_element {
+ margin-top: 0.5em;
+}
+
+.firstline {
+ margin-left: 2 em;
+}
+
+.method {
+ margin-top: 1em;
+ border: solid 1px #CCC;
+ padding: 1em;
+ background: #EEE;
+}
+
+.details {
+ font-weight: bold;
+ font-size: 14px;
+}
+
+</style>
+
+<h1><a href="cloudkms_v1beta1.html">Google Cloud Key Management Service (KMS) API</a> . <a href="cloudkms_v1beta1.projects.html">projects</a> . <a href="cloudkms_v1beta1.projects.locations.html">locations</a> . <a href="cloudkms_v1beta1.projects.locations.keyRings.html">keyRings</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="cloudkms_v1beta1.projects.locations.keyRings.cryptoKeys.html">cryptoKeys()</a></code>
+</p>
+<p class="firstline">Returns the cryptoKeys Resource.</p>
+
+<p class="toc_element">
+ <code><a href="#create">create(parent=None, body, keyRingId=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Create a new KeyRing in a given Project and Location.</p>
+<p class="toc_element">
+ <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
+<p class="firstline">Returns metadata for a given KeyRing.</p>
+<p class="toc_element">
+ <code><a href="#getIamPolicy">getIamPolicy(resource=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Gets the access control policy for a resource.</p>
+<p class="toc_element">
+ <code><a href="#list">list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
+<p class="firstline">Lists KeyRings.</p>
+<p class="toc_element">
+ <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
+<p class="firstline">Retrieves the next page of results.</p>
+<p class="toc_element">
+ <code><a href="#setIamPolicy">setIamPolicy(resource=None, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Sets the access control policy on the specified resource. Replaces any</p>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(resource=None, body, x__xgafv=None)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="create">create(parent=None, body, keyRingId=None, x__xgafv=None)</code>
+ <pre>Create a new KeyRing in a given Project and Location.
+
+Args:
+ parent: string, Required. The resource name of the location associated with the
+KeyRings, in the format `projects/*/locations/*`. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # A KeyRing is a toplevel logical grouping of CryptoKeys.
+ "name": "A String", # Output only. The resource name for the KeyRing in the format
+ # `projects/*/locations/*/keyRings/*`.
+ "createTime": "A String", # Output only. The time at which this KeyRing was created.
+}
+
+ keyRingId: string, Required. It must be unique within a location and match the regular
+expression `[a-zA-Z0-9_-]{1,63}`
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A KeyRing is a toplevel logical grouping of CryptoKeys.
+ "name": "A String", # Output only. The resource name for the KeyRing in the format
+ # `projects/*/locations/*/keyRings/*`.
+ "createTime": "A String", # Output only. The time at which this KeyRing was created.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(name, x__xgafv=None)</code>
+ <pre>Returns metadata for a given KeyRing.
+
+Args:
+ name: string, The name of the KeyRing to get. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A KeyRing is a toplevel logical grouping of CryptoKeys.
+ "name": "A String", # Output only. The resource name for the KeyRing in the format
+ # `projects/*/locations/*/keyRings/*`.
+ "createTime": "A String", # Output only. The time at which this KeyRing was created.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="getIamPolicy">getIamPolicy(resource=None, x__xgafv=None)</code>
+ <pre>Gets the access control policy for a resource.
+Returns an empty policy if the resource exists and does not have a policy
+set.
+
+Args:
+ resource: string, REQUIRED: The resource for which the policy is being requested.
+See the operation documentation for the appropriate value for this field. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Defines an Identity and Access Management (IAM) policy. It is used to
+ # specify access control policies for Cloud Platform resources.
+ #
+ #
+ # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of
+ # `members` to a `role`, where the members can be user accounts, Google groups,
+ # Google domains, and service accounts. A `role` is a named list of permissions
+ # defined by IAM.
+ #
+ # **Example**
+ #
+ # {
+ # "bindings": [
+ # {
+ # "role": "roles/owner",
+ # "members": [
+ # "user:mike@example.com",
+ # "group:admins@example.com",
+ # "domain:google.com",
+ # "serviceAccount:my-other-app@appspot.gserviceaccount.com",
+ # ]
+ # },
+ # {
+ # "role": "roles/viewer",
+ # "members": ["user:sean@example.com"]
+ # }
+ # ]
+ # }
+ #
+ # For a description of IAM and its features, see the
+ # [IAM developer's guide](https://cloud.google.com/iam).
+ "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+ { # Specifies the audit configuration for a service.
+ # It consists of which permission types are logged, and what identities, if
+ # any, are exempted from logging.
+ # An AuditConifg must have one or more AuditLogConfigs.
+ #
+ # If there are AuditConfigs for both `allServices` and a specific service,
+ # the union of the two AuditConfigs is used for that service: the log_types
+ # specified in each AuditConfig are enabled, and the exempted_members in each
+ # AuditConfig are exempted.
+ # Example Policy with multiple AuditConfigs:
+ # {
+ # "audit_configs": [
+ # {
+ # "service": "allServices"
+ # "audit_log_configs": [
+ # {
+ # "log_type": "DATA_READ",
+ # "exempted_members": [
+ # "user:foo@gmail.com"
+ # ]
+ # },
+ # {
+ # "log_type": "DATA_WRITE",
+ # },
+ # {
+ # "log_type": "ADMIN_READ",
+ # }
+ # ]
+ # },
+ # {
+ # "service": "fooservice@googleapis.com"
+ # "audit_log_configs": [
+ # {
+ # "log_type": "DATA_READ",
+ # },
+ # {
+ # "log_type": "DATA_WRITE",
+ # "exempted_members": [
+ # "user:bar@gmail.com"
+ # ]
+ # }
+ # ]
+ # }
+ # ]
+ # }
+ # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
+ # logging. It also exempts foo@gmail.com from DATA_READ logging, and
+ # bar@gmail.com from DATA_WRITE logging.
+ "exemptedMembers": [
+ "A String",
+ ],
+ "auditLogConfigs": [ # The configuration for logging of each type of permission.
+ # Next ID: 4
+ { # Provides the configuration for logging a type of permissions.
+ # Example:
+ #
+ # {
+ # "audit_log_configs": [
+ # {
+ # "log_type": "DATA_READ",
+ # "exempted_members": [
+ # "user:foo@gmail.com"
+ # ]
+ # },
+ # {
+ # "log_type": "DATA_WRITE",
+ # }
+ # ]
+ # }
+ #
+ # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
+ # foo@gmail.com from DATA_READ logging.
+ "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
+ # permission.
+ # Follows the same format of Binding.members.
+ "A String",
+ ],
+ "logType": "A String", # The log type that this config enables.
+ },
+ ],
+ "service": "A String", # Specifies a service that will be enabled for audit logging.
+ # For example, `resourcemanager`, `storage`, `compute`.
+ # `allServices` is a special value that covers all services.
+ },
+ ],
+ "version": 42, # Version of the `Policy`. The default version is 0.
+ "rules": [ # If more than one rule is specified, the rules are applied in the following
+ # manner:
+ # - All matching LOG rules are always applied.
+ # - If any DENY/DENY_WITH_LOG rule matches, permission is denied.
+ # Logging will be applied if one or more matching rule requires logging.
+ # - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is
+ # granted.
+ # Logging will be applied if one or more matching rule requires logging.
+ # - Otherwise, if no rule applies, permission is denied.
+ { # A rule to be applied in a Policy.
+ "notIn": [ # If one or more 'not_in' clauses are specified, the rule matches
+ # if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
+ # The format for in and not_in entries is the same as for members in a
+ # Binding (see google/iam/v1/policy.proto).
+ "A String",
+ ],
+ "description": "A String", # Human-readable description of the rule.
+ "in": [ # If one or more 'in' clauses are specified, the rule matches if
+ # the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.
+ "A String",
+ ],
+ "action": "A String", # Required
+ "conditions": [ # Additional restrictions that must be met
+ { # A condition to be met.
+ "iam": "A String", # Trusted attributes supplied by the IAM system.
+ "svc": "A String", # Trusted attributes discharged by the service.
+ "value": "A String", # DEPRECATED. Use 'values' instead.
+ "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses
+ # the IAM system for access control.
+ "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
+ "A String",
+ ],
+ "op": "A String", # An operator to apply the subject with.
+ },
+ ],
+ "logConfig": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries
+ # that match the LOG action.
+ { # Specifies what kind of log the caller must write
+ # Increment a streamz counter with the specified metric and field names.
+ #
+ # Metric names should start with a '/', generally be lowercase-only,
+ # and end in "_count". Field names should not contain an initial slash.
+ # The actual exported metric names will have "/iam/policy" prepended.
+ #
+ # Field names correspond to IAM request parameters and field values are
+ # their respective values.
+ #
+ # At present the only supported field names are
+ # - "iam_principal", corresponding to IAMContext.principal;
+ # - "" (empty string), resulting in one aggretated counter with no field.
+ #
+ # Examples:
+ # counter { metric: "/debug_access_count" field: "iam_principal" }
+ # ==> increment counter /iam/policy/backend_debug_access_count
+ # {iam_principal=[value of IAMContext.principal]}
+ #
+ # At this time we do not support:
+ # * multiple field names (though this may be supported in the future)
+ # * decrementing the counter
+ # * incrementing it by anything other than 1
+ "counter": { # Options for counters # Counter options.
+ "field": "A String", # The field value to attribute.
+ "metric": "A String", # The metric to update.
+ },
+ "dataAccess": { # Write a Data Access (Gin) log # Data access options.
+ },
+ "cloudAudit": { # Write a Cloud Audit log # Cloud audit options.
+ },
+ },
+ ],
+ "permissions": [ # A permission is a string of form '<service>.<resource type>.<verb>'
+ # (e.g., 'storage.buckets.list'). A value of '*' matches all permissions,
+ # and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
+ "A String",
+ ],
+ },
+ ],
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
+ # prevent simultaneous updates of a policy from overwriting each other.
+ # It is strongly suggested that systems make use of the `etag` in the
+ # read-modify-write cycle to perform policy updates in order to avoid race
+ # conditions: An `etag` is returned in the response to `getIamPolicy`, and
+ # systems are expected to put that etag in the request to `setIamPolicy` to
+ # ensure that their change will be applied to the same version of the policy.
+ #
+ # If no `etag` is provided in the call to `setIamPolicy`, then the existing
+ # policy is overwritten blindly.
+ "bindings": [ # Associates a list of `members` to a `role`.
+ # Multiple `bindings` must not be specified for the same `role`.
+ # `bindings` with no members will result in an error.
+ { # Associates `members` with a `role`.
+ "role": "A String", # Role that is assigned to `members`.
+ # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+ # Required
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
+ # `members` can have the following values:
+ #
+ # * `allUsers`: A special identifier that represents anyone who is
+ # on the internet; with or without a Google account.
+ #
+ # * `allAuthenticatedUsers`: A special identifier that represents anyone
+ # who is authenticated with a Google account or a service account.
+ #
+ # * `user:{emailid}`: An email address that represents a specific Google
+ # account. For example, `alice@gmail.com` or `joe@example.com`.
+ #
+ #
+ # * `serviceAccount:{emailid}`: An email address that represents a service
+ # account. For example, `my-other-app@appspot.gserviceaccount.com`.
+ #
+ # * `group:{emailid}`: An email address that represents a Google group.
+ # For example, `admins@example.com`.
+ #
+ # * `domain:{domain}`: A Google Apps domain name that represents all the
+ # users of that domain. For example, `google.com` or `example.com`.
+ #
+ "A String",
+ ],
+ },
+ ],
+ "iamOwned": True or False,
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)</code>
+ <pre>Lists KeyRings.
+
+Args:
+ parent: string, Required. The resource name of the location associated with the
+KeyRings, in the format `projects/*/locations/*`. (required)
+ pageToken: string, Optional pagination token, returned earlier via
+ListKeyRingsResponse.next_page_token.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+ pageSize: integer, Optional limit on the number of KeyRings to include in the
+response. Further KeyRings can subsequently be obtained by
+including the ListKeyRingsResponse.next_page_token in a subsequent
+request. If unspecified, the server will pick an appropriate default.
+
+Returns:
+ An object of the form:
+
+ { # Response message for KeyManagementService.ListKeyRings.
+ "nextPageToken": "A String", # A token to retrieve next page of results. Pass this value in
+ # ListKeyRingsRequest.page_token to retrieve the next page of results.
+ "totalSize": 42, # The total number of KeyRings that matched the query.
+ "keyRings": [ # The list of KeyRings.
+ { # A KeyRing is a toplevel logical grouping of CryptoKeys.
+ "name": "A String", # Output only. The resource name for the KeyRing in the format
+ # `projects/*/locations/*/keyRings/*`.
+ "createTime": "A String", # Output only. The time at which this KeyRing was created.
+ },
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
+ <pre>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.
+ </pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setIamPolicy">setIamPolicy(resource=None, body, x__xgafv=None)</code>
+ <pre>Sets the access control policy on the specified resource. Replaces any
+existing policy.
+
+Args:
+ resource: string, REQUIRED: The resource for which the policy is being specified.
+See the operation documentation for the appropriate value for this field. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Request message for `SetIamPolicy` method.
+ "policy": { # Defines an Identity and Access Management (IAM) policy. It is used to # REQUIRED: The complete policy to be applied to the `resource`. The size of
+ # the policy is limited to a few 10s of KB. An empty policy is a
+ # valid policy but certain Cloud Platform services (such as Projects)
+ # might reject them.
+ # specify access control policies for Cloud Platform resources.
+ #
+ #
+ # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of
+ # `members` to a `role`, where the members can be user accounts, Google groups,
+ # Google domains, and service accounts. A `role` is a named list of permissions
+ # defined by IAM.
+ #
+ # **Example**
+ #
+ # {
+ # "bindings": [
+ # {
+ # "role": "roles/owner",
+ # "members": [
+ # "user:mike@example.com",
+ # "group:admins@example.com",
+ # "domain:google.com",
+ # "serviceAccount:my-other-app@appspot.gserviceaccount.com",
+ # ]
+ # },
+ # {
+ # "role": "roles/viewer",
+ # "members": ["user:sean@example.com"]
+ # }
+ # ]
+ # }
+ #
+ # For a description of IAM and its features, see the
+ # [IAM developer's guide](https://cloud.google.com/iam).
+ "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+ { # Specifies the audit configuration for a service.
+ # It consists of which permission types are logged, and what identities, if
+ # any, are exempted from logging.
+ # An AuditConifg must have one or more AuditLogConfigs.
+ #
+ # If there are AuditConfigs for both `allServices` and a specific service,
+ # the union of the two AuditConfigs is used for that service: the log_types
+ # specified in each AuditConfig are enabled, and the exempted_members in each
+ # AuditConfig are exempted.
+ # Example Policy with multiple AuditConfigs:
+ # {
+ # "audit_configs": [
+ # {
+ # "service": "allServices"
+ # "audit_log_configs": [
+ # {
+ # "log_type": "DATA_READ",
+ # "exempted_members": [
+ # "user:foo@gmail.com"
+ # ]
+ # },
+ # {
+ # "log_type": "DATA_WRITE",
+ # },
+ # {
+ # "log_type": "ADMIN_READ",
+ # }
+ # ]
+ # },
+ # {
+ # "service": "fooservice@googleapis.com"
+ # "audit_log_configs": [
+ # {
+ # "log_type": "DATA_READ",
+ # },
+ # {
+ # "log_type": "DATA_WRITE",
+ # "exempted_members": [
+ # "user:bar@gmail.com"
+ # ]
+ # }
+ # ]
+ # }
+ # ]
+ # }
+ # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
+ # logging. It also exempts foo@gmail.com from DATA_READ logging, and
+ # bar@gmail.com from DATA_WRITE logging.
+ "exemptedMembers": [
+ "A String",
+ ],
+ "auditLogConfigs": [ # The configuration for logging of each type of permission.
+ # Next ID: 4
+ { # Provides the configuration for logging a type of permissions.
+ # Example:
+ #
+ # {
+ # "audit_log_configs": [
+ # {
+ # "log_type": "DATA_READ",
+ # "exempted_members": [
+ # "user:foo@gmail.com"
+ # ]
+ # },
+ # {
+ # "log_type": "DATA_WRITE",
+ # }
+ # ]
+ # }
+ #
+ # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
+ # foo@gmail.com from DATA_READ logging.
+ "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
+ # permission.
+ # Follows the same format of Binding.members.
+ "A String",
+ ],
+ "logType": "A String", # The log type that this config enables.
+ },
+ ],
+ "service": "A String", # Specifies a service that will be enabled for audit logging.
+ # For example, `resourcemanager`, `storage`, `compute`.
+ # `allServices` is a special value that covers all services.
+ },
+ ],
+ "version": 42, # Version of the `Policy`. The default version is 0.
+ "rules": [ # If more than one rule is specified, the rules are applied in the following
+ # manner:
+ # - All matching LOG rules are always applied.
+ # - If any DENY/DENY_WITH_LOG rule matches, permission is denied.
+ # Logging will be applied if one or more matching rule requires logging.
+ # - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is
+ # granted.
+ # Logging will be applied if one or more matching rule requires logging.
+ # - Otherwise, if no rule applies, permission is denied.
+ { # A rule to be applied in a Policy.
+ "notIn": [ # If one or more 'not_in' clauses are specified, the rule matches
+ # if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
+ # The format for in and not_in entries is the same as for members in a
+ # Binding (see google/iam/v1/policy.proto).
+ "A String",
+ ],
+ "description": "A String", # Human-readable description of the rule.
+ "in": [ # If one or more 'in' clauses are specified, the rule matches if
+ # the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.
+ "A String",
+ ],
+ "action": "A String", # Required
+ "conditions": [ # Additional restrictions that must be met
+ { # A condition to be met.
+ "iam": "A String", # Trusted attributes supplied by the IAM system.
+ "svc": "A String", # Trusted attributes discharged by the service.
+ "value": "A String", # DEPRECATED. Use 'values' instead.
+ "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses
+ # the IAM system for access control.
+ "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
+ "A String",
+ ],
+ "op": "A String", # An operator to apply the subject with.
+ },
+ ],
+ "logConfig": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries
+ # that match the LOG action.
+ { # Specifies what kind of log the caller must write
+ # Increment a streamz counter with the specified metric and field names.
+ #
+ # Metric names should start with a '/', generally be lowercase-only,
+ # and end in "_count". Field names should not contain an initial slash.
+ # The actual exported metric names will have "/iam/policy" prepended.
+ #
+ # Field names correspond to IAM request parameters and field values are
+ # their respective values.
+ #
+ # At present the only supported field names are
+ # - "iam_principal", corresponding to IAMContext.principal;
+ # - "" (empty string), resulting in one aggretated counter with no field.
+ #
+ # Examples:
+ # counter { metric: "/debug_access_count" field: "iam_principal" }
+ # ==> increment counter /iam/policy/backend_debug_access_count
+ # {iam_principal=[value of IAMContext.principal]}
+ #
+ # At this time we do not support:
+ # * multiple field names (though this may be supported in the future)
+ # * decrementing the counter
+ # * incrementing it by anything other than 1
+ "counter": { # Options for counters # Counter options.
+ "field": "A String", # The field value to attribute.
+ "metric": "A String", # The metric to update.
+ },
+ "dataAccess": { # Write a Data Access (Gin) log # Data access options.
+ },
+ "cloudAudit": { # Write a Cloud Audit log # Cloud audit options.
+ },
+ },
+ ],
+ "permissions": [ # A permission is a string of form '<service>.<resource type>.<verb>'
+ # (e.g., 'storage.buckets.list'). A value of '*' matches all permissions,
+ # and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
+ "A String",
+ ],
+ },
+ ],
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
+ # prevent simultaneous updates of a policy from overwriting each other.
+ # It is strongly suggested that systems make use of the `etag` in the
+ # read-modify-write cycle to perform policy updates in order to avoid race
+ # conditions: An `etag` is returned in the response to `getIamPolicy`, and
+ # systems are expected to put that etag in the request to `setIamPolicy` to
+ # ensure that their change will be applied to the same version of the policy.
+ #
+ # If no `etag` is provided in the call to `setIamPolicy`, then the existing
+ # policy is overwritten blindly.
+ "bindings": [ # Associates a list of `members` to a `role`.
+ # Multiple `bindings` must not be specified for the same `role`.
+ # `bindings` with no members will result in an error.
+ { # Associates `members` with a `role`.
+ "role": "A String", # Role that is assigned to `members`.
+ # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+ # Required
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
+ # `members` can have the following values:
+ #
+ # * `allUsers`: A special identifier that represents anyone who is
+ # on the internet; with or without a Google account.
+ #
+ # * `allAuthenticatedUsers`: A special identifier that represents anyone
+ # who is authenticated with a Google account or a service account.
+ #
+ # * `user:{emailid}`: An email address that represents a specific Google
+ # account. For example, `alice@gmail.com` or `joe@example.com`.
+ #
+ #
+ # * `serviceAccount:{emailid}`: An email address that represents a service
+ # account. For example, `my-other-app@appspot.gserviceaccount.com`.
+ #
+ # * `group:{emailid}`: An email address that represents a Google group.
+ # For example, `admins@example.com`.
+ #
+ # * `domain:{domain}`: A Google Apps domain name that represents all the
+ # users of that domain. For example, `google.com` or `example.com`.
+ #
+ "A String",
+ ],
+ },
+ ],
+ "iamOwned": True or False,
+ },
+ "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
+ # the fields in the mask will be modified. If no mask is provided, a default
+ # mask is used:
+ # paths: "bindings, etag"
+ # This field is only used by Cloud IAM.
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Defines an Identity and Access Management (IAM) policy. It is used to
+ # specify access control policies for Cloud Platform resources.
+ #
+ #
+ # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of
+ # `members` to a `role`, where the members can be user accounts, Google groups,
+ # Google domains, and service accounts. A `role` is a named list of permissions
+ # defined by IAM.
+ #
+ # **Example**
+ #
+ # {
+ # "bindings": [
+ # {
+ # "role": "roles/owner",
+ # "members": [
+ # "user:mike@example.com",
+ # "group:admins@example.com",
+ # "domain:google.com",
+ # "serviceAccount:my-other-app@appspot.gserviceaccount.com",
+ # ]
+ # },
+ # {
+ # "role": "roles/viewer",
+ # "members": ["user:sean@example.com"]
+ # }
+ # ]
+ # }
+ #
+ # For a description of IAM and its features, see the
+ # [IAM developer's guide](https://cloud.google.com/iam).
+ "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+ { # Specifies the audit configuration for a service.
+ # It consists of which permission types are logged, and what identities, if
+ # any, are exempted from logging.
+ # An AuditConifg must have one or more AuditLogConfigs.
+ #
+ # If there are AuditConfigs for both `allServices` and a specific service,
+ # the union of the two AuditConfigs is used for that service: the log_types
+ # specified in each AuditConfig are enabled, and the exempted_members in each
+ # AuditConfig are exempted.
+ # Example Policy with multiple AuditConfigs:
+ # {
+ # "audit_configs": [
+ # {
+ # "service": "allServices"
+ # "audit_log_configs": [
+ # {
+ # "log_type": "DATA_READ",
+ # "exempted_members": [
+ # "user:foo@gmail.com"
+ # ]
+ # },
+ # {
+ # "log_type": "DATA_WRITE",
+ # },
+ # {
+ # "log_type": "ADMIN_READ",
+ # }
+ # ]
+ # },
+ # {
+ # "service": "fooservice@googleapis.com"
+ # "audit_log_configs": [
+ # {
+ # "log_type": "DATA_READ",
+ # },
+ # {
+ # "log_type": "DATA_WRITE",
+ # "exempted_members": [
+ # "user:bar@gmail.com"
+ # ]
+ # }
+ # ]
+ # }
+ # ]
+ # }
+ # For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
+ # logging. It also exempts foo@gmail.com from DATA_READ logging, and
+ # bar@gmail.com from DATA_WRITE logging.
+ "exemptedMembers": [
+ "A String",
+ ],
+ "auditLogConfigs": [ # The configuration for logging of each type of permission.
+ # Next ID: 4
+ { # Provides the configuration for logging a type of permissions.
+ # Example:
+ #
+ # {
+ # "audit_log_configs": [
+ # {
+ # "log_type": "DATA_READ",
+ # "exempted_members": [
+ # "user:foo@gmail.com"
+ # ]
+ # },
+ # {
+ # "log_type": "DATA_WRITE",
+ # }
+ # ]
+ # }
+ #
+ # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
+ # foo@gmail.com from DATA_READ logging.
+ "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
+ # permission.
+ # Follows the same format of Binding.members.
+ "A String",
+ ],
+ "logType": "A String", # The log type that this config enables.
+ },
+ ],
+ "service": "A String", # Specifies a service that will be enabled for audit logging.
+ # For example, `resourcemanager`, `storage`, `compute`.
+ # `allServices` is a special value that covers all services.
+ },
+ ],
+ "version": 42, # Version of the `Policy`. The default version is 0.
+ "rules": [ # If more than one rule is specified, the rules are applied in the following
+ # manner:
+ # - All matching LOG rules are always applied.
+ # - If any DENY/DENY_WITH_LOG rule matches, permission is denied.
+ # Logging will be applied if one or more matching rule requires logging.
+ # - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is
+ # granted.
+ # Logging will be applied if one or more matching rule requires logging.
+ # - Otherwise, if no rule applies, permission is denied.
+ { # A rule to be applied in a Policy.
+ "notIn": [ # If one or more 'not_in' clauses are specified, the rule matches
+ # if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
+ # The format for in and not_in entries is the same as for members in a
+ # Binding (see google/iam/v1/policy.proto).
+ "A String",
+ ],
+ "description": "A String", # Human-readable description of the rule.
+ "in": [ # If one or more 'in' clauses are specified, the rule matches if
+ # the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.
+ "A String",
+ ],
+ "action": "A String", # Required
+ "conditions": [ # Additional restrictions that must be met
+ { # A condition to be met.
+ "iam": "A String", # Trusted attributes supplied by the IAM system.
+ "svc": "A String", # Trusted attributes discharged by the service.
+ "value": "A String", # DEPRECATED. Use 'values' instead.
+ "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses
+ # the IAM system for access control.
+ "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
+ "A String",
+ ],
+ "op": "A String", # An operator to apply the subject with.
+ },
+ ],
+ "logConfig": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries
+ # that match the LOG action.
+ { # Specifies what kind of log the caller must write
+ # Increment a streamz counter with the specified metric and field names.
+ #
+ # Metric names should start with a '/', generally be lowercase-only,
+ # and end in "_count". Field names should not contain an initial slash.
+ # The actual exported metric names will have "/iam/policy" prepended.
+ #
+ # Field names correspond to IAM request parameters and field values are
+ # their respective values.
+ #
+ # At present the only supported field names are
+ # - "iam_principal", corresponding to IAMContext.principal;
+ # - "" (empty string), resulting in one aggretated counter with no field.
+ #
+ # Examples:
+ # counter { metric: "/debug_access_count" field: "iam_principal" }
+ # ==> increment counter /iam/policy/backend_debug_access_count
+ # {iam_principal=[value of IAMContext.principal]}
+ #
+ # At this time we do not support:
+ # * multiple field names (though this may be supported in the future)
+ # * decrementing the counter
+ # * incrementing it by anything other than 1
+ "counter": { # Options for counters # Counter options.
+ "field": "A String", # The field value to attribute.
+ "metric": "A String", # The metric to update.
+ },
+ "dataAccess": { # Write a Data Access (Gin) log # Data access options.
+ },
+ "cloudAudit": { # Write a Cloud Audit log # Cloud audit options.
+ },
+ },
+ ],
+ "permissions": [ # A permission is a string of form '<service>.<resource type>.<verb>'
+ # (e.g., 'storage.buckets.list'). A value of '*' matches all permissions,
+ # and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
+ "A String",
+ ],
+ },
+ ],
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
+ # prevent simultaneous updates of a policy from overwriting each other.
+ # It is strongly suggested that systems make use of the `etag` in the
+ # read-modify-write cycle to perform policy updates in order to avoid race
+ # conditions: An `etag` is returned in the response to `getIamPolicy`, and
+ # systems are expected to put that etag in the request to `setIamPolicy` to
+ # ensure that their change will be applied to the same version of the policy.
+ #
+ # If no `etag` is provided in the call to `setIamPolicy`, then the existing
+ # policy is overwritten blindly.
+ "bindings": [ # Associates a list of `members` to a `role`.
+ # Multiple `bindings` must not be specified for the same `role`.
+ # `bindings` with no members will result in an error.
+ { # Associates `members` with a `role`.
+ "role": "A String", # Role that is assigned to `members`.
+ # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+ # Required
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
+ # `members` can have the following values:
+ #
+ # * `allUsers`: A special identifier that represents anyone who is
+ # on the internet; with or without a Google account.
+ #
+ # * `allAuthenticatedUsers`: A special identifier that represents anyone
+ # who is authenticated with a Google account or a service account.
+ #
+ # * `user:{emailid}`: An email address that represents a specific Google
+ # account. For example, `alice@gmail.com` or `joe@example.com`.
+ #
+ #
+ # * `serviceAccount:{emailid}`: An email address that represents a service
+ # account. For example, `my-other-app@appspot.gserviceaccount.com`.
+ #
+ # * `group:{emailid}`: An email address that represents a Google group.
+ # For example, `admins@example.com`.
+ #
+ # * `domain:{domain}`: A Google Apps domain name that represents all the
+ # users of that domain. For example, `google.com` or `example.com`.
+ #
+ "A String",
+ ],
+ },
+ ],
+ "iamOwned": True or False,
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(resource=None, body, x__xgafv=None)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+If the resource does not exist, this will return an empty set of
+permissions, not a NOT_FOUND error.
+
+Note: This operation is designed to be used for building permission-aware
+UIs and command-line tools, not for authorization checking. This operation
+may "fail open" without warning.
+
+Args:
+ resource: string, REQUIRED: The resource for which the policy detail is being requested.
+See the operation documentation for the appropriate value for this field. (required)
+ body: object, The request body. (required)
+ The object takes the form of:
+
+{ # Request message for `TestIamPermissions` method.
+ "permissions": [ # The set of permissions to check for the `resource`. Permissions with
+ # wildcards (such as '*' or 'storage.*') are not allowed. For more
+ # information see
+ # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
+ "A String",
+ ],
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response message for `TestIamPermissions` method.
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
+ # allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file