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_v1.projects.html b/docs/dyn/cloudresourcemanager_v1.projects.html
index 6a891b8..12f3fbb 100644
--- a/docs/dyn/cloudresourcemanager_v1.projects.html
+++ b/docs/dyn/cloudresourcemanager_v1.projects.html
@@ -99,7 +99,7 @@
<code><a href="#getOrgPolicy">getOrgPolicy(resource, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a `Policy` on a resource.</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="#listAvailableOrgPolicyConstraints">listAvailableOrgPolicyConstraints(resource, body=None, x__xgafv=None)</a></code></p>
@@ -142,9 +142,9 @@
The object takes the form of:
{ # The request sent to the ClearOrgPolicy method.
- "etag": "A String", # The current version, for concurrency control. Not sending an `etag`
+ "etag": "A String", # The current version, for concurrency control. Not sending an `etag`
# will cause the `Policy` to be cleared blindly.
- "constraint": "A String", # Name of the `Constraint` of the `Policy` to clear.
+ "constraint": "A String", # Name of the `Constraint` of the `Policy` to clear.
}
x__xgafv: string, V1 error format.
@@ -190,67 +190,67 @@
The object takes the form of:
{ # 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.
- "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,
- # 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: "organization", "folder", and "project".
- "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.
- #
- # 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>
- # Read-write.
- "a_key": "A String",
- },
- "projectNumber": "A String", # The number uniquely identifying the project.
- #
- # Example: <code>415104041262</code>
- # Read-only.
- "lifecycleState": "A String", # The Project lifecycle state.
- #
- # Read-only.
- "createTime": "A String", # Creation time.
- #
- # Read-only.
- }
+ # container for ACLs, APIs, App Engine Apps, VMs, and other
+ # Google Cloud Platform resources.
+ "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,
+ # 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: "organization", "folder", and "project".
+ "id": "A String", # Required field for the type-specific id. This should correspond to the id
+ # used in the type-specific API's.
+ },
+ "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>
+ # Read-write.
+ "a_key": "A String",
+ },
+ "createTime": "A String", # Creation time.
+ #
+ # Read-only.
+ "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.
+ # Trailing hyphens are prohibited.
+ #
+ # Example: <code>tokyo-rain-123</code>
+ # Read-only after creation.
+ "lifecycleState": "A String", # The Project lifecycle state.
+ #
+ # Read-only.
+ "projectNumber": "A String", # The number uniquely identifying the project.
+ #
+ # Example: <code>415104041262</code>
+ # Read-only.
+}
x__xgafv: string, V1 error format.
Allowed values
@@ -262,34 +262,16 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "metadata": { # Service-specific metadata associated with the operation. It typically
+ "metadata": { # Service-specific metadata associated with the operation. It typically
# contains progress information and common metadata such as create time.
# Some services might not provide such metadata. Any method that returns a
# long-running operation should document the metadata type, if any.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
- # different programming environments, including REST APIs and RPC APIs. It is
- # used by [gRPC](https://github.com/grpc). Each `Status` message contains
- # three pieces of data: error code, error message, and error details.
- #
- # You can find out more about this error model and how to work with it in the
- # [API Design Guide](https://cloud.google.com/apis/design/errors).
- "message": "A String", # A developer-facing error message, which should be in English. Any
- # user-facing error message should be localized and sent in the
- # google.rpc.Status.details field, or localized by the client.
- "code": 42, # The status code, which should be an enum value of google.rpc.Code.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
- {
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- ],
- },
- "done": True or False, # If the value is `false`, it means the operation is still in progress.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress.
# If `true`, the operation is completed, and either `error` or `response` is
# available.
- "response": { # The normal response of the operation in case of success. If the original
+ "response": { # The normal response of the operation in case of success. If the original
# method returns no data on success, such as `Delete`, the response is
# `google.protobuf.Empty`. If the original method is standard
# `Get`/`Create`/`Update`, the response should be the resource. For other
@@ -297,11 +279,29 @@
# is the original method name. For example, if the original method name
# is `TakeSnapshot()`, the inferred response type is
# `TakeSnapshotResponse`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "name": "A String", # The server-assigned name, which is only unique within the same service that
+ "name": "A String", # The server-assigned name, which is only unique within the same service that
# originally returns it. If you use the default HTTP mapping, the
# `name` should be a resource name ending with `operations/{unique_id}`.
+ "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
+ # different programming environments, including REST APIs and RPC APIs. It is
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
+ #
+ # You can find out more about this error model and how to work with it in the
+ # [API Design Guide](https://cloud.google.com/apis/design/errors).
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "message": "A String", # A developer-facing error message, which should be in English. Any
+ # user-facing error message should be localized and sent in the
+ # google.rpc.Status.details field, or localized by the client.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
}</pre>
</div>
@@ -312,7 +312,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,
@@ -373,67 +373,67 @@
An object of the form:
{ # 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.
- "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,
- # 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: "organization", "folder", and "project".
- "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.
- #
- # 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>
- # Read-write.
- "a_key": "A String",
- },
- "projectNumber": "A String", # The number uniquely identifying the project.
- #
- # Example: <code>415104041262</code>
- # Read-only.
- "lifecycleState": "A String", # The Project lifecycle state.
- #
- # Read-only.
- "createTime": "A String", # Creation time.
- #
- # Read-only.
- }</pre>
+ # container for ACLs, APIs, App Engine Apps, VMs, and other
+ # Google Cloud Platform resources.
+ "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,
+ # 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: "organization", "folder", and "project".
+ "id": "A String", # Required field for the type-specific id. This should correspond to the id
+ # used in the type-specific API's.
+ },
+ "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>
+ # Read-write.
+ "a_key": "A String",
+ },
+ "createTime": "A String", # Creation time.
+ #
+ # Read-only.
+ "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.
+ # Trailing hyphens are prohibited.
+ #
+ # Example: <code>tokyo-rain-123</code>
+ # Read-only after creation.
+ "lifecycleState": "A String", # The Project lifecycle state.
+ #
+ # Read-only.
+ "projectNumber": "A String", # The number uniquely identifying the project.
+ #
+ # Example: <code>415104041262</code>
+ # Read-only.
+ }</pre>
</div>
<div class="method">
@@ -464,18 +464,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: "organization", "folder", and "project".
- "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: "organization", "folder", and "project".
+ "id": "A String", # Required field for the type-specific id. This should correspond to the id
+ # used in the type-specific API's.
},
},
],
@@ -487,7 +487,7 @@
<pre>Gets the effective `Policy` on a resource. This is the result of merging
`Policies` in the resource hierarchy. The returned `Policy` will not have
an `etag`set because it is a computed `Policy` across multiple resources.
-Subtrees of Resource Manager resource hierarchy with 'under:' prefix will
+Subtrees of Resource Manager resource hierarchy with 'under:' prefix will
not be expanded.
Args:
@@ -496,7 +496,7 @@
The object takes the form of:
{ # The request sent to the GetEffectiveOrgPolicy method.
- "constraint": "A String", # The name of the `Constraint` to compute the effective `Policy`.
+ "constraint": "A String", # The name of the `Constraint` to compute the effective `Policy`.
}
x__xgafv: string, V1 error format.
@@ -509,16 +509,12 @@
{ # Defines a Cloud Organization `Policy` which is used to specify `Constraints`
# for configurations of Cloud Platform resources.
- "updateTime": "A String", # The time stamp the `Policy` was previously updated. This is set by the
+ "updateTime": "A String", # The time stamp the `Policy` was previously updated. This is set by the
# server, not specified by the caller, and represents the last time a call to
# `SetOrgPolicy` was made for that `Policy`. Any value set by the client will
# be ignored.
- "version": 42, # Version of the `Policy`. Default version is 0;
- "constraint": "A String", # The name of the `Constraint` the `Policy` is configuring, for example,
- # `constraints/serviceuser.services`.
- #
- # Immutable after creation.
- "restoreDefault": { # Ignores policies set above this resource and restores the # Restores the default behavior of the constraint; independent of
+ "version": 42, # Version of the `Policy`. Default version is 0;
+ "restoreDefault": { # Ignores policies set above this resource and restores the # Restores the default behavior of the constraint; independent of
# `Constraint` type.
# `constraint_default` enforcement behavior of the specific `Constraint` at
# this resource.
@@ -532,7 +528,7 @@
# enforcement of the `Constraint` for only those projects, allowing those
# projects to have all services activated.
},
- "listPolicy": { # Used in `policy_type` to specify how `list_policy` behaves at this # List of values either allowed or disallowed.
+ "listPolicy": { # Used in `policy_type` to specify how `list_policy` behaves at this # List of values either allowed or disallowed.
# resource.
#
# `ListPolicy` can define specific values and subtrees of Cloud Resource
@@ -541,24 +537,27 @@
# fields. This is achieved by using the `under:` and optional `is:` prefixes.
# The `under:` prefix is used to denote resource subtree values.
# The `is:` prefix is used to denote specific values, and is required only
- # if the value contains a ":". Values prefixed with "is:" are treated the
+ # if the value contains a ":". Values prefixed with "is:" are treated the
# same as values with no prefix.
# Ancestry subtrees must be in one of the following formats:
- # - "projects/<project-id>", e.g. "projects/tokyo-rain-123"
- # - "folders/<folder-id>", e.g. "folders/1234"
- # - "organizations/<organization-id>", e.g. "organizations/1234"
+ # - "projects/<project-id>", e.g. "projects/tokyo-rain-123"
+ # - "folders/<folder-id>", e.g. "folders/1234"
+ # - "organizations/<organization-id>", e.g. "organizations/1234"
# The `supports_under` field of the associated `Constraint` defines whether
# ancestry prefixes can be used. You can set `allowed_values` and
# `denied_values` in the same `Policy` if `all_values` is
# `ALL_VALUES_UNSPECIFIED`. `ALLOW` or `DENY` are used to allow or deny all
# values. If `all_values` is set to either `ALLOW` or `DENY`,
# `allowed_values` and `denied_values` must be unset.
- "allValues": "A String", # The policy all_values state.
- "deniedValues": [ # List of values denied at this resource. Can only be set if `all_values`
+ "allowedValues": [ # List of values allowed at this resource. Can only be set if `all_values`
# is set to `ALL_VALUES_UNSPECIFIED`.
- "A String",
+ "A String",
],
- "inheritFromParent": True or False, # Determines the inheritance behavior for this `Policy`.
+ "suggestedValue": "A String", # Optional. The Google Cloud Console will try to default to a configuration
+ # that matches the value specified in this `Policy`. If `suggested_value`
+ # is not set, it will inherit the value specified higher in the hierarchy,
+ # unless `inherit_from_parent` is `false`.
+ "inheritFromParent": True or False, # Determines the inheritance behavior for this `Policy`.
#
# By default, a `ListPolicy` set at a resource supercedes any `Policy` set
# anywhere up the resource hierarchy. However, if `inherit_from_parent` is
@@ -567,7 +566,7 @@
# added to the values inherited up the hierarchy.
#
# Setting `Policy` hierarchies that inherit both allowed values and denied
- # values isn't recommended in most circumstances to keep the configuration
+ # values isn't recommended in most circumstances to keep the configuration
# simple and understandable. However, it is possible to set a `Policy` with
# `allowed_values` set that inherits a `Policy` with `denied_values` set.
# In this case, the values that are allowed must be in `allowed_values` and
@@ -587,31 +586,31 @@
#
# Example 1 (no inherited values):
# `organizations/foo` has a `Policy` with values:
- # {allowed_values: "E1" allowed_values:"E2"}
+ # {allowed_values: "E1" allowed_values:"E2"}
# `projects/bar` has `inherit_from_parent` `false` and values:
- # {allowed_values: "E3" allowed_values: "E4"}
+ # {allowed_values: "E3" allowed_values: "E4"}
# The accepted values at `organizations/foo` are `E1`, `E2`.
# The accepted values at `projects/bar` are `E3`, and `E4`.
#
# Example 2 (inherited values):
# `organizations/foo` has a `Policy` with values:
- # {allowed_values: "E1" allowed_values:"E2"}
+ # {allowed_values: "E1" allowed_values:"E2"}
# `projects/bar` has a `Policy` with values:
- # {value: "E3" value: "E4" inherit_from_parent: true}
+ # {value: "E3" value: "E4" inherit_from_parent: true}
# The accepted values at `organizations/foo` are `E1`, `E2`.
# The accepted values at `projects/bar` are `E1`, `E2`, `E3`, and `E4`.
#
# Example 3 (inheriting both allowed and denied values):
# `organizations/foo` has a `Policy` with values:
- # {allowed_values: "E1" allowed_values: "E2"}
+ # {allowed_values: "E1" allowed_values: "E2"}
# `projects/bar` has a `Policy` with:
- # {denied_values: "E1"}
+ # {denied_values: "E1"}
# The accepted values at `organizations/foo` are `E1`, `E2`.
# The value accepted at `projects/bar` is `E2`.
#
# Example 4 (RestoreDefault):
# `organizations/foo` has a `Policy` with values:
- # {allowed_values: "E1" allowed_values:"E2"}
+ # {allowed_values: "E1" allowed_values:"E2"}
# `projects/bar` has a `Policy` with values:
# {RestoreDefault: {}}
# The accepted values at `organizations/foo` are `E1`, `E2`.
@@ -628,7 +627,7 @@
#
# Example 6 (ListConstraint allowing all):
# `organizations/foo` has a `Policy` with values:
- # {allowed_values: "E1" allowed_values: "E2"}
+ # {allowed_values: "E1" allowed_values: "E2"}
# `projects/bar` has a `Policy` with:
# {all: ALLOW}
# The accepted values at `organizations/foo` are `E1`, E2`.
@@ -636,7 +635,7 @@
#
# Example 7 (ListConstraint allowing none):
# `organizations/foo` has a `Policy` with values:
- # {allowed_values: "E1" allowed_values: "E2"}
+ # {allowed_values: "E1" allowed_values: "E2"}
# `projects/bar` has a `Policy` with:
# {all: DENY}
# The accepted values at `organizations/foo` are `E1`, E2`.
@@ -646,27 +645,43 @@
# Given the following resource hierarchy
# O1->{F1, F2}; F1->{P1}; F2->{P2, P3},
# `organizations/foo` has a `Policy` with values:
- # {allowed_values: "under:organizations/O1"}
+ # {allowed_values: "under:organizations/O1"}
# `projects/bar` has a `Policy` with:
- # {allowed_values: "under:projects/P3"}
- # {denied_values: "under:folders/F2"}
+ # {allowed_values: "under:projects/P3"}
+ # {denied_values: "under:folders/F2"}
# The accepted values at `organizations/foo` are `organizations/O1`,
# `folders/F1`, `folders/F2`, `projects/P1`, `projects/P2`,
# `projects/P3`.
# The accepted values at `projects/bar` are `organizations/O1`,
# `folders/F1`, `projects/P1`.
- "suggestedValue": "A String", # Optional. The Google Cloud Console will try to default to a configuration
- # that matches the value specified in this `Policy`. If `suggested_value`
- # is not set, it will inherit the value specified higher in the hierarchy,
- # unless `inherit_from_parent` is `false`.
- "allowedValues": [ # List of values allowed at this resource. Can only be set if `all_values`
+ "deniedValues": [ # List of values denied at this resource. Can only be set if `all_values`
# is set to `ALL_VALUES_UNSPECIFIED`.
- "A String",
+ "A String",
],
+ "allValues": "A String", # The policy all_values state.
},
- "booleanPolicy": { # Used in `policy_type` to specify how `boolean_policy` will behave at this # For boolean `Constraints`, whether to enforce the `Constraint` or not.
+ "etag": "A String", # An opaque tag indicating the current version of the `Policy`, used for
+ # concurrency control.
+ #
+ # When the `Policy` is returned from either a `GetPolicy` or a
+ # `ListOrgPolicy` request, this `etag` indicates the version of the current
+ # `Policy` to use when executing a read-modify-write loop.
+ #
+ # When the `Policy` is returned from a `GetEffectivePolicy` request, the
+ # `etag` will be unset.
+ #
+ # When the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value
+ # that was returned from a `GetOrgPolicy` request as part of a
+ # read-modify-write loop for concurrency control. Not setting the `etag`in a
+ # `SetOrgPolicy` request will result in an unconditional write of the
+ # `Policy`.
+ "constraint": "A String", # The name of the `Constraint` the `Policy` is configuring, for example,
+ # `constraints/serviceuser.services`.
+ #
+ # Immutable after creation.
+ "booleanPolicy": { # Used in `policy_type` to specify how `boolean_policy` will behave at this # For boolean `Constraints`, whether to enforce the `Constraint` or not.
# resource.
- "enforced": True or False, # If `true`, then the `Policy` is enforced. If `false`, then any
+ "enforced": True or False, # If `true`, then the `Policy` is enforced. If `false`, then any
# configuration is acceptable.
#
# Suppose you have a `Constraint`
@@ -711,21 +726,6 @@
# The constraint at `projects/bar` is not enforced, because
# `constraint_default` for the `Constraint` is `ALLOW`.
},
- "etag": "A String", # An opaque tag indicating the current version of the `Policy`, used for
- # concurrency control.
- #
- # When the `Policy` is returned from either a `GetPolicy` or a
- # `ListOrgPolicy` request, this `etag` indicates the version of the current
- # `Policy` to use when executing a read-modify-write loop.
- #
- # When the `Policy` is returned from a `GetEffectivePolicy` request, the
- # `etag` will be unset.
- #
- # When the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value
- # that was returned from a `GetOrgPolicy` request as part of a
- # read-modify-write loop for concurrency control. Not setting the `etag`in a
- # `SetOrgPolicy` request will result in an unconditional write of the
- # `Policy`.
}</pre>
</div>
@@ -747,9 +747,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.
@@ -757,6 +757,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).
},
}
@@ -778,36 +782,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:**
@@ -825,19 +833,192 @@
# 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
+ "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
+ # 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.
+ "logType": "A String", # The log type that this config enables.
+ "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
+ # permission.
+ # Follows the same format of Binding.members.
+ "A String",
+ ],
+ },
+ ],
+ },
+ ],
+ "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`.
- "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
+ "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"
+ #
+ # Example (Equality):
+ #
+ # title: "Requestor is owner"
+ # description: "Determines if requestor is the document owner"
+ # expression: "document.owner == request.auth.claims.email"
+ #
+ # Example (Logic):
+ #
+ # title: "Public documents"
+ # description: "Determine whether the document should be publicly visible"
+ # expression: "document.type != 'private' && document.type != 'internal'"
+ #
+ # Example (Data Manipulation):
+ #
+ # title: "Notification string"
+ # description: "Create a notification string with a timestamp."
+ # expression: "'New message received at ' + string(document.create_time)"
+ #
+ # The exact variables and functions that may be referenced within an expression
+ # are determined by the service that evaluates it. See the service
+ # documentation for additional information.
+ "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` can have the following values:
#
# * `allUsers`: A special identifier that represents anyone who is
@@ -880,172 +1061,10 @@
# * `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",
],
- "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
- # NOTE: An unsatisfied condition will not allow user access via current
- # binding. Different bindings, including their conditions, are examined
- # independently.
- # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
- # are documented at https://github.com/google/cel-spec.
- #
- # Example (Comparison):
- #
- # title: "Summary size limit"
- # description: "Determines if a summary is less than 100 chars"
- # expression: "document.summary.size() < 100"
- #
- # Example (Equality):
- #
- # title: "Requestor is owner"
- # description: "Determines if requestor is the document owner"
- # expression: "document.owner == request.auth.claims.email"
- #
- # Example (Logic):
- #
- # title: "Public documents"
- # description: "Determine whether the document should be publicly visible"
- # expression: "document.type != 'private' && document.type != 'internal'"
- #
- # Example (Data Manipulation):
- #
- # title: "Notification string"
- # description: "Create a notification string with a timestamp."
- # expression: "'New message received at ' + string(document.create_time)"
- #
- # The exact variables and functions that may be referenced within an expression
- # are determined by the service that evaluates it. See the service
- # documentation for additional information.
- "description": "A String", # Optional. Description of the expression. This is a longer text which
- # describes the expression, e.g. when hovered over it in a UI.
- "expression": "A String", # Textual representation of an expression in Common Expression Language
- # syntax.
- "location": "A String", # Optional. String indicating the location of the expression for error
- # reporting, e.g. a file name and a position in the file.
- "title": "A String", # Optional. Title for the expression, i.e. a short string describing
- # its purpose. This can be used e.g. in UIs which allow to enter the
- # expression.
- },
},
],
- "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
- # 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.
}</pre>
</div>
@@ -1064,7 +1083,7 @@
The object takes the form of:
{ # The request sent to the GetOrgPolicy method.
- "constraint": "A String", # Name of the `Constraint` to get the `Policy`.
+ "constraint": "A String", # Name of the `Constraint` to get the `Policy`.
}
x__xgafv: string, V1 error format.
@@ -1077,16 +1096,12 @@
{ # Defines a Cloud Organization `Policy` which is used to specify `Constraints`
# for configurations of Cloud Platform resources.
- "updateTime": "A String", # The time stamp the `Policy` was previously updated. This is set by the
+ "updateTime": "A String", # The time stamp the `Policy` was previously updated. This is set by the
# server, not specified by the caller, and represents the last time a call to
# `SetOrgPolicy` was made for that `Policy`. Any value set by the client will
# be ignored.
- "version": 42, # Version of the `Policy`. Default version is 0;
- "constraint": "A String", # The name of the `Constraint` the `Policy` is configuring, for example,
- # `constraints/serviceuser.services`.
- #
- # Immutable after creation.
- "restoreDefault": { # Ignores policies set above this resource and restores the # Restores the default behavior of the constraint; independent of
+ "version": 42, # Version of the `Policy`. Default version is 0;
+ "restoreDefault": { # Ignores policies set above this resource and restores the # Restores the default behavior of the constraint; independent of
# `Constraint` type.
# `constraint_default` enforcement behavior of the specific `Constraint` at
# this resource.
@@ -1100,7 +1115,7 @@
# enforcement of the `Constraint` for only those projects, allowing those
# projects to have all services activated.
},
- "listPolicy": { # Used in `policy_type` to specify how `list_policy` behaves at this # List of values either allowed or disallowed.
+ "listPolicy": { # Used in `policy_type` to specify how `list_policy` behaves at this # List of values either allowed or disallowed.
# resource.
#
# `ListPolicy` can define specific values and subtrees of Cloud Resource
@@ -1109,24 +1124,27 @@
# fields. This is achieved by using the `under:` and optional `is:` prefixes.
# The `under:` prefix is used to denote resource subtree values.
# The `is:` prefix is used to denote specific values, and is required only
- # if the value contains a ":". Values prefixed with "is:" are treated the
+ # if the value contains a ":". Values prefixed with "is:" are treated the
# same as values with no prefix.
# Ancestry subtrees must be in one of the following formats:
- # - "projects/<project-id>", e.g. "projects/tokyo-rain-123"
- # - "folders/<folder-id>", e.g. "folders/1234"
- # - "organizations/<organization-id>", e.g. "organizations/1234"
+ # - "projects/<project-id>", e.g. "projects/tokyo-rain-123"
+ # - "folders/<folder-id>", e.g. "folders/1234"
+ # - "organizations/<organization-id>", e.g. "organizations/1234"
# The `supports_under` field of the associated `Constraint` defines whether
# ancestry prefixes can be used. You can set `allowed_values` and
# `denied_values` in the same `Policy` if `all_values` is
# `ALL_VALUES_UNSPECIFIED`. `ALLOW` or `DENY` are used to allow or deny all
# values. If `all_values` is set to either `ALLOW` or `DENY`,
# `allowed_values` and `denied_values` must be unset.
- "allValues": "A String", # The policy all_values state.
- "deniedValues": [ # List of values denied at this resource. Can only be set if `all_values`
+ "allowedValues": [ # List of values allowed at this resource. Can only be set if `all_values`
# is set to `ALL_VALUES_UNSPECIFIED`.
- "A String",
+ "A String",
],
- "inheritFromParent": True or False, # Determines the inheritance behavior for this `Policy`.
+ "suggestedValue": "A String", # Optional. The Google Cloud Console will try to default to a configuration
+ # that matches the value specified in this `Policy`. If `suggested_value`
+ # is not set, it will inherit the value specified higher in the hierarchy,
+ # unless `inherit_from_parent` is `false`.
+ "inheritFromParent": True or False, # Determines the inheritance behavior for this `Policy`.
#
# By default, a `ListPolicy` set at a resource supercedes any `Policy` set
# anywhere up the resource hierarchy. However, if `inherit_from_parent` is
@@ -1135,7 +1153,7 @@
# added to the values inherited up the hierarchy.
#
# Setting `Policy` hierarchies that inherit both allowed values and denied
- # values isn't recommended in most circumstances to keep the configuration
+ # values isn't recommended in most circumstances to keep the configuration
# simple and understandable. However, it is possible to set a `Policy` with
# `allowed_values` set that inherits a `Policy` with `denied_values` set.
# In this case, the values that are allowed must be in `allowed_values` and
@@ -1155,31 +1173,31 @@
#
# Example 1 (no inherited values):
# `organizations/foo` has a `Policy` with values:
- # {allowed_values: "E1" allowed_values:"E2"}
+ # {allowed_values: "E1" allowed_values:"E2"}
# `projects/bar` has `inherit_from_parent` `false` and values:
- # {allowed_values: "E3" allowed_values: "E4"}
+ # {allowed_values: "E3" allowed_values: "E4"}
# The accepted values at `organizations/foo` are `E1`, `E2`.
# The accepted values at `projects/bar` are `E3`, and `E4`.
#
# Example 2 (inherited values):
# `organizations/foo` has a `Policy` with values:
- # {allowed_values: "E1" allowed_values:"E2"}
+ # {allowed_values: "E1" allowed_values:"E2"}
# `projects/bar` has a `Policy` with values:
- # {value: "E3" value: "E4" inherit_from_parent: true}
+ # {value: "E3" value: "E4" inherit_from_parent: true}
# The accepted values at `organizations/foo` are `E1`, `E2`.
# The accepted values at `projects/bar` are `E1`, `E2`, `E3`, and `E4`.
#
# Example 3 (inheriting both allowed and denied values):
# `organizations/foo` has a `Policy` with values:
- # {allowed_values: "E1" allowed_values: "E2"}
+ # {allowed_values: "E1" allowed_values: "E2"}
# `projects/bar` has a `Policy` with:
- # {denied_values: "E1"}
+ # {denied_values: "E1"}
# The accepted values at `organizations/foo` are `E1`, `E2`.
# The value accepted at `projects/bar` is `E2`.
#
# Example 4 (RestoreDefault):
# `organizations/foo` has a `Policy` with values:
- # {allowed_values: "E1" allowed_values:"E2"}
+ # {allowed_values: "E1" allowed_values:"E2"}
# `projects/bar` has a `Policy` with values:
# {RestoreDefault: {}}
# The accepted values at `organizations/foo` are `E1`, `E2`.
@@ -1196,7 +1214,7 @@
#
# Example 6 (ListConstraint allowing all):
# `organizations/foo` has a `Policy` with values:
- # {allowed_values: "E1" allowed_values: "E2"}
+ # {allowed_values: "E1" allowed_values: "E2"}
# `projects/bar` has a `Policy` with:
# {all: ALLOW}
# The accepted values at `organizations/foo` are `E1`, E2`.
@@ -1204,7 +1222,7 @@
#
# Example 7 (ListConstraint allowing none):
# `organizations/foo` has a `Policy` with values:
- # {allowed_values: "E1" allowed_values: "E2"}
+ # {allowed_values: "E1" allowed_values: "E2"}
# `projects/bar` has a `Policy` with:
# {all: DENY}
# The accepted values at `organizations/foo` are `E1`, E2`.
@@ -1214,27 +1232,43 @@
# Given the following resource hierarchy
# O1->{F1, F2}; F1->{P1}; F2->{P2, P3},
# `organizations/foo` has a `Policy` with values:
- # {allowed_values: "under:organizations/O1"}
+ # {allowed_values: "under:organizations/O1"}
# `projects/bar` has a `Policy` with:
- # {allowed_values: "under:projects/P3"}
- # {denied_values: "under:folders/F2"}
+ # {allowed_values: "under:projects/P3"}
+ # {denied_values: "under:folders/F2"}
# The accepted values at `organizations/foo` are `organizations/O1`,
# `folders/F1`, `folders/F2`, `projects/P1`, `projects/P2`,
# `projects/P3`.
# The accepted values at `projects/bar` are `organizations/O1`,
# `folders/F1`, `projects/P1`.
- "suggestedValue": "A String", # Optional. The Google Cloud Console will try to default to a configuration
- # that matches the value specified in this `Policy`. If `suggested_value`
- # is not set, it will inherit the value specified higher in the hierarchy,
- # unless `inherit_from_parent` is `false`.
- "allowedValues": [ # List of values allowed at this resource. Can only be set if `all_values`
+ "deniedValues": [ # List of values denied at this resource. Can only be set if `all_values`
# is set to `ALL_VALUES_UNSPECIFIED`.
- "A String",
+ "A String",
],
+ "allValues": "A String", # The policy all_values state.
},
- "booleanPolicy": { # Used in `policy_type` to specify how `boolean_policy` will behave at this # For boolean `Constraints`, whether to enforce the `Constraint` or not.
+ "etag": "A String", # An opaque tag indicating the current version of the `Policy`, used for
+ # concurrency control.
+ #
+ # When the `Policy` is returned from either a `GetPolicy` or a
+ # `ListOrgPolicy` request, this `etag` indicates the version of the current
+ # `Policy` to use when executing a read-modify-write loop.
+ #
+ # When the `Policy` is returned from a `GetEffectivePolicy` request, the
+ # `etag` will be unset.
+ #
+ # When the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value
+ # that was returned from a `GetOrgPolicy` request as part of a
+ # read-modify-write loop for concurrency control. Not setting the `etag`in a
+ # `SetOrgPolicy` request will result in an unconditional write of the
+ # `Policy`.
+ "constraint": "A String", # The name of the `Constraint` the `Policy` is configuring, for example,
+ # `constraints/serviceuser.services`.
+ #
+ # Immutable after creation.
+ "booleanPolicy": { # Used in `policy_type` to specify how `boolean_policy` will behave at this # For boolean `Constraints`, whether to enforce the `Constraint` or not.
# resource.
- "enforced": True or False, # If `true`, then the `Policy` is enforced. If `false`, then any
+ "enforced": True or False, # If `true`, then the `Policy` is enforced. If `false`, then any
# configuration is acceptable.
#
# Suppose you have a `Constraint`
@@ -1279,26 +1313,11 @@
# The constraint at `projects/bar` is not enforced, because
# `constraint_default` for the `Constraint` is `ALLOW`.
},
- "etag": "A String", # An opaque tag indicating the current version of the `Policy`, used for
- # concurrency control.
- #
- # When the `Policy` is returned from either a `GetPolicy` or a
- # `ListOrgPolicy` request, this `etag` indicates the version of the current
- # `Policy` to use when executing a read-modify-write loop.
- #
- # When the `Policy` is returned from a `GetEffectivePolicy` request, the
- # `etag` will be unset.
- #
- # When the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value
- # that was returned from a `GetOrgPolicy` request as part of a
- # read-modify-write loop for concurrency control. Not setting the `etag`in a
- # `SetOrgPolicy` request will result in an unconditional write of the
- # `Policy`.
}</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.
@@ -1317,19 +1336,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:
@@ -1343,13 +1349,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
@@ -1359,10 +1365,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:
@@ -1374,7 +1393,72 @@
# 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.
+ "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.
+ "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,
+ # 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: "organization", "folder", and "project".
+ "id": "A String", # Required field for the type-specific id. This should correspond to the id
+ # used in the type-specific API's.
+ },
+ "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>
+ # Read-write.
+ "a_key": "A String",
+ },
+ "createTime": "A String", # Creation time.
+ #
+ # Read-only.
+ "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.
+ # Trailing hyphens are prohibited.
+ #
+ # Example: <code>tokyo-rain-123</code>
+ # Read-only after creation.
+ "lifecycleState": "A String", # The Project lifecycle state.
+ #
+ # Read-only.
+ "projectNumber": "A String", # The number uniquely identifying the project.
+ #
+ # Example: <code>415104041262</code>
+ # Read-only.
+ },
+ ],
+ "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.
@@ -1385,71 +1469,6 @@
# 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.
- "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,
- # 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: "organization", "folder", and "project".
- "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.
- #
- # 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>
- # Read-write.
- "a_key": "A String",
- },
- "projectNumber": "A String", # The number uniquely identifying the project.
- #
- # Example: <code>415104041262</code>
- # Read-only.
- "lifecycleState": "A String", # The Project lifecycle state.
- #
- # Read-only.
- "createTime": "A String", # Creation time.
- #
- # Read-only.
- },
- ],
}</pre>
</div>
@@ -1464,9 +1483,9 @@
{ # The request sent to the [ListAvailableOrgPolicyConstraints]
# google.cloud.OrgPolicy.v1.ListAvailableOrgPolicyConstraints] method.
- "pageToken": "A String", # Page token used to retrieve the next page. This is currently unsupported
+ "pageToken": "A String", # Page token used to retrieve the next page. This is currently unsupported
# and will be ignored. The server may at any point start using this field.
- "pageSize": 42, # Size of the pages to be returned. This is currently unsupported and will
+ "pageSize": 42, # Size of the pages to be returned. This is currently unsupported and will
# be ignored. The server may at any point start using this field to limit
# page size.
}
@@ -1483,15 +1502,15 @@
# Returns all `Constraints` that could be set at this level of the hierarchy
# (contrast with the response from `ListPolicies`, which returns all policies
# which are set).
- "nextPageToken": "A String", # Page token used to retrieve the next page. This is currently not used.
- "constraints": [ # The collection of constraints that are settable on the request resource.
- { # A `Constraint` describes a way in which a resource's configuration can be
+ "nextPageToken": "A String", # Page token used to retrieve the next page. This is currently not used.
+ "constraints": [ # The collection of constraints that are settable on the request resource.
+ { # A `Constraint` describes a way in which a resource's configuration can be
# restricted. For example, it controls which cloud services can be activated
# across an organization, or whether a Compute Engine instance can have
# serial port connections established. `Constraints` can be configured by the
- # organization's policy adminstrator to fit the needs of the organzation by
+ # organization's policy adminstrator to fit the needs of the organzation by
# setting Policies for `Constraints` at different locations in the
- # organization's resource hierarchy. Policies are inherited down the resource
+ # organization's resource hierarchy. Policies are inherited down the resource
# hierarchy from higher levels, but can also be overridden. For details about
# the inheritance rules please read about
# Policies.
@@ -1499,32 +1518,32 @@
# `Constraints` have a default behavior determined by the `constraint_default`
# field, which is the enforcement behavior that is used in the absence of a
# `Policy` being defined or inherited for the resource in question.
- "constraintDefault": "A String", # The evaluation behavior of this constraint in the absense of 'Policy'.
- "displayName": "A String", # The human readable name.
+ "listConstraint": { # A `Constraint` that allows or disallows a list of string values, which are # Defines this constraint as being a ListConstraint.
+ # configured by an Organization's policy administrator with a `Policy`.
+ "supportsUnder": True or False, # Indicates whether subtrees of Cloud Resource Manager resource hierarchy
+ # can be used in `Policy.allowed_values` and `Policy.denied_values`. For
+ # example, `"under:folders/123"` would match any resource under the
+ # 'folders/123' folder.
+ "suggestedValue": "A String", # Optional. The Google Cloud Console will try to default to a configuration
+ # that matches the value specified in this `Constraint`.
+ },
+ "version": 42, # Version of the `Constraint`. Default version is 0;
+ "description": "A String", # Detailed description of what this `Constraint` controls as well as how and
+ # where it is enforced.
#
# Mutable.
- "name": "A String", # Immutable value, required to globally be unique. For example,
- # `constraints/serviceuser.services`
- "booleanConstraint": { # A `Constraint` that is either enforced or not. # Defines this constraint as being a BooleanConstraint.
+ "displayName": "A String", # The human readable name.
+ #
+ # Mutable.
+ "booleanConstraint": { # A `Constraint` that is either enforced or not. # Defines this constraint as being a BooleanConstraint.
#
# For example a constraint `constraints/compute.disableSerialPortAccess`.
# If it is enforced on a VM instance, serial port connections will not be
# opened to that instance.
},
- "version": 42, # Version of the `Constraint`. Default version is 0;
- "listConstraint": { # A `Constraint` that allows or disallows a list of string values, which are # Defines this constraint as being a ListConstraint.
- # configured by an Organization's policy administrator with a `Policy`.
- "supportsUnder": True or False, # Indicates whether subtrees of Cloud Resource Manager resource hierarchy
- # can be used in `Policy.allowed_values` and `Policy.denied_values`. For
- # example, `"under:folders/123"` would match any resource under the
- # 'folders/123' folder.
- "suggestedValue": "A String", # Optional. The Google Cloud Console will try to default to a configuration
- # that matches the value specified in this `Constraint`.
- },
- "description": "A String", # Detailed description of what this `Constraint` controls as well as how and
- # where it is enforced.
- #
- # Mutable.
+ "constraintDefault": "A String", # The evaluation behavior of this constraint in the absense of 'Policy'.
+ "name": "A String", # Immutable value, required to globally be unique. For example,
+ # `constraints/serviceuser.services`
},
],
}</pre>
@@ -1539,7 +1558,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>
@@ -1554,9 +1573,9 @@
The object takes the form of:
{ # The request sent to the ListOrgPolicies method.
- "pageToken": "A String", # Page token used to retrieve the next page. This is currently unsupported
+ "pageToken": "A String", # Page token used to retrieve the next page. This is currently unsupported
# and will be ignored. The server may at any point start using this field.
- "pageSize": 42, # Size of the pages to be returned. This is currently unsupported and will
+ "pageSize": 42, # Size of the pages to be returned. This is currently unsupported and will
# be ignored. The server may at any point start using this field to limit
# page size.
}
@@ -1571,22 +1590,16 @@
{ # The response returned from the ListOrgPolicies method. It will be empty
# if no `Policies` are set on the resource.
- "nextPageToken": "A String", # Page token used to retrieve the next page. This is currently not used, but
- # the server may at any point start supplying a valid token.
- "policies": [ # The `Policies` that are set on the resource. It will be empty if no
+ "policies": [ # The `Policies` that are set on the resource. It will be empty if no
# `Policies` are set.
{ # Defines a Cloud Organization `Policy` which is used to specify `Constraints`
# for configurations of Cloud Platform resources.
- "updateTime": "A String", # The time stamp the `Policy` was previously updated. This is set by the
+ "updateTime": "A String", # The time stamp the `Policy` was previously updated. This is set by the
# server, not specified by the caller, and represents the last time a call to
# `SetOrgPolicy` was made for that `Policy`. Any value set by the client will
# be ignored.
- "version": 42, # Version of the `Policy`. Default version is 0;
- "constraint": "A String", # The name of the `Constraint` the `Policy` is configuring, for example,
- # `constraints/serviceuser.services`.
- #
- # Immutable after creation.
- "restoreDefault": { # Ignores policies set above this resource and restores the # Restores the default behavior of the constraint; independent of
+ "version": 42, # Version of the `Policy`. Default version is 0;
+ "restoreDefault": { # Ignores policies set above this resource and restores the # Restores the default behavior of the constraint; independent of
# `Constraint` type.
# `constraint_default` enforcement behavior of the specific `Constraint` at
# this resource.
@@ -1600,7 +1613,7 @@
# enforcement of the `Constraint` for only those projects, allowing those
# projects to have all services activated.
},
- "listPolicy": { # Used in `policy_type` to specify how `list_policy` behaves at this # List of values either allowed or disallowed.
+ "listPolicy": { # Used in `policy_type` to specify how `list_policy` behaves at this # List of values either allowed or disallowed.
# resource.
#
# `ListPolicy` can define specific values and subtrees of Cloud Resource
@@ -1609,24 +1622,27 @@
# fields. This is achieved by using the `under:` and optional `is:` prefixes.
# The `under:` prefix is used to denote resource subtree values.
# The `is:` prefix is used to denote specific values, and is required only
- # if the value contains a ":". Values prefixed with "is:" are treated the
+ # if the value contains a ":". Values prefixed with "is:" are treated the
# same as values with no prefix.
# Ancestry subtrees must be in one of the following formats:
- # - "projects/<project-id>", e.g. "projects/tokyo-rain-123"
- # - "folders/<folder-id>", e.g. "folders/1234"
- # - "organizations/<organization-id>", e.g. "organizations/1234"
+ # - "projects/<project-id>", e.g. "projects/tokyo-rain-123"
+ # - "folders/<folder-id>", e.g. "folders/1234"
+ # - "organizations/<organization-id>", e.g. "organizations/1234"
# The `supports_under` field of the associated `Constraint` defines whether
# ancestry prefixes can be used. You can set `allowed_values` and
# `denied_values` in the same `Policy` if `all_values` is
# `ALL_VALUES_UNSPECIFIED`. `ALLOW` or `DENY` are used to allow or deny all
# values. If `all_values` is set to either `ALLOW` or `DENY`,
# `allowed_values` and `denied_values` must be unset.
- "allValues": "A String", # The policy all_values state.
- "deniedValues": [ # List of values denied at this resource. Can only be set if `all_values`
+ "allowedValues": [ # List of values allowed at this resource. Can only be set if `all_values`
# is set to `ALL_VALUES_UNSPECIFIED`.
- "A String",
+ "A String",
],
- "inheritFromParent": True or False, # Determines the inheritance behavior for this `Policy`.
+ "suggestedValue": "A String", # Optional. The Google Cloud Console will try to default to a configuration
+ # that matches the value specified in this `Policy`. If `suggested_value`
+ # is not set, it will inherit the value specified higher in the hierarchy,
+ # unless `inherit_from_parent` is `false`.
+ "inheritFromParent": True or False, # Determines the inheritance behavior for this `Policy`.
#
# By default, a `ListPolicy` set at a resource supercedes any `Policy` set
# anywhere up the resource hierarchy. However, if `inherit_from_parent` is
@@ -1635,7 +1651,7 @@
# added to the values inherited up the hierarchy.
#
# Setting `Policy` hierarchies that inherit both allowed values and denied
- # values isn't recommended in most circumstances to keep the configuration
+ # values isn't recommended in most circumstances to keep the configuration
# simple and understandable. However, it is possible to set a `Policy` with
# `allowed_values` set that inherits a `Policy` with `denied_values` set.
# In this case, the values that are allowed must be in `allowed_values` and
@@ -1655,31 +1671,31 @@
#
# Example 1 (no inherited values):
# `organizations/foo` has a `Policy` with values:
- # {allowed_values: "E1" allowed_values:"E2"}
+ # {allowed_values: "E1" allowed_values:"E2"}
# `projects/bar` has `inherit_from_parent` `false` and values:
- # {allowed_values: "E3" allowed_values: "E4"}
+ # {allowed_values: "E3" allowed_values: "E4"}
# The accepted values at `organizations/foo` are `E1`, `E2`.
# The accepted values at `projects/bar` are `E3`, and `E4`.
#
# Example 2 (inherited values):
# `organizations/foo` has a `Policy` with values:
- # {allowed_values: "E1" allowed_values:"E2"}
+ # {allowed_values: "E1" allowed_values:"E2"}
# `projects/bar` has a `Policy` with values:
- # {value: "E3" value: "E4" inherit_from_parent: true}
+ # {value: "E3" value: "E4" inherit_from_parent: true}
# The accepted values at `organizations/foo` are `E1`, `E2`.
# The accepted values at `projects/bar` are `E1`, `E2`, `E3`, and `E4`.
#
# Example 3 (inheriting both allowed and denied values):
# `organizations/foo` has a `Policy` with values:
- # {allowed_values: "E1" allowed_values: "E2"}
+ # {allowed_values: "E1" allowed_values: "E2"}
# `projects/bar` has a `Policy` with:
- # {denied_values: "E1"}
+ # {denied_values: "E1"}
# The accepted values at `organizations/foo` are `E1`, `E2`.
# The value accepted at `projects/bar` is `E2`.
#
# Example 4 (RestoreDefault):
# `organizations/foo` has a `Policy` with values:
- # {allowed_values: "E1" allowed_values:"E2"}
+ # {allowed_values: "E1" allowed_values:"E2"}
# `projects/bar` has a `Policy` with values:
# {RestoreDefault: {}}
# The accepted values at `organizations/foo` are `E1`, `E2`.
@@ -1696,7 +1712,7 @@
#
# Example 6 (ListConstraint allowing all):
# `organizations/foo` has a `Policy` with values:
- # {allowed_values: "E1" allowed_values: "E2"}
+ # {allowed_values: "E1" allowed_values: "E2"}
# `projects/bar` has a `Policy` with:
# {all: ALLOW}
# The accepted values at `organizations/foo` are `E1`, E2`.
@@ -1704,7 +1720,7 @@
#
# Example 7 (ListConstraint allowing none):
# `organizations/foo` has a `Policy` with values:
- # {allowed_values: "E1" allowed_values: "E2"}
+ # {allowed_values: "E1" allowed_values: "E2"}
# `projects/bar` has a `Policy` with:
# {all: DENY}
# The accepted values at `organizations/foo` are `E1`, E2`.
@@ -1714,27 +1730,43 @@
# Given the following resource hierarchy
# O1->{F1, F2}; F1->{P1}; F2->{P2, P3},
# `organizations/foo` has a `Policy` with values:
- # {allowed_values: "under:organizations/O1"}
+ # {allowed_values: "under:organizations/O1"}
# `projects/bar` has a `Policy` with:
- # {allowed_values: "under:projects/P3"}
- # {denied_values: "under:folders/F2"}
+ # {allowed_values: "under:projects/P3"}
+ # {denied_values: "under:folders/F2"}
# The accepted values at `organizations/foo` are `organizations/O1`,
# `folders/F1`, `folders/F2`, `projects/P1`, `projects/P2`,
# `projects/P3`.
# The accepted values at `projects/bar` are `organizations/O1`,
# `folders/F1`, `projects/P1`.
- "suggestedValue": "A String", # Optional. The Google Cloud Console will try to default to a configuration
- # that matches the value specified in this `Policy`. If `suggested_value`
- # is not set, it will inherit the value specified higher in the hierarchy,
- # unless `inherit_from_parent` is `false`.
- "allowedValues": [ # List of values allowed at this resource. Can only be set if `all_values`
+ "deniedValues": [ # List of values denied at this resource. Can only be set if `all_values`
# is set to `ALL_VALUES_UNSPECIFIED`.
- "A String",
+ "A String",
],
+ "allValues": "A String", # The policy all_values state.
},
- "booleanPolicy": { # Used in `policy_type` to specify how `boolean_policy` will behave at this # For boolean `Constraints`, whether to enforce the `Constraint` or not.
+ "etag": "A String", # An opaque tag indicating the current version of the `Policy`, used for
+ # concurrency control.
+ #
+ # When the `Policy` is returned from either a `GetPolicy` or a
+ # `ListOrgPolicy` request, this `etag` indicates the version of the current
+ # `Policy` to use when executing a read-modify-write loop.
+ #
+ # When the `Policy` is returned from a `GetEffectivePolicy` request, the
+ # `etag` will be unset.
+ #
+ # When the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value
+ # that was returned from a `GetOrgPolicy` request as part of a
+ # read-modify-write loop for concurrency control. Not setting the `etag`in a
+ # `SetOrgPolicy` request will result in an unconditional write of the
+ # `Policy`.
+ "constraint": "A String", # The name of the `Constraint` the `Policy` is configuring, for example,
+ # `constraints/serviceuser.services`.
+ #
+ # Immutable after creation.
+ "booleanPolicy": { # Used in `policy_type` to specify how `boolean_policy` will behave at this # For boolean `Constraints`, whether to enforce the `Constraint` or not.
# resource.
- "enforced": True or False, # If `true`, then the `Policy` is enforced. If `false`, then any
+ "enforced": True or False, # If `true`, then the `Policy` is enforced. If `false`, then any
# configuration is acceptable.
#
# Suppose you have a `Constraint`
@@ -1779,23 +1811,10 @@
# The constraint at `projects/bar` is not enforced, because
# `constraint_default` for the `Constraint` is `ALLOW`.
},
- "etag": "A String", # An opaque tag indicating the current version of the `Policy`, used for
- # concurrency control.
- #
- # When the `Policy` is returned from either a `GetPolicy` or a
- # `ListOrgPolicy` request, this `etag` indicates the version of the current
- # `Policy` to use when executing a read-modify-write loop.
- #
- # When the `Policy` is returned from a `GetEffectivePolicy` request, the
- # `etag` will be unset.
- #
- # When the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value
- # that was returned from a `GetOrgPolicy` request as part of a
- # read-modify-write loop for concurrency control. Not setting the `etag`in a
- # `SetOrgPolicy` request will result in an unconditional write of the
- # `Policy`.
},
],
+ "nextPageToken": "A String", # Page token used to retrieve the next page. This is currently not used, but
+ # the server may at any point start supplying a valid token.
}</pre>
</div>
@@ -1808,7 +1827,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>
@@ -1822,7 +1841,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>
@@ -1886,7 +1905,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.
@@ -1899,36 +1918,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:**
@@ -1946,19 +1969,192 @@
# 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
+ "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
+ # 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.
+ "logType": "A String", # The log type that this config enables.
+ "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
+ # permission.
+ # Follows the same format of Binding.members.
+ "A String",
+ ],
+ },
+ ],
+ },
+ ],
+ "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`.
- "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
+ "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"
+ #
+ # Example (Equality):
+ #
+ # title: "Requestor is owner"
+ # description: "Determines if requestor is the document owner"
+ # expression: "document.owner == request.auth.claims.email"
+ #
+ # Example (Logic):
+ #
+ # title: "Public documents"
+ # description: "Determine whether the document should be publicly visible"
+ # expression: "document.type != 'private' && document.type != 'internal'"
+ #
+ # Example (Data Manipulation):
+ #
+ # title: "Notification string"
+ # description: "Create a notification string with a timestamp."
+ # expression: "'New message received at ' + string(document.create_time)"
+ #
+ # The exact variables and functions that may be referenced within an expression
+ # are determined by the service that evaluates it. See the service
+ # documentation for additional information.
+ "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` can have the following values:
#
# * `allUsers`: A special identifier that represents anyone who is
@@ -2001,178 +2197,16 @@
# * `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",
],
- "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
- # NOTE: An unsatisfied condition will not allow user access via current
- # binding. Different bindings, including their conditions, are examined
- # independently.
- # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
- # are documented at https://github.com/google/cel-spec.
- #
- # Example (Comparison):
- #
- # title: "Summary size limit"
- # description: "Determines if a summary is less than 100 chars"
- # expression: "document.summary.size() < 100"
- #
- # Example (Equality):
- #
- # title: "Requestor is owner"
- # description: "Determines if requestor is the document owner"
- # expression: "document.owner == request.auth.claims.email"
- #
- # Example (Logic):
- #
- # title: "Public documents"
- # description: "Determine whether the document should be publicly visible"
- # expression: "document.type != 'private' && document.type != 'internal'"
- #
- # Example (Data Manipulation):
- #
- # title: "Notification string"
- # description: "Create a notification string with a timestamp."
- # expression: "'New message received at ' + string(document.create_time)"
- #
- # The exact variables and functions that may be referenced within an expression
- # are determined by the service that evaluates it. See the service
- # documentation for additional information.
- "description": "A String", # Optional. Description of the expression. This is a longer text which
- # describes the expression, e.g. when hovered over it in a UI.
- "expression": "A String", # Textual representation of an expression in Common Expression Language
- # syntax.
- "location": "A String", # Optional. String indicating the location of the expression for error
- # reporting, e.g. a file name and a position in the file.
- "title": "A String", # Optional. Title for the expression, i.e. a short string describing
- # its purpose. This can be used e.g. in UIs which allow to enter the
- # expression.
- },
},
],
- "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
- # 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.
},
- "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.
@@ -2193,36 +2227,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:**
@@ -2240,19 +2278,192 @@
# 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
+ "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
+ # 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.
+ "logType": "A String", # The log type that this config enables.
+ "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
+ # permission.
+ # Follows the same format of Binding.members.
+ "A String",
+ ],
+ },
+ ],
+ },
+ ],
+ "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`.
- "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
+ "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"
+ #
+ # Example (Equality):
+ #
+ # title: "Requestor is owner"
+ # description: "Determines if requestor is the document owner"
+ # expression: "document.owner == request.auth.claims.email"
+ #
+ # Example (Logic):
+ #
+ # title: "Public documents"
+ # description: "Determine whether the document should be publicly visible"
+ # expression: "document.type != 'private' && document.type != 'internal'"
+ #
+ # Example (Data Manipulation):
+ #
+ # title: "Notification string"
+ # description: "Create a notification string with a timestamp."
+ # expression: "'New message received at ' + string(document.create_time)"
+ #
+ # The exact variables and functions that may be referenced within an expression
+ # are determined by the service that evaluates it. See the service
+ # documentation for additional information.
+ "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` can have the following values:
#
# * `allUsers`: A special identifier that represents anyone who is
@@ -2295,172 +2506,10 @@
# * `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",
],
- "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
- # NOTE: An unsatisfied condition will not allow user access via current
- # binding. Different bindings, including their conditions, are examined
- # independently.
- # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
- # are documented at https://github.com/google/cel-spec.
- #
- # Example (Comparison):
- #
- # title: "Summary size limit"
- # description: "Determines if a summary is less than 100 chars"
- # expression: "document.summary.size() < 100"
- #
- # Example (Equality):
- #
- # title: "Requestor is owner"
- # description: "Determines if requestor is the document owner"
- # expression: "document.owner == request.auth.claims.email"
- #
- # Example (Logic):
- #
- # title: "Public documents"
- # description: "Determine whether the document should be publicly visible"
- # expression: "document.type != 'private' && document.type != 'internal'"
- #
- # Example (Data Manipulation):
- #
- # title: "Notification string"
- # description: "Create a notification string with a timestamp."
- # expression: "'New message received at ' + string(document.create_time)"
- #
- # The exact variables and functions that may be referenced within an expression
- # are determined by the service that evaluates it. See the service
- # documentation for additional information.
- "description": "A String", # Optional. Description of the expression. This is a longer text which
- # describes the expression, e.g. when hovered over it in a UI.
- "expression": "A String", # Textual representation of an expression in Common Expression Language
- # syntax.
- "location": "A String", # Optional. String indicating the location of the expression for error
- # reporting, e.g. a file name and a position in the file.
- "title": "A String", # Optional. Title for the expression, i.e. a short string describing
- # its purpose. This can be used e.g. in UIs which allow to enter the
- # expression.
- },
},
],
- "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
- # 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.
}</pre>
</div>
@@ -2478,18 +2527,14 @@
The object takes the form of:
{ # The request sent to the SetOrgPolicyRequest method.
- "policy": { # Defines a Cloud Organization `Policy` which is used to specify `Constraints` # `Policy` to set on the resource.
+ "policy": { # Defines a Cloud Organization `Policy` which is used to specify `Constraints` # `Policy` to set on the resource.
# for configurations of Cloud Platform resources.
- "updateTime": "A String", # The time stamp the `Policy` was previously updated. This is set by the
+ "updateTime": "A String", # The time stamp the `Policy` was previously updated. This is set by the
# server, not specified by the caller, and represents the last time a call to
# `SetOrgPolicy` was made for that `Policy`. Any value set by the client will
# be ignored.
- "version": 42, # Version of the `Policy`. Default version is 0;
- "constraint": "A String", # The name of the `Constraint` the `Policy` is configuring, for example,
- # `constraints/serviceuser.services`.
- #
- # Immutable after creation.
- "restoreDefault": { # Ignores policies set above this resource and restores the # Restores the default behavior of the constraint; independent of
+ "version": 42, # Version of the `Policy`. Default version is 0;
+ "restoreDefault": { # Ignores policies set above this resource and restores the # Restores the default behavior of the constraint; independent of
# `Constraint` type.
# `constraint_default` enforcement behavior of the specific `Constraint` at
# this resource.
@@ -2503,7 +2548,7 @@
# enforcement of the `Constraint` for only those projects, allowing those
# projects to have all services activated.
},
- "listPolicy": { # Used in `policy_type` to specify how `list_policy` behaves at this # List of values either allowed or disallowed.
+ "listPolicy": { # Used in `policy_type` to specify how `list_policy` behaves at this # List of values either allowed or disallowed.
# resource.
#
# `ListPolicy` can define specific values and subtrees of Cloud Resource
@@ -2512,24 +2557,27 @@
# fields. This is achieved by using the `under:` and optional `is:` prefixes.
# The `under:` prefix is used to denote resource subtree values.
# The `is:` prefix is used to denote specific values, and is required only
- # if the value contains a ":". Values prefixed with "is:" are treated the
+ # if the value contains a ":". Values prefixed with "is:" are treated the
# same as values with no prefix.
# Ancestry subtrees must be in one of the following formats:
- # - "projects/<project-id>", e.g. "projects/tokyo-rain-123"
- # - "folders/<folder-id>", e.g. "folders/1234"
- # - "organizations/<organization-id>", e.g. "organizations/1234"
+ # - "projects/<project-id>", e.g. "projects/tokyo-rain-123"
+ # - "folders/<folder-id>", e.g. "folders/1234"
+ # - "organizations/<organization-id>", e.g. "organizations/1234"
# The `supports_under` field of the associated `Constraint` defines whether
# ancestry prefixes can be used. You can set `allowed_values` and
# `denied_values` in the same `Policy` if `all_values` is
# `ALL_VALUES_UNSPECIFIED`. `ALLOW` or `DENY` are used to allow or deny all
# values. If `all_values` is set to either `ALLOW` or `DENY`,
# `allowed_values` and `denied_values` must be unset.
- "allValues": "A String", # The policy all_values state.
- "deniedValues": [ # List of values denied at this resource. Can only be set if `all_values`
+ "allowedValues": [ # List of values allowed at this resource. Can only be set if `all_values`
# is set to `ALL_VALUES_UNSPECIFIED`.
- "A String",
+ "A String",
],
- "inheritFromParent": True or False, # Determines the inheritance behavior for this `Policy`.
+ "suggestedValue": "A String", # Optional. The Google Cloud Console will try to default to a configuration
+ # that matches the value specified in this `Policy`. If `suggested_value`
+ # is not set, it will inherit the value specified higher in the hierarchy,
+ # unless `inherit_from_parent` is `false`.
+ "inheritFromParent": True or False, # Determines the inheritance behavior for this `Policy`.
#
# By default, a `ListPolicy` set at a resource supercedes any `Policy` set
# anywhere up the resource hierarchy. However, if `inherit_from_parent` is
@@ -2538,7 +2586,7 @@
# added to the values inherited up the hierarchy.
#
# Setting `Policy` hierarchies that inherit both allowed values and denied
- # values isn't recommended in most circumstances to keep the configuration
+ # values isn't recommended in most circumstances to keep the configuration
# simple and understandable. However, it is possible to set a `Policy` with
# `allowed_values` set that inherits a `Policy` with `denied_values` set.
# In this case, the values that are allowed must be in `allowed_values` and
@@ -2558,31 +2606,31 @@
#
# Example 1 (no inherited values):
# `organizations/foo` has a `Policy` with values:
- # {allowed_values: "E1" allowed_values:"E2"}
+ # {allowed_values: "E1" allowed_values:"E2"}
# `projects/bar` has `inherit_from_parent` `false` and values:
- # {allowed_values: "E3" allowed_values: "E4"}
+ # {allowed_values: "E3" allowed_values: "E4"}
# The accepted values at `organizations/foo` are `E1`, `E2`.
# The accepted values at `projects/bar` are `E3`, and `E4`.
#
# Example 2 (inherited values):
# `organizations/foo` has a `Policy` with values:
- # {allowed_values: "E1" allowed_values:"E2"}
+ # {allowed_values: "E1" allowed_values:"E2"}
# `projects/bar` has a `Policy` with values:
- # {value: "E3" value: "E4" inherit_from_parent: true}
+ # {value: "E3" value: "E4" inherit_from_parent: true}
# The accepted values at `organizations/foo` are `E1`, `E2`.
# The accepted values at `projects/bar` are `E1`, `E2`, `E3`, and `E4`.
#
# Example 3 (inheriting both allowed and denied values):
# `organizations/foo` has a `Policy` with values:
- # {allowed_values: "E1" allowed_values: "E2"}
+ # {allowed_values: "E1" allowed_values: "E2"}
# `projects/bar` has a `Policy` with:
- # {denied_values: "E1"}
+ # {denied_values: "E1"}
# The accepted values at `organizations/foo` are `E1`, `E2`.
# The value accepted at `projects/bar` is `E2`.
#
# Example 4 (RestoreDefault):
# `organizations/foo` has a `Policy` with values:
- # {allowed_values: "E1" allowed_values:"E2"}
+ # {allowed_values: "E1" allowed_values:"E2"}
# `projects/bar` has a `Policy` with values:
# {RestoreDefault: {}}
# The accepted values at `organizations/foo` are `E1`, `E2`.
@@ -2599,7 +2647,7 @@
#
# Example 6 (ListConstraint allowing all):
# `organizations/foo` has a `Policy` with values:
- # {allowed_values: "E1" allowed_values: "E2"}
+ # {allowed_values: "E1" allowed_values: "E2"}
# `projects/bar` has a `Policy` with:
# {all: ALLOW}
# The accepted values at `organizations/foo` are `E1`, E2`.
@@ -2607,7 +2655,7 @@
#
# Example 7 (ListConstraint allowing none):
# `organizations/foo` has a `Policy` with values:
- # {allowed_values: "E1" allowed_values: "E2"}
+ # {allowed_values: "E1" allowed_values: "E2"}
# `projects/bar` has a `Policy` with:
# {all: DENY}
# The accepted values at `organizations/foo` are `E1`, E2`.
@@ -2617,27 +2665,43 @@
# Given the following resource hierarchy
# O1->{F1, F2}; F1->{P1}; F2->{P2, P3},
# `organizations/foo` has a `Policy` with values:
- # {allowed_values: "under:organizations/O1"}
+ # {allowed_values: "under:organizations/O1"}
# `projects/bar` has a `Policy` with:
- # {allowed_values: "under:projects/P3"}
- # {denied_values: "under:folders/F2"}
+ # {allowed_values: "under:projects/P3"}
+ # {denied_values: "under:folders/F2"}
# The accepted values at `organizations/foo` are `organizations/O1`,
# `folders/F1`, `folders/F2`, `projects/P1`, `projects/P2`,
# `projects/P3`.
# The accepted values at `projects/bar` are `organizations/O1`,
# `folders/F1`, `projects/P1`.
- "suggestedValue": "A String", # Optional. The Google Cloud Console will try to default to a configuration
- # that matches the value specified in this `Policy`. If `suggested_value`
- # is not set, it will inherit the value specified higher in the hierarchy,
- # unless `inherit_from_parent` is `false`.
- "allowedValues": [ # List of values allowed at this resource. Can only be set if `all_values`
+ "deniedValues": [ # List of values denied at this resource. Can only be set if `all_values`
# is set to `ALL_VALUES_UNSPECIFIED`.
- "A String",
+ "A String",
],
+ "allValues": "A String", # The policy all_values state.
},
- "booleanPolicy": { # Used in `policy_type` to specify how `boolean_policy` will behave at this # For boolean `Constraints`, whether to enforce the `Constraint` or not.
+ "etag": "A String", # An opaque tag indicating the current version of the `Policy`, used for
+ # concurrency control.
+ #
+ # When the `Policy` is returned from either a `GetPolicy` or a
+ # `ListOrgPolicy` request, this `etag` indicates the version of the current
+ # `Policy` to use when executing a read-modify-write loop.
+ #
+ # When the `Policy` is returned from a `GetEffectivePolicy` request, the
+ # `etag` will be unset.
+ #
+ # When the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value
+ # that was returned from a `GetOrgPolicy` request as part of a
+ # read-modify-write loop for concurrency control. Not setting the `etag`in a
+ # `SetOrgPolicy` request will result in an unconditional write of the
+ # `Policy`.
+ "constraint": "A String", # The name of the `Constraint` the `Policy` is configuring, for example,
+ # `constraints/serviceuser.services`.
+ #
+ # Immutable after creation.
+ "booleanPolicy": { # Used in `policy_type` to specify how `boolean_policy` will behave at this # For boolean `Constraints`, whether to enforce the `Constraint` or not.
# resource.
- "enforced": True or False, # If `true`, then the `Policy` is enforced. If `false`, then any
+ "enforced": True or False, # If `true`, then the `Policy` is enforced. If `false`, then any
# configuration is acceptable.
#
# Suppose you have a `Constraint`
@@ -2682,21 +2746,6 @@
# The constraint at `projects/bar` is not enforced, because
# `constraint_default` for the `Constraint` is `ALLOW`.
},
- "etag": "A String", # An opaque tag indicating the current version of the `Policy`, used for
- # concurrency control.
- #
- # When the `Policy` is returned from either a `GetPolicy` or a
- # `ListOrgPolicy` request, this `etag` indicates the version of the current
- # `Policy` to use when executing a read-modify-write loop.
- #
- # When the `Policy` is returned from a `GetEffectivePolicy` request, the
- # `etag` will be unset.
- #
- # When the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value
- # that was returned from a `GetOrgPolicy` request as part of a
- # read-modify-write loop for concurrency control. Not setting the `etag`in a
- # `SetOrgPolicy` request will result in an unconditional write of the
- # `Policy`.
},
}
@@ -2710,16 +2759,12 @@
{ # Defines a Cloud Organization `Policy` which is used to specify `Constraints`
# for configurations of Cloud Platform resources.
- "updateTime": "A String", # The time stamp the `Policy` was previously updated. This is set by the
+ "updateTime": "A String", # The time stamp the `Policy` was previously updated. This is set by the
# server, not specified by the caller, and represents the last time a call to
# `SetOrgPolicy` was made for that `Policy`. Any value set by the client will
# be ignored.
- "version": 42, # Version of the `Policy`. Default version is 0;
- "constraint": "A String", # The name of the `Constraint` the `Policy` is configuring, for example,
- # `constraints/serviceuser.services`.
- #
- # Immutable after creation.
- "restoreDefault": { # Ignores policies set above this resource and restores the # Restores the default behavior of the constraint; independent of
+ "version": 42, # Version of the `Policy`. Default version is 0;
+ "restoreDefault": { # Ignores policies set above this resource and restores the # Restores the default behavior of the constraint; independent of
# `Constraint` type.
# `constraint_default` enforcement behavior of the specific `Constraint` at
# this resource.
@@ -2733,7 +2778,7 @@
# enforcement of the `Constraint` for only those projects, allowing those
# projects to have all services activated.
},
- "listPolicy": { # Used in `policy_type` to specify how `list_policy` behaves at this # List of values either allowed or disallowed.
+ "listPolicy": { # Used in `policy_type` to specify how `list_policy` behaves at this # List of values either allowed or disallowed.
# resource.
#
# `ListPolicy` can define specific values and subtrees of Cloud Resource
@@ -2742,24 +2787,27 @@
# fields. This is achieved by using the `under:` and optional `is:` prefixes.
# The `under:` prefix is used to denote resource subtree values.
# The `is:` prefix is used to denote specific values, and is required only
- # if the value contains a ":". Values prefixed with "is:" are treated the
+ # if the value contains a ":". Values prefixed with "is:" are treated the
# same as values with no prefix.
# Ancestry subtrees must be in one of the following formats:
- # - "projects/<project-id>", e.g. "projects/tokyo-rain-123"
- # - "folders/<folder-id>", e.g. "folders/1234"
- # - "organizations/<organization-id>", e.g. "organizations/1234"
+ # - "projects/<project-id>", e.g. "projects/tokyo-rain-123"
+ # - "folders/<folder-id>", e.g. "folders/1234"
+ # - "organizations/<organization-id>", e.g. "organizations/1234"
# The `supports_under` field of the associated `Constraint` defines whether
# ancestry prefixes can be used. You can set `allowed_values` and
# `denied_values` in the same `Policy` if `all_values` is
# `ALL_VALUES_UNSPECIFIED`. `ALLOW` or `DENY` are used to allow or deny all
# values. If `all_values` is set to either `ALLOW` or `DENY`,
# `allowed_values` and `denied_values` must be unset.
- "allValues": "A String", # The policy all_values state.
- "deniedValues": [ # List of values denied at this resource. Can only be set if `all_values`
+ "allowedValues": [ # List of values allowed at this resource. Can only be set if `all_values`
# is set to `ALL_VALUES_UNSPECIFIED`.
- "A String",
+ "A String",
],
- "inheritFromParent": True or False, # Determines the inheritance behavior for this `Policy`.
+ "suggestedValue": "A String", # Optional. The Google Cloud Console will try to default to a configuration
+ # that matches the value specified in this `Policy`. If `suggested_value`
+ # is not set, it will inherit the value specified higher in the hierarchy,
+ # unless `inherit_from_parent` is `false`.
+ "inheritFromParent": True or False, # Determines the inheritance behavior for this `Policy`.
#
# By default, a `ListPolicy` set at a resource supercedes any `Policy` set
# anywhere up the resource hierarchy. However, if `inherit_from_parent` is
@@ -2768,7 +2816,7 @@
# added to the values inherited up the hierarchy.
#
# Setting `Policy` hierarchies that inherit both allowed values and denied
- # values isn't recommended in most circumstances to keep the configuration
+ # values isn't recommended in most circumstances to keep the configuration
# simple and understandable. However, it is possible to set a `Policy` with
# `allowed_values` set that inherits a `Policy` with `denied_values` set.
# In this case, the values that are allowed must be in `allowed_values` and
@@ -2788,31 +2836,31 @@
#
# Example 1 (no inherited values):
# `organizations/foo` has a `Policy` with values:
- # {allowed_values: "E1" allowed_values:"E2"}
+ # {allowed_values: "E1" allowed_values:"E2"}
# `projects/bar` has `inherit_from_parent` `false` and values:
- # {allowed_values: "E3" allowed_values: "E4"}
+ # {allowed_values: "E3" allowed_values: "E4"}
# The accepted values at `organizations/foo` are `E1`, `E2`.
# The accepted values at `projects/bar` are `E3`, and `E4`.
#
# Example 2 (inherited values):
# `organizations/foo` has a `Policy` with values:
- # {allowed_values: "E1" allowed_values:"E2"}
+ # {allowed_values: "E1" allowed_values:"E2"}
# `projects/bar` has a `Policy` with values:
- # {value: "E3" value: "E4" inherit_from_parent: true}
+ # {value: "E3" value: "E4" inherit_from_parent: true}
# The accepted values at `organizations/foo` are `E1`, `E2`.
# The accepted values at `projects/bar` are `E1`, `E2`, `E3`, and `E4`.
#
# Example 3 (inheriting both allowed and denied values):
# `organizations/foo` has a `Policy` with values:
- # {allowed_values: "E1" allowed_values: "E2"}
+ # {allowed_values: "E1" allowed_values: "E2"}
# `projects/bar` has a `Policy` with:
- # {denied_values: "E1"}
+ # {denied_values: "E1"}
# The accepted values at `organizations/foo` are `E1`, `E2`.
# The value accepted at `projects/bar` is `E2`.
#
# Example 4 (RestoreDefault):
# `organizations/foo` has a `Policy` with values:
- # {allowed_values: "E1" allowed_values:"E2"}
+ # {allowed_values: "E1" allowed_values:"E2"}
# `projects/bar` has a `Policy` with values:
# {RestoreDefault: {}}
# The accepted values at `organizations/foo` are `E1`, `E2`.
@@ -2829,7 +2877,7 @@
#
# Example 6 (ListConstraint allowing all):
# `organizations/foo` has a `Policy` with values:
- # {allowed_values: "E1" allowed_values: "E2"}
+ # {allowed_values: "E1" allowed_values: "E2"}
# `projects/bar` has a `Policy` with:
# {all: ALLOW}
# The accepted values at `organizations/foo` are `E1`, E2`.
@@ -2837,7 +2885,7 @@
#
# Example 7 (ListConstraint allowing none):
# `organizations/foo` has a `Policy` with values:
- # {allowed_values: "E1" allowed_values: "E2"}
+ # {allowed_values: "E1" allowed_values: "E2"}
# `projects/bar` has a `Policy` with:
# {all: DENY}
# The accepted values at `organizations/foo` are `E1`, E2`.
@@ -2847,27 +2895,43 @@
# Given the following resource hierarchy
# O1->{F1, F2}; F1->{P1}; F2->{P2, P3},
# `organizations/foo` has a `Policy` with values:
- # {allowed_values: "under:organizations/O1"}
+ # {allowed_values: "under:organizations/O1"}
# `projects/bar` has a `Policy` with:
- # {allowed_values: "under:projects/P3"}
- # {denied_values: "under:folders/F2"}
+ # {allowed_values: "under:projects/P3"}
+ # {denied_values: "under:folders/F2"}
# The accepted values at `organizations/foo` are `organizations/O1`,
# `folders/F1`, `folders/F2`, `projects/P1`, `projects/P2`,
# `projects/P3`.
# The accepted values at `projects/bar` are `organizations/O1`,
# `folders/F1`, `projects/P1`.
- "suggestedValue": "A String", # Optional. The Google Cloud Console will try to default to a configuration
- # that matches the value specified in this `Policy`. If `suggested_value`
- # is not set, it will inherit the value specified higher in the hierarchy,
- # unless `inherit_from_parent` is `false`.
- "allowedValues": [ # List of values allowed at this resource. Can only be set if `all_values`
+ "deniedValues": [ # List of values denied at this resource. Can only be set if `all_values`
# is set to `ALL_VALUES_UNSPECIFIED`.
- "A String",
+ "A String",
],
+ "allValues": "A String", # The policy all_values state.
},
- "booleanPolicy": { # Used in `policy_type` to specify how `boolean_policy` will behave at this # For boolean `Constraints`, whether to enforce the `Constraint` or not.
+ "etag": "A String", # An opaque tag indicating the current version of the `Policy`, used for
+ # concurrency control.
+ #
+ # When the `Policy` is returned from either a `GetPolicy` or a
+ # `ListOrgPolicy` request, this `etag` indicates the version of the current
+ # `Policy` to use when executing a read-modify-write loop.
+ #
+ # When the `Policy` is returned from a `GetEffectivePolicy` request, the
+ # `etag` will be unset.
+ #
+ # When the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value
+ # that was returned from a `GetOrgPolicy` request as part of a
+ # read-modify-write loop for concurrency control. Not setting the `etag`in a
+ # `SetOrgPolicy` request will result in an unconditional write of the
+ # `Policy`.
+ "constraint": "A String", # The name of the `Constraint` the `Policy` is configuring, for example,
+ # `constraints/serviceuser.services`.
+ #
+ # Immutable after creation.
+ "booleanPolicy": { # Used in `policy_type` to specify how `boolean_policy` will behave at this # For boolean `Constraints`, whether to enforce the `Constraint` or not.
# resource.
- "enforced": True or False, # If `true`, then the `Policy` is enforced. If `false`, then any
+ "enforced": True or False, # If `true`, then the `Policy` is enforced. If `false`, then any
# configuration is acceptable.
#
# Suppose you have a `Constraint`
@@ -2912,21 +2976,6 @@
# The constraint at `projects/bar` is not enforced, because
# `constraint_default` for the `Constraint` is `ALLOW`.
},
- "etag": "A String", # An opaque tag indicating the current version of the `Policy`, used for
- # concurrency control.
- #
- # When the `Policy` is returned from either a `GetPolicy` or a
- # `ListOrgPolicy` request, this `etag` indicates the version of the current
- # `Policy` to use when executing a read-modify-write loop.
- #
- # When the `Policy` is returned from a `GetEffectivePolicy` request, the
- # `etag` will be unset.
- #
- # When the `Policy` is used in a `SetOrgPolicy` method, use the `etag` value
- # that was returned from a `GetOrgPolicy` request as part of a
- # read-modify-write loop for concurrency control. Not setting the `etag`in a
- # `SetOrgPolicy` request will result in an unconditional write of the
- # `Policy`.
}</pre>
</div>
@@ -2943,11 +2992,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",
],
}
@@ -2960,9 +3009,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>
@@ -3023,67 +3072,67 @@
The object takes the form of:
{ # 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.
- "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,
- # 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: "organization", "folder", and "project".
- "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.
- #
- # 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>
- # Read-write.
- "a_key": "A String",
- },
- "projectNumber": "A String", # The number uniquely identifying the project.
- #
- # Example: <code>415104041262</code>
- # Read-only.
- "lifecycleState": "A String", # The Project lifecycle state.
- #
- # Read-only.
- "createTime": "A String", # Creation time.
- #
- # Read-only.
- }
+ # container for ACLs, APIs, App Engine Apps, VMs, and other
+ # Google Cloud Platform resources.
+ "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,
+ # 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: "organization", "folder", and "project".
+ "id": "A String", # Required field for the type-specific id. This should correspond to the id
+ # used in the type-specific API's.
+ },
+ "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>
+ # Read-write.
+ "a_key": "A String",
+ },
+ "createTime": "A String", # Creation time.
+ #
+ # Read-only.
+ "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.
+ # Trailing hyphens are prohibited.
+ #
+ # Example: <code>tokyo-rain-123</code>
+ # Read-only after creation.
+ "lifecycleState": "A String", # The Project lifecycle state.
+ #
+ # Read-only.
+ "projectNumber": "A String", # The number uniquely identifying the project.
+ #
+ # Example: <code>415104041262</code>
+ # Read-only.
+}
x__xgafv: string, V1 error format.
Allowed values
@@ -3094,67 +3143,67 @@
An object of the form:
{ # 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.
- "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,
- # 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: "organization", "folder", and "project".
- "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.
- #
- # 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>
- # Read-write.
- "a_key": "A String",
- },
- "projectNumber": "A String", # The number uniquely identifying the project.
- #
- # Example: <code>415104041262</code>
- # Read-only.
- "lifecycleState": "A String", # The Project lifecycle state.
- #
- # Read-only.
- "createTime": "A String", # Creation time.
- #
- # Read-only.
- }</pre>
+ # container for ACLs, APIs, App Engine Apps, VMs, and other
+ # Google Cloud Platform resources.
+ "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,
+ # 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: "organization", "folder", and "project".
+ "id": "A String", # Required field for the type-specific id. This should correspond to the id
+ # used in the type-specific API's.
+ },
+ "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>
+ # Read-write.
+ "a_key": "A String",
+ },
+ "createTime": "A String", # Creation time.
+ #
+ # Read-only.
+ "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.
+ # Trailing hyphens are prohibited.
+ #
+ # Example: <code>tokyo-rain-123</code>
+ # Read-only after creation.
+ "lifecycleState": "A String", # The Project lifecycle state.
+ #
+ # Read-only.
+ "projectNumber": "A String", # The number uniquely identifying the project.
+ #
+ # Example: <code>415104041262</code>
+ # Read-only.
+ }</pre>
</div>
</body></html>
\ No newline at end of file