• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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">
83  <code><a href="#exportAssets">exportAssets(parent, body, x__xgafv=None)</a></code></p>
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">
87    <code class="details" id="exportAssets">exportAssets(parent, body, x__xgafv=None)</code>
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)
98  body: object, The request body. (required)
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    ],
109    "outputConfig": { # Output configuration for export assets destination. # Required. Output configuration indicating where the results will be output
110        # to. All results will be in newline delimited JSON format.
111      "gcsDestination": { # A Cloud Storage location. # Destination on Cloud Storage.
112        "uriPrefix": "A String", # The uri prefix of all generated Cloud Storage objects. For example:
113            # "gs://bucket_name/object_name_prefix". Each object uri is in format:
114            # "gs://bucket_name/object_name_prefix/<asset type>/<shard number> and only
115            # contains assets for that type. <shard number> starts from 0. For example:
116            # "gs://bucket_name/object_name_prefix/google.compute.disk/0" is the first
117            # shard of output objects containing all google.compute.disk assets.
118            # An INVALID_ARGUMENT error will be returned if file with the same name
119            # "gs://bucket_name/object_name_prefix" already exists.
120        "uri": "A String", # The uri of the Cloud Storage object. It's the same uri that is used by
121            # gsutil. For example: "gs://bucket_name/object_name". See [Viewing and
122            # Editing Object
123            # Metadata](https://cloud.google.com/storage/docs/viewing-editing-metadata)
124            # for more information.
125      },
126    },
127    "contentType": "A String", # Asset content type. If not specified, no content but the asset name will be
128        # returned.
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
154        # used by [gRPC](https://github.com/grpc). The error model is designed to be:
155        #
156        # - Simple to use and understand for most users
157        # - Flexible enough to meet unexpected needs
158        #
159        # # Overview
160        #
161        # The `Status` message contains three pieces of data: error code, error
162        # message, and error details. The error code should be an enum value of
163        # google.rpc.Code, but it may accept additional error codes if needed.  The
164        # error message should be a developer-facing English message that helps
165        # developers *understand* and *resolve* the error. If a localized user-facing
166        # error message is needed, put the localized message in the error details or
167        # localize it in the client. The optional error details may contain arbitrary
168        # information about the error. There is a predefined set of error detail types
169        # in the package `google.rpc` that can be used for common error conditions.
170        #
171        # # Language mapping
172        #
173        # The `Status` message is the logical representation of the error model, but it
174        # is not necessarily the actual wire format. When the `Status` message is
175        # exposed in different client libraries and different wire protocols, it can be
176        # mapped differently. For example, it will likely be mapped to some exceptions
177        # in Java, but more likely mapped to some error codes in C.
178        #
179        # # Other uses
180        #
181        # The error model and the `Status` message can be used in a variety of
182        # environments, either with or without APIs, to provide a
183        # consistent developer experience across different environments.
184        #
185        # Example uses of this error model include:
186        #
187        # - Partial errors. If a service needs to return partial errors to the client,
188        #     it may embed the `Status` in the normal response to indicate the partial
189        #     errors.
190        #
191        # - Workflow errors. A typical workflow has multiple steps. Each step may
192        #     have a `Status` message for error reporting.
193        #
194        # - Batch operations. If a client uses batch request and batch response, the
195        #     `Status` message should be used directly inside batch response, one for
196        #     each error sub-response.
197        #
198        # - Asynchronous operations. If an API call embeds asynchronous operation
199        #     results in its response, the status of those operations should be
200        #     represented directly using the `Status` message.
201        #
202        # - Logging. If some API errors are stored in logs, the message `Status` could
203        #     be used directly after any stripping needed for security/privacy reasons.
204      "message": "A String", # A developer-facing error message, which should be in English. Any
205          # user-facing error message should be localized and sent in the
206          # google.rpc.Status.details field, or localized by the client.
207      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
208      "details": [ # A list of messages that carry the error details.  There is a common set of
209          # message types for APIs to use.
210        {
211          "a_key": "", # Properties of the object. Contains field @type with type URL.
212        },
213      ],
214    },
215    "done": True or False, # If the value is `false`, it means the operation is still in progress.
216        # If `true`, the operation is completed, and either `error` or `response` is
217        # available.
218    "response": { # The normal response of the operation in case of success.  If the original
219        # method returns no data on success, such as `Delete`, the response is
220        # `google.protobuf.Empty`.  If the original method is standard
221        # `Get`/`Create`/`Update`, the response should be the resource.  For other
222        # methods, the response should have the type `XxxResponse`, where `Xxx`
223        # is the original method name.  For example, if the original method name
224        # is `TakeSnapshot()`, the inferred response type is
225        # `TakeSnapshotResponse`.
226      "a_key": "", # Properties of the object. Contains field @type with type URL.
227    },
228    "name": "A String", # The server-assigned name, which is only unique within the same service that
229        # originally returns it. If you use the default HTTP mapping, the
230        # `name` should have the format of `operations/some/unique/name`.
231  }</pre>
232</div>
233
234</body></html>