Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / f80be181200f4aae910badec3f4bddea08ae5044 / . / docs / dyn / cloudasset_v1beta1.folders.html
blob: 36f70ea164aad6a4e022524b5b1d0c01527d563c [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="cloudasset_v1beta1.html">Cloud Asset API</a> . <a href="cloudasset_v1beta1.folders.html">folders</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="cloudasset_v1beta1.folders.operations.html">operations()</a></code>
79</p>
80<p class="firstline">Returns the operations Resource.</p>
81
82<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]83 <code><a href="#exportAssets">exportAssets(parent, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]84<p class="firstline">Exports assets with time and resource types to a given Cloud Storage</p>
85<h3>Method Details</h3>
86<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]87 <code class="details" id="exportAssets">exportAssets(parent, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]88 <pre>Exports assets with time and resource types to a given Cloud Storage
89location. The output format is newline-delimited JSON.
90This API implements the google.longrunning.Operation API allowing you
91to keep track of the export.
92
93Args:
94 parent: string, Required. The relative name of the root asset. This can only be an
95organization number (such as "organizations/123"), a project ID (such as
96"projects/my-project-id"), a project number (such as "projects/12345"), or
97a folder number (such as "folders/123"). (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]98 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]99 The object takes the form of:
100
101{ # Export asset request.
102 "assetTypes": [ # A list of asset types of which to take a snapshot for. For example:
103 # "google.compute.Disk". If specified, only matching assets will be returned.
104 # See [Introduction to Cloud Asset
105 # Inventory](https://cloud.google.com/resource-manager/docs/cloud-asset-inventory/overview)
106 # for all supported asset types.
107 "A String",
108 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]109 "contentType": "A String", # Asset content type. If not specified, no content but the asset name will be
110 # returned.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]111 "outputConfig": { # Output configuration for export assets destination. # Required. Output configuration indicating where the results will be output
112 # to. All results will be in newline delimited JSON format.
113 "gcsDestination": { # A Cloud Storage location. # Destination on Cloud Storage.
114 "uriPrefix": "A String", # The uri prefix of all generated Cloud Storage objects. For example:
115 # "gs://bucket_name/object_name_prefix". Each object uri is in format:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]116 # "gs://bucket_name/object_name_prefix/&lt;asset type&gt;/&lt;shard number&gt; and only
117 # contains assets for that type. &lt;shard number&gt; starts from 0. For example:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]118 # "gs://bucket_name/object_name_prefix/google.compute.disk/0" is the first
119 # shard of output objects containing all google.compute.disk assets.
120 # An INVALID_ARGUMENT error will be returned if file with the same name
121 # "gs://bucket_name/object_name_prefix" already exists.
122 "uri": "A String", # The uri of the Cloud Storage object. It's the same uri that is used by
123 # gsutil. For example: "gs://bucket_name/object_name". See [Viewing and
124 # Editing Object
125 # Metadata](https://cloud.google.com/storage/docs/viewing-editing-metadata)
126 # for more information.
127 },
128 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]129 "readTime": "A String", # Timestamp to take an asset snapshot. This can only be set to a timestamp
130 # between 2018-10-02 UTC (inclusive) and the current time. If not specified,
131 # the current time will be used. Due to delays in resource data collection
132 # and indexing, there is a volatile window during which running the same
133 # query may get different results.
134 }
135
136 x__xgafv: string, V1 error format.
137 Allowed values
138 1 - v1 error format
139 2 - v2 error format
140
141Returns:
142 An object of the form:
143
144 { # This resource represents a long-running operation that is the result of a
145 # network API call.
146 "metadata": { # Service-specific metadata associated with the operation. It typically
147 # contains progress information and common metadata such as create time.
148 # Some services might not provide such metadata. Any method that returns a
149 # long-running operation should document the metadata type, if any.
150 "a_key": "", # Properties of the object. Contains field @type with type URL.
151 },
152 "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.
153 # different programming environments, including REST APIs and RPC APIs. It is
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]154 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
155 # three pieces of data: error code, error message, and error details.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]156 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]157 # You can find out more about this error model and how to work with it in the
158 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]159 "message": "A String", # A developer-facing error message, which should be in English. Any
160 # user-facing error message should be localized and sent in the
161 # google.rpc.Status.details field, or localized by the client.
162 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
163 "details": [ # A list of messages that carry the error details. There is a common set of
164 # message types for APIs to use.
165 {
166 "a_key": "", # Properties of the object. Contains field @type with type URL.
167 },
168 ],
169 },
170 "done": True or False, # If the value is `false`, it means the operation is still in progress.
171 # If `true`, the operation is completed, and either `error` or `response` is
172 # available.
173 "response": { # The normal response of the operation in case of success. If the original
174 # method returns no data on success, such as `Delete`, the response is
175 # `google.protobuf.Empty`. If the original method is standard
176 # `Get`/`Create`/`Update`, the response should be the resource. For other
177 # methods, the response should have the type `XxxResponse`, where `Xxx`
178 # is the original method name. For example, if the original method name
179 # is `TakeSnapshot()`, the inferred response type is
180 # `TakeSnapshotResponse`.
181 "a_key": "", # Properties of the object. Contains field @type with type URL.
182 },
183 "name": "A String", # The server-assigned name, which is only unique within the same service that
184 # originally returns it. If you use the default HTTP mapping, the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]185 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]186 }</pre>
187</div>
188
189</body></html>