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/cloudasset_v1.v1.html b/docs/dyn/cloudasset_v1.v1.html
index 99d23df..471b5f0 100644
--- a/docs/dyn/cloudasset_v1.v1.html
+++ b/docs/dyn/cloudasset_v1.v1.html
@@ -75,14 +75,14 @@
<h1><a href="cloudasset_v1.html">Cloud Asset API</a> . <a href="cloudasset_v1.v1.html">v1</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#batchGetAssetsHistory">batchGetAssetsHistory(parent, contentType=None, assetNames=None, readTimeWindow_startTime=None, readTimeWindow_endTime=None, x__xgafv=None)</a></code></p>
+ <code><a href="#batchGetAssetsHistory">batchGetAssetsHistory(parent, assetNames=None, contentType=None, readTimeWindow_endTime=None, readTimeWindow_startTime=None, x__xgafv=None)</a></code></p>
<p class="firstline">Batch gets the update history of assets that overlap a time window.</p>
<p class="toc_element">
<code><a href="#exportAssets">exportAssets(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Exports assets with time and resource types to a given Cloud Storage</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="batchGetAssetsHistory">batchGetAssetsHistory(parent, contentType=None, assetNames=None, readTimeWindow_startTime=None, readTimeWindow_endTime=None, x__xgafv=None)</code>
+ <code class="details" id="batchGetAssetsHistory">batchGetAssetsHistory(parent, assetNames=None, contentType=None, readTimeWindow_endTime=None, readTimeWindow_startTime=None, x__xgafv=None)</code>
<pre>Batch gets the update history of assets that overlap a time window.
For RESOURCE content, this API outputs history with asset in both
non-delete or deleted status.
@@ -93,9 +93,8 @@
Args:
parent: string, Required. The relative name of the root asset. It can only be an
-organization number (such as "organizations/123"), a project ID (such as
-"projects/my-project-id")", or a project number (such as "projects/12345"). (required)
- contentType: string, Optional. The content type.
+organization number (such as "organizations/123"), a project ID (such as
+"projects/my-project-id")", or a project number (such as "projects/12345"). (required)
assetNames: string, A list of the full names of the assets. For example:
`//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1`.
See [Resource
@@ -106,9 +105,10 @@
The request becomes a no-op if the asset name list is empty, and the max
size of the asset name list is 100 in one request. (repeated)
- readTimeWindow_startTime: string, Start time of the time window (exclusive).
+ contentType: string, Optional. The content type.
readTimeWindow_endTime: string, End time of the time window (inclusive). If not specified, the current
timestamp is used instead.
+ readTimeWindow_startTime: string, Start time of the time window (exclusive).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -118,42 +118,171 @@
An object of the form:
{ # Batch get assets history response.
- "assets": [ # A list of assets with valid time windows.
+ "assets": [ # A list of assets with valid time windows.
{ # An asset in Google Cloud and its temporal metadata, including the time window
# when it was observed and its status during that window.
- "deleted": True or False, # Whether the asset has been deleted or not.
- "window": { # A time window specified by its "start_time" and "end_time". # The time window when the asset data and state was observed.
- "endTime": "A String", # End time of the time window (inclusive). If not specified, the current
+ "deleted": True or False, # Whether the asset has been deleted or not.
+ "window": { # A time window specified by its "start_time" and "end_time". # The time window when the asset data and state was observed.
+ "endTime": "A String", # End time of the time window (inclusive). If not specified, the current
# timestamp is used instead.
- "startTime": "A String", # Start time of the time window (exclusive).
+ "startTime": "A String", # Start time of the time window (exclusive).
},
- "asset": { # An asset in Google Cloud. An asset can be any resource in the Google Cloud # An asset in Google Cloud.
+ "asset": { # An asset in Google Cloud. An asset can be any resource in the Google Cloud # An asset in Google Cloud.
# [resource
# hierarchy](https://cloud.google.com/resource-manager/docs/cloud-platform-resource-hierarchy),
# a resource outside the Google Cloud resource hierarchy (such as Google
# Kubernetes Engine clusters and objects), or a Cloud IAM policy.
- "assetType": "A String", # The type of the asset. For example: "compute.googleapis.com/Disk"
+ "assetType": "A String", # The type of the asset. For example: "compute.googleapis.com/Disk"
#
# See [Supported asset
# types](https://cloud.google.com/asset-inventory/docs/supported-asset-types)
# for more information.
- "ancestors": [ # The ancestry path of an asset in Google Cloud [resource
+ "accessPolicy": { # `AccessPolicy` is a container for `AccessLevels` (which define the necessary
+ # attributes to use Google Cloud services) and `ServicePerimeters` (which
+ # define regions of services able to freely pass data within a perimeter). An
+ # access policy is globally visible within an organization, and the
+ # restrictions it specifies apply to all projects within an organization.
+ "name": "A String", # Output only. Resource name of the `AccessPolicy`. Format:
+ # `accessPolicies/{policy_id}`
+ "etag": "A String", # Output only. An opaque identifier for the current version of the
+ # `AccessPolicy`. This will always be a strongly validated etag, meaning that
+ # two Access Polices will be identical if and only if their etags are
+ # identical. Clients should not expect this to be in any specific format.
+ "parent": "A String", # Required. The parent of this `AccessPolicy` in the Cloud Resource
+ # Hierarchy. Currently immutable once created. Format:
+ # `organizations/{organization_id}`
+ "title": "A String", # Required. Human readable title. Does not affect behavior.
+ },
+ "ancestors": [ # The ancestry path of an asset in Google Cloud [resource
# hierarchy](https://cloud.google.com/resource-manager/docs/cloud-platform-resource-hierarchy),
# represented as a list of relative resource names. An ancestry path starts
# with the closest ancestor in the hierarchy and ends at root. If the asset
# is a project, folder, or organization, the ancestry path starts from the
# asset itself.
#
- # For example: `["projects/123456789", "folders/5432", "organizations/1234"]`
- "A String",
+ # For example: `["projects/123456789", "folders/5432", "organizations/1234"]`
+ "A String",
],
- "resource": { # A representation of a Google Cloud resource. # A representation of the resource.
- "resourceUrl": "A String", # The REST URL for accessing the resource. An HTTP `GET` request using this
- # URL returns the resource itself. For example:
- # "https://cloudresourcemanager.googleapis.com/v1/projects/my-project-123"
+ "servicePerimeter": { # `ServicePerimeter` describes a set of Google Cloud resources which can freely
+ # import and export data amongst themselves, but not export outside of the
+ # `ServicePerimeter`. If a request with a source within this `ServicePerimeter`
+ # has a target outside of the `ServicePerimeter`, the request will be blocked.
+ # Otherwise the request is allowed. There are two types of Service Perimeter -
+ # Regular and Bridge. Regular Service Perimeters cannot overlap, a single
+ # Google Cloud project can only belong to a single regular Service Perimeter.
+ # Service Perimeter Bridges can contain only Google Cloud projects as members,
+ # a single Google Cloud project may belong to multiple Service Perimeter
+ # Bridges.
+ "name": "A String", # Required. Resource name for the ServicePerimeter. The `short_name`
+ # component must begin with a letter and only include alphanumeric and '_'.
+ # Format: `accessPolicies/{policy_id}/servicePerimeters/{short_name}`
+ "perimeterType": "A String", # Perimeter type indicator. A single project is
+ # allowed to be a member of single regular perimeter, but multiple service
+ # perimeter bridges. A project cannot be a included in a perimeter bridge
+ # without being included in regular perimeter. For perimeter bridges,
+ # the restricted service list as well as access level lists must be
+ # empty.
+ "title": "A String", # Human readable title. Must be unique within the Policy.
+ "useExplicitDryRunSpec": True or False, # Use explicit dry run spec flag. Ordinarily, a dry-run spec implicitly
+ # exists for all Service Perimeters, and that spec is identical to the
+ # status for those Service Perimeters. When this flag is set, it inhibits the
+ # generation of the implicit spec, thereby allowing the user to explicitly
+ # provide a configuration ("spec") to use in a dry-run version of the Service
+ # Perimeter. This allows the user to test changes to the enforced config
+ # ("status") without actually enforcing them. This testing is done through
+ # analyzing the differences between currently enforced and suggested
+ # restrictions. use_explicit_dry_run_spec must bet set to True if any of the
+ # fields in the spec are set to non-default values.
+ "description": "A String", # Description of the `ServicePerimeter` and its use. Does not affect
+ # behavior.
+ "status": { # `ServicePerimeterConfig` specifies a set of Google Cloud resources that # Current ServicePerimeter configuration. Specifies sets of resources,
+ # restricted services and access levels that determine perimeter
+ # content and boundaries.
+ # describe specific Service Perimeter configuration.
+ "resources": [ # A list of Google Cloud resources that are inside of the service perimeter.
+ # Currently only projects are allowed. Format: `projects/{project_number}`
+ "A String",
+ ],
+ "accessLevels": [ # A list of `AccessLevel` resource names that allow resources within the
+ # `ServicePerimeter` to be accessed from the internet. `AccessLevels` listed
+ # must be in the same policy as this `ServicePerimeter`. Referencing a
+ # nonexistent `AccessLevel` is a syntax error. If no `AccessLevel` names are
+ # listed, resources within the perimeter can only be accessed via Google
+ # Cloud calls with request origins within the perimeter. Example:
+ # `"accessPolicies/MY_POLICY/accessLevels/MY_LEVEL"`.
+ # For Service Perimeter Bridge, must be empty.
+ "A String",
+ ],
+ "restrictedServices": [ # Google Cloud services that are subject to the Service Perimeter
+ # restrictions. For example, if `storage.googleapis.com` is specified, access
+ # to the storage buckets inside the perimeter must meet the perimeter's
+ # access restrictions.
+ "A String",
+ ],
+ "vpcAccessibleServices": { # Specifies how APIs are allowed to communicate within the Service # Configuration for APIs allowed within Perimeter.
+ # Perimeter.
+ "enableRestriction": True or False, # Whether to restrict API calls within the Service Perimeter to the list of
+ # APIs specified in 'allowed_services'.
+ "allowedServices": [ # The list of APIs usable within the Service Perimeter. Must be empty
+ # unless 'enable_restriction' is True.
+ "A String",
+ ],
+ },
+ },
+ "spec": { # `ServicePerimeterConfig` specifies a set of Google Cloud resources that # Proposed (or dry run) ServicePerimeter configuration. This configuration
+ # allows to specify and test ServicePerimeter configuration without enforcing
+ # actual access restrictions. Only allowed to be set when the
+ # "use_explicit_dry_run_spec" flag is set.
+ # describe specific Service Perimeter configuration.
+ "resources": [ # A list of Google Cloud resources that are inside of the service perimeter.
+ # Currently only projects are allowed. Format: `projects/{project_number}`
+ "A String",
+ ],
+ "accessLevels": [ # A list of `AccessLevel` resource names that allow resources within the
+ # `ServicePerimeter` to be accessed from the internet. `AccessLevels` listed
+ # must be in the same policy as this `ServicePerimeter`. Referencing a
+ # nonexistent `AccessLevel` is a syntax error. If no `AccessLevel` names are
+ # listed, resources within the perimeter can only be accessed via Google
+ # Cloud calls with request origins within the perimeter. Example:
+ # `"accessPolicies/MY_POLICY/accessLevels/MY_LEVEL"`.
+ # For Service Perimeter Bridge, must be empty.
+ "A String",
+ ],
+ "restrictedServices": [ # Google Cloud services that are subject to the Service Perimeter
+ # restrictions. For example, if `storage.googleapis.com` is specified, access
+ # to the storage buckets inside the perimeter must meet the perimeter's
+ # access restrictions.
+ "A String",
+ ],
+ "vpcAccessibleServices": { # Specifies how APIs are allowed to communicate within the Service # Configuration for APIs allowed within Perimeter.
+ # Perimeter.
+ "enableRestriction": True or False, # Whether to restrict API calls within the Service Perimeter to the list of
+ # APIs specified in 'allowed_services'.
+ "allowedServices": [ # The list of APIs usable within the Service Perimeter. Must be empty
+ # unless 'enable_restriction' is True.
+ "A String",
+ ],
+ },
+ },
+ },
+ "resource": { # A representation of a Google Cloud resource. # A representation of the resource.
+ "discoveryName": "A String", # The JSON schema name listed in the discovery document. For example:
+ # "Project"
#
- # This value is unspecified for resources without a REST API.
- "parent": "A String", # The full name of the immediate parent of this resource. See
+ # This value is unspecified for resources that do not have an API based on a
+ # discovery document, such as Cloud Bigtable.
+ "version": "A String", # The API version. For example: "v1"
+ "data": { # The content of the resource, in which some sensitive fields are removed
+ # and may not be present.
+ "a_key": "", # Properties of the object.
+ },
+ "discoveryDocumentUri": "A String", # The URL of the discovery document containing the resource's JSON schema.
+ # For example:
+ # "https://www.googleapis.com/discovery/v1/apis/compute/v1/rest"
+ #
+ # This value is unspecified for resources that do not have an API based on a
+ # discovery document, such as Cloud Bigtable.
+ "parent": "A String", # The full name of the immediate parent of this resource. See
# [Resource
# Names](https://cloud.google.com/apis/design/resource_names#full_resource_name)
# for more information.
@@ -162,62 +291,28 @@
# [Cloud IAM policy
# hierarchy](https://cloud.google.com/iam/docs/overview#policy_hierarchy).
# For example:
- # "//cloudresourcemanager.googleapis.com/projects/my_project_123"
+ # "//cloudresourcemanager.googleapis.com/projects/my_project_123"
#
# For third-party assets, this field may be set differently.
- "discoveryDocumentUri": "A String", # The URL of the discovery document containing the resource's JSON schema.
- # For example:
- # "https://www.googleapis.com/discovery/v1/apis/compute/v1/rest"
+ "resourceUrl": "A String", # The REST URL for accessing the resource. An HTTP `GET` request using this
+ # URL returns the resource itself. For example:
+ # "https://cloudresourcemanager.googleapis.com/v1/projects/my-project-123"
#
- # This value is unspecified for resources that do not have an API based on a
- # discovery document, such as Cloud Bigtable.
- "discoveryName": "A String", # The JSON schema name listed in the discovery document. For example:
- # "Project"
- #
- # This value is unspecified for resources that do not have an API based on a
- # discovery document, such as Cloud Bigtable.
- "version": "A String", # The API version. For example: "v1"
- "data": { # The content of the resource, in which some sensitive fields are removed
- # and may not be present.
- "a_key": "", # Properties of the object.
- },
+ # This value is unspecified for resources without a REST API.
},
- "name": "A String", # The full name of the asset. For example:
- # "//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1"
+ "name": "A String", # The full name of the asset. For example:
+ # "//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1"
#
# See [Resource
# names](https://cloud.google.com/apis/design/resource_names#full_resource_name)
# for more information.
- "orgPolicy": [ # A representation of an [organization
+ "orgPolicy": [ # A representation of an [organization
# policy](https://cloud.google.com/resource-manager/docs/organization-policy/overview#organization_policy).
# There can be more than one organization policy with different constraints
# set on a given resource.
{ # 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
- # 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
- # `Constraint` type.
- # `constraint_default` enforcement behavior of the specific `Constraint` at
- # this resource.
- #
- # Suppose that `constraint_default` is set to `ALLOW` for the
- # `Constraint` `constraints/serviceuser.services`. Suppose that organization
- # foo.com sets a `Policy` at their Organization resource node that restricts
- # the allowed service activations to deny all service activations. They
- # could then set a `Policy` with the `policy_type` `restore_default` on
- # several experimental projects, restoring the `constraint_default`
- # 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
@@ -226,24 +321,32 @@
# 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.
- "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",
],
- "inheritFromParent": True or False, # Determines the inheritance behavior for this `Policy`.
+ "allValues": "A String", # The policy all_values state.
+ "allowedValues": [ # List of values allowed at this resource. Can only be set if `all_values`
+ # is set to `ALL_VALUES_UNSPECIFIED`.
+ "A String",
+ ],
+ "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
@@ -252,7 +355,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
@@ -272,31 +375,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`.
@@ -313,7 +416,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`.
@@ -321,7 +424,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`.
@@ -331,27 +434,34 @@
# 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`.
- "deniedValues": [ # List of values denied at this resource. Can only be set if `all_values`
- # is set to `ALL_VALUES_UNSPECIFIED`.
- "A String",
- ],
},
- "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`.
+ "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`
@@ -396,147 +506,37 @@
# 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.
+ "constraint": "A String", # The name of the `Constraint` the `Policy` is configuring, for example,
+ # `constraints/serviceuser.services`.
#
- # 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.
+ # Immutable after creation.
+ "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;
+ "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.
#
- # 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`.
+ # Suppose that `constraint_default` is set to `ALLOW` for the
+ # `Constraint` `constraints/serviceuser.services`. Suppose that organization
+ # foo.com sets a `Policy` at their Organization resource node that restricts
+ # the allowed service activations to deny all service activations. They
+ # could then set a `Policy` with the `policy_type` `restore_default` on
+ # several experimental projects, restoring the `constraint_default`
+ # enforcement of the `Constraint` for only those projects, allowing those
+ # projects to have all services activated.
+ },
},
],
- "accessPolicy": { # `AccessPolicy` is a container for `AccessLevels` (which define the necessary
- # attributes to use Google Cloud services) and `ServicePerimeters` (which
- # define regions of services able to freely pass data within a perimeter). An
- # access policy is globally visible within an organization, and the
- # restrictions it specifies apply to all projects within an organization.
- "etag": "A String", # Output only. An opaque identifier for the current version of the
- # `AccessPolicy`. This will always be a strongly validated etag, meaning that
- # two Access Polices will be identical if and only if their etags are
- # identical. Clients should not expect this to be in any specific format.
- "name": "A String", # Output only. Resource name of the `AccessPolicy`. Format:
- # `accessPolicies/{policy_id}`
- "parent": "A String", # Required. The parent of this `AccessPolicy` in the Cloud Resource
- # Hierarchy. Currently immutable once created. Format:
- # `organizations/{organization_id}`
- "title": "A String", # Required. Human readable title. Does not affect behavior.
- },
- "servicePerimeter": { # `ServicePerimeter` describes a set of Google Cloud resources which can freely
- # import and export data amongst themselves, but not export outside of the
- # `ServicePerimeter`. If a request with a source within this `ServicePerimeter`
- # has a target outside of the `ServicePerimeter`, the request will be blocked.
- # Otherwise the request is allowed. There are two types of Service Perimeter -
- # Regular and Bridge. Regular Service Perimeters cannot overlap, a single
- # Google Cloud project can only belong to a single regular Service Perimeter.
- # Service Perimeter Bridges can contain only Google Cloud projects as members,
- # a single Google Cloud project may belong to multiple Service Perimeter
- # Bridges.
- "status": { # `ServicePerimeterConfig` specifies a set of Google Cloud resources that # Current ServicePerimeter configuration. Specifies sets of resources,
- # restricted services and access levels that determine perimeter
- # content and boundaries.
- # describe specific Service Perimeter configuration.
- "restrictedServices": [ # Google Cloud services that are subject to the Service Perimeter
- # restrictions. For example, if `storage.googleapis.com` is specified, access
- # to the storage buckets inside the perimeter must meet the perimeter's
- # access restrictions.
- "A String",
- ],
- "vpcAccessibleServices": { # Specifies how APIs are allowed to communicate within the Service # Configuration for APIs allowed within Perimeter.
- # Perimeter.
- "enableRestriction": True or False, # Whether to restrict API calls within the Service Perimeter to the list of
- # APIs specified in 'allowed_services'.
- "allowedServices": [ # The list of APIs usable within the Service Perimeter. Must be empty
- # unless 'enable_restriction' is True.
- "A String",
- ],
- },
- "resources": [ # A list of Google Cloud resources that are inside of the service perimeter.
- # Currently only projects are allowed. Format: `projects/{project_number}`
- "A String",
- ],
- "accessLevels": [ # A list of `AccessLevel` resource names that allow resources within the
- # `ServicePerimeter` to be accessed from the internet. `AccessLevels` listed
- # must be in the same policy as this `ServicePerimeter`. Referencing a
- # nonexistent `AccessLevel` is a syntax error. If no `AccessLevel` names are
- # listed, resources within the perimeter can only be accessed via Google
- # Cloud calls with request origins within the perimeter. Example:
- # `"accessPolicies/MY_POLICY/accessLevels/MY_LEVEL"`.
- # For Service Perimeter Bridge, must be empty.
- "A String",
- ],
- },
- "name": "A String", # Required. Resource name for the ServicePerimeter. The `short_name`
- # component must begin with a letter and only include alphanumeric and '_'.
- # Format: `accessPolicies/{policy_id}/servicePerimeters/{short_name}`
- "title": "A String", # Human readable title. Must be unique within the Policy.
- "perimeterType": "A String", # Perimeter type indicator. A single project is
- # allowed to be a member of single regular perimeter, but multiple service
- # perimeter bridges. A project cannot be a included in a perimeter bridge
- # without being included in regular perimeter. For perimeter bridges,
- # the restricted service list as well as access level lists must be
- # empty.
- "useExplicitDryRunSpec": True or False, # Use explicit dry run spec flag. Ordinarily, a dry-run spec implicitly
- # exists for all Service Perimeters, and that spec is identical to the
- # status for those Service Perimeters. When this flag is set, it inhibits the
- # generation of the implicit spec, thereby allowing the user to explicitly
- # provide a configuration ("spec") to use in a dry-run version of the Service
- # Perimeter. This allows the user to test changes to the enforced config
- # ("status") without actually enforcing them. This testing is done through
- # analyzing the differences between currently enforced and suggested
- # restrictions. use_explicit_dry_run_spec must bet set to True if any of the
- # fields in the spec are set to non-default values.
- "spec": { # `ServicePerimeterConfig` specifies a set of Google Cloud resources that # Proposed (or dry run) ServicePerimeter configuration. This configuration
- # allows to specify and test ServicePerimeter configuration without enforcing
- # actual access restrictions. Only allowed to be set when the
- # "use_explicit_dry_run_spec" flag is set.
- # describe specific Service Perimeter configuration.
- "restrictedServices": [ # Google Cloud services that are subject to the Service Perimeter
- # restrictions. For example, if `storage.googleapis.com` is specified, access
- # to the storage buckets inside the perimeter must meet the perimeter's
- # access restrictions.
- "A String",
- ],
- "vpcAccessibleServices": { # Specifies how APIs are allowed to communicate within the Service # Configuration for APIs allowed within Perimeter.
- # Perimeter.
- "enableRestriction": True or False, # Whether to restrict API calls within the Service Perimeter to the list of
- # APIs specified in 'allowed_services'.
- "allowedServices": [ # The list of APIs usable within the Service Perimeter. Must be empty
- # unless 'enable_restriction' is True.
- "A String",
- ],
- },
- "resources": [ # A list of Google Cloud resources that are inside of the service perimeter.
- # Currently only projects are allowed. Format: `projects/{project_number}`
- "A String",
- ],
- "accessLevels": [ # A list of `AccessLevel` resource names that allow resources within the
- # `ServicePerimeter` to be accessed from the internet. `AccessLevels` listed
- # must be in the same policy as this `ServicePerimeter`. Referencing a
- # nonexistent `AccessLevel` is a syntax error. If no `AccessLevel` names are
- # listed, resources within the perimeter can only be accessed via Google
- # Cloud calls with request origins within the perimeter. Example:
- # `"accessPolicies/MY_POLICY/accessLevels/MY_LEVEL"`.
- # For Service Perimeter Bridge, must be empty.
- "A String",
- ],
- },
- "description": "A String", # Description of the `ServicePerimeter` and its use. Does not affect
- # behavior.
- },
- "iamPolicy": { # An Identity and Access Management (IAM) policy, which specifies access # A representation of the Cloud IAM policy set on a Google Cloud resource.
+ "iamPolicy": { # An Identity and Access Management (IAM) policy, which specifies access # A representation of the Cloud IAM policy set on a Google Cloud resource.
# There can be a maximum of one Cloud IAM policy set on any given resource.
# In addition, Cloud IAM policies inherit their granted access scope from any
# policies set on parent resources in the resource hierarchy. Therefore, the
# effectively policy is the union of both the policy set on this resource
- # and each policy set on all of the resource's ancestry resource levels in
+ # and each policy set on all of the resource's ancestry resource levels in
# the hierarchy. See
# [this topic](https://cloud.google.com/iam/docs/policies#inheritance) for
# more information.
@@ -557,28 +557,28 @@
# **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:**
@@ -596,19 +596,17 @@
# 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
+ "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
# `condition` that determines how and when the `bindings` are applied. Each
# of the `bindings` must contain at least one member.
{ # Associates `members` with a `role`.
- "role": "A String", # Role that is assigned to `members`.
- # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
- "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+ "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.
@@ -617,42 +615,42 @@
#
# Example (Comparison):
#
- # title: "Summary size limit"
- # description: "Determines if a summary is less than 100 chars"
- # expression: "document.summary.size() < 100"
+ # title: "Summary size limit"
+ # description: "Determines if a summary is less than 100 chars"
+ # expression: "document.summary.size() < 100"
#
# Example (Equality):
#
- # title: "Requestor is owner"
- # description: "Determines if requestor is the document owner"
- # expression: "document.owner == request.auth.claims.email"
+ # title: "Requestor is owner"
+ # description: "Determines if requestor is the document owner"
+ # expression: "document.owner == request.auth.claims.email"
#
# Example (Logic):
#
- # title: "Public documents"
- # description: "Determine whether the document should be publicly visible"
- # expression: "document.type != 'private' && document.type != 'internal'"
+ # title: "Public documents"
+ # description: "Determine whether the document should be publicly visible"
+ # expression: "document.type != 'private' && document.type != 'internal'"
#
# Example (Data Manipulation):
#
- # title: "Notification string"
- # description: "Create a notification string with a timestamp."
- # expression: "'New message received at ' + string(document.create_time)"
+ # title: "Notification string"
+ # description: "Create a notification string with a timestamp."
+ # expression: "'New message received at ' + string(document.create_time)"
#
# The exact variables and functions that may be referenced within an expression
# are determined by the service that evaluates it. See the service
# documentation for additional information.
- "description": "A String", # Optional. Description of the expression. This is a longer text which
+ "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
+ "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
+ "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.
},
- "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
# `members` can have the following values:
#
# * `allUsers`: A special identifier that represents anyone who is
@@ -695,96 +693,13 @@
# * `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",
],
+ "role": "A String", # Role that is assigned to `members`.
+ # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
},
],
- "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
- { # Specifies the audit configuration for a service.
- # The configuration determines which permission types are logged, and what
- # identities, if any, are exempted from logging.
- # An AuditConfig must have one or more AuditLogConfigs.
- #
- # If there are AuditConfigs for both `allServices` and a specific service,
- # the union of the two AuditConfigs is used for that service: the log_types
- # specified in each AuditConfig are enabled, and the exempted_members in each
- # AuditLogConfig are exempted.
- #
- # Example Policy with multiple AuditConfigs:
- #
- # {
- # "audit_configs": [
- # {
- # "service": "allServices"
- # "audit_log_configs": [
- # {
- # "log_type": "DATA_READ",
- # "exempted_members": [
- # "user:jose@example.com"
- # ]
- # },
- # {
- # "log_type": "DATA_WRITE",
- # },
- # {
- # "log_type": "ADMIN_READ",
- # }
- # ]
- # },
- # {
- # "service": "sampleservice.googleapis.com"
- # "audit_log_configs": [
- # {
- # "log_type": "DATA_READ",
- # },
- # {
- # "log_type": "DATA_WRITE",
- # "exempted_members": [
- # "user:aliya@example.com"
- # ]
- # }
- # ]
- # }
- # ]
- # }
- #
- # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
- # logging. It also exempts jose@example.com from DATA_READ logging, and
- # aliya@example.com from DATA_WRITE logging.
- "auditLogConfigs": [ # The configuration for logging of each type of permission.
- { # Provides the configuration for logging a type of permissions.
- # Example:
- #
- # {
- # "audit_log_configs": [
- # {
- # "log_type": "DATA_READ",
- # "exempted_members": [
- # "user:jose@example.com"
- # ]
- # },
- # {
- # "log_type": "DATA_WRITE",
- # }
- # ]
- # }
- #
- # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
- # jose@example.com from DATA_READ logging.
- "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
- # permission.
- # Follows the same format of Binding.members.
- "A String",
- ],
- "logType": "A String", # The log type that this config enables.
- },
- ],
- "service": "A String", # Specifies a service that will be enabled for audit logging.
- # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
- # `allServices` is a special value that covers all services.
- },
- ],
- "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
# prevent simultaneous updates of a policy from overwriting each other.
# It is strongly suggested that systems make use of the `etag` in the
# read-modify-write cycle to perform policy updates in order to avoid race
@@ -796,7 +711,7 @@
# whenever you call `setIamPolicy`. If you omit this field, then IAM allows
# you to overwrite a version `3` policy with a version `1` policy, and all of
# the conditions in the version `3` policy are lost.
- "version": 42, # Specifies the format of the policy.
+ "version": 42, # Specifies the format of the policy.
#
# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
# are rejected.
@@ -817,76 +732,164 @@
#
# If a policy does not include any conditions, operations on that policy may
# specify any valid version or leave the field unset.
+ "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.
+ "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",
+ ],
+ },
+ ],
+ "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.
+ },
+ ],
},
- "accessLevel": { # An `AccessLevel` is a label that can be applied to requests to Google Cloud
+ "accessLevel": { # An `AccessLevel` is a label that can be applied to requests to Google Cloud
# services, along with a list of requirements necessary for the label to be
# applied.
- "custom": { # `CustomLevel` is an `AccessLevel` using the Cloud Common Expression Language # A `CustomLevel` written in the Common Expression Language.
+ "custom": { # `CustomLevel` is an `AccessLevel` using the Cloud Common Expression Language # A `CustomLevel` written in the Common Expression Language.
# to represent the necessary conditions for the level to apply to a request.
# See CEL spec at: https://github.com/google/cel-spec
- "expr": { # Represents a textual expression in the Common Expression Language (CEL) # Required. A Cloud CEL expression evaluating to a boolean.
+ "expr": { # Represents a textual expression in the Common Expression Language (CEL) # Required. A Cloud CEL expression evaluating to a boolean.
# syntax. CEL is a C-like expression language. The syntax and semantics of CEL
# are documented at https://github.com/google/cel-spec.
#
# Example (Comparison):
#
- # title: "Summary size limit"
- # description: "Determines if a summary is less than 100 chars"
- # expression: "document.summary.size() < 100"
+ # title: "Summary size limit"
+ # description: "Determines if a summary is less than 100 chars"
+ # expression: "document.summary.size() < 100"
#
# Example (Equality):
#
- # title: "Requestor is owner"
- # description: "Determines if requestor is the document owner"
- # expression: "document.owner == request.auth.claims.email"
+ # title: "Requestor is owner"
+ # description: "Determines if requestor is the document owner"
+ # expression: "document.owner == request.auth.claims.email"
#
# Example (Logic):
#
- # title: "Public documents"
- # description: "Determine whether the document should be publicly visible"
- # expression: "document.type != 'private' && document.type != 'internal'"
+ # title: "Public documents"
+ # description: "Determine whether the document should be publicly visible"
+ # expression: "document.type != 'private' && document.type != 'internal'"
#
# Example (Data Manipulation):
#
- # title: "Notification string"
- # description: "Create a notification string with a timestamp."
- # expression: "'New message received at ' + string(document.create_time)"
+ # title: "Notification string"
+ # description: "Create a notification string with a timestamp."
+ # expression: "'New message received at ' + string(document.create_time)"
#
# The exact variables and functions that may be referenced within an expression
# are determined by the service that evaluates it. See the service
# documentation for additional information.
- "description": "A String", # Optional. Description of the expression. This is a longer text which
+ "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
+ "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
+ "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", # Description of the `AccessLevel` and its use. Does not affect behavior.
- "basic": { # `BasicLevel` is an `AccessLevel` using a set of recommended features. # A `BasicLevel` composed of `Conditions`.
- "combiningFunction": "A String", # How the `conditions` list should be combined to determine if a request is
- # granted this `AccessLevel`. If AND is used, each `Condition` in
- # `conditions` must be satisfied for the `AccessLevel` to be applied. If OR
- # is used, at least one `Condition` in `conditions` must be satisfied for the
- # `AccessLevel` to be applied. Default behavior is AND.
- "conditions": [ # Required. A list of requirements for the `AccessLevel` to be granted.
+ "title": "A String", # Human readable title. Must be unique within the Policy.
+ "name": "A String", # Required. Resource name for the Access Level. The `short_name` component
+ # must begin with a letter and only include alphanumeric and '_'. Format:
+ # `accessPolicies/{policy_id}/accessLevels/{short_name}`. The maximum length
+ # of the `short_name` component is 50 characters.
+ "basic": { # `BasicLevel` is an `AccessLevel` using a set of recommended features. # A `BasicLevel` composed of `Conditions`.
+ "conditions": [ # Required. A list of requirements for the `AccessLevel` to be granted.
{ # A condition necessary for an `AccessLevel` to be granted. The Condition is an
# AND over its fields. So a Condition is true if: 1) the request IP is from one
# of the listed subnetworks AND 2) the originating device complies with the
# listed device policy AND 3) all listed access levels are granted AND 4) the
# request was sent at a time allowed by the DateTimeRestriction.
- "requiredAccessLevels": [ # A list of other access levels defined in the same `Policy`, referenced by
+ "regions": [ # The request must originate from one of the provided countries/regions.
+ # Must be valid ISO 3166-1 alpha-2 codes.
+ "A String",
+ ],
+ "requiredAccessLevels": [ # A list of other access levels defined in the same `Policy`, referenced by
# resource name. Referencing an `AccessLevel` which does not exist is an
# error. All access levels listed must be granted for the Condition
# to be true. Example:
- # "`accessPolicies/MY_POLICY/accessLevels/LEVEL_NAME"`
- "A String",
+ # "`accessPolicies/MY_POLICY/accessLevels/LEVEL_NAME"`
+ "A String",
],
- "devicePolicy": { # `DevicePolicy` specifies device specific restrictions necessary to acquire a # Device specific restrictions, all restrictions must hold for the
+ "devicePolicy": { # `DevicePolicy` specifies device specific restrictions necessary to acquire a # Device specific restrictions, all restrictions must hold for the
# Condition to be true. If not specified, all devices are allowed.
# given access level. A `DevicePolicy` specifies requirements for requests from
# devices to be granted access levels, it does not do any enforcement on the
@@ -896,63 +899,60 @@
# DESKTOP_LINUX, encryption_status: ENCRYPTED}, then the DevicePolicy will be
# true for requests originating from encrypted Linux desktops and encrypted
# Windows desktops.
- "allowedEncryptionStatuses": [ # Allowed encryptions statuses, an empty list allows all statuses.
- "A String",
+ "allowedEncryptionStatuses": [ # Allowed encryptions statuses, an empty list allows all statuses.
+ "A String",
],
- "osConstraints": [ # Allowed OS versions, an empty list allows all types and all versions.
+ "allowedDeviceManagementLevels": [ # Allowed device management levels, an empty list allows all management
+ # levels.
+ "A String",
+ ],
+ "osConstraints": [ # Allowed OS versions, an empty list allows all types and all versions.
{ # A restriction on the OS type and version of devices making requests.
- "osType": "A String", # Required. The allowed OS type.
- "requireVerifiedChromeOs": True or False, # Only allows requests from devices with a verified Chrome OS.
+ "minimumVersion": "A String", # The minimum allowed OS version. If not set, any version of this OS
+ # satisfies the constraint. Format: `"major.minor.patch"`.
+ # Examples: `"10.5.301"`, `"9.2.1"`.
+ "osType": "A String", # Required. The allowed OS type.
+ "requireVerifiedChromeOs": True or False, # Only allows requests from devices with a verified Chrome OS.
# Verifications includes requirements that the device is enterprise-managed,
# conformant to domain policies, and the caller has permission to call
# the API targeted by the request.
- "minimumVersion": "A String", # The minimum allowed OS version. If not set, any version of this OS
- # satisfies the constraint. Format: `"major.minor.patch"`.
- # Examples: `"10.5.301"`, `"9.2.1"`.
},
],
- "requireAdminApproval": True or False, # Whether the device needs to be approved by the customer admin.
- "requireCorpOwned": True or False, # Whether the device needs to be corp owned.
- "allowedDeviceManagementLevels": [ # Allowed device management levels, an empty list allows all management
- # levels.
- "A String",
- ],
- "requireScreenlock": True or False, # Whether or not screenlock is required for the DevicePolicy to be true.
+ "requireCorpOwned": True or False, # Whether the device needs to be corp owned.
+ "requireAdminApproval": True or False, # Whether the device needs to be approved by the customer admin.
+ "requireScreenlock": True or False, # Whether or not screenlock is required for the DevicePolicy to be true.
# Defaults to `false`.
},
- "ipSubnetworks": [ # CIDR block IP subnetwork specification. May be IPv4 or IPv6. Note that for
- # a CIDR IP address block, the specified IP address portion must be properly
- # truncated (i.e. all the host bits must be zero) or the input is considered
- # malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is
- # not. Similarly, for IPv6, "2001:db8::/32" is accepted whereas
- # "2001:db8::1/32" is not. The originating IP of a request must be in one of
- # the listed subnets in order for this Condition to be true. If empty, all IP
- # addresses are allowed.
- "A String",
- ],
- "regions": [ # The request must originate from one of the provided countries/regions.
- # Must be valid ISO 3166-1 alpha-2 codes.
- "A String",
- ],
- "members": [ # The request must be made by one of the provided user or service
+ "members": [ # The request must be made by one of the provided user or service
# accounts. Groups are not supported.
# Syntax:
# `user:{emailid}`
# `serviceAccount:{emailid}`
# If not specified, a request may come from any user.
- "A String",
+ "A String",
],
- "negate": True or False, # Whether to negate the Condition. If true, the Condition becomes a NAND over
+ "negate": True or False, # Whether to negate the Condition. If true, the Condition becomes a NAND over
# its non-empty fields, each field must be false for the Condition overall to
# be satisfied. Defaults to false.
+ "ipSubnetworks": [ # CIDR block IP subnetwork specification. May be IPv4 or IPv6. Note that for
+ # a CIDR IP address block, the specified IP address portion must be properly
+ # truncated (i.e. all the host bits must be zero) or the input is considered
+ # malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is
+ # not. Similarly, for IPv6, "2001:db8::/32" is accepted whereas
+ # "2001:db8::1/32" is not. The originating IP of a request must be in one of
+ # the listed subnets in order for this Condition to be true. If empty, all IP
+ # addresses are allowed.
+ "A String",
+ ],
},
],
+ "combiningFunction": "A String", # How the `conditions` list should be combined to determine if a request is
+ # granted this `AccessLevel`. If AND is used, each `Condition` in
+ # `conditions` must be satisfied for the `AccessLevel` to be applied. If OR
+ # is used, at least one `Condition` in `conditions` must be satisfied for the
+ # `AccessLevel` to be applied. Default behavior is AND.
},
- "name": "A String", # Required. Resource name for the Access Level. The `short_name` component
- # must begin with a letter and only include alphanumeric and '_'. Format:
- # `accessPolicies/{policy_id}/accessLevels/{short_name}`. The maximum length
- # of the `short_name` component is 50 characters.
- "title": "A String", # Human readable title. Must be unique within the Policy.
+ "description": "A String", # Description of the `AccessLevel` and its use. Does not affect behavior.
},
},
},
@@ -969,62 +969,62 @@
Args:
parent: string, Required. The relative name of the root asset. This can only be an
-organization number (such as "organizations/123"), a project ID (such as
-"projects/my-project-id"), or a project number (such as "projects/12345"),
-or a folder number (such as "folders/123"). (required)
+organization number (such as "organizations/123"), a project ID (such as
+"projects/my-project-id"), or a project number (such as "projects/12345"),
+or a folder number (such as "folders/123"). (required)
body: object, The request body.
The object takes the form of:
{ # Export asset request.
- "assetTypes": [ # A list of asset types of which to take a snapshot for. For example:
- # "compute.googleapis.com/Disk". If specified, only matching assets will be
- # returned. See [Introduction to Cloud Asset
- # Inventory](https://cloud.google.com/asset-inventory/docs/overview)
- # for all supported asset types.
- "A String",
- ],
- "contentType": "A String", # Asset content type. If not specified, no content but the asset name will be
+ "readTime": "A String", # Timestamp to take an asset snapshot. This can only be set to a timestamp
+ # between the current time and the current time minus 35 days (inclusive).
+ # If not specified, the current time will be used. Due to delays in resource
+ # data collection and indexing, there is a volatile window during which
+ # running the same query may get different results.
+ "contentType": "A String", # Asset content type. If not specified, no content but the asset name will be
# returned.
- "outputConfig": { # Output configuration for export assets destination. # Required. Output configuration indicating where the results will be output
+ "outputConfig": { # Output configuration for export assets destination. # Required. Output configuration indicating where the results will be output
# to. All results will be in newline delimited JSON format.
- "bigqueryDestination": { # A BigQuery destination. # Destination on BigQuery. The output table stores the fields in asset
+ "bigqueryDestination": { # A BigQuery destination. # Destination on BigQuery. The output table stores the fields in asset
# proto as columns in BigQuery. The resource/iam_policy field is converted
# to a record with each field to a column, except metadata to a single JSON
# string.
- "table": "A String", # Required. The BigQuery table to which the snapshot result should be
- # written. If this table does not exist, a new table with the given name
- # will be created.
- "force": True or False, # If the destination table already exists and this flag is `TRUE`, the
+ "dataset": "A String", # Required. The BigQuery dataset in format
+ # "projects/projectId/datasets/datasetId", to which the snapshot result
+ # should be exported. If this dataset does not exist, the export call returns
+ # an INVALID_ARGUMENT error.
+ "force": True or False, # If the destination table already exists and this flag is `TRUE`, the
# table will be overwritten by the contents of assets snapshot. If the flag
# is `FALSE` or unset and the destination table already exists, the export
# call returns an INVALID_ARGUMEMT error.
- "dataset": "A String", # Required. The BigQuery dataset in format
- # "projects/projectId/datasets/datasetId", to which the snapshot result
- # should be exported. If this dataset does not exist, the export call returns
- # an INVALID_ARGUMENT error.
+ "table": "A String", # Required. The BigQuery table to which the snapshot result should be
+ # written. If this table does not exist, a new table with the given name
+ # will be created.
},
- "gcsDestination": { # A Cloud Storage location. # Destination on Cloud Storage.
- "uriPrefix": "A String", # The uri prefix of all generated Cloud Storage objects. For example:
- # "gs://bucket_name/object_name_prefix". Each object uri is in format:
- # "gs://bucket_name/object_name_prefix/<asset type>/<shard number> and only
+ "gcsDestination": { # A Cloud Storage location. # Destination on Cloud Storage.
+ "uriPrefix": "A String", # The uri prefix of all generated Cloud Storage objects. For example:
+ # "gs://bucket_name/object_name_prefix". Each object uri is in format:
+ # "gs://bucket_name/object_name_prefix/<asset type>/<shard number> and only
# contains assets for that type. <shard number> starts from 0. For example:
- # "gs://bucket_name/object_name_prefix/compute.googleapis.com/Disk/0" is
+ # "gs://bucket_name/object_name_prefix/compute.googleapis.com/Disk/0" is
# the first shard of output objects containing all
# compute.googleapis.com/Disk assets. An INVALID_ARGUMENT error will be
- # returned if file with the same name "gs://bucket_name/object_name_prefix"
+ # returned if file with the same name "gs://bucket_name/object_name_prefix"
# already exists.
- "uri": "A String", # The uri of the Cloud Storage object. It's the same uri that is used by
- # gsutil. For example: "gs://bucket_name/object_name". See [Viewing and
+ "uri": "A String", # The uri of the Cloud Storage object. It's the same uri that is used by
+ # gsutil. For example: "gs://bucket_name/object_name". See [Viewing and
# Editing Object
# Metadata](https://cloud.google.com/storage/docs/viewing-editing-metadata)
# for more information.
},
},
- "readTime": "A String", # Timestamp to take an asset snapshot. This can only be set to a timestamp
- # between the current time and the current time minus 35 days (inclusive).
- # If not specified, the current time will be used. Due to delays in resource
- # data collection and indexing, there is a volatile window during which
- # running the same query may get different results.
+ "assetTypes": [ # A list of asset types of which to take a snapshot for. For example:
+ # "compute.googleapis.com/Disk". If specified, only matching assets will be
+ # returned. See [Introduction to Cloud Asset
+ # Inventory](https://cloud.google.com/asset-inventory/docs/overview)
+ # for all supported asset types.
+ "A String",
+ ],
}
x__xgafv: string, V1 error format.
@@ -1037,7 +1037,10 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "response": { # The normal response of the operation in case of success. If the original
+ "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
# 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
@@ -1045,38 +1048,35 @@
# 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.
},
- "metadata": { # Service-specific metadata associated with the operation. It typically
- # contains progress information and common metadata such as create time.
- # Some services might not provide such metadata. Any method that returns a
- # long-running operation should document the metadata type, if any.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "done": True or False, # If the value is `false`, it means the operation is still in progress.
- # If `true`, the operation is completed, and either `error` or `response` is
- # available.
- "name": "A String", # The server-assigned name, which is only unique within the same service that
+ "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.
+ "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
+ "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.
- "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
+ "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.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
},
+ "metadata": { # Service-specific metadata associated with the operation. It typically
+ # contains progress information and common metadata such as create time.
+ # Some services might not provide such metadata. Any method that returns a
+ # long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
}</pre>
</div>