blob: 5774aaf4d1698e90931c1fcf08745d5eb18808cc [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_v1beta1.html">Cloud Asset API</a> . <a href="cloudasset_v1beta1.projects.html">projects</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="cloudasset_v1beta1.projects.operations.html">operations()</a></code>
</p>
<p class="firstline">Returns the operations Resource.</p>
<p class="toc_element">
<code><a href="#batchGetAssetsHistory">batchGetAssetsHistory(parent, contentType=None, readTimeWindow_endTime=None, readTimeWindow_startTime=None, assetNames=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, readTimeWindow_endTime=None, readTimeWindow_startTime=None, assetNames=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)
contentType: string, Optional. The content type.
readTimeWindow_endTime: string, End time of the time window (inclusive).
Current timestamp if not specified.
readTimeWindow_startTime: string, Start time of the time window (exclusive).
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)
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)
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.
{ # Temporal asset. In addition to the asset, the temporal asset includes the
# status of the asset and valid from and to time of it.
&quot;deleted&quot;: True or False, # If the asset is deleted or not.
&quot;window&quot;: { # A time window of (start_time, end_time]. # The time window when the asset data and state was observed.
&quot;startTime&quot;: &quot;A String&quot;, # Start time of the time window (exclusive).
&quot;endTime&quot;: &quot;A String&quot;, # End time of the time window (inclusive).
# Current timestamp if not specified.
},
&quot;asset&quot;: { # Cloud asset. This includes all Google Cloud Platform resources, # Asset.
# Cloud IAM policies, and other non-GCP assets.
&quot;resource&quot;: { # Representation of a cloud resource. # Representation of the resource.
&quot;version&quot;: &quot;A String&quot;, # The API version. Example: &quot;v1&quot;.
&quot;data&quot;: { # The content of the resource, in which some sensitive fields are scrubbed
# away 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;`.
# It will be left unspecified for resources without a discovery-based API,
# 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 GCP assets, it 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, it is up to the users to define.
&quot;resourceUrl&quot;: &quot;A String&quot;, # The REST URL for accessing the resource. An HTTP GET operation using this
# URL returns the resource itself.
# Example:
# `https://cloudresourcemanager.googleapis.com/v1/projects/my-project-123`.
# It will be left unspecified for resources without a REST API.
&quot;discoveryName&quot;: &quot;A String&quot;, # The JSON schema name listed in the discovery document.
# Example: &quot;Project&quot;. It will be left unspecified for resources (such as
# Cloud Bigtable) without a discovery-based API.
},
&quot;assetType&quot;: &quot;A String&quot;, # Type of the asset. Example: &quot;google.compute.Disk&quot;.
&quot;name&quot;: &quot;A String&quot;, # 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.
&quot;iamPolicy&quot;: { # An Identity and Access Management (IAM) policy, which specifies access # Representation of the actual Cloud IAM policy set on a cloud resource. For
# each resource, there must be at most one Cloud IAM policy set on it.
# 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.
#
# For some types of Google Cloud resources, a `binding` can also specify a
# `condition`, which is a logical expression that allows access to a resource
# only if the expression evaluates to `true`. A condition can add constraints
# based on attributes of the request, the resource, or both. To learn which
# resources support conditions in their IAM policies, see the
# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
#
# **JSON example:**
#
# {
# &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;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.
#
# To learn which resources support conditions in their IAM policies, see the
# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
&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;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;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;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;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
},
],
},
],
&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;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;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
#
# If the condition evaluates to `true`, then this binding applies to the
# current request.
#
# If the condition evaluates to `false`, then this binding does not apply to
# the current request. However, a different role binding might grant the same
# role to one or more of the members in this binding.
#
# To learn which resources support conditions in their IAM policies, see the
# [IAM
# documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
# syntax. CEL is a C-like expression language. The syntax and semantics of CEL
# are documented at https://github.com/google/cel-spec.
#
# Example (Comparison):
#
# title: &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;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;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;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.
},
},
},
],
}</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. We recommend intervals of at least 2 seconds
with exponential retry to poll the export operation result. For
regular-size resource parent, the export operation usually finishes within
5 minutes.
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;), 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;assetTypes&quot;: [ # A list of asset types of which to take a snapshot for. For example:
# &quot;google.compute.Disk&quot;. If specified, only matching assets will be returned.
# See [Introduction to Cloud Asset
# Inventory](https://cloud.google.com/resource-manager/docs/cloud-asset-inventory/overview)
# for all supported asset types.
&quot;A String&quot;,
],
&quot;readTime&quot;: &quot;A String&quot;, # Timestamp to take an asset snapshot. This can only be set to a timestamp
# between 2018-10-02 UTC (inclusive) and the current time. 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;gcsDestination&quot;: { # A Cloud Storage location. # Destination on Cloud Storage.
&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;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/google.compute.disk/0&quot; is the first
# shard of output objects containing all google.compute.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.
},
},
}
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;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;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;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
},
&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.
},
&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}`.
}</pre>
</div>
</body></html>