blob: 471b5f0b967cbeb47f1e974c65a87e39720474ab [file] [log] [blame]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="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, 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, 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.
For IAM_POLICY content, this API outputs history when the asset and its
attached IAM POLICY both exist. This can create gaps in the output history.
If a specified asset does not exist, this API returns an INVALID_ARGUMENT
error.
Args:
parent: string, Required. The relative name of the root asset. It can only be an
organization number (such as &quot;organizations/123&quot;), a project ID (such as
&quot;projects/my-project-id&quot;)&quot;, or a project number (such as &quot;projects/12345&quot;). (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
Names](https://cloud.google.com/apis/design/resource_names#full_resource_name)
and [Resource Name
Format](https://cloud.google.com/asset-inventory/docs/resource-name-format)
for more info.
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)
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
2 - v2 error format
Returns:
An object of the form:
{ # Batch get assets history response.
&quot;assets&quot;: [ # 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.
&quot;deleted&quot;: True or False, # Whether the asset has been deleted or not.
&quot;window&quot;: { # A time window specified by its &quot;start_time&quot; and &quot;end_time&quot;. # The time window when the asset data and state was observed.
&quot;endTime&quot;: &quot;A String&quot;, # End time of the time window (inclusive). If not specified, the current
# timestamp is used instead.
&quot;startTime&quot;: &quot;A String&quot;, # Start time of the time window (exclusive).
},
&quot;asset&quot;: { # 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.
&quot;assetType&quot;: &quot;A String&quot;, # The type of the asset. For example: &quot;compute.googleapis.com/Disk&quot;
#
# See [Supported asset
# types](https://cloud.google.com/asset-inventory/docs/supported-asset-types)
# for more information.
&quot;accessPolicy&quot;: { # `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.
&quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of the `AccessPolicy`. Format:
# `accessPolicies/{policy_id}`
&quot;etag&quot;: &quot;A String&quot;, # 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.
&quot;parent&quot;: &quot;A String&quot;, # Required. The parent of this `AccessPolicy` in the Cloud Resource
# Hierarchy. Currently immutable once created. Format:
# `organizations/{organization_id}`
&quot;title&quot;: &quot;A String&quot;, # Required. Human readable title. Does not affect behavior.
},
&quot;ancestors&quot;: [ # 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: `[&quot;projects/123456789&quot;, &quot;folders/5432&quot;, &quot;organizations/1234&quot;]`
&quot;A String&quot;,
],
&quot;servicePerimeter&quot;: { # `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.
&quot;name&quot;: &quot;A String&quot;, # Required. Resource name for the ServicePerimeter. The `short_name`
# component must begin with a letter and only include alphanumeric and &#x27;_&#x27;.
# Format: `accessPolicies/{policy_id}/servicePerimeters/{short_name}`
&quot;perimeterType&quot;: &quot;A String&quot;, # 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.
&quot;title&quot;: &quot;A String&quot;, # Human readable title. Must be unique within the Policy.
&quot;useExplicitDryRunSpec&quot;: 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 (&quot;spec&quot;) to use in a dry-run version of the Service
# Perimeter. This allows the user to test changes to the enforced config
# (&quot;status&quot;) 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.
&quot;description&quot;: &quot;A String&quot;, # Description of the `ServicePerimeter` and its use. Does not affect
# behavior.
&quot;status&quot;: { # `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.
&quot;resources&quot;: [ # A list of Google Cloud resources that are inside of the service perimeter.
# Currently only projects are allowed. Format: `projects/{project_number}`
&quot;A String&quot;,
],
&quot;accessLevels&quot;: [ # 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:
# `&quot;accessPolicies/MY_POLICY/accessLevels/MY_LEVEL&quot;`.
# For Service Perimeter Bridge, must be empty.
&quot;A String&quot;,
],
&quot;restrictedServices&quot;: [ # 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&#x27;s
# access restrictions.
&quot;A String&quot;,
],
&quot;vpcAccessibleServices&quot;: { # Specifies how APIs are allowed to communicate within the Service # Configuration for APIs allowed within Perimeter.
# Perimeter.
&quot;enableRestriction&quot;: True or False, # Whether to restrict API calls within the Service Perimeter to the list of
# APIs specified in &#x27;allowed_services&#x27;.
&quot;allowedServices&quot;: [ # The list of APIs usable within the Service Perimeter. Must be empty
# unless &#x27;enable_restriction&#x27; is True.
&quot;A String&quot;,
],
},
},
&quot;spec&quot;: { # `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
# &quot;use_explicit_dry_run_spec&quot; flag is set.
# describe specific Service Perimeter configuration.
&quot;resources&quot;: [ # A list of Google Cloud resources that are inside of the service perimeter.
# Currently only projects are allowed. Format: `projects/{project_number}`
&quot;A String&quot;,
],
&quot;accessLevels&quot;: [ # 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:
# `&quot;accessPolicies/MY_POLICY/accessLevels/MY_LEVEL&quot;`.
# For Service Perimeter Bridge, must be empty.
&quot;A String&quot;,
],
&quot;restrictedServices&quot;: [ # 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&#x27;s
# access restrictions.
&quot;A String&quot;,
],
&quot;vpcAccessibleServices&quot;: { # Specifies how APIs are allowed to communicate within the Service # Configuration for APIs allowed within Perimeter.
# Perimeter.
&quot;enableRestriction&quot;: True or False, # Whether to restrict API calls within the Service Perimeter to the list of
# APIs specified in &#x27;allowed_services&#x27;.
&quot;allowedServices&quot;: [ # The list of APIs usable within the Service Perimeter. Must be empty
# unless &#x27;enable_restriction&#x27; is True.
&quot;A String&quot;,
],
},
},
},
&quot;resource&quot;: { # A representation of a Google Cloud resource. # A representation of the resource.
&quot;discoveryName&quot;: &quot;A String&quot;, # The JSON schema name listed in the discovery document. For example:
# &quot;Project&quot;
#
# This value is unspecified for resources that do not have an API based on a
# discovery document, such as Cloud Bigtable.
&quot;version&quot;: &quot;A String&quot;, # The API version. For example: &quot;v1&quot;
&quot;data&quot;: { # The content of the resource, in which some sensitive fields are removed
# and may not be present.
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
},
&quot;discoveryDocumentUri&quot;: &quot;A String&quot;, # The URL of the discovery document containing the resource&#x27;s JSON schema.
# For example:
# &quot;https://www.googleapis.com/discovery/v1/apis/compute/v1/rest&quot;
#
# This value is unspecified for resources that do not have an API based on a
# discovery document, such as Cloud Bigtable.
&quot;parent&quot;: &quot;A String&quot;, # 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.
#
# For Google Cloud assets, this value is the parent resource defined in the
# [Cloud IAM policy
# hierarchy](https://cloud.google.com/iam/docs/overview#policy_hierarchy).
# For example:
# &quot;//cloudresourcemanager.googleapis.com/projects/my_project_123&quot;
#
# For third-party assets, this field may be set differently.
&quot;resourceUrl&quot;: &quot;A String&quot;, # The REST URL for accessing the resource. An HTTP `GET` request using this
# URL returns the resource itself. For example:
# &quot;https://cloudresourcemanager.googleapis.com/v1/projects/my-project-123&quot;
#
# This value is unspecified for resources without a REST API.
},
&quot;name&quot;: &quot;A String&quot;, # The full name of the asset. For example:
# &quot;//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1&quot;
#
# See [Resource
# names](https://cloud.google.com/apis/design/resource_names#full_resource_name)
# for more information.
&quot;orgPolicy&quot;: [ # 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.
&quot;listPolicy&quot;: { # 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
# Manager resource hierarchy (`Organizations`, `Folders`, `Projects`) that
# are allowed or denied by setting the `allowed_values` and `denied_values`
# 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 &quot;:&quot;. Values prefixed with &quot;is:&quot; are treated the
# same as values with no prefix.
# Ancestry subtrees must be in one of the following formats:
# - &quot;projects/&lt;project-id&gt;&quot;, e.g. &quot;projects/tokyo-rain-123&quot;
# - &quot;folders/&lt;folder-id&gt;&quot;, e.g. &quot;folders/1234&quot;
# - &quot;organizations/&lt;organization-id&gt;&quot;, e.g. &quot;organizations/1234&quot;
# 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.
&quot;deniedValues&quot;: [ # List of values denied at this resource. Can only be set if `all_values`
# is set to `ALL_VALUES_UNSPECIFIED`.
&quot;A String&quot;,
],
&quot;allValues&quot;: &quot;A String&quot;, # The policy all_values state.
&quot;allowedValues&quot;: [ # List of values allowed at this resource. Can only be set if `all_values`
# is set to `ALL_VALUES_UNSPECIFIED`.
&quot;A String&quot;,
],
&quot;suggestedValue&quot;: &quot;A String&quot;, # 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`.
&quot;inheritFromParent&quot;: 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
# set to `true`, then the values from the effective `Policy` of the parent
# resource are inherited, meaning the values set in this `Policy` are
# added to the values inherited up the hierarchy.
#
# Setting `Policy` hierarchies that inherit both allowed values and denied
# values isn&#x27;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
# not present in `denied_values`.
#
# For example, suppose you have a `Constraint`
# `constraints/serviceuser.services`, which has a `constraint_type` of
# `list_constraint`, and with `constraint_default` set to `ALLOW`.
# Suppose that at the Organization level, a `Policy` is applied that
# restricts the allowed API activations to {`E1`, `E2`}. Then, if a
# `Policy` is applied to a project below the Organization that has
# `inherit_from_parent` set to `false` and field all_values set to DENY,
# then an attempt to activate any API will be denied.
#
# The following examples demonstrate different possible layerings for
# `projects/bar` parented by `organizations/foo`:
#
# Example 1 (no inherited values):
# `organizations/foo` has a `Policy` with values:
# {allowed_values: &quot;E1&quot; allowed_values:&quot;E2&quot;}
# `projects/bar` has `inherit_from_parent` `false` and values:
# {allowed_values: &quot;E3&quot; allowed_values: &quot;E4&quot;}
# 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: &quot;E1&quot; allowed_values:&quot;E2&quot;}
# `projects/bar` has a `Policy` with values:
# {value: &quot;E3&quot; value: &quot;E4&quot; 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: &quot;E1&quot; allowed_values: &quot;E2&quot;}
# `projects/bar` has a `Policy` with:
# {denied_values: &quot;E1&quot;}
# 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: &quot;E1&quot; allowed_values:&quot;E2&quot;}
# `projects/bar` has a `Policy` with values:
# {RestoreDefault: {}}
# The accepted values at `organizations/foo` are `E1`, `E2`.
# The accepted values at `projects/bar` are either all or none depending on
# the value of `constraint_default` (if `ALLOW`, all; if
# `DENY`, none).
#
# Example 5 (no policy inherits parent policy):
# `organizations/foo` has no `Policy` set.
# `projects/bar` has no `Policy` set.
# The accepted values at both levels are either all or none depending on
# the value of `constraint_default` (if `ALLOW`, all; if
# `DENY`, none).
#
# Example 6 (ListConstraint allowing all):
# `organizations/foo` has a `Policy` with values:
# {allowed_values: &quot;E1&quot; allowed_values: &quot;E2&quot;}
# `projects/bar` has a `Policy` with:
# {all: ALLOW}
# The accepted values at `organizations/foo` are `E1`, E2`.
# Any value is accepted at `projects/bar`.
#
# Example 7 (ListConstraint allowing none):
# `organizations/foo` has a `Policy` with values:
# {allowed_values: &quot;E1&quot; allowed_values: &quot;E2&quot;}
# `projects/bar` has a `Policy` with:
# {all: DENY}
# The accepted values at `organizations/foo` are `E1`, E2`.
# No value is accepted at `projects/bar`.
#
# Example 10 (allowed and denied subtrees of Resource Manager hierarchy):
# Given the following resource hierarchy
# O1-&gt;{F1, F2}; F1-&gt;{P1}; F2-&gt;{P2, P3},
# `organizations/foo` has a `Policy` with values:
# {allowed_values: &quot;under:organizations/O1&quot;}
# `projects/bar` has a `Policy` with:
# {allowed_values: &quot;under:projects/P3&quot;}
# {denied_values: &quot;under:folders/F2&quot;}
# 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`.
},
&quot;etag&quot;: &quot;A String&quot;, # 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`.
&quot;booleanPolicy&quot;: { # Used in `policy_type` to specify how `boolean_policy` will behave at this # For boolean `Constraints`, whether to enforce the `Constraint` or not.
# resource.
&quot;enforced&quot;: True or False, # If `true`, then the `Policy` is enforced. If `false`, then any
# configuration is acceptable.
#
# Suppose you have a `Constraint`
# `constraints/compute.disableSerialPortAccess` with `constraint_default`
# set to `ALLOW`. A `Policy` for that `Constraint` exhibits the following
# behavior:
# - If the `Policy` at this resource has enforced set to `false`, serial
# port connection attempts will be allowed.
# - If the `Policy` at this resource has enforced set to `true`, serial
# port connection attempts will be refused.
# - If the `Policy` at this resource is `RestoreDefault`, serial port
# connection attempts will be allowed.
# - If no `Policy` is set at this resource or anywhere higher in the
# resource hierarchy, serial port connection attempts will be allowed.
# - If no `Policy` is set at this resource, but one exists higher in the
# resource hierarchy, the behavior is as if the`Policy` were set at
# this resource.
#
# The following examples demonstrate the different possible layerings:
#
# Example 1 (nearest `Constraint` wins):
# `organizations/foo` has a `Policy` with:
# {enforced: false}
# `projects/bar` has no `Policy` set.
# The constraint at `projects/bar` and `organizations/foo` will not be
# enforced.
#
# Example 2 (enforcement gets replaced):
# `organizations/foo` has a `Policy` with:
# {enforced: false}
# `projects/bar` has a `Policy` with:
# {enforced: true}
# The constraint at `organizations/foo` is not enforced.
# The constraint at `projects/bar` is enforced.
#
# Example 3 (RestoreDefault):
# `organizations/foo` has a `Policy` with:
# {enforced: true}
# `projects/bar` has a `Policy` with:
# {RestoreDefault: {}}
# The constraint at `organizations/foo` is enforced.
# The constraint at `projects/bar` is not enforced, because
# `constraint_default` for the `Constraint` is `ALLOW`.
},
&quot;constraint&quot;: &quot;A String&quot;, # The name of the `Constraint` the `Policy` is configuring, for example,
# `constraints/serviceuser.services`.
#
# Immutable after creation.
&quot;updateTime&quot;: &quot;A String&quot;, # 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.
&quot;version&quot;: 42, # Version of the `Policy`. Default version is 0;
&quot;restoreDefault&quot;: { # 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.
},
},
],
&quot;iamPolicy&quot;: { # 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&#x27;s ancestry resource levels in
# the hierarchy. See
# [this topic](https://cloud.google.com/iam/docs/policies#inheritance) for
# more information.
# controls for Google Cloud resources.
#
#
# A `Policy` is a collection of `bindings`. A `binding` binds one or more
# `members` to a single `role`. Members can be user accounts, service accounts,
# Google groups, and domains (such as G Suite). A `role` is a named list of
# 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.
#
# **JSON example:**
#
# {
# &quot;bindings&quot;: [
# {
# &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
# &quot;members&quot;: [
# &quot;user:mike@example.com&quot;,
# &quot;group:admins@example.com&quot;,
# &quot;domain:google.com&quot;,
# &quot;serviceAccount:my-project-id@appspot.gserviceaccount.com&quot;
# ]
# },
# {
# &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
# &quot;members&quot;: [&quot;user:eve@example.com&quot;],
# &quot;condition&quot;: {
# &quot;title&quot;: &quot;expirable access&quot;,
# &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
# &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
# }
# }
# ],
# &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
# &quot;version&quot;: 3
# }
#
# **YAML example:**
#
# bindings:
# - 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:eve@example.com
# role: roles/resourcemanager.organizationViewer
# condition:
# title: expirable access
# description: Does not grant access after Sep 2020
# expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
# - etag: BwWWja0YfJA=
# - version: 3
#
# For a description of IAM and its features, see the
# [IAM documentation](https://cloud.google.com/iam/docs/).
&quot;bindings&quot;: [ # 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`.
&quot;condition&quot;: { # 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: &quot;Summary size limit&quot;
# description: &quot;Determines if a summary is less than 100 chars&quot;
# expression: &quot;document.summary.size() &lt; 100&quot;
#
# Example (Equality):
#
# title: &quot;Requestor is owner&quot;
# description: &quot;Determines if requestor is the document owner&quot;
# expression: &quot;document.owner == request.auth.claims.email&quot;
#
# Example (Logic):
#
# title: &quot;Public documents&quot;
# description: &quot;Determine whether the document should be publicly visible&quot;
# expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
#
# Example (Data Manipulation):
#
# title: &quot;Notification string&quot;
# description: &quot;Create a notification string with a timestamp.&quot;
# expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
#
# 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.
&quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
# describes the expression, e.g. when hovered over it in a UI.
&quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
# syntax.
&quot;title&quot;: &quot;A String&quot;, # 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.
&quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
# reporting, e.g. a file name and a position in the file.
},
&quot;members&quot;: [ # Specifies the identities requesting access for a Cloud Platform resource.
# `members` can have the following values:
#
# * `allUsers`: A special identifier that represents anyone who is
# on the internet; with or without a Google account.
#
# * `allAuthenticatedUsers`: A special identifier that represents anyone
# who is authenticated with a Google account or a service account.
#
# * `user:{emailid}`: An email address that represents a specific Google
# account. For example, `alice@example.com` .
#
#
# * `serviceAccount:{emailid}`: An email address that represents a service
# account. For example, `my-other-app@appspot.gserviceaccount.com`.
#
# * `group:{emailid}`: An email address that represents a Google group.
# For example, `admins@example.com`.
#
# * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
# identifier) representing a user that has been recently deleted. For
# example, `alice@example.com?uid=123456789012345678901`. If the user is
# recovered, this value reverts to `user:{emailid}` and the recovered user
# retains the role in the binding.
#
# * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
# unique identifier) representing a service account that has been recently
# deleted. For example,
# `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
# If the service account is undeleted, this value reverts to
# `serviceAccount:{emailid}` and the undeleted service account retains the
# role in the binding.
#
# * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
# identifier) representing a Google group that has been recently
# deleted. For example, `admins@example.com?uid=123456789012345678901`. If
# the group is recovered, this value reverts to `group:{emailid}` and the
# recovered group retains the role in the binding.
#
#
# * `domain:{domain}`: The G Suite domain (primary) that represents all the
# users of that domain. For example, `google.com` or `example.com`.
#
&quot;A String&quot;,
],
&quot;role&quot;: &quot;A String&quot;, # Role that is assigned to `members`.
# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
},
],
&quot;etag&quot;: &quot;A String&quot;, # `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.
&quot;version&quot;: 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.
&quot;auditConfigs&quot;: [ # 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:
#
# {
# &quot;audit_configs&quot;: [
# {
# &quot;service&quot;: &quot;allServices&quot;
# &quot;audit_log_configs&quot;: [
# {
# &quot;log_type&quot;: &quot;DATA_READ&quot;,
# &quot;exempted_members&quot;: [
# &quot;user:jose@example.com&quot;
# ]
# },
# {
# &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
# },
# {
# &quot;log_type&quot;: &quot;ADMIN_READ&quot;,
# }
# ]
# },
# {
# &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;
# &quot;audit_log_configs&quot;: [
# {
# &quot;log_type&quot;: &quot;DATA_READ&quot;,
# },
# {
# &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
# &quot;exempted_members&quot;: [
# &quot;user:aliya@example.com&quot;
# ]
# }
# ]
# }
# ]
# }
#
# 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.
&quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
{ # Provides the configuration for logging a type of permissions.
# Example:
#
# {
# &quot;audit_log_configs&quot;: [
# {
# &quot;log_type&quot;: &quot;DATA_READ&quot;,
# &quot;exempted_members&quot;: [
# &quot;user:jose@example.com&quot;
# ]
# },
# {
# &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
# }
# ]
# }
#
# This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
# jose@example.com from DATA_READ logging.
&quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
&quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
# permission.
# Follows the same format of Binding.members.
&quot;A String&quot;,
],
},
],
&quot;service&quot;: &quot;A String&quot;, # 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.
},
],
},
&quot;accessLevel&quot;: { # 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.
&quot;custom&quot;: { # `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
&quot;expr&quot;: { # 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: &quot;Summary size limit&quot;
# description: &quot;Determines if a summary is less than 100 chars&quot;
# expression: &quot;document.summary.size() &lt; 100&quot;
#
# Example (Equality):
#
# title: &quot;Requestor is owner&quot;
# description: &quot;Determines if requestor is the document owner&quot;
# expression: &quot;document.owner == request.auth.claims.email&quot;
#
# Example (Logic):
#
# title: &quot;Public documents&quot;
# description: &quot;Determine whether the document should be publicly visible&quot;
# expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
#
# Example (Data Manipulation):
#
# title: &quot;Notification string&quot;
# description: &quot;Create a notification string with a timestamp.&quot;
# expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
#
# 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.
&quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
# describes the expression, e.g. when hovered over it in a UI.
&quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
# syntax.
&quot;title&quot;: &quot;A String&quot;, # 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.
&quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
# reporting, e.g. a file name and a position in the file.
},
},
&quot;title&quot;: &quot;A String&quot;, # Human readable title. Must be unique within the Policy.
&quot;name&quot;: &quot;A String&quot;, # Required. Resource name for the Access Level. The `short_name` component
# must begin with a letter and only include alphanumeric and &#x27;_&#x27;. Format:
# `accessPolicies/{policy_id}/accessLevels/{short_name}`. The maximum length
# of the `short_name` component is 50 characters.
&quot;basic&quot;: { # `BasicLevel` is an `AccessLevel` using a set of recommended features. # A `BasicLevel` composed of `Conditions`.
&quot;conditions&quot;: [ # 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.
&quot;regions&quot;: [ # The request must originate from one of the provided countries/regions.
# Must be valid ISO 3166-1 alpha-2 codes.
&quot;A String&quot;,
],
&quot;requiredAccessLevels&quot;: [ # 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:
# &quot;`accessPolicies/MY_POLICY/accessLevels/LEVEL_NAME&quot;`
&quot;A String&quot;,
],
&quot;devicePolicy&quot;: { # `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
# device. `DevicePolicy` acts as an AND over all specified fields, and each
# repeated field is an OR over its elements. Any unset fields are ignored. For
# example, if the proto is { os_type : DESKTOP_WINDOWS, os_type :
# DESKTOP_LINUX, encryption_status: ENCRYPTED}, then the DevicePolicy will be
# true for requests originating from encrypted Linux desktops and encrypted
# Windows desktops.
&quot;allowedEncryptionStatuses&quot;: [ # Allowed encryptions statuses, an empty list allows all statuses.
&quot;A String&quot;,
],
&quot;allowedDeviceManagementLevels&quot;: [ # Allowed device management levels, an empty list allows all management
# levels.
&quot;A String&quot;,
],
&quot;osConstraints&quot;: [ # Allowed OS versions, an empty list allows all types and all versions.
{ # A restriction on the OS type and version of devices making requests.
&quot;minimumVersion&quot;: &quot;A String&quot;, # The minimum allowed OS version. If not set, any version of this OS
# satisfies the constraint. Format: `&quot;major.minor.patch&quot;`.
# Examples: `&quot;10.5.301&quot;`, `&quot;9.2.1&quot;`.
&quot;osType&quot;: &quot;A String&quot;, # Required. The allowed OS type.
&quot;requireVerifiedChromeOs&quot;: 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.
},
],
&quot;requireCorpOwned&quot;: True or False, # Whether the device needs to be corp owned.
&quot;requireAdminApproval&quot;: True or False, # Whether the device needs to be approved by the customer admin.
&quot;requireScreenlock&quot;: True or False, # Whether or not screenlock is required for the DevicePolicy to be true.
# Defaults to `false`.
},
&quot;members&quot;: [ # 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.
&quot;A String&quot;,
],
&quot;negate&quot;: 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.
&quot;ipSubnetworks&quot;: [ # 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, &quot;192.0.2.0/24&quot; is accepted but &quot;192.0.2.1/24&quot; is
# not. Similarly, for IPv6, &quot;2001:db8::/32&quot; is accepted whereas
# &quot;2001:db8::1/32&quot; 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.
&quot;A String&quot;,
],
},
],
&quot;combiningFunction&quot;: &quot;A String&quot;, # 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.
},
&quot;description&quot;: &quot;A String&quot;, # Description of the `AccessLevel` and its use. Does not affect behavior.
},
},
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="exportAssets">exportAssets(parent, body=None, x__xgafv=None)</code>
<pre>Exports assets with time and resource types to a given Cloud Storage
location. The output format is newline-delimited JSON.
This API implements the google.longrunning.Operation API allowing you
to keep track of the export.
Args:
parent: string, Required. The relative name of the root asset. This can only be an
organization number (such as &quot;organizations/123&quot;), a project ID (such as
&quot;projects/my-project-id&quot;), or a project number (such as &quot;projects/12345&quot;),
or a folder number (such as &quot;folders/123&quot;). (required)
body: object, The request body.
The object takes the form of:
{ # Export asset request.
&quot;readTime&quot;: &quot;A String&quot;, # 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.
&quot;contentType&quot;: &quot;A String&quot;, # Asset content type. If not specified, no content but the asset name will be
# returned.
&quot;outputConfig&quot;: { # 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.
&quot;bigqueryDestination&quot;: { # 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.
&quot;dataset&quot;: &quot;A String&quot;, # Required. The BigQuery dataset in format
# &quot;projects/projectId/datasets/datasetId&quot;, to which the snapshot result
# should be exported. If this dataset does not exist, the export call returns
# an INVALID_ARGUMENT error.
&quot;force&quot;: 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.
&quot;table&quot;: &quot;A String&quot;, # 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.
},
&quot;gcsDestination&quot;: { # A Cloud Storage location. # Destination on Cloud Storage.
&quot;uriPrefix&quot;: &quot;A String&quot;, # The uri prefix of all generated Cloud Storage objects. For example:
# &quot;gs://bucket_name/object_name_prefix&quot;. Each object uri is in format:
# &quot;gs://bucket_name/object_name_prefix/&lt;asset type&gt;/&lt;shard number&gt; and only
# contains assets for that type. &lt;shard number&gt; starts from 0. For example:
# &quot;gs://bucket_name/object_name_prefix/compute.googleapis.com/Disk/0&quot; 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 &quot;gs://bucket_name/object_name_prefix&quot;
# already exists.
&quot;uri&quot;: &quot;A String&quot;, # The uri of the Cloud Storage object. It&#x27;s the same uri that is used by
# gsutil. For example: &quot;gs://bucket_name/object_name&quot;. See [Viewing and
# Editing Object
# Metadata](https://cloud.google.com/storage/docs/viewing-editing-metadata)
# for more information.
},
},
&quot;assetTypes&quot;: [ # A list of asset types of which to take a snapshot for. For example:
# &quot;compute.googleapis.com/Disk&quot;. 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.
&quot;A String&quot;,
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a
# network API call.
&quot;done&quot;: 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.
&quot;response&quot;: { # 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
# methods, the response should have the type `XxxResponse`, where `Xxx`
# is the original method name. For example, if the original method name
# is `TakeSnapshot()`, the inferred response type is
# `TakeSnapshotResponse`.
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
&quot;name&quot;: &quot;A String&quot;, # 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}`.
&quot;error&quot;: { # 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).
&quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
&quot;message&quot;: &quot;A String&quot;, # 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.
&quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
# message types for APIs to use.
{
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
],
},
&quot;metadata&quot;: { # 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.
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
</body></html>