docs: update generated docs (#981)
diff --git a/docs/dyn/cloudresourcemanager_v1beta1.projects.html b/docs/dyn/cloudresourcemanager_v1beta1.projects.html
index 62e0738..af203e5 100644
--- a/docs/dyn/cloudresourcemanager_v1beta1.projects.html
+++ b/docs/dyn/cloudresourcemanager_v1beta1.projects.html
@@ -90,14 +90,14 @@
<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(filter=None, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(filter=None, pageSize=None, pageToken=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>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Sets the IAM access control policy for the specified Project. Overwrites</p>
+<p class="firstline">Sets the IAM access control policy for the specified Project.</p>
<p class="toc_element">
<code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns permissions that a caller has on the specified Project.</p>
@@ -133,13 +133,6 @@
{ # 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.
- #
- # 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.
@@ -147,13 +140,33 @@
#
# Example: <code>tokyo-rain-123</code>
# Read-only after creation.
- "lifecycleState": "A String", # The Project lifecycle state.
+ "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{0,62}.
+ #
+ # Label values must be between 0 and 63 characters long and must conform
+ # to the regular expression [a-z0-9_-]{0,63}. A label value can be empty.
+ #
+ # No more than 256 labels can be associated with a given resource.
+ #
+ # Clients should store labels in a representation such as JSON that does not
+ # depend on specific characters being disallowed.
+ #
+ # Example: <code>"environment" : "dev"</code>
+ # Read-write.
+ "a_key": "A String",
+ },
+ "createTime": "A String", # Creation time.
#
# Read-only.
"projectNumber": "A String", # The number uniquely identifying the project.
#
# Example: <code>415104041262</code>
# Read-only.
+ "lifecycleState": "A String", # The Project lifecycle state.
+ #
+ # 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
@@ -165,32 +178,18 @@
# 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,
# 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".
},
- "createTime": "A String", # Creation time.
+ "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.
- "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\])?.
- #
- # Label values must be between 0 and 63 characters long and must conform
- # to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. A label
- # value can be empty.
- #
- # No more than 256 labels can be associated with a given resource.
- #
- # 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>My Project</code>
# Read-write.
- "a_key": "A String",
- },
}
useLegacyStack: boolean, A now unused experiment opt-out option.
@@ -205,13 +204,6 @@
{ # 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.
- #
- # 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.
@@ -219,13 +211,33 @@
#
# Example: <code>tokyo-rain-123</code>
# Read-only after creation.
- "lifecycleState": "A String", # The Project lifecycle state.
+ "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{0,62}.
+ #
+ # Label values must be between 0 and 63 characters long and must conform
+ # to the regular expression [a-z0-9_-]{0,63}. A label value can be empty.
+ #
+ # No more than 256 labels can be associated with a given resource.
+ #
+ # Clients should store labels in a representation such as JSON that does not
+ # depend on specific characters being disallowed.
+ #
+ # Example: <code>"environment" : "dev"</code>
+ # Read-write.
+ "a_key": "A String",
+ },
+ "createTime": "A String", # Creation time.
#
# Read-only.
"projectNumber": "A String", # The number uniquely identifying the project.
#
# Example: <code>415104041262</code>
# Read-only.
+ "lifecycleState": "A String", # The Project lifecycle state.
+ #
+ # 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
@@ -237,32 +249,18 @@
# 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,
# 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".
},
- "createTime": "A String", # Creation time.
+ "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.
- "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\])?.
- #
- # Label values must be between 0 and 63 characters long and must conform
- # to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. A label
- # value can be empty.
- #
- # No more than 256 labels can be associated with a given resource.
- #
- # 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>My Project</code>
# Read-write.
- "a_key": "A String",
- },
}</pre>
</div>
@@ -337,13 +335,6 @@
{ # 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.
- #
- # 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.
@@ -351,13 +342,33 @@
#
# Example: <code>tokyo-rain-123</code>
# Read-only after creation.
- "lifecycleState": "A String", # The Project lifecycle state.
+ "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{0,62}.
+ #
+ # Label values must be between 0 and 63 characters long and must conform
+ # to the regular expression [a-z0-9_-]{0,63}. A label value can be empty.
+ #
+ # No more than 256 labels can be associated with a given resource.
+ #
+ # Clients should store labels in a representation such as JSON that does not
+ # depend on specific characters being disallowed.
+ #
+ # Example: <code>"environment" : "dev"</code>
+ # Read-write.
+ "a_key": "A String",
+ },
+ "createTime": "A String", # Creation time.
#
# Read-only.
"projectNumber": "A String", # The number uniquely identifying the project.
#
# Example: <code>415104041262</code>
# Read-only.
+ "lifecycleState": "A String", # The Project lifecycle state.
+ #
+ # 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
@@ -369,32 +380,18 @@
# 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,
# 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".
},
- "createTime": "A String", # Creation time.
+ "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.
- "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\])?.
- #
- # Label values must be between 0 and 63 characters long and must conform
- # to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. A label
- # value can be empty.
- #
- # No more than 256 labels can be associated with a given resource.
- #
- # 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>My Project</code>
# Read-write.
- "a_key": "A String",
- },
}</pre>
</div>
@@ -413,7 +410,7 @@
The object takes the form of:
{ # The request sent to the
- # GetAncestry
+ # [google.cloudresourcemanager.projects.v1beta1.DeveloperProjects.GetAncestry]
# method.
}
@@ -425,7 +422,9 @@
Returns:
An object of the form:
- { # Response from the GetAncestry method.
+ { # Response from the
+ # projects.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,
# etc.
@@ -434,10 +433,10 @@
# 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,
# 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".
},
},
],
@@ -551,6 +550,42 @@
#
# For a description of IAM and its features, see the
# [IAM documentation](https://cloud.google.com/iam/docs/).
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
+ # prevent simultaneous updates of a policy from overwriting each other.
+ # It is strongly suggested that systems make use of the `etag` in the
+ # read-modify-write cycle to perform policy updates in order to avoid race
+ # conditions: An `etag` is returned in the response to `getIamPolicy`, and
+ # systems are expected to put that etag in the request to `setIamPolicy` to
+ # ensure that their change will be applied to the same version of the policy.
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ "version": 42, # Specifies the format of the policy.
+ #
+ # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
+ # are rejected.
+ #
+ # Any operation that affects conditional role bindings must specify version
+ # `3`. This requirement applies to the following operations:
+ #
+ # * Getting a policy that includes a conditional role binding
+ # * Adding a conditional role binding to a policy
+ # * Changing a conditional role binding in a policy
+ # * Removing any role binding, with or without a condition, from a policy
+ # that includes conditions
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ #
+ # If a policy does not include any conditions, operations on that policy may
+ # specify any valid version or leave the field unset.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
"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.
@@ -601,11 +636,11 @@
# documentation for additional information.
"expression": "A String", # Textual representation of an expression in Common Expression Language
# syntax.
+ "location": "A String", # Optional. String indicating the location of the expression for error
+ # reporting, e.g. a file name and a position in the file.
"title": "A String", # Optional. Title for the expression, i.e. a short string describing
# its purpose. This can be used e.g. in UIs which allow to enter the
# expression.
- "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.
},
@@ -656,42 +691,6 @@
],
},
],
- "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
- # prevent simultaneous updates of a policy from overwriting each other.
- # It is strongly suggested that systems make use of the `etag` in the
- # read-modify-write cycle to perform policy updates in order to avoid race
- # conditions: An `etag` is returned in the response to `getIamPolicy`, and
- # systems are expected to put that etag in the request to `setIamPolicy` to
- # ensure that their change will be applied to the same version of the policy.
- #
- # **Important:** If you use IAM Conditions, you must include the `etag` field
- # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
- # you to overwrite a version `3` policy with a version `1` policy, and all of
- # the conditions in the version `3` policy are lost.
- "version": 42, # Specifies the format of the policy.
- #
- # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
- # are rejected.
- #
- # Any operation that affects conditional role bindings must specify version
- # `3`. This requirement applies to the following operations:
- #
- # * Getting a policy that includes a conditional role binding
- # * Adding a conditional role binding to a policy
- # * Changing a conditional role binding in a policy
- # * Removing any role binding, with or without a condition, from a policy
- # that includes conditions
- #
- # **Important:** If you use IAM Conditions, you must include the `etag` field
- # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
- # you to overwrite a version `3` policy with a version `1` policy, and all of
- # the conditions in the version `3` policy are lost.
- #
- # If a policy does not include any conditions, operations on that policy may
- # specify any valid version or leave the field unset.
- #
- # To learn which resources support conditions in their IAM policies, see the
- # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
{ # Specifies the audit configuration for a service.
# The configuration determines which permission types are logged, and what
@@ -708,7 +707,7 @@
# {
# "audit_configs": [
# {
- # "service": "allServices"
+ # "service": "allServices",
# "audit_log_configs": [
# {
# "log_type": "DATA_READ",
@@ -717,18 +716,18 @@
# ]
# },
# {
- # "log_type": "DATA_WRITE",
+ # "log_type": "DATA_WRITE"
# },
# {
- # "log_type": "ADMIN_READ",
+ # "log_type": "ADMIN_READ"
# }
# ]
# },
# {
- # "service": "sampleservice.googleapis.com"
+ # "service": "sampleservice.googleapis.com",
# "audit_log_configs": [
# {
- # "log_type": "DATA_READ",
+ # "log_type": "DATA_READ"
# },
# {
# "log_type": "DATA_WRITE",
@@ -744,6 +743,9 @@
# 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:
@@ -757,7 +759,7 @@
# ]
# },
# {
- # "log_type": "DATA_WRITE",
+ # "log_type": "DATA_WRITE"
# }
# ]
# }
@@ -772,16 +774,13 @@
"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.
},
],
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(filter=None, pageToken=None, pageSize=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists Projects that the caller has the `resourcemanager.projects.get`
permission on and satisfy the specified filter.
@@ -833,15 +832,15 @@
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.
+ 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
@@ -857,18 +856,22 @@
# 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
# 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.
- #
- # 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.
@@ -876,13 +879,33 @@
#
# Example: <code>tokyo-rain-123</code>
# Read-only after creation.
- "lifecycleState": "A String", # The Project lifecycle state.
+ "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{0,62}.
+ #
+ # Label values must be between 0 and 63 characters long and must conform
+ # to the regular expression [a-z0-9_-]{0,63}. A label value can be empty.
+ #
+ # No more than 256 labels can be associated with a given resource.
+ #
+ # Clients should store labels in a representation such as JSON that does not
+ # depend on specific characters being disallowed.
+ #
+ # Example: <code>"environment" : "dev"</code>
+ # Read-write.
+ "a_key": "A String",
+ },
+ "createTime": "A String", # Creation time.
#
# Read-only.
"projectNumber": "A String", # The number uniquely identifying the project.
#
# Example: <code>415104041262</code>
# Read-only.
+ "lifecycleState": "A String", # The Project lifecycle state.
+ #
+ # 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
@@ -894,45 +917,20 @@
# 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,
# 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".
},
- "createTime": "A String", # Creation time.
+ "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.
- "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\])?.
- #
- # Label values must be between 0 and 63 characters long and must conform
- # to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. A label
- # value can be empty.
- #
- # No more than 256 labels can be associated with a given resource.
- #
- # 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>My Project</code>
# Read-write.
- "a_key": "A String",
- },
},
],
- "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>
@@ -952,8 +950,14 @@
<div class="method">
<code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code>
- <pre>Sets the IAM access control policy for the specified Project. Overwrites
-any existing policy.
+ <pre>Sets the IAM access control policy for the specified Project.
+
+CAUTION: This method will replace the existing policy, and cannot be used
+to append additional IAM settings.
+
+NOTE: Removing service accounts from policies or changing their roles can
+render services completely inoperable. It is important to understand how
+the service account is being used before removing or updating its roles.
The following constraints apply when using `setIamPolicy()`:
@@ -988,13 +992,8 @@
IAM policies will be rejected until the lack of a ToS-accepting owner is
rectified.
-+ This method will replace the existing policy, and cannot be used to
-append additional IAM settings.
-
-Note: Removing service accounts from policies or changing their roles
-can render services completely inoperable. It is important to understand
-how the service account is being used before removing or updating its
-roles.
+Authorization requires the Google IAM permission
+`resourcemanager.projects.setIamPolicy` on the project
Args:
resource: string, REQUIRED: The resource for which the policy is being specified.
@@ -1003,6 +1002,11 @@
The object takes the form of:
{ # Request message for `SetIamPolicy` method.
+ "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
+ # the fields in the mask will be modified. If no mask is provided, the
+ # following default mask is used:
+ #
+ # `paths: "bindings, etag"`
"policy": { # An Identity and Access Management (IAM) policy, which specifies access # REQUIRED: The complete policy to be applied to the `resource`. The size of
# the policy is limited to a few 10s of KB. An empty policy is a
# valid policy but certain Cloud Platform services (such as Projects)
@@ -1073,6 +1077,42 @@
#
# For a description of IAM and its features, see the
# [IAM documentation](https://cloud.google.com/iam/docs/).
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
+ # prevent simultaneous updates of a policy from overwriting each other.
+ # It is strongly suggested that systems make use of the `etag` in the
+ # read-modify-write cycle to perform policy updates in order to avoid race
+ # conditions: An `etag` is returned in the response to `getIamPolicy`, and
+ # systems are expected to put that etag in the request to `setIamPolicy` to
+ # ensure that their change will be applied to the same version of the policy.
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ "version": 42, # Specifies the format of the policy.
+ #
+ # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
+ # are rejected.
+ #
+ # Any operation that affects conditional role bindings must specify version
+ # `3`. This requirement applies to the following operations:
+ #
+ # * Getting a policy that includes a conditional role binding
+ # * Adding a conditional role binding to a policy
+ # * Changing a conditional role binding in a policy
+ # * Removing any role binding, with or without a condition, from a policy
+ # that includes conditions
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ #
+ # If a policy does not include any conditions, operations on that policy may
+ # specify any valid version or leave the field unset.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
"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.
@@ -1123,11 +1163,11 @@
# documentation for additional information.
"expression": "A String", # Textual representation of an expression in Common Expression Language
# syntax.
+ "location": "A String", # Optional. String indicating the location of the expression for error
+ # reporting, e.g. a file name and a position in the file.
"title": "A String", # Optional. Title for the expression, i.e. a short string describing
# its purpose. This can be used e.g. in UIs which allow to enter the
# expression.
- "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.
},
@@ -1178,42 +1218,6 @@
],
},
],
- "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
- # prevent simultaneous updates of a policy from overwriting each other.
- # It is strongly suggested that systems make use of the `etag` in the
- # read-modify-write cycle to perform policy updates in order to avoid race
- # conditions: An `etag` is returned in the response to `getIamPolicy`, and
- # systems are expected to put that etag in the request to `setIamPolicy` to
- # ensure that their change will be applied to the same version of the policy.
- #
- # **Important:** If you use IAM Conditions, you must include the `etag` field
- # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
- # you to overwrite a version `3` policy with a version `1` policy, and all of
- # the conditions in the version `3` policy are lost.
- "version": 42, # Specifies the format of the policy.
- #
- # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
- # are rejected.
- #
- # Any operation that affects conditional role bindings must specify version
- # `3`. This requirement applies to the following operations:
- #
- # * Getting a policy that includes a conditional role binding
- # * Adding a conditional role binding to a policy
- # * Changing a conditional role binding in a policy
- # * Removing any role binding, with or without a condition, from a policy
- # that includes conditions
- #
- # **Important:** If you use IAM Conditions, you must include the `etag` field
- # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
- # you to overwrite a version `3` policy with a version `1` policy, and all of
- # the conditions in the version `3` policy are lost.
- #
- # If a policy does not include any conditions, operations on that policy may
- # specify any valid version or leave the field unset.
- #
- # To learn which resources support conditions in their IAM policies, see the
- # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
{ # Specifies the audit configuration for a service.
# The configuration determines which permission types are logged, and what
@@ -1230,7 +1234,7 @@
# {
# "audit_configs": [
# {
- # "service": "allServices"
+ # "service": "allServices",
# "audit_log_configs": [
# {
# "log_type": "DATA_READ",
@@ -1239,18 +1243,18 @@
# ]
# },
# {
- # "log_type": "DATA_WRITE",
+ # "log_type": "DATA_WRITE"
# },
# {
- # "log_type": "ADMIN_READ",
+ # "log_type": "ADMIN_READ"
# }
# ]
# },
# {
- # "service": "sampleservice.googleapis.com"
+ # "service": "sampleservice.googleapis.com",
# "audit_log_configs": [
# {
- # "log_type": "DATA_READ",
+ # "log_type": "DATA_READ"
# },
# {
# "log_type": "DATA_WRITE",
@@ -1266,6 +1270,9 @@
# 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:
@@ -1279,7 +1286,7 @@
# ]
# },
# {
- # "log_type": "DATA_WRITE",
+ # "log_type": "DATA_WRITE"
# }
# ]
# }
@@ -1294,17 +1301,9 @@
"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.
},
],
},
- "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"`
}
x__xgafv: string, V1 error format.
@@ -1382,6 +1381,42 @@
#
# For a description of IAM and its features, see the
# [IAM documentation](https://cloud.google.com/iam/docs/).
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
+ # prevent simultaneous updates of a policy from overwriting each other.
+ # It is strongly suggested that systems make use of the `etag` in the
+ # read-modify-write cycle to perform policy updates in order to avoid race
+ # conditions: An `etag` is returned in the response to `getIamPolicy`, and
+ # systems are expected to put that etag in the request to `setIamPolicy` to
+ # ensure that their change will be applied to the same version of the policy.
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ "version": 42, # Specifies the format of the policy.
+ #
+ # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
+ # are rejected.
+ #
+ # Any operation that affects conditional role bindings must specify version
+ # `3`. This requirement applies to the following operations:
+ #
+ # * Getting a policy that includes a conditional role binding
+ # * Adding a conditional role binding to a policy
+ # * Changing a conditional role binding in a policy
+ # * Removing any role binding, with or without a condition, from a policy
+ # that includes conditions
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ #
+ # If a policy does not include any conditions, operations on that policy may
+ # specify any valid version or leave the field unset.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
"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.
@@ -1432,11 +1467,11 @@
# documentation for additional information.
"expression": "A String", # Textual representation of an expression in Common Expression Language
# syntax.
+ "location": "A String", # Optional. String indicating the location of the expression for error
+ # reporting, e.g. a file name and a position in the file.
"title": "A String", # Optional. Title for the expression, i.e. a short string describing
# its purpose. This can be used e.g. in UIs which allow to enter the
# expression.
- "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.
},
@@ -1487,42 +1522,6 @@
],
},
],
- "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
- # prevent simultaneous updates of a policy from overwriting each other.
- # It is strongly suggested that systems make use of the `etag` in the
- # read-modify-write cycle to perform policy updates in order to avoid race
- # conditions: An `etag` is returned in the response to `getIamPolicy`, and
- # systems are expected to put that etag in the request to `setIamPolicy` to
- # ensure that their change will be applied to the same version of the policy.
- #
- # **Important:** If you use IAM Conditions, you must include the `etag` field
- # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
- # you to overwrite a version `3` policy with a version `1` policy, and all of
- # the conditions in the version `3` policy are lost.
- "version": 42, # Specifies the format of the policy.
- #
- # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
- # are rejected.
- #
- # Any operation that affects conditional role bindings must specify version
- # `3`. This requirement applies to the following operations:
- #
- # * Getting a policy that includes a conditional role binding
- # * Adding a conditional role binding to a policy
- # * Changing a conditional role binding in a policy
- # * Removing any role binding, with or without a condition, from a policy
- # that includes conditions
- #
- # **Important:** If you use IAM Conditions, you must include the `etag` field
- # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
- # you to overwrite a version `3` policy with a version `1` policy, and all of
- # the conditions in the version `3` policy are lost.
- #
- # If a policy does not include any conditions, operations on that policy may
- # specify any valid version or leave the field unset.
- #
- # To learn which resources support conditions in their IAM policies, see the
- # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
{ # Specifies the audit configuration for a service.
# The configuration determines which permission types are logged, and what
@@ -1539,7 +1538,7 @@
# {
# "audit_configs": [
# {
- # "service": "allServices"
+ # "service": "allServices",
# "audit_log_configs": [
# {
# "log_type": "DATA_READ",
@@ -1548,18 +1547,18 @@
# ]
# },
# {
- # "log_type": "DATA_WRITE",
+ # "log_type": "DATA_WRITE"
# },
# {
- # "log_type": "ADMIN_READ",
+ # "log_type": "ADMIN_READ"
# }
# ]
# },
# {
- # "service": "sampleservice.googleapis.com"
+ # "service": "sampleservice.googleapis.com",
# "audit_log_configs": [
# {
- # "log_type": "DATA_READ",
+ # "log_type": "DATA_READ"
# },
# {
# "log_type": "DATA_WRITE",
@@ -1575,6 +1574,9 @@
# 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:
@@ -1588,7 +1590,7 @@
# ]
# },
# {
- # "log_type": "DATA_WRITE",
+ # "log_type": "DATA_WRITE"
# }
# ]
# }
@@ -1603,9 +1605,6 @@
"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.
},
],
}</pre>
@@ -1704,13 +1703,6 @@
{ # 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.
- #
- # 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.
@@ -1718,13 +1710,33 @@
#
# Example: <code>tokyo-rain-123</code>
# Read-only after creation.
- "lifecycleState": "A String", # The Project lifecycle state.
+ "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{0,62}.
+ #
+ # Label values must be between 0 and 63 characters long and must conform
+ # to the regular expression [a-z0-9_-]{0,63}. A label value can be empty.
+ #
+ # No more than 256 labels can be associated with a given resource.
+ #
+ # Clients should store labels in a representation such as JSON that does not
+ # depend on specific characters being disallowed.
+ #
+ # Example: <code>"environment" : "dev"</code>
+ # Read-write.
+ "a_key": "A String",
+ },
+ "createTime": "A String", # Creation time.
#
# Read-only.
"projectNumber": "A String", # The number uniquely identifying the project.
#
# Example: <code>415104041262</code>
# Read-only.
+ "lifecycleState": "A String", # The Project lifecycle state.
+ #
+ # 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
@@ -1736,32 +1748,18 @@
# 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,
# 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".
},
- "createTime": "A String", # Creation time.
+ "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.
- "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\])?.
- #
- # Label values must be between 0 and 63 characters long and must conform
- # to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. A label
- # value can be empty.
- #
- # No more than 256 labels can be associated with a given resource.
- #
- # 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>My Project</code>
# Read-write.
- "a_key": "A String",
- },
}
x__xgafv: string, V1 error format.
@@ -1775,13 +1773,6 @@
{ # 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.
- #
- # 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.
@@ -1789,13 +1780,33 @@
#
# Example: <code>tokyo-rain-123</code>
# Read-only after creation.
- "lifecycleState": "A String", # The Project lifecycle state.
+ "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{0,62}.
+ #
+ # Label values must be between 0 and 63 characters long and must conform
+ # to the regular expression [a-z0-9_-]{0,63}. A label value can be empty.
+ #
+ # No more than 256 labels can be associated with a given resource.
+ #
+ # Clients should store labels in a representation such as JSON that does not
+ # depend on specific characters being disallowed.
+ #
+ # Example: <code>"environment" : "dev"</code>
+ # Read-write.
+ "a_key": "A String",
+ },
+ "createTime": "A String", # Creation time.
#
# Read-only.
"projectNumber": "A String", # The number uniquely identifying the project.
#
# Example: <code>415104041262</code>
# Read-only.
+ "lifecycleState": "A String", # The Project lifecycle state.
+ #
+ # 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
@@ -1807,32 +1818,18 @@
# 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,
# 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".
},
- "createTime": "A String", # Creation time.
+ "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.
- "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\])?.
- #
- # Label values must be between 0 and 63 characters long and must conform
- # to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. A label
- # value can be empty.
- #
- # No more than 256 labels can be associated with a given resource.
- #
- # 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>My Project</code>
# Read-write.
- "a_key": "A String",
- },
}</pre>
</div>