docs: docs update (#911)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)
Fixes #<issue_number_goes_here> 🦕
diff --git a/docs/dyn/cloudresourcemanager_v1beta1.projects.html b/docs/dyn/cloudresourcemanager_v1beta1.projects.html
index 4c5c0b7..4d9383e 100644
--- a/docs/dyn/cloudresourcemanager_v1beta1.projects.html
+++ b/docs/dyn/cloudresourcemanager_v1beta1.projects.html
@@ -90,7 +90,7 @@
<code><a href="#getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns the IAM access control policy for the specified Project.</p>
<p class="toc_element">
- <code><a href="#list">list(pageSize=None, pageToken=None, x__xgafv=None, filter=None)</a></code></p>
+ <code><a href="#list">list(filter=None, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists Projects that the caller has the `resourcemanager.projects.get`</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -133,37 +133,30 @@
{ # A Project is a high-level Google Cloud Platform entity. It is a
# container for ACLs, APIs, App Engine Apps, VMs, and other
# Google Cloud Platform resources.
- "name": "A String", # The optional user-assigned display name of the Project.
- # When present it must be between 4 to 30 characters.
- # Allowed characters are: lowercase and uppercase letters, numbers,
- # hyphen, single-quote, double-quote, space, and exclamation point.
+ "lifecycleState": "A String", # The Project lifecycle state.
#
- # Example: <code>My Project</code>
- # Read-write.
- "parent": { # A container to reference an id for any resource type. A `resource` in Google # An optional reference to a parent Resource.
+ # Read-only.
+ "projectNumber": "A String", # The number uniquely identifying the project.
#
- # Supported parent types include "organization" and "folder". Once set, the
+ # Example: <code>415104041262</code>
+ # Read-only.
+ "parent": { # A container to reference an id for any resource type. A `resource` in Google # An optional reference to a parent Resource.
+ #
+ # Supported parent types include "organization" and "folder". Once set, the
# parent cannot be cleared. The `parent` can be set on creation or using the
# `UpdateProject` method; the end user must have the
# `resourcemanager.projects.create` permission on the parent.
#
# Read-write.
# Cloud Platform is a generic term for something you (a developer) may want to
- # interact with through one of our API's. Some examples are an App Engine app,
+ # interact with through one of our API's. Some examples are an App Engine app,
# a Compute Engine instance, a Cloud SQL database, and so on.
- "type": "A String", # Required field representing the resource type this id is for.
- # At present, the valid types are "project", "folder", and "organization".
- "id": "A String", # Required field for the type-specific id. This should correspond to the id
- # used in the type-specific API's.
+ "type": "A String", # Required field representing the resource type this id is for.
+ # At present, the valid types are "project", "folder", and "organization".
+ "id": "A String", # Required field for the type-specific id. This should correspond to the id
+ # used in the type-specific API's.
},
- "projectId": "A String", # The unique, user-assigned ID of the Project.
- # It must be 6 to 30 lowercase letters, digits, or hyphens.
- # It must start with a letter.
- # Trailing hyphens are prohibited.
- #
- # Example: <code>tokyo-rain-123</code>
- # Read-only after creation.
- "labels": { # The labels associated with this Project.
+ "labels": { # The labels associated with this Project.
#
# Label keys must be between 1 and 63 characters long and must conform
# to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?.
@@ -177,20 +170,27 @@
# Clients should store labels in a representation such as JSON that does not
# depend on specific characters being disallowed.
#
- # Example: <code>"environment" : "dev"</code>
+ # Example: <code>"environment" : "dev"</code>
# Read-write.
- "a_key": "A String",
+ "a_key": "A String",
},
- "createTime": "A String", # Creation time.
+ "createTime": "A String", # Creation time.
#
# Read-only.
- "lifecycleState": "A String", # The Project lifecycle state.
+ "name": "A String", # The optional user-assigned display name of the Project.
+ # When present it must be between 4 to 30 characters.
+ # Allowed characters are: lowercase and uppercase letters, numbers,
+ # hyphen, single-quote, double-quote, space, and exclamation point.
#
- # Read-only.
- "projectNumber": "A String", # The number uniquely identifying the project.
+ # Example: <code>My Project</code>
+ # Read-write.
+ "projectId": "A String", # The unique, user-assigned ID of the Project.
+ # It must be 6 to 30 lowercase letters, digits, or hyphens.
+ # It must start with a letter.
+ # Trailing hyphens are prohibited.
#
- # Example: <code>415104041262</code>
- # Read-only.
+ # Example: <code>tokyo-rain-123</code>
+ # Read-only after creation.
}
useLegacyStack: boolean, A now unused experiment opt-out option.
@@ -205,37 +205,30 @@
{ # A Project is a high-level Google Cloud Platform entity. It is a
# container for ACLs, APIs, App Engine Apps, VMs, and other
# Google Cloud Platform resources.
- "name": "A String", # The optional user-assigned display name of the Project.
- # When present it must be between 4 to 30 characters.
- # Allowed characters are: lowercase and uppercase letters, numbers,
- # hyphen, single-quote, double-quote, space, and exclamation point.
+ "lifecycleState": "A String", # The Project lifecycle state.
#
- # Example: <code>My Project</code>
- # Read-write.
- "parent": { # A container to reference an id for any resource type. A `resource` in Google # An optional reference to a parent Resource.
+ # Read-only.
+ "projectNumber": "A String", # The number uniquely identifying the project.
#
- # Supported parent types include "organization" and "folder". Once set, the
+ # Example: <code>415104041262</code>
+ # Read-only.
+ "parent": { # A container to reference an id for any resource type. A `resource` in Google # An optional reference to a parent Resource.
+ #
+ # Supported parent types include "organization" and "folder". Once set, the
# parent cannot be cleared. The `parent` can be set on creation or using the
# `UpdateProject` method; the end user must have the
# `resourcemanager.projects.create` permission on the parent.
#
# Read-write.
# Cloud Platform is a generic term for something you (a developer) may want to
- # interact with through one of our API's. Some examples are an App Engine app,
+ # interact with through one of our API's. Some examples are an App Engine app,
# a Compute Engine instance, a Cloud SQL database, and so on.
- "type": "A String", # Required field representing the resource type this id is for.
- # At present, the valid types are "project", "folder", and "organization".
- "id": "A String", # Required field for the type-specific id. This should correspond to the id
- # used in the type-specific API's.
+ "type": "A String", # Required field representing the resource type this id is for.
+ # At present, the valid types are "project", "folder", and "organization".
+ "id": "A String", # Required field for the type-specific id. This should correspond to the id
+ # used in the type-specific API's.
},
- "projectId": "A String", # The unique, user-assigned ID of the Project.
- # It must be 6 to 30 lowercase letters, digits, or hyphens.
- # It must start with a letter.
- # Trailing hyphens are prohibited.
- #
- # Example: <code>tokyo-rain-123</code>
- # Read-only after creation.
- "labels": { # The labels associated with this Project.
+ "labels": { # The labels associated with this Project.
#
# Label keys must be between 1 and 63 characters long and must conform
# to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?.
@@ -249,20 +242,27 @@
# Clients should store labels in a representation such as JSON that does not
# depend on specific characters being disallowed.
#
- # Example: <code>"environment" : "dev"</code>
+ # Example: <code>"environment" : "dev"</code>
# Read-write.
- "a_key": "A String",
+ "a_key": "A String",
},
- "createTime": "A String", # Creation time.
+ "createTime": "A String", # Creation time.
#
# Read-only.
- "lifecycleState": "A String", # The Project lifecycle state.
+ "name": "A String", # The optional user-assigned display name of the Project.
+ # When present it must be between 4 to 30 characters.
+ # Allowed characters are: lowercase and uppercase letters, numbers,
+ # hyphen, single-quote, double-quote, space, and exclamation point.
#
- # Read-only.
- "projectNumber": "A String", # The number uniquely identifying the project.
+ # Example: <code>My Project</code>
+ # Read-write.
+ "projectId": "A String", # The unique, user-assigned ID of the Project.
+ # It must be 6 to 30 lowercase letters, digits, or hyphens.
+ # It must start with a letter.
+ # Trailing hyphens are prohibited.
#
- # Example: <code>415104041262</code>
- # Read-only.
+ # Example: <code>tokyo-rain-123</code>
+ # Read-only after creation.
}</pre>
</div>
@@ -273,7 +273,7 @@
This method will only affect the Project if it has a lifecycle state of
ACTIVE.
-This method changes the Project's lifecycle state from
+This method changes the Project's lifecycle state from
ACTIVE
to DELETE_REQUESTED.
The deletion starts at an unspecified time, at which point the project is
@@ -337,37 +337,30 @@
{ # A Project is a high-level Google Cloud Platform entity. It is a
# container for ACLs, APIs, App Engine Apps, VMs, and other
# Google Cloud Platform resources.
- "name": "A String", # The optional user-assigned display name of the Project.
- # When present it must be between 4 to 30 characters.
- # Allowed characters are: lowercase and uppercase letters, numbers,
- # hyphen, single-quote, double-quote, space, and exclamation point.
+ "lifecycleState": "A String", # The Project lifecycle state.
#
- # Example: <code>My Project</code>
- # Read-write.
- "parent": { # A container to reference an id for any resource type. A `resource` in Google # An optional reference to a parent Resource.
+ # Read-only.
+ "projectNumber": "A String", # The number uniquely identifying the project.
#
- # Supported parent types include "organization" and "folder". Once set, the
+ # Example: <code>415104041262</code>
+ # Read-only.
+ "parent": { # A container to reference an id for any resource type. A `resource` in Google # An optional reference to a parent Resource.
+ #
+ # Supported parent types include "organization" and "folder". Once set, the
# parent cannot be cleared. The `parent` can be set on creation or using the
# `UpdateProject` method; the end user must have the
# `resourcemanager.projects.create` permission on the parent.
#
# Read-write.
# Cloud Platform is a generic term for something you (a developer) may want to
- # interact with through one of our API's. Some examples are an App Engine app,
+ # interact with through one of our API's. Some examples are an App Engine app,
# a Compute Engine instance, a Cloud SQL database, and so on.
- "type": "A String", # Required field representing the resource type this id is for.
- # At present, the valid types are "project", "folder", and "organization".
- "id": "A String", # Required field for the type-specific id. This should correspond to the id
- # used in the type-specific API's.
+ "type": "A String", # Required field representing the resource type this id is for.
+ # At present, the valid types are "project", "folder", and "organization".
+ "id": "A String", # Required field for the type-specific id. This should correspond to the id
+ # used in the type-specific API's.
},
- "projectId": "A String", # The unique, user-assigned ID of the Project.
- # It must be 6 to 30 lowercase letters, digits, or hyphens.
- # It must start with a letter.
- # Trailing hyphens are prohibited.
- #
- # Example: <code>tokyo-rain-123</code>
- # Read-only after creation.
- "labels": { # The labels associated with this Project.
+ "labels": { # The labels associated with this Project.
#
# Label keys must be between 1 and 63 characters long and must conform
# to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?.
@@ -381,20 +374,27 @@
# Clients should store labels in a representation such as JSON that does not
# depend on specific characters being disallowed.
#
- # Example: <code>"environment" : "dev"</code>
+ # Example: <code>"environment" : "dev"</code>
# Read-write.
- "a_key": "A String",
+ "a_key": "A String",
},
- "createTime": "A String", # Creation time.
+ "createTime": "A String", # Creation time.
#
# Read-only.
- "lifecycleState": "A String", # The Project lifecycle state.
+ "name": "A String", # The optional user-assigned display name of the Project.
+ # When present it must be between 4 to 30 characters.
+ # Allowed characters are: lowercase and uppercase letters, numbers,
+ # hyphen, single-quote, double-quote, space, and exclamation point.
#
- # Read-only.
- "projectNumber": "A String", # The number uniquely identifying the project.
+ # Example: <code>My Project</code>
+ # Read-write.
+ "projectId": "A String", # The unique, user-assigned ID of the Project.
+ # It must be 6 to 30 lowercase letters, digits, or hyphens.
+ # It must start with a letter.
+ # Trailing hyphens are prohibited.
#
- # Example: <code>415104041262</code>
- # Read-only.
+ # Example: <code>tokyo-rain-123</code>
+ # Read-only after creation.
}</pre>
</div>
@@ -426,18 +426,18 @@
An object of the form:
{ # Response from the GetAncestry method.
- "ancestor": [ # Ancestors are ordered from bottom to top of the resource hierarchy. The
- # first ancestor is the project itself, followed by the project's parent,
+ "ancestor": [ # Ancestors are ordered from bottom to top of the resource hierarchy. The
+ # first ancestor is the project itself, followed by the project's parent,
# etc.
{ # Identifying information for a single ancestor of a project.
- "resourceId": { # A container to reference an id for any resource type. A `resource` in Google # Resource id of the ancestor.
+ "resourceId": { # A container to reference an id for any resource type. A `resource` in Google # Resource id of the ancestor.
# Cloud Platform is a generic term for something you (a developer) may want to
- # interact with through one of our API's. Some examples are an App Engine app,
+ # interact with through one of our API's. Some examples are an App Engine app,
# a Compute Engine instance, a Cloud SQL database, and so on.
- "type": "A String", # Required field representing the resource type this id is for.
- # At present, the valid types are "project", "folder", and "organization".
- "id": "A String", # Required field for the type-specific id. This should correspond to the id
- # used in the type-specific API's.
+ "type": "A String", # Required field representing the resource type this id is for.
+ # At present, the valid types are "project", "folder", and "organization".
+ "id": "A String", # Required field for the type-specific id. This should correspond to the id
+ # used in the type-specific API's.
},
},
],
@@ -459,9 +459,9 @@
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
+ "options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to
# `GetIamPolicy`.
- "requestedPolicyVersion": 42, # Optional. The policy format version to be returned.
+ "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.
@@ -469,6 +469,10 @@
# Requests for policies with any conditional bindings must specify version 3.
# Policies without any conditional bindings may specify any valid value or
# leave the field unset.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM
+ # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
},
}
@@ -490,36 +494,40 @@
# 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.
+ # For some types of Google Cloud resources, a `binding` can also specify a
+ # `condition`, which is a logical expression that allows access to a resource
+ # only if the expression evaluates to `true`. A condition can add constraints
+ # based on attributes of the request, the resource, or both. To learn which
+ # resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
#
# **JSON example:**
#
# {
- # "bindings": [
+ # "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.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')",
+ # "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
+ # "etag": "BwWWja0YfJA=",
+ # "version": 3
# }
#
# **YAML example:**
@@ -537,63 +545,156 @@
# condition:
# title: expirable access
# description: Does not grant access after Sep 2020
- # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+ # 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/).
- "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
+ "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+ { # Specifies the audit configuration for a service.
+ # The configuration determines which permission types are logged, and what
+ # identities, if any, are exempted from logging.
+ # An AuditConfig must have one or more AuditLogConfigs.
+ #
+ # If there are AuditConfigs for both `allServices` and a specific service,
+ # the union of the two AuditConfigs is used for that service: the log_types
+ # specified in each AuditConfig are enabled, and the exempted_members in each
+ # AuditLogConfig are exempted.
+ #
+ # Example Policy with multiple AuditConfigs:
+ #
+ # {
+ # "audit_configs": [
+ # {
+ # "service": "allServices"
+ # "audit_log_configs": [
+ # {
+ # "log_type": "DATA_READ",
+ # "exempted_members": [
+ # "user:jose@example.com"
+ # ]
+ # },
+ # {
+ # "log_type": "DATA_WRITE",
+ # },
+ # {
+ # "log_type": "ADMIN_READ",
+ # }
+ # ]
+ # },
+ # {
+ # "service": "sampleservice.googleapis.com"
+ # "audit_log_configs": [
+ # {
+ # "log_type": "DATA_READ",
+ # },
+ # {
+ # "log_type": "DATA_WRITE",
+ # "exempted_members": [
+ # "user:aliya@example.com"
+ # ]
+ # }
+ # ]
+ # }
+ # ]
+ # }
+ #
+ # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
+ # logging. It also exempts jose@example.com from DATA_READ logging, and
+ # aliya@example.com from DATA_WRITE logging.
+ "service": "A String", # Specifies a service that will be enabled for audit logging.
+ # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
+ # `allServices` is a special value that covers all services.
+ "auditLogConfigs": [ # The configuration for logging of each type of permission.
+ { # Provides the configuration for logging a type of permissions.
+ # Example:
+ #
+ # {
+ # "audit_log_configs": [
+ # {
+ # "log_type": "DATA_READ",
+ # "exempted_members": [
+ # "user:jose@example.com"
+ # ]
+ # },
+ # {
+ # "log_type": "DATA_WRITE",
+ # }
+ # ]
+ # }
+ #
+ # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
+ # jose@example.com from DATA_READ logging.
+ "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
+ # permission.
+ # Follows the same format of Binding.members.
+ "A String",
+ ],
+ "logType": "A String", # The log type that this config enables.
+ },
+ ],
+ },
+ ],
+ "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
# `condition` that determines how and when the `bindings` are applied. Each
# of the `bindings` must contain at least one member.
{ # Associates `members` with a `role`.
- "role": "A String", # Role that is assigned to `members`.
+ "role": "A String", # Role that is assigned to `members`.
# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
- "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.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+ #
+ # If the condition evaluates to `true`, then this binding applies to the
+ # current request.
+ #
+ # If the condition evaluates to `false`, then this binding does not apply to
+ # the current request. However, a different role binding might grant the same
+ # role to one or more of the members in this binding.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM
+ # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
# syntax. CEL is a C-like expression language. The syntax and semantics of CEL
# are documented at https://github.com/google/cel-spec.
#
# Example (Comparison):
#
- # title: "Summary size limit"
- # description: "Determines if a summary is less than 100 chars"
- # expression: "document.summary.size() < 100"
+ # 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"
+ # 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'"
+ # 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)"
+ # 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.
- "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.
- "expression": "A String", # Textual representation of an expression in Common Expression Language
- # syntax.
- "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.
- "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing
# its purpose. This can be used e.g. in UIs which allow to enter the
# expression.
+ "location": "A String", # Optional. String indicating the location of the expression for error
+ # reporting, e.g. a file name and a position in the file.
+ "description": "A String", # Optional. Description of the expression. This is a longer text which
+ # describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
},
- "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
+ "members": [ # 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
@@ -636,96 +737,11 @@
# * `domain:{domain}`: The G Suite domain (primary) that represents all the
# users of that domain. For example, `google.com` or `example.com`.
#
- "A String",
+ "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: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.
- },
- ],
- "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
+ "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
@@ -737,7 +753,7 @@
# whenever you call `setIamPolicy`. If you omit this field, then IAM allows
# you to overwrite a version `3` policy with a version `1` policy, and all of
# the conditions in the version `3` policy are lost.
- "version": 42, # Specifies the format of the policy.
+ "version": 42, # Specifies the format of the policy.
#
# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
# are rejected.
@@ -758,11 +774,14 @@
#
# If a policy does not include any conditions, operations on that policy may
# specify any valid version or leave the field unset.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(pageSize=None, pageToken=None, x__xgafv=None, filter=None)</code>
+ <code class="details" id="list">list(filter=None, pageToken=None, pageSize=None, x__xgafv=None)</code>
<pre>Lists Projects that the caller has the `resourcemanager.projects.get`
permission on and satisfy the specified filter.
@@ -781,19 +800,6 @@
difference.
Args:
- pageSize: integer, The maximum number of Projects to return in the response.
-The server can return fewer Projects than requested.
-If unspecified, server picks an appropriate default.
-
-Optional.
- pageToken: string, A pagination token returned from a previous call to ListProjects
-that indicates from where listing should continue.
-
-Optional.
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
filter: string, An expression for filtering the results of the request. Filter rules are
case insensitive. The fields eligible for filtering are:
@@ -807,13 +813,13 @@
| Filter | Description |
|------------------|-----------------------------------------------------|
-| name:how* | The project's name starts with "how". |
-| name:Howl | The project's name is `Howl` or `howl`. |
+| name:how* | The project's name starts with "how". |
+| name:Howl | The project's name is `Howl` or `howl`. |
| name:HOWL | Equivalent to above. |
| NAME:howl | Equivalent to above. |
| labels.color:* | The project has the label `color`. |
-| labels.color:red | The project's label `color` has the value `red`. |
-| labels.color:red&nbsp;labels.size:big |The project's label `color` has
+| labels.color:red | The project's label `color` has the value `red`. |
+| labels.color:red&nbsp;labels.size:big |The project's label `color` has
the value `red` and its label `size` has the value `big`. |
If no filter is specified, the call will return projects for which the user
@@ -823,10 +829,23 @@
Folder), the caller must have the `resourcemanager.projects.list`
permission on the parent and the filter must contain both a `parent.type`
and a `parent.id` restriction
-(example: "parent.type:folder parent.id:123"). In this case an alternate
+(example: "parent.type:folder parent.id:123"). In this case an alternate
search index is used which provides more consistent results.
Optional.
+ pageToken: string, A pagination token returned from a previous call to ListProjects
+that indicates from where listing should continue.
+
+Optional.
+ pageSize: integer, The maximum number of Projects to return in the response.
+The server can return fewer Projects than requested.
+If unspecified, server picks an appropriate default.
+
+Optional.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
Returns:
An object of the form:
@@ -838,53 +857,35 @@
# A paginated response where more pages are available has
# `next_page_token` set. This token can be used in a subsequent request to
# retrieve the next request page.
- "nextPageToken": "A String", # Pagination token.
- #
- # If the result set is too large to fit in a single response, this token
- # is returned. It encodes the position of the current result cursor.
- # Feeding this value into a new list request with the `page_token` parameter
- # gives the next page of the results.
- #
- # When `next_page_token` is not filled in, there is no next page and
- # the list returned is the last page in the result set.
- #
- # Pagination tokens have a limited lifetime.
- "projects": [ # The list of Projects that matched the list filter. This list can
+ "projects": [ # The list of Projects that matched the list filter. This list can
# be paginated.
{ # A Project is a high-level Google Cloud Platform entity. It is a
# container for ACLs, APIs, App Engine Apps, VMs, and other
# Google Cloud Platform resources.
- "name": "A String", # The optional user-assigned display name of the Project.
- # When present it must be between 4 to 30 characters.
- # Allowed characters are: lowercase and uppercase letters, numbers,
- # hyphen, single-quote, double-quote, space, and exclamation point.
+ "lifecycleState": "A String", # The Project lifecycle state.
#
- # Example: <code>My Project</code>
- # Read-write.
- "parent": { # A container to reference an id for any resource type. A `resource` in Google # An optional reference to a parent Resource.
+ # Read-only.
+ "projectNumber": "A String", # The number uniquely identifying the project.
#
- # Supported parent types include "organization" and "folder". Once set, the
+ # Example: <code>415104041262</code>
+ # Read-only.
+ "parent": { # A container to reference an id for any resource type. A `resource` in Google # An optional reference to a parent Resource.
+ #
+ # Supported parent types include "organization" and "folder". Once set, the
# parent cannot be cleared. The `parent` can be set on creation or using the
# `UpdateProject` method; the end user must have the
# `resourcemanager.projects.create` permission on the parent.
#
# Read-write.
# Cloud Platform is a generic term for something you (a developer) may want to
- # interact with through one of our API's. Some examples are an App Engine app,
+ # interact with through one of our API's. Some examples are an App Engine app,
# a Compute Engine instance, a Cloud SQL database, and so on.
- "type": "A String", # Required field representing the resource type this id is for.
- # At present, the valid types are "project", "folder", and "organization".
- "id": "A String", # Required field for the type-specific id. This should correspond to the id
- # used in the type-specific API's.
+ "type": "A String", # Required field representing the resource type this id is for.
+ # At present, the valid types are "project", "folder", and "organization".
+ "id": "A String", # Required field for the type-specific id. This should correspond to the id
+ # used in the type-specific API's.
},
- "projectId": "A String", # The unique, user-assigned ID of the Project.
- # It must be 6 to 30 lowercase letters, digits, or hyphens.
- # It must start with a letter.
- # Trailing hyphens are prohibited.
- #
- # Example: <code>tokyo-rain-123</code>
- # Read-only after creation.
- "labels": { # The labels associated with this Project.
+ "labels": { # The labels associated with this Project.
#
# Label keys must be between 1 and 63 characters long and must conform
# to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?.
@@ -898,22 +899,40 @@
# Clients should store labels in a representation such as JSON that does not
# depend on specific characters being disallowed.
#
- # Example: <code>"environment" : "dev"</code>
+ # Example: <code>"environment" : "dev"</code>
# Read-write.
- "a_key": "A String",
+ "a_key": "A String",
},
- "createTime": "A String", # Creation time.
+ "createTime": "A String", # Creation time.
#
# Read-only.
- "lifecycleState": "A String", # The Project lifecycle state.
+ "name": "A String", # The optional user-assigned display name of the Project.
+ # When present it must be between 4 to 30 characters.
+ # Allowed characters are: lowercase and uppercase letters, numbers,
+ # hyphen, single-quote, double-quote, space, and exclamation point.
#
- # Read-only.
- "projectNumber": "A String", # The number uniquely identifying the project.
+ # Example: <code>My Project</code>
+ # Read-write.
+ "projectId": "A String", # The unique, user-assigned ID of the Project.
+ # It must be 6 to 30 lowercase letters, digits, or hyphens.
+ # It must start with a letter.
+ # Trailing hyphens are prohibited.
#
- # Example: <code>415104041262</code>
- # Read-only.
+ # Example: <code>tokyo-rain-123</code>
+ # Read-only after creation.
},
],
+ "nextPageToken": "A String", # Pagination token.
+ #
+ # If the result set is too large to fit in a single response, this token
+ # is returned. It encodes the position of the current result cursor.
+ # Feeding this value into a new list request with the `page_token` parameter
+ # gives the next page of the results.
+ #
+ # When `next_page_token` is not filled in, there is no next page and
+ # the list returned is the last page in the result set.
+ #
+ # Pagination tokens have a limited lifetime.
}</pre>
</div>
@@ -926,7 +945,7 @@
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
+ 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>
@@ -984,7 +1003,7 @@
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
+ "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.
@@ -997,36 +1016,40 @@
# 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.
+ # For some types of Google Cloud resources, a `binding` can also specify a
+ # `condition`, which is a logical expression that allows access to a resource
+ # only if the expression evaluates to `true`. A condition can add constraints
+ # based on attributes of the request, the resource, or both. To learn which
+ # resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
#
# **JSON example:**
#
# {
- # "bindings": [
+ # "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.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')",
+ # "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
+ # "etag": "BwWWja0YfJA=",
+ # "version": 3
# }
#
# **YAML example:**
@@ -1044,63 +1067,156 @@
# condition:
# title: expirable access
# description: Does not grant access after Sep 2020
- # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+ # 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/).
- "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
+ "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+ { # Specifies the audit configuration for a service.
+ # The configuration determines which permission types are logged, and what
+ # identities, if any, are exempted from logging.
+ # An AuditConfig must have one or more AuditLogConfigs.
+ #
+ # If there are AuditConfigs for both `allServices` and a specific service,
+ # the union of the two AuditConfigs is used for that service: the log_types
+ # specified in each AuditConfig are enabled, and the exempted_members in each
+ # AuditLogConfig are exempted.
+ #
+ # Example Policy with multiple AuditConfigs:
+ #
+ # {
+ # "audit_configs": [
+ # {
+ # "service": "allServices"
+ # "audit_log_configs": [
+ # {
+ # "log_type": "DATA_READ",
+ # "exempted_members": [
+ # "user:jose@example.com"
+ # ]
+ # },
+ # {
+ # "log_type": "DATA_WRITE",
+ # },
+ # {
+ # "log_type": "ADMIN_READ",
+ # }
+ # ]
+ # },
+ # {
+ # "service": "sampleservice.googleapis.com"
+ # "audit_log_configs": [
+ # {
+ # "log_type": "DATA_READ",
+ # },
+ # {
+ # "log_type": "DATA_WRITE",
+ # "exempted_members": [
+ # "user:aliya@example.com"
+ # ]
+ # }
+ # ]
+ # }
+ # ]
+ # }
+ #
+ # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
+ # logging. It also exempts jose@example.com from DATA_READ logging, and
+ # aliya@example.com from DATA_WRITE logging.
+ "service": "A String", # Specifies a service that will be enabled for audit logging.
+ # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
+ # `allServices` is a special value that covers all services.
+ "auditLogConfigs": [ # The configuration for logging of each type of permission.
+ { # Provides the configuration for logging a type of permissions.
+ # Example:
+ #
+ # {
+ # "audit_log_configs": [
+ # {
+ # "log_type": "DATA_READ",
+ # "exempted_members": [
+ # "user:jose@example.com"
+ # ]
+ # },
+ # {
+ # "log_type": "DATA_WRITE",
+ # }
+ # ]
+ # }
+ #
+ # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
+ # jose@example.com from DATA_READ logging.
+ "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
+ # permission.
+ # Follows the same format of Binding.members.
+ "A String",
+ ],
+ "logType": "A String", # The log type that this config enables.
+ },
+ ],
+ },
+ ],
+ "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
# `condition` that determines how and when the `bindings` are applied. Each
# of the `bindings` must contain at least one member.
{ # Associates `members` with a `role`.
- "role": "A String", # Role that is assigned to `members`.
+ "role": "A String", # Role that is assigned to `members`.
# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
- "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.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+ #
+ # If the condition evaluates to `true`, then this binding applies to the
+ # current request.
+ #
+ # If the condition evaluates to `false`, then this binding does not apply to
+ # the current request. However, a different role binding might grant the same
+ # role to one or more of the members in this binding.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM
+ # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
# syntax. CEL is a C-like expression language. The syntax and semantics of CEL
# are documented at https://github.com/google/cel-spec.
#
# Example (Comparison):
#
- # title: "Summary size limit"
- # description: "Determines if a summary is less than 100 chars"
- # expression: "document.summary.size() < 100"
+ # 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"
+ # 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'"
+ # 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)"
+ # 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.
- "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.
- "expression": "A String", # Textual representation of an expression in Common Expression Language
- # syntax.
- "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.
- "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing
# its purpose. This can be used e.g. in UIs which allow to enter the
# expression.
+ "location": "A String", # Optional. String indicating the location of the expression for error
+ # reporting, e.g. a file name and a position in the file.
+ "description": "A String", # Optional. Description of the expression. This is a longer text which
+ # describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
},
- "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
+ "members": [ # 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
@@ -1143,96 +1259,11 @@
# * `domain:{domain}`: The G Suite domain (primary) that represents all the
# users of that domain. For example, `google.com` or `example.com`.
#
- "A String",
+ "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: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.
- },
- ],
- "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
+ "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
@@ -1244,7 +1275,7 @@
# whenever you call `setIamPolicy`. If you omit this field, then IAM allows
# you to overwrite a version `3` policy with a version `1` policy, and all of
# the conditions in the version `3` policy are lost.
- "version": 42, # Specifies the format of the policy.
+ "version": 42, # Specifies the format of the policy.
#
# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
# are rejected.
@@ -1265,12 +1296,15 @@
#
# If a policy does not include any conditions, operations on that policy may
# specify any valid version or leave the field unset.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
},
- "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
+ "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"`
+ # `paths: "bindings, etag"`
}
x__xgafv: string, V1 error format.
@@ -1291,36 +1325,40 @@
# 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.
+ # For some types of Google Cloud resources, a `binding` can also specify a
+ # `condition`, which is a logical expression that allows access to a resource
+ # only if the expression evaluates to `true`. A condition can add constraints
+ # based on attributes of the request, the resource, or both. To learn which
+ # resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
#
# **JSON example:**
#
# {
- # "bindings": [
+ # "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.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')",
+ # "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
+ # "etag": "BwWWja0YfJA=",
+ # "version": 3
# }
#
# **YAML example:**
@@ -1338,63 +1376,156 @@
# condition:
# title: expirable access
# description: Does not grant access after Sep 2020
- # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+ # 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/).
- "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
+ "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+ { # Specifies the audit configuration for a service.
+ # The configuration determines which permission types are logged, and what
+ # identities, if any, are exempted from logging.
+ # An AuditConfig must have one or more AuditLogConfigs.
+ #
+ # If there are AuditConfigs for both `allServices` and a specific service,
+ # the union of the two AuditConfigs is used for that service: the log_types
+ # specified in each AuditConfig are enabled, and the exempted_members in each
+ # AuditLogConfig are exempted.
+ #
+ # Example Policy with multiple AuditConfigs:
+ #
+ # {
+ # "audit_configs": [
+ # {
+ # "service": "allServices"
+ # "audit_log_configs": [
+ # {
+ # "log_type": "DATA_READ",
+ # "exempted_members": [
+ # "user:jose@example.com"
+ # ]
+ # },
+ # {
+ # "log_type": "DATA_WRITE",
+ # },
+ # {
+ # "log_type": "ADMIN_READ",
+ # }
+ # ]
+ # },
+ # {
+ # "service": "sampleservice.googleapis.com"
+ # "audit_log_configs": [
+ # {
+ # "log_type": "DATA_READ",
+ # },
+ # {
+ # "log_type": "DATA_WRITE",
+ # "exempted_members": [
+ # "user:aliya@example.com"
+ # ]
+ # }
+ # ]
+ # }
+ # ]
+ # }
+ #
+ # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
+ # logging. It also exempts jose@example.com from DATA_READ logging, and
+ # aliya@example.com from DATA_WRITE logging.
+ "service": "A String", # Specifies a service that will be enabled for audit logging.
+ # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
+ # `allServices` is a special value that covers all services.
+ "auditLogConfigs": [ # The configuration for logging of each type of permission.
+ { # Provides the configuration for logging a type of permissions.
+ # Example:
+ #
+ # {
+ # "audit_log_configs": [
+ # {
+ # "log_type": "DATA_READ",
+ # "exempted_members": [
+ # "user:jose@example.com"
+ # ]
+ # },
+ # {
+ # "log_type": "DATA_WRITE",
+ # }
+ # ]
+ # }
+ #
+ # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
+ # jose@example.com from DATA_READ logging.
+ "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
+ # permission.
+ # Follows the same format of Binding.members.
+ "A String",
+ ],
+ "logType": "A String", # The log type that this config enables.
+ },
+ ],
+ },
+ ],
+ "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
# `condition` that determines how and when the `bindings` are applied. Each
# of the `bindings` must contain at least one member.
{ # Associates `members` with a `role`.
- "role": "A String", # Role that is assigned to `members`.
+ "role": "A String", # Role that is assigned to `members`.
# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
- "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.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+ #
+ # If the condition evaluates to `true`, then this binding applies to the
+ # current request.
+ #
+ # If the condition evaluates to `false`, then this binding does not apply to
+ # the current request. However, a different role binding might grant the same
+ # role to one or more of the members in this binding.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM
+ # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
# syntax. CEL is a C-like expression language. The syntax and semantics of CEL
# are documented at https://github.com/google/cel-spec.
#
# Example (Comparison):
#
- # title: "Summary size limit"
- # description: "Determines if a summary is less than 100 chars"
- # expression: "document.summary.size() < 100"
+ # 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"
+ # 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'"
+ # 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)"
+ # 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.
- "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.
- "expression": "A String", # Textual representation of an expression in Common Expression Language
- # syntax.
- "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.
- "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing
# its purpose. This can be used e.g. in UIs which allow to enter the
# expression.
+ "location": "A String", # Optional. String indicating the location of the expression for error
+ # reporting, e.g. a file name and a position in the file.
+ "description": "A String", # Optional. Description of the expression. This is a longer text which
+ # describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
},
- "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
+ "members": [ # 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
@@ -1437,96 +1568,11 @@
# * `domain:{domain}`: The G Suite domain (primary) that represents all the
# users of that domain. For example, `google.com` or `example.com`.
#
- "A String",
+ "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: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.
- },
- ],
- "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
+ "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
@@ -1538,7 +1584,7 @@
# whenever you call `setIamPolicy`. If you omit this field, then IAM allows
# you to overwrite a version `3` policy with a version `1` policy, and all of
# the conditions in the version `3` policy are lost.
- "version": 42, # Specifies the format of the policy.
+ "version": 42, # Specifies the format of the policy.
#
# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
# are rejected.
@@ -1559,6 +1605,9 @@
#
# If a policy does not include any conditions, operations on that policy may
# specify any valid version or leave the field unset.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
}</pre>
</div>
@@ -1573,11 +1622,11 @@
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
+ "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",
+ "A String",
],
}
@@ -1590,9 +1639,9 @@
An object of the form:
{ # Response message for `TestIamPermissions` method.
- "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
# allowed.
- "A String",
+ "A String",
],
}</pre>
</div>
@@ -1655,37 +1704,30 @@
{ # A Project is a high-level Google Cloud Platform entity. It is a
# container for ACLs, APIs, App Engine Apps, VMs, and other
# Google Cloud Platform resources.
- "name": "A String", # The optional user-assigned display name of the Project.
- # When present it must be between 4 to 30 characters.
- # Allowed characters are: lowercase and uppercase letters, numbers,
- # hyphen, single-quote, double-quote, space, and exclamation point.
+ "lifecycleState": "A String", # The Project lifecycle state.
#
- # Example: <code>My Project</code>
- # Read-write.
- "parent": { # A container to reference an id for any resource type. A `resource` in Google # An optional reference to a parent Resource.
+ # Read-only.
+ "projectNumber": "A String", # The number uniquely identifying the project.
#
- # Supported parent types include "organization" and "folder". Once set, the
+ # Example: <code>415104041262</code>
+ # Read-only.
+ "parent": { # A container to reference an id for any resource type. A `resource` in Google # An optional reference to a parent Resource.
+ #
+ # Supported parent types include "organization" and "folder". Once set, the
# parent cannot be cleared. The `parent` can be set on creation or using the
# `UpdateProject` method; the end user must have the
# `resourcemanager.projects.create` permission on the parent.
#
# Read-write.
# Cloud Platform is a generic term for something you (a developer) may want to
- # interact with through one of our API's. Some examples are an App Engine app,
+ # interact with through one of our API's. Some examples are an App Engine app,
# a Compute Engine instance, a Cloud SQL database, and so on.
- "type": "A String", # Required field representing the resource type this id is for.
- # At present, the valid types are "project", "folder", and "organization".
- "id": "A String", # Required field for the type-specific id. This should correspond to the id
- # used in the type-specific API's.
+ "type": "A String", # Required field representing the resource type this id is for.
+ # At present, the valid types are "project", "folder", and "organization".
+ "id": "A String", # Required field for the type-specific id. This should correspond to the id
+ # used in the type-specific API's.
},
- "projectId": "A String", # The unique, user-assigned ID of the Project.
- # It must be 6 to 30 lowercase letters, digits, or hyphens.
- # It must start with a letter.
- # Trailing hyphens are prohibited.
- #
- # Example: <code>tokyo-rain-123</code>
- # Read-only after creation.
- "labels": { # The labels associated with this Project.
+ "labels": { # The labels associated with this Project.
#
# Label keys must be between 1 and 63 characters long and must conform
# to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?.
@@ -1699,20 +1741,27 @@
# Clients should store labels in a representation such as JSON that does not
# depend on specific characters being disallowed.
#
- # Example: <code>"environment" : "dev"</code>
+ # Example: <code>"environment" : "dev"</code>
# Read-write.
- "a_key": "A String",
+ "a_key": "A String",
},
- "createTime": "A String", # Creation time.
+ "createTime": "A String", # Creation time.
#
# Read-only.
- "lifecycleState": "A String", # The Project lifecycle state.
+ "name": "A String", # The optional user-assigned display name of the Project.
+ # When present it must be between 4 to 30 characters.
+ # Allowed characters are: lowercase and uppercase letters, numbers,
+ # hyphen, single-quote, double-quote, space, and exclamation point.
#
- # Read-only.
- "projectNumber": "A String", # The number uniquely identifying the project.
+ # Example: <code>My Project</code>
+ # Read-write.
+ "projectId": "A String", # The unique, user-assigned ID of the Project.
+ # It must be 6 to 30 lowercase letters, digits, or hyphens.
+ # It must start with a letter.
+ # Trailing hyphens are prohibited.
#
- # Example: <code>415104041262</code>
- # Read-only.
+ # Example: <code>tokyo-rain-123</code>
+ # Read-only after creation.
}
x__xgafv: string, V1 error format.
@@ -1726,37 +1775,30 @@
{ # A Project is a high-level Google Cloud Platform entity. It is a
# container for ACLs, APIs, App Engine Apps, VMs, and other
# Google Cloud Platform resources.
- "name": "A String", # The optional user-assigned display name of the Project.
- # When present it must be between 4 to 30 characters.
- # Allowed characters are: lowercase and uppercase letters, numbers,
- # hyphen, single-quote, double-quote, space, and exclamation point.
+ "lifecycleState": "A String", # The Project lifecycle state.
#
- # Example: <code>My Project</code>
- # Read-write.
- "parent": { # A container to reference an id for any resource type. A `resource` in Google # An optional reference to a parent Resource.
+ # Read-only.
+ "projectNumber": "A String", # The number uniquely identifying the project.
#
- # Supported parent types include "organization" and "folder". Once set, the
+ # Example: <code>415104041262</code>
+ # Read-only.
+ "parent": { # A container to reference an id for any resource type. A `resource` in Google # An optional reference to a parent Resource.
+ #
+ # Supported parent types include "organization" and "folder". Once set, the
# parent cannot be cleared. The `parent` can be set on creation or using the
# `UpdateProject` method; the end user must have the
# `resourcemanager.projects.create` permission on the parent.
#
# Read-write.
# Cloud Platform is a generic term for something you (a developer) may want to
- # interact with through one of our API's. Some examples are an App Engine app,
+ # interact with through one of our API's. Some examples are an App Engine app,
# a Compute Engine instance, a Cloud SQL database, and so on.
- "type": "A String", # Required field representing the resource type this id is for.
- # At present, the valid types are "project", "folder", and "organization".
- "id": "A String", # Required field for the type-specific id. This should correspond to the id
- # used in the type-specific API's.
+ "type": "A String", # Required field representing the resource type this id is for.
+ # At present, the valid types are "project", "folder", and "organization".
+ "id": "A String", # Required field for the type-specific id. This should correspond to the id
+ # used in the type-specific API's.
},
- "projectId": "A String", # The unique, user-assigned ID of the Project.
- # It must be 6 to 30 lowercase letters, digits, or hyphens.
- # It must start with a letter.
- # Trailing hyphens are prohibited.
- #
- # Example: <code>tokyo-rain-123</code>
- # Read-only after creation.
- "labels": { # The labels associated with this Project.
+ "labels": { # The labels associated with this Project.
#
# Label keys must be between 1 and 63 characters long and must conform
# to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?.
@@ -1770,20 +1812,27 @@
# Clients should store labels in a representation such as JSON that does not
# depend on specific characters being disallowed.
#
- # Example: <code>"environment" : "dev"</code>
+ # Example: <code>"environment" : "dev"</code>
# Read-write.
- "a_key": "A String",
+ "a_key": "A String",
},
- "createTime": "A String", # Creation time.
+ "createTime": "A String", # Creation time.
#
# Read-only.
- "lifecycleState": "A String", # The Project lifecycle state.
+ "name": "A String", # The optional user-assigned display name of the Project.
+ # When present it must be between 4 to 30 characters.
+ # Allowed characters are: lowercase and uppercase letters, numbers,
+ # hyphen, single-quote, double-quote, space, and exclamation point.
#
- # Read-only.
- "projectNumber": "A String", # The number uniquely identifying the project.
+ # Example: <code>My Project</code>
+ # Read-write.
+ "projectId": "A String", # The unique, user-assigned ID of the Project.
+ # It must be 6 to 30 lowercase letters, digits, or hyphens.
+ # It must start with a letter.
+ # Trailing hyphens are prohibited.
#
- # Example: <code>415104041262</code>
- # Read-only.
+ # Example: <code>tokyo-rain-123</code>
+ # Read-only after creation.
}</pre>
</div>