blob: 6895fab709569567296544ba973ef0e3807ee7a4 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001<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="datafusion_v1beta1.html">Cloud Data Fusion API</a> . <a href="datafusion_v1beta1.projects.html">projects</a> . <a href="datafusion_v1beta1.projects.locations.html">locations</a> . <a href="datafusion_v1beta1.projects.locations.instances.html">instances</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070078 <code><a href="#create">create(parent, body=None, instanceId=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070079<p class="firstline">Creates a new Data Fusion instance in the specified project and location.</p>
80<p class="toc_element">
81 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
82<p class="firstline">Deletes a single Date Fusion instance.</p>
83<p class="toc_element">
84 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
85<p class="firstline">Gets details of a single Data Fusion instance.</p>
86<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070087 <code><a href="#getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070088<p class="firstline">Gets the access control policy for a resource.</p>
89<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -070090 <code><a href="#list">list(parent, pageToken=None, orderBy=None, pageSize=None, filter=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070091<p class="firstline">Lists Data Fusion instances in the specified project and location.</p>
92<p class="toc_element">
93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070096 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070097<p class="firstline">Updates a single Data Fusion instance.</p>
98<p class="toc_element">
99 <code><a href="#restart">restart(name, body=None, x__xgafv=None)</a></code></p>
100<p class="firstline">Restart a single Data Fusion instance.</p>
101<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700102 <code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700103<p class="firstline">Sets the access control policy on the specified resource. Replaces any</p>
104<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700105 <code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700106<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
107<p class="toc_element">
108 <code><a href="#upgrade">upgrade(name, body=None, x__xgafv=None)</a></code></p>
109<p class="firstline">Upgrade a single Data Fusion instance.</p>
110<h3>Method Details</h3>
111<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700112 <code class="details" id="create">create(parent, body=None, instanceId=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700113 <pre>Creates a new Data Fusion instance in the specified project and location.
114
115Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700116 parent: string, The instance&#x27;s project and location in the format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700117projects/{project}/locations/{location}. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700118 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700119 The object takes the form of:
120
121{ # Represents a Data Fusion instance.
Dan O'Mearadd494642020-05-01 07:42:23 -0700122 # Next available ID: 23
Bu Sun Kim65020912020-05-20 12:08:20 -0700123 &quot;description&quot;: &quot;A String&quot;, # Optional. An optional description of this instance.
124 &quot;options&quot;: { # Map of additional options used to configure the behavior of
125 # Data Fusion instance.
126 &quot;a_key&quot;: &quot;A String&quot;,
127 },
128 &quot;networkConfig&quot;: { # Network configuration for a Data Fusion instance. These configurations # Network configuration options. These are required when a private Data
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700129 # Fusion instance is to be created.
130 # are used for peering with the customer network. Configurations are optional
131 # when a public Data Fusion instance is to be created. However, providing
132 # these configurations allows several benefits, such as reduced network latency
133 # while accessing the customer resources from managed Data Fusion instance
134 # nodes, as well as access to the customer on-prem resources.
Bu Sun Kim65020912020-05-20 12:08:20 -0700135 &quot;network&quot;: &quot;A String&quot;, # Name of the network in the customer project with which the Tenant Project
Dan O'Mearadd494642020-05-01 07:42:23 -0700136 # will be peered for executing pipelines. In case of shared VPC where the
137 # network resides in another host project the network should specified in
138 # the form of projects/{host-project-id}/global/networks/{network}
Bu Sun Kim65020912020-05-20 12:08:20 -0700139 &quot;ipAllocation&quot;: &quot;A String&quot;, # The IP range in CIDR notation to use for the managed Data Fusion instance
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700140 # nodes. This range must not overlap with any other ranges used in the Data
141 # Fusion instance network.
142 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700143 &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of this Data Fusion instance.
144 &quot;gcsBucket&quot;: &quot;A String&quot;, # Output only. Cloud Storage bucket generated by Data Fusion in the customer project.
145 &quot;name&quot;: &quot;A String&quot;, # Output only. The name of this instance is in the form of
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700146 # projects/{project}/locations/{location}/instances/{instance}.
Bu Sun Kim65020912020-05-20 12:08:20 -0700147 &quot;enableStackdriverLogging&quot;: True or False, # Option to enable Stackdriver Logging.
148 &quot;privateInstance&quot;: True or False, # Specifies whether the Data Fusion instance should be private. If set to
149 # true, all Data Fusion nodes will have private IP addresses and will not be
150 # able to access the public internet.
151 &quot;serviceAccount&quot;: &quot;A String&quot;, # Output only. Service account which will be used to access resources in
152 # the customer project.&quot;
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700153 &quot;availableVersion&quot;: [ # Available versions that the instance can be upgraded to using
154 # UpdateInstanceRequest.
155 { # The Data Fusion version.
156 &quot;versionNumber&quot;: &quot;A String&quot;, # The version number of the Data Fusion instance, such as &#x27;6.0.1.0&#x27;.
157 },
158 ],
159 &quot;displayName&quot;: &quot;A String&quot;, # Display name for an instance.
160 &quot;zone&quot;: &quot;A String&quot;, # Name of the zone in which the Data Fusion instance will be created.
161 &quot;apiEndpoint&quot;: &quot;A String&quot;, # Output only. Endpoint on which the REST APIs is accessible.
162 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time the instance was created.
163 &quot;labels&quot;: { # The resource labels for instance to use to annotate any related underlying
164 # resources such as Compute Engine VMs. The character &#x27;=&#x27; is not allowed to
165 # be used within the labels.
166 &quot;a_key&quot;: &quot;A String&quot;,
167 },
168 &quot;serviceEndpoint&quot;: &quot;A String&quot;, # Output only. Endpoint on which the Data Fusion UI is accessible.
169 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time the instance was last updated.
170 &quot;enableStackdriverMonitoring&quot;: True or False, # Option to enable Stackdriver Monitoring.
171 &quot;type&quot;: &quot;A String&quot;, # Required. Instance type.
172 &quot;version&quot;: &quot;A String&quot;, # Current version of Data Fusion.
173 &quot;accelerators&quot;: [ # List of accelerators enabled for this CDF instance.
174 { # Identifies Data Fusion accelerators for an instance.
175 &quot;acceleratorType&quot;: &quot;A String&quot;, # The type of an accelator for a CDF instance.
176 },
177 ],
178 &quot;stateMessage&quot;: &quot;A String&quot;, # Output only. Additional information about the current state of this Data
179 # Fusion instance if available.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700180}
181
182 instanceId: string, The name of the instance to create.
183 x__xgafv: string, V1 error format.
184 Allowed values
185 1 - v1 error format
186 2 - v2 error format
187
188Returns:
189 An object of the form:
190
191 { # This resource represents a long-running operation that is the result of a
192 # network API call.
Bu Sun Kim65020912020-05-20 12:08:20 -0700193 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700194 # method returns no data on success, such as `Delete`, the response is
195 # `google.protobuf.Empty`. If the original method is standard
196 # `Get`/`Create`/`Update`, the response should be the resource. For other
197 # methods, the response should have the type `XxxResponse`, where `Xxx`
198 # is the original method name. For example, if the original method name
199 # is `TakeSnapshot()`, the inferred response type is
200 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700201 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700202 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700203 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700204 # originally returns it. If you use the default HTTP mapping, the
205 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700206 &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.
207 # different programming environments, including REST APIs and RPC APIs. It is
208 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
209 # three pieces of data: error code, error message, and error details.
210 #
211 # You can find out more about this error model and how to work with it in the
212 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700213 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
214 # user-facing error message should be localized and sent in the
215 # google.rpc.Status.details field, or localized by the client.
Bu Sun Kim65020912020-05-20 12:08:20 -0700216 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
217 # message types for APIs to use.
218 {
219 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
220 },
221 ],
222 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim65020912020-05-20 12:08:20 -0700223 },
224 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
Dan O'Mearadd494642020-05-01 07:42:23 -0700225 # contains progress information and common metadata such as create time.
226 # Some services might not provide such metadata. Any method that returns a
227 # long-running operation should document the metadata type, if any.
Bu Sun Kim65020912020-05-20 12:08:20 -0700228 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Dan O'Mearadd494642020-05-01 07:42:23 -0700229 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700230 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
231 # If `true`, the operation is completed, and either `error` or `response` is
232 # available.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700233 }</pre>
234</div>
235
236<div class="method">
237 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
238 <pre>Deletes a single Date Fusion instance.
239
240Args:
241 name: string, The instance resource name in the format
242projects/{project}/locations/{location}/instances/{instance} (required)
243 x__xgafv: string, V1 error format.
244 Allowed values
245 1 - v1 error format
246 2 - v2 error format
247
248Returns:
249 An object of the form:
250
251 { # This resource represents a long-running operation that is the result of a
252 # network API call.
Bu Sun Kim65020912020-05-20 12:08:20 -0700253 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700254 # method returns no data on success, such as `Delete`, the response is
255 # `google.protobuf.Empty`. If the original method is standard
256 # `Get`/`Create`/`Update`, the response should be the resource. For other
257 # methods, the response should have the type `XxxResponse`, where `Xxx`
258 # is the original method name. For example, if the original method name
259 # is `TakeSnapshot()`, the inferred response type is
260 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700261 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700262 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700263 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700264 # originally returns it. If you use the default HTTP mapping, the
265 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700266 &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.
267 # different programming environments, including REST APIs and RPC APIs. It is
268 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
269 # three pieces of data: error code, error message, and error details.
270 #
271 # You can find out more about this error model and how to work with it in the
272 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700273 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
274 # user-facing error message should be localized and sent in the
275 # google.rpc.Status.details field, or localized by the client.
Bu Sun Kim65020912020-05-20 12:08:20 -0700276 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
277 # message types for APIs to use.
278 {
279 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
280 },
281 ],
282 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim65020912020-05-20 12:08:20 -0700283 },
284 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
Dan O'Mearadd494642020-05-01 07:42:23 -0700285 # contains progress information and common metadata such as create time.
286 # Some services might not provide such metadata. Any method that returns a
287 # long-running operation should document the metadata type, if any.
Bu Sun Kim65020912020-05-20 12:08:20 -0700288 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Dan O'Mearadd494642020-05-01 07:42:23 -0700289 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700290 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
291 # If `true`, the operation is completed, and either `error` or `response` is
292 # available.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700293 }</pre>
294</div>
295
296<div class="method">
297 <code class="details" id="get">get(name, x__xgafv=None)</code>
298 <pre>Gets details of a single Data Fusion instance.
299
300Args:
301 name: string, The instance resource name in the format
302projects/{project}/locations/{location}/instances/{instance}. (required)
303 x__xgafv: string, V1 error format.
304 Allowed values
305 1 - v1 error format
306 2 - v2 error format
307
308Returns:
309 An object of the form:
310
311 { # Represents a Data Fusion instance.
Dan O'Mearadd494642020-05-01 07:42:23 -0700312 # Next available ID: 23
Bu Sun Kim65020912020-05-20 12:08:20 -0700313 &quot;description&quot;: &quot;A String&quot;, # Optional. An optional description of this instance.
314 &quot;options&quot;: { # Map of additional options used to configure the behavior of
315 # Data Fusion instance.
316 &quot;a_key&quot;: &quot;A String&quot;,
317 },
318 &quot;networkConfig&quot;: { # Network configuration for a Data Fusion instance. These configurations # Network configuration options. These are required when a private Data
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700319 # Fusion instance is to be created.
320 # are used for peering with the customer network. Configurations are optional
321 # when a public Data Fusion instance is to be created. However, providing
322 # these configurations allows several benefits, such as reduced network latency
323 # while accessing the customer resources from managed Data Fusion instance
324 # nodes, as well as access to the customer on-prem resources.
Bu Sun Kim65020912020-05-20 12:08:20 -0700325 &quot;network&quot;: &quot;A String&quot;, # Name of the network in the customer project with which the Tenant Project
Dan O'Mearadd494642020-05-01 07:42:23 -0700326 # will be peered for executing pipelines. In case of shared VPC where the
327 # network resides in another host project the network should specified in
328 # the form of projects/{host-project-id}/global/networks/{network}
Bu Sun Kim65020912020-05-20 12:08:20 -0700329 &quot;ipAllocation&quot;: &quot;A String&quot;, # The IP range in CIDR notation to use for the managed Data Fusion instance
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700330 # nodes. This range must not overlap with any other ranges used in the Data
331 # Fusion instance network.
332 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700333 &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of this Data Fusion instance.
334 &quot;gcsBucket&quot;: &quot;A String&quot;, # Output only. Cloud Storage bucket generated by Data Fusion in the customer project.
335 &quot;name&quot;: &quot;A String&quot;, # Output only. The name of this instance is in the form of
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700336 # projects/{project}/locations/{location}/instances/{instance}.
Bu Sun Kim65020912020-05-20 12:08:20 -0700337 &quot;enableStackdriverLogging&quot;: True or False, # Option to enable Stackdriver Logging.
338 &quot;privateInstance&quot;: True or False, # Specifies whether the Data Fusion instance should be private. If set to
339 # true, all Data Fusion nodes will have private IP addresses and will not be
340 # able to access the public internet.
341 &quot;serviceAccount&quot;: &quot;A String&quot;, # Output only. Service account which will be used to access resources in
342 # the customer project.&quot;
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700343 &quot;availableVersion&quot;: [ # Available versions that the instance can be upgraded to using
344 # UpdateInstanceRequest.
345 { # The Data Fusion version.
346 &quot;versionNumber&quot;: &quot;A String&quot;, # The version number of the Data Fusion instance, such as &#x27;6.0.1.0&#x27;.
347 },
348 ],
349 &quot;displayName&quot;: &quot;A String&quot;, # Display name for an instance.
350 &quot;zone&quot;: &quot;A String&quot;, # Name of the zone in which the Data Fusion instance will be created.
351 &quot;apiEndpoint&quot;: &quot;A String&quot;, # Output only. Endpoint on which the REST APIs is accessible.
352 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time the instance was created.
353 &quot;labels&quot;: { # The resource labels for instance to use to annotate any related underlying
354 # resources such as Compute Engine VMs. The character &#x27;=&#x27; is not allowed to
355 # be used within the labels.
356 &quot;a_key&quot;: &quot;A String&quot;,
357 },
358 &quot;serviceEndpoint&quot;: &quot;A String&quot;, # Output only. Endpoint on which the Data Fusion UI is accessible.
359 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time the instance was last updated.
360 &quot;enableStackdriverMonitoring&quot;: True or False, # Option to enable Stackdriver Monitoring.
361 &quot;type&quot;: &quot;A String&quot;, # Required. Instance type.
362 &quot;version&quot;: &quot;A String&quot;, # Current version of Data Fusion.
363 &quot;accelerators&quot;: [ # List of accelerators enabled for this CDF instance.
364 { # Identifies Data Fusion accelerators for an instance.
365 &quot;acceleratorType&quot;: &quot;A String&quot;, # The type of an accelator for a CDF instance.
366 },
367 ],
368 &quot;stateMessage&quot;: &quot;A String&quot;, # Output only. Additional information about the current state of this Data
369 # Fusion instance if available.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700370 }</pre>
371</div>
372
373<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700374 <code class="details" id="getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700375 <pre>Gets the access control policy for a resource.
376Returns an empty policy if the resource exists and does not have a policy
377set.
378
379Args:
380 resource: string, REQUIRED: The resource for which the policy is being requested.
381See the operation documentation for the appropriate value for this field. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700382 options_requestedPolicyVersion: integer, Optional. The policy format version to be returned.
383
384Valid values are 0, 1, and 3. Requests specifying an invalid value will be
385rejected.
386
387Requests for policies with any conditional bindings must specify version 3.
388Policies without any conditional bindings may specify any valid value or
389leave the field unset.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700390 x__xgafv: string, V1 error format.
391 Allowed values
392 1 - v1 error format
393 2 - v2 error format
394
395Returns:
396 An object of the form:
397
Dan O'Mearadd494642020-05-01 07:42:23 -0700398 { # An Identity and Access Management (IAM) policy, which specifies access
399 # controls for Google Cloud resources.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700400 #
401 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700402 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
403 # `members` to a single `role`. Members can be user accounts, service accounts,
404 # Google groups, and domains (such as G Suite). A `role` is a named list of
405 # permissions; each `role` can be an IAM predefined role or a user-created
406 # custom role.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700407 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700408 # Optionally, a `binding` can specify a `condition`, which is a logical
409 # expression that allows access to a resource only if the expression evaluates
410 # to `true`. A condition can add constraints based on attributes of the
411 # request, the resource, or both.
412 #
413 # **JSON example:**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700414 #
415 # {
Bu Sun Kim65020912020-05-20 12:08:20 -0700416 # &quot;bindings&quot;: [
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700417 # {
Bu Sun Kim65020912020-05-20 12:08:20 -0700418 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
419 # &quot;members&quot;: [
420 # &quot;user:mike@example.com&quot;,
421 # &quot;group:admins@example.com&quot;,
422 # &quot;domain:google.com&quot;,
423 # &quot;serviceAccount:my-project-id@appspot.gserviceaccount.com&quot;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700424 # ]
425 # },
426 # {
Bu Sun Kim65020912020-05-20 12:08:20 -0700427 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
428 # &quot;members&quot;: [&quot;user:eve@example.com&quot;],
429 # &quot;condition&quot;: {
430 # &quot;title&quot;: &quot;expirable access&quot;,
431 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
432 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
Dan O'Mearadd494642020-05-01 07:42:23 -0700433 # }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700434 # }
Dan O'Mearadd494642020-05-01 07:42:23 -0700435 # ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700436 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
437 # &quot;version&quot;: 3
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700438 # }
439 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700440 # **YAML example:**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700441 #
442 # bindings:
443 # - members:
444 # - user:mike@example.com
445 # - group:admins@example.com
446 # - domain:google.com
Dan O'Mearadd494642020-05-01 07:42:23 -0700447 # - serviceAccount:my-project-id@appspot.gserviceaccount.com
448 # role: roles/resourcemanager.organizationAdmin
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700449 # - members:
Dan O'Mearadd494642020-05-01 07:42:23 -0700450 # - user:eve@example.com
451 # role: roles/resourcemanager.organizationViewer
452 # condition:
453 # title: expirable access
454 # description: Does not grant access after Sep 2020
Bu Sun Kim65020912020-05-20 12:08:20 -0700455 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
Dan O'Mearadd494642020-05-01 07:42:23 -0700456 # - etag: BwWWja0YfJA=
457 # - version: 3
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700458 #
459 # For a description of IAM and its features, see the
Dan O'Mearadd494642020-05-01 07:42:23 -0700460 # [IAM documentation](https://cloud.google.com/iam/docs/).
Bu Sun Kim65020912020-05-20 12:08:20 -0700461 &quot;version&quot;: 42, # Specifies the format of the policy.
462 #
463 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
464 # are rejected.
465 #
466 # Any operation that affects conditional role bindings must specify version
467 # `3`. This requirement applies to the following operations:
468 #
469 # * Getting a policy that includes a conditional role binding
470 # * Adding a conditional role binding to a policy
471 # * Changing a conditional role binding in a policy
472 # * Removing any role binding, with or without a condition, from a policy
473 # that includes conditions
474 #
475 # **Important:** If you use IAM Conditions, you must include the `etag` field
476 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
477 # you to overwrite a version `3` policy with a version `1` policy, and all of
478 # the conditions in the version `3` policy are lost.
479 #
480 # If a policy does not include any conditions, operations on that policy may
481 # specify any valid version or leave the field unset.
482 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
483 { # Specifies the audit configuration for a service.
484 # The configuration determines which permission types are logged, and what
485 # identities, if any, are exempted from logging.
486 # An AuditConfig must have one or more AuditLogConfigs.
487 #
488 # If there are AuditConfigs for both `allServices` and a specific service,
489 # the union of the two AuditConfigs is used for that service: the log_types
490 # specified in each AuditConfig are enabled, and the exempted_members in each
491 # AuditLogConfig are exempted.
492 #
493 # Example Policy with multiple AuditConfigs:
494 #
495 # {
496 # &quot;audit_configs&quot;: [
497 # {
498 # &quot;service&quot;: &quot;allServices&quot;
499 # &quot;audit_log_configs&quot;: [
500 # {
501 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
502 # &quot;exempted_members&quot;: [
503 # &quot;user:jose@example.com&quot;
504 # ]
505 # },
506 # {
507 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
508 # },
509 # {
510 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;,
511 # }
512 # ]
513 # },
514 # {
515 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;
516 # &quot;audit_log_configs&quot;: [
517 # {
518 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
519 # },
520 # {
521 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
522 # &quot;exempted_members&quot;: [
523 # &quot;user:aliya@example.com&quot;
524 # ]
525 # }
526 # ]
527 # }
528 # ]
529 # }
530 #
531 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
532 # logging. It also exempts jose@example.com from DATA_READ logging, and
533 # aliya@example.com from DATA_WRITE logging.
534 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
535 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
536 # `allServices` is a special value that covers all services.
537 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
538 { # Provides the configuration for logging a type of permissions.
539 # Example:
540 #
541 # {
542 # &quot;audit_log_configs&quot;: [
543 # {
544 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
545 # &quot;exempted_members&quot;: [
546 # &quot;user:jose@example.com&quot;
547 # ]
548 # },
549 # {
550 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
551 # }
552 # ]
553 # }
554 #
555 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
556 # jose@example.com from DATA_READ logging.
Bu Sun Kim65020912020-05-20 12:08:20 -0700557 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
558 # permission.
559 # Follows the same format of Binding.members.
560 &quot;A String&quot;,
561 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700562 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
Bu Sun Kim65020912020-05-20 12:08:20 -0700563 },
564 ],
565 },
566 ],
567 &quot;bindings&quot;: [ # Associates a list of `members` to a `role`. Optionally, may specify a
Dan O'Mearadd494642020-05-01 07:42:23 -0700568 # `condition` that determines how and when the `bindings` are applied. Each
569 # of the `bindings` must contain at least one member.
570 { # Associates `members` with a `role`.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700571 &quot;members&quot;: [ # Specifies the identities requesting access for a Cloud Platform resource.
572 # `members` can have the following values:
573 #
574 # * `allUsers`: A special identifier that represents anyone who is
575 # on the internet; with or without a Google account.
576 #
577 # * `allAuthenticatedUsers`: A special identifier that represents anyone
578 # who is authenticated with a Google account or a service account.
579 #
580 # * `user:{emailid}`: An email address that represents a specific Google
581 # account. For example, `alice@example.com` .
582 #
583 #
584 # * `serviceAccount:{emailid}`: An email address that represents a service
585 # account. For example, `my-other-app@appspot.gserviceaccount.com`.
586 #
587 # * `group:{emailid}`: An email address that represents a Google group.
588 # For example, `admins@example.com`.
589 #
590 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
591 # identifier) representing a user that has been recently deleted. For
592 # example, `alice@example.com?uid=123456789012345678901`. If the user is
593 # recovered, this value reverts to `user:{emailid}` and the recovered user
594 # retains the role in the binding.
595 #
596 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
597 # unique identifier) representing a service account that has been recently
598 # deleted. For example,
599 # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
600 # If the service account is undeleted, this value reverts to
601 # `serviceAccount:{emailid}` and the undeleted service account retains the
602 # role in the binding.
603 #
604 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
605 # identifier) representing a Google group that has been recently
606 # deleted. For example, `admins@example.com?uid=123456789012345678901`. If
607 # the group is recovered, this value reverts to `group:{emailid}` and the
608 # recovered group retains the role in the binding.
609 #
610 #
611 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
612 # users of that domain. For example, `google.com` or `example.com`.
613 #
614 &quot;A String&quot;,
615 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700616 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to `members`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700617 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700618 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
619 # NOTE: An unsatisfied condition will not allow user access via current
620 # binding. Different bindings, including their conditions, are examined
621 # independently.
622 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
623 # are documented at https://github.com/google/cel-spec.
624 #
625 # Example (Comparison):
626 #
627 # title: &quot;Summary size limit&quot;
628 # description: &quot;Determines if a summary is less than 100 chars&quot;
629 # expression: &quot;document.summary.size() &lt; 100&quot;
630 #
631 # Example (Equality):
632 #
633 # title: &quot;Requestor is owner&quot;
634 # description: &quot;Determines if requestor is the document owner&quot;
635 # expression: &quot;document.owner == request.auth.claims.email&quot;
636 #
637 # Example (Logic):
638 #
639 # title: &quot;Public documents&quot;
640 # description: &quot;Determine whether the document should be publicly visible&quot;
641 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
642 #
643 # Example (Data Manipulation):
644 #
645 # title: &quot;Notification string&quot;
646 # description: &quot;Create a notification string with a timestamp.&quot;
647 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
648 #
649 # The exact variables and functions that may be referenced within an expression
650 # are determined by the service that evaluates it. See the service
651 # documentation for additional information.
652 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
653 # its purpose. This can be used e.g. in UIs which allow to enter the
654 # expression.
655 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
656 # reporting, e.g. a file name and a position in the file.
657 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
658 # describes the expression, e.g. when hovered over it in a UI.
659 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
660 # syntax.
661 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700662 },
663 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700664 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
665 # prevent simultaneous updates of a policy from overwriting each other.
666 # It is strongly suggested that systems make use of the `etag` in the
667 # read-modify-write cycle to perform policy updates in order to avoid race
668 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
669 # systems are expected to put that etag in the request to `setIamPolicy` to
670 # ensure that their change will be applied to the same version of the policy.
671 #
672 # **Important:** If you use IAM Conditions, you must include the `etag` field
673 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
674 # you to overwrite a version `3` policy with a version `1` policy, and all of
675 # the conditions in the version `3` policy are lost.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700676 }</pre>
677</div>
678
679<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700680 <code class="details" id="list">list(parent, pageToken=None, orderBy=None, pageSize=None, filter=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700681 <pre>Lists Data Fusion instances in the specified project and location.
682
683Args:
684 parent: string, The project and location for which to retrieve instance information
685in the format projects/{project}/locations/{location}. If the location is
Bu Sun Kim65020912020-05-20 12:08:20 -0700686specified as &#x27;-&#x27; (wildcard), then all regions available to the project
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700687are queried, and the results are aggregated. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700688 pageToken: string, The next_page_token value to use if there are additional
689results to retrieve for this list request.
Bu Sun Kim65020912020-05-20 12:08:20 -0700690 orderBy: string, Sort results. Supported values are &quot;name&quot;, &quot;name desc&quot;, or &quot;&quot; (unsorted).
691 pageSize: integer, The maximum number of items to return.
692 filter: string, List filter.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700693 x__xgafv: string, V1 error format.
694 Allowed values
695 1 - v1 error format
696 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700697
698Returns:
699 An object of the form:
700
701 { # Response message for the list instance request.
Bu Sun Kim65020912020-05-20 12:08:20 -0700702 &quot;instances&quot;: [ # Represents a list of Data Fusion instances.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700703 { # Represents a Data Fusion instance.
Dan O'Mearadd494642020-05-01 07:42:23 -0700704 # Next available ID: 23
Bu Sun Kim65020912020-05-20 12:08:20 -0700705 &quot;description&quot;: &quot;A String&quot;, # Optional. An optional description of this instance.
706 &quot;options&quot;: { # Map of additional options used to configure the behavior of
707 # Data Fusion instance.
708 &quot;a_key&quot;: &quot;A String&quot;,
709 },
710 &quot;networkConfig&quot;: { # Network configuration for a Data Fusion instance. These configurations # Network configuration options. These are required when a private Data
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700711 # Fusion instance is to be created.
712 # are used for peering with the customer network. Configurations are optional
713 # when a public Data Fusion instance is to be created. However, providing
714 # these configurations allows several benefits, such as reduced network latency
715 # while accessing the customer resources from managed Data Fusion instance
716 # nodes, as well as access to the customer on-prem resources.
Bu Sun Kim65020912020-05-20 12:08:20 -0700717 &quot;network&quot;: &quot;A String&quot;, # Name of the network in the customer project with which the Tenant Project
Dan O'Mearadd494642020-05-01 07:42:23 -0700718 # will be peered for executing pipelines. In case of shared VPC where the
719 # network resides in another host project the network should specified in
720 # the form of projects/{host-project-id}/global/networks/{network}
Bu Sun Kim65020912020-05-20 12:08:20 -0700721 &quot;ipAllocation&quot;: &quot;A String&quot;, # The IP range in CIDR notation to use for the managed Data Fusion instance
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700722 # nodes. This range must not overlap with any other ranges used in the Data
723 # Fusion instance network.
724 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700725 &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of this Data Fusion instance.
726 &quot;gcsBucket&quot;: &quot;A String&quot;, # Output only. Cloud Storage bucket generated by Data Fusion in the customer project.
727 &quot;name&quot;: &quot;A String&quot;, # Output only. The name of this instance is in the form of
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700728 # projects/{project}/locations/{location}/instances/{instance}.
Bu Sun Kim65020912020-05-20 12:08:20 -0700729 &quot;enableStackdriverLogging&quot;: True or False, # Option to enable Stackdriver Logging.
730 &quot;privateInstance&quot;: True or False, # Specifies whether the Data Fusion instance should be private. If set to
731 # true, all Data Fusion nodes will have private IP addresses and will not be
732 # able to access the public internet.
733 &quot;serviceAccount&quot;: &quot;A String&quot;, # Output only. Service account which will be used to access resources in
734 # the customer project.&quot;
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700735 &quot;availableVersion&quot;: [ # Available versions that the instance can be upgraded to using
736 # UpdateInstanceRequest.
737 { # The Data Fusion version.
738 &quot;versionNumber&quot;: &quot;A String&quot;, # The version number of the Data Fusion instance, such as &#x27;6.0.1.0&#x27;.
739 },
740 ],
741 &quot;displayName&quot;: &quot;A String&quot;, # Display name for an instance.
742 &quot;zone&quot;: &quot;A String&quot;, # Name of the zone in which the Data Fusion instance will be created.
743 &quot;apiEndpoint&quot;: &quot;A String&quot;, # Output only. Endpoint on which the REST APIs is accessible.
744 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time the instance was created.
745 &quot;labels&quot;: { # The resource labels for instance to use to annotate any related underlying
746 # resources such as Compute Engine VMs. The character &#x27;=&#x27; is not allowed to
747 # be used within the labels.
748 &quot;a_key&quot;: &quot;A String&quot;,
749 },
750 &quot;serviceEndpoint&quot;: &quot;A String&quot;, # Output only. Endpoint on which the Data Fusion UI is accessible.
751 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time the instance was last updated.
752 &quot;enableStackdriverMonitoring&quot;: True or False, # Option to enable Stackdriver Monitoring.
753 &quot;type&quot;: &quot;A String&quot;, # Required. Instance type.
754 &quot;version&quot;: &quot;A String&quot;, # Current version of Data Fusion.
755 &quot;accelerators&quot;: [ # List of accelerators enabled for this CDF instance.
756 { # Identifies Data Fusion accelerators for an instance.
757 &quot;acceleratorType&quot;: &quot;A String&quot;, # The type of an accelator for a CDF instance.
758 },
759 ],
760 &quot;stateMessage&quot;: &quot;A String&quot;, # Output only. Additional information about the current state of this Data
761 # Fusion instance if available.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700762 },
763 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700764 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results or empty if there are no more
765 # results in the list.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700766 &quot;unreachable&quot;: [ # Locations that could not be reached.
767 &quot;A String&quot;,
768 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700769 }</pre>
770</div>
771
772<div class="method">
773 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
774 <pre>Retrieves the next page of results.
775
776Args:
777 previous_request: The request for the previous page. (required)
778 previous_response: The response from the request for the previous page. (required)
779
780Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700781 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700782 page. Returns None if there are no more items in the collection.
783 </pre>
784</div>
785
786<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700787 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700788 <pre>Updates a single Data Fusion instance.
789
790Args:
791 name: string, Output only. The name of this instance is in the form of
792projects/{project}/locations/{location}/instances/{instance}. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700793 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700794 The object takes the form of:
795
796{ # Represents a Data Fusion instance.
Dan O'Mearadd494642020-05-01 07:42:23 -0700797 # Next available ID: 23
Bu Sun Kim65020912020-05-20 12:08:20 -0700798 &quot;description&quot;: &quot;A String&quot;, # Optional. An optional description of this instance.
799 &quot;options&quot;: { # Map of additional options used to configure the behavior of
800 # Data Fusion instance.
801 &quot;a_key&quot;: &quot;A String&quot;,
802 },
803 &quot;networkConfig&quot;: { # Network configuration for a Data Fusion instance. These configurations # Network configuration options. These are required when a private Data
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700804 # Fusion instance is to be created.
805 # are used for peering with the customer network. Configurations are optional
806 # when a public Data Fusion instance is to be created. However, providing
807 # these configurations allows several benefits, such as reduced network latency
808 # while accessing the customer resources from managed Data Fusion instance
809 # nodes, as well as access to the customer on-prem resources.
Bu Sun Kim65020912020-05-20 12:08:20 -0700810 &quot;network&quot;: &quot;A String&quot;, # Name of the network in the customer project with which the Tenant Project
Dan O'Mearadd494642020-05-01 07:42:23 -0700811 # will be peered for executing pipelines. In case of shared VPC where the
812 # network resides in another host project the network should specified in
813 # the form of projects/{host-project-id}/global/networks/{network}
Bu Sun Kim65020912020-05-20 12:08:20 -0700814 &quot;ipAllocation&quot;: &quot;A String&quot;, # The IP range in CIDR notation to use for the managed Data Fusion instance
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700815 # nodes. This range must not overlap with any other ranges used in the Data
816 # Fusion instance network.
817 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700818 &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of this Data Fusion instance.
819 &quot;gcsBucket&quot;: &quot;A String&quot;, # Output only. Cloud Storage bucket generated by Data Fusion in the customer project.
820 &quot;name&quot;: &quot;A String&quot;, # Output only. The name of this instance is in the form of
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700821 # projects/{project}/locations/{location}/instances/{instance}.
Bu Sun Kim65020912020-05-20 12:08:20 -0700822 &quot;enableStackdriverLogging&quot;: True or False, # Option to enable Stackdriver Logging.
823 &quot;privateInstance&quot;: True or False, # Specifies whether the Data Fusion instance should be private. If set to
824 # true, all Data Fusion nodes will have private IP addresses and will not be
825 # able to access the public internet.
826 &quot;serviceAccount&quot;: &quot;A String&quot;, # Output only. Service account which will be used to access resources in
827 # the customer project.&quot;
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700828 &quot;availableVersion&quot;: [ # Available versions that the instance can be upgraded to using
829 # UpdateInstanceRequest.
830 { # The Data Fusion version.
831 &quot;versionNumber&quot;: &quot;A String&quot;, # The version number of the Data Fusion instance, such as &#x27;6.0.1.0&#x27;.
832 },
833 ],
834 &quot;displayName&quot;: &quot;A String&quot;, # Display name for an instance.
835 &quot;zone&quot;: &quot;A String&quot;, # Name of the zone in which the Data Fusion instance will be created.
836 &quot;apiEndpoint&quot;: &quot;A String&quot;, # Output only. Endpoint on which the REST APIs is accessible.
837 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time the instance was created.
838 &quot;labels&quot;: { # The resource labels for instance to use to annotate any related underlying
839 # resources such as Compute Engine VMs. The character &#x27;=&#x27; is not allowed to
840 # be used within the labels.
841 &quot;a_key&quot;: &quot;A String&quot;,
842 },
843 &quot;serviceEndpoint&quot;: &quot;A String&quot;, # Output only. Endpoint on which the Data Fusion UI is accessible.
844 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time the instance was last updated.
845 &quot;enableStackdriverMonitoring&quot;: True or False, # Option to enable Stackdriver Monitoring.
846 &quot;type&quot;: &quot;A String&quot;, # Required. Instance type.
847 &quot;version&quot;: &quot;A String&quot;, # Current version of Data Fusion.
848 &quot;accelerators&quot;: [ # List of accelerators enabled for this CDF instance.
849 { # Identifies Data Fusion accelerators for an instance.
850 &quot;acceleratorType&quot;: &quot;A String&quot;, # The type of an accelator for a CDF instance.
851 },
852 ],
853 &quot;stateMessage&quot;: &quot;A String&quot;, # Output only. Additional information about the current state of this Data
854 # Fusion instance if available.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700855}
856
857 updateMask: string, Field mask is used to specify the fields that the update will overwrite
858in an instance resource. The fields specified in the update_mask are
859relative to the resource, not the full request.
860A field will be overwritten if it is in the mask.
861If the user does not provide a mask, all the supported fields (labels and
862options currently) will be overwritten.
863 x__xgafv: string, V1 error format.
864 Allowed values
865 1 - v1 error format
866 2 - v2 error format
867
868Returns:
869 An object of the form:
870
871 { # This resource represents a long-running operation that is the result of a
872 # network API call.
Bu Sun Kim65020912020-05-20 12:08:20 -0700873 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700874 # method returns no data on success, such as `Delete`, the response is
875 # `google.protobuf.Empty`. If the original method is standard
876 # `Get`/`Create`/`Update`, the response should be the resource. For other
877 # methods, the response should have the type `XxxResponse`, where `Xxx`
878 # is the original method name. For example, if the original method name
879 # is `TakeSnapshot()`, the inferred response type is
880 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700881 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700882 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700883 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700884 # originally returns it. If you use the default HTTP mapping, the
885 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700886 &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.
887 # different programming environments, including REST APIs and RPC APIs. It is
888 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
889 # three pieces of data: error code, error message, and error details.
890 #
891 # You can find out more about this error model and how to work with it in the
892 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700893 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
894 # user-facing error message should be localized and sent in the
895 # google.rpc.Status.details field, or localized by the client.
Bu Sun Kim65020912020-05-20 12:08:20 -0700896 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
897 # message types for APIs to use.
898 {
899 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
900 },
901 ],
902 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim65020912020-05-20 12:08:20 -0700903 },
904 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
Dan O'Mearadd494642020-05-01 07:42:23 -0700905 # contains progress information and common metadata such as create time.
906 # Some services might not provide such metadata. Any method that returns a
907 # long-running operation should document the metadata type, if any.
Bu Sun Kim65020912020-05-20 12:08:20 -0700908 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Dan O'Mearadd494642020-05-01 07:42:23 -0700909 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700910 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
911 # If `true`, the operation is completed, and either `error` or `response` is
912 # available.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700913 }</pre>
914</div>
915
916<div class="method">
917 <code class="details" id="restart">restart(name, body=None, x__xgafv=None)</code>
918 <pre>Restart a single Data Fusion instance.
919At the end of an operation instance is fully restarted.
920
921Args:
922 name: string, Name of the Data Fusion instance which need to be restarted in the form of
923projects/{project}/locations/{location}/instances/{instance} (required)
924 body: object, The request body.
925 The object takes the form of:
926
927{ # Request message for restarting a Data Fusion instance.
928 }
929
930 x__xgafv: string, V1 error format.
931 Allowed values
932 1 - v1 error format
933 2 - v2 error format
934
935Returns:
936 An object of the form:
937
938 { # This resource represents a long-running operation that is the result of a
939 # network API call.
Bu Sun Kim65020912020-05-20 12:08:20 -0700940 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700941 # method returns no data on success, such as `Delete`, the response is
942 # `google.protobuf.Empty`. If the original method is standard
943 # `Get`/`Create`/`Update`, the response should be the resource. For other
944 # methods, the response should have the type `XxxResponse`, where `Xxx`
945 # is the original method name. For example, if the original method name
946 # is `TakeSnapshot()`, the inferred response type is
947 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700948 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700949 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700950 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700951 # originally returns it. If you use the default HTTP mapping, the
952 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700953 &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.
954 # different programming environments, including REST APIs and RPC APIs. It is
955 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
956 # three pieces of data: error code, error message, and error details.
957 #
958 # You can find out more about this error model and how to work with it in the
959 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700960 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
961 # user-facing error message should be localized and sent in the
962 # google.rpc.Status.details field, or localized by the client.
Bu Sun Kim65020912020-05-20 12:08:20 -0700963 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
964 # message types for APIs to use.
965 {
966 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
967 },
968 ],
969 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim65020912020-05-20 12:08:20 -0700970 },
971 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
Dan O'Mearadd494642020-05-01 07:42:23 -0700972 # contains progress information and common metadata such as create time.
973 # Some services might not provide such metadata. Any method that returns a
974 # long-running operation should document the metadata type, if any.
Bu Sun Kim65020912020-05-20 12:08:20 -0700975 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Dan O'Mearadd494642020-05-01 07:42:23 -0700976 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700977 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
978 # If `true`, the operation is completed, and either `error` or `response` is
979 # available.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700980 }</pre>
981</div>
982
983<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700984 <code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700985 <pre>Sets the access control policy on the specified resource. Replaces any
986existing policy.
987
Dan O'Mearadd494642020-05-01 07:42:23 -0700988Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED
989
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700990Args:
991 resource: string, REQUIRED: The resource for which the policy is being specified.
992See the operation documentation for the appropriate value for this field. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700993 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700994 The object takes the form of:
995
996{ # Request message for `SetIamPolicy` method.
Bu Sun Kim65020912020-05-20 12:08:20 -0700997 &quot;policy&quot;: { # An Identity and Access Management (IAM) policy, which specifies access # REQUIRED: The complete policy to be applied to the `resource`. The size of
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700998 # the policy is limited to a few 10s of KB. An empty policy is a
999 # valid policy but certain Cloud Platform services (such as Projects)
1000 # might reject them.
Dan O'Mearadd494642020-05-01 07:42:23 -07001001 # controls for Google Cloud resources.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001002 #
1003 #
Dan O'Mearadd494642020-05-01 07:42:23 -07001004 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
1005 # `members` to a single `role`. Members can be user accounts, service accounts,
1006 # Google groups, and domains (such as G Suite). A `role` is a named list of
1007 # permissions; each `role` can be an IAM predefined role or a user-created
1008 # custom role.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001009 #
Dan O'Mearadd494642020-05-01 07:42:23 -07001010 # Optionally, a `binding` can specify a `condition`, which is a logical
1011 # expression that allows access to a resource only if the expression evaluates
1012 # to `true`. A condition can add constraints based on attributes of the
1013 # request, the resource, or both.
1014 #
1015 # **JSON example:**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001016 #
1017 # {
Bu Sun Kim65020912020-05-20 12:08:20 -07001018 # &quot;bindings&quot;: [
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001019 # {
Bu Sun Kim65020912020-05-20 12:08:20 -07001020 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
1021 # &quot;members&quot;: [
1022 # &quot;user:mike@example.com&quot;,
1023 # &quot;group:admins@example.com&quot;,
1024 # &quot;domain:google.com&quot;,
1025 # &quot;serviceAccount:my-project-id@appspot.gserviceaccount.com&quot;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001026 # ]
1027 # },
1028 # {
Bu Sun Kim65020912020-05-20 12:08:20 -07001029 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
1030 # &quot;members&quot;: [&quot;user:eve@example.com&quot;],
1031 # &quot;condition&quot;: {
1032 # &quot;title&quot;: &quot;expirable access&quot;,
1033 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
1034 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
Dan O'Mearadd494642020-05-01 07:42:23 -07001035 # }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001036 # }
Dan O'Mearadd494642020-05-01 07:42:23 -07001037 # ],
Bu Sun Kim65020912020-05-20 12:08:20 -07001038 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
1039 # &quot;version&quot;: 3
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001040 # }
1041 #
Dan O'Mearadd494642020-05-01 07:42:23 -07001042 # **YAML example:**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001043 #
1044 # bindings:
1045 # - members:
1046 # - user:mike@example.com
1047 # - group:admins@example.com
1048 # - domain:google.com
Dan O'Mearadd494642020-05-01 07:42:23 -07001049 # - serviceAccount:my-project-id@appspot.gserviceaccount.com
1050 # role: roles/resourcemanager.organizationAdmin
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001051 # - members:
Dan O'Mearadd494642020-05-01 07:42:23 -07001052 # - user:eve@example.com
1053 # role: roles/resourcemanager.organizationViewer
1054 # condition:
1055 # title: expirable access
1056 # description: Does not grant access after Sep 2020
Bu Sun Kim65020912020-05-20 12:08:20 -07001057 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
Dan O'Mearadd494642020-05-01 07:42:23 -07001058 # - etag: BwWWja0YfJA=
1059 # - version: 3
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001060 #
1061 # For a description of IAM and its features, see the
Dan O'Mearadd494642020-05-01 07:42:23 -07001062 # [IAM documentation](https://cloud.google.com/iam/docs/).
Bu Sun Kim65020912020-05-20 12:08:20 -07001063 &quot;version&quot;: 42, # Specifies the format of the policy.
1064 #
1065 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
1066 # are rejected.
1067 #
1068 # Any operation that affects conditional role bindings must specify version
1069 # `3`. This requirement applies to the following operations:
1070 #
1071 # * Getting a policy that includes a conditional role binding
1072 # * Adding a conditional role binding to a policy
1073 # * Changing a conditional role binding in a policy
1074 # * Removing any role binding, with or without a condition, from a policy
1075 # that includes conditions
1076 #
1077 # **Important:** If you use IAM Conditions, you must include the `etag` field
1078 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
1079 # you to overwrite a version `3` policy with a version `1` policy, and all of
1080 # the conditions in the version `3` policy are lost.
1081 #
1082 # If a policy does not include any conditions, operations on that policy may
1083 # specify any valid version or leave the field unset.
1084 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
1085 { # Specifies the audit configuration for a service.
1086 # The configuration determines which permission types are logged, and what
1087 # identities, if any, are exempted from logging.
1088 # An AuditConfig must have one or more AuditLogConfigs.
1089 #
1090 # If there are AuditConfigs for both `allServices` and a specific service,
1091 # the union of the two AuditConfigs is used for that service: the log_types
1092 # specified in each AuditConfig are enabled, and the exempted_members in each
1093 # AuditLogConfig are exempted.
1094 #
1095 # Example Policy with multiple AuditConfigs:
1096 #
1097 # {
1098 # &quot;audit_configs&quot;: [
1099 # {
1100 # &quot;service&quot;: &quot;allServices&quot;
1101 # &quot;audit_log_configs&quot;: [
1102 # {
1103 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
1104 # &quot;exempted_members&quot;: [
1105 # &quot;user:jose@example.com&quot;
1106 # ]
1107 # },
1108 # {
1109 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
1110 # },
1111 # {
1112 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;,
1113 # }
1114 # ]
1115 # },
1116 # {
1117 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;
1118 # &quot;audit_log_configs&quot;: [
1119 # {
1120 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
1121 # },
1122 # {
1123 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
1124 # &quot;exempted_members&quot;: [
1125 # &quot;user:aliya@example.com&quot;
1126 # ]
1127 # }
1128 # ]
1129 # }
1130 # ]
1131 # }
1132 #
1133 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
1134 # logging. It also exempts jose@example.com from DATA_READ logging, and
1135 # aliya@example.com from DATA_WRITE logging.
1136 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
1137 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
1138 # `allServices` is a special value that covers all services.
1139 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
1140 { # Provides the configuration for logging a type of permissions.
1141 # Example:
1142 #
1143 # {
1144 # &quot;audit_log_configs&quot;: [
1145 # {
1146 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
1147 # &quot;exempted_members&quot;: [
1148 # &quot;user:jose@example.com&quot;
1149 # ]
1150 # },
1151 # {
1152 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
1153 # }
1154 # ]
1155 # }
1156 #
1157 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
1158 # jose@example.com from DATA_READ logging.
Bu Sun Kim65020912020-05-20 12:08:20 -07001159 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
1160 # permission.
1161 # Follows the same format of Binding.members.
1162 &quot;A String&quot;,
1163 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001164 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
Bu Sun Kim65020912020-05-20 12:08:20 -07001165 },
1166 ],
1167 },
1168 ],
1169 &quot;bindings&quot;: [ # Associates a list of `members` to a `role`. Optionally, may specify a
Dan O'Mearadd494642020-05-01 07:42:23 -07001170 # `condition` that determines how and when the `bindings` are applied. Each
1171 # of the `bindings` must contain at least one member.
1172 { # Associates `members` with a `role`.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001173 &quot;members&quot;: [ # Specifies the identities requesting access for a Cloud Platform resource.
1174 # `members` can have the following values:
1175 #
1176 # * `allUsers`: A special identifier that represents anyone who is
1177 # on the internet; with or without a Google account.
1178 #
1179 # * `allAuthenticatedUsers`: A special identifier that represents anyone
1180 # who is authenticated with a Google account or a service account.
1181 #
1182 # * `user:{emailid}`: An email address that represents a specific Google
1183 # account. For example, `alice@example.com` .
1184 #
1185 #
1186 # * `serviceAccount:{emailid}`: An email address that represents a service
1187 # account. For example, `my-other-app@appspot.gserviceaccount.com`.
1188 #
1189 # * `group:{emailid}`: An email address that represents a Google group.
1190 # For example, `admins@example.com`.
1191 #
1192 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
1193 # identifier) representing a user that has been recently deleted. For
1194 # example, `alice@example.com?uid=123456789012345678901`. If the user is
1195 # recovered, this value reverts to `user:{emailid}` and the recovered user
1196 # retains the role in the binding.
1197 #
1198 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
1199 # unique identifier) representing a service account that has been recently
1200 # deleted. For example,
1201 # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
1202 # If the service account is undeleted, this value reverts to
1203 # `serviceAccount:{emailid}` and the undeleted service account retains the
1204 # role in the binding.
1205 #
1206 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
1207 # identifier) representing a Google group that has been recently
1208 # deleted. For example, `admins@example.com?uid=123456789012345678901`. If
1209 # the group is recovered, this value reverts to `group:{emailid}` and the
1210 # recovered group retains the role in the binding.
1211 #
1212 #
1213 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
1214 # users of that domain. For example, `google.com` or `example.com`.
1215 #
1216 &quot;A String&quot;,
1217 ],
Bu Sun Kim65020912020-05-20 12:08:20 -07001218 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to `members`.
Dan O'Mearadd494642020-05-01 07:42:23 -07001219 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
Bu Sun Kim65020912020-05-20 12:08:20 -07001220 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
1221 # NOTE: An unsatisfied condition will not allow user access via current
1222 # binding. Different bindings, including their conditions, are examined
1223 # independently.
1224 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
1225 # are documented at https://github.com/google/cel-spec.
1226 #
1227 # Example (Comparison):
1228 #
1229 # title: &quot;Summary size limit&quot;
1230 # description: &quot;Determines if a summary is less than 100 chars&quot;
1231 # expression: &quot;document.summary.size() &lt; 100&quot;
1232 #
1233 # Example (Equality):
1234 #
1235 # title: &quot;Requestor is owner&quot;
1236 # description: &quot;Determines if requestor is the document owner&quot;
1237 # expression: &quot;document.owner == request.auth.claims.email&quot;
1238 #
1239 # Example (Logic):
1240 #
1241 # title: &quot;Public documents&quot;
1242 # description: &quot;Determine whether the document should be publicly visible&quot;
1243 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
1244 #
1245 # Example (Data Manipulation):
1246 #
1247 # title: &quot;Notification string&quot;
1248 # description: &quot;Create a notification string with a timestamp.&quot;
1249 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
1250 #
1251 # The exact variables and functions that may be referenced within an expression
1252 # are determined by the service that evaluates it. See the service
1253 # documentation for additional information.
1254 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
1255 # its purpose. This can be used e.g. in UIs which allow to enter the
1256 # expression.
1257 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
1258 # reporting, e.g. a file name and a position in the file.
1259 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
1260 # describes the expression, e.g. when hovered over it in a UI.
1261 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
1262 # syntax.
1263 },
Dan O'Mearadd494642020-05-01 07:42:23 -07001264 },
1265 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001266 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
1267 # prevent simultaneous updates of a policy from overwriting each other.
1268 # It is strongly suggested that systems make use of the `etag` in the
1269 # read-modify-write cycle to perform policy updates in order to avoid race
1270 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
1271 # systems are expected to put that etag in the request to `setIamPolicy` to
1272 # ensure that their change will be applied to the same version of the policy.
1273 #
1274 # **Important:** If you use IAM Conditions, you must include the `etag` field
1275 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
1276 # you to overwrite a version `3` policy with a version `1` policy, and all of
1277 # the conditions in the version `3` policy are lost.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001278 },
Bu Sun Kim65020912020-05-20 12:08:20 -07001279 &quot;updateMask&quot;: &quot;A String&quot;, # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001280 # the fields in the mask will be modified. If no mask is provided, the
1281 # following default mask is used:
Bu Sun Kim65020912020-05-20 12:08:20 -07001282 # paths: &quot;bindings, etag&quot;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001283 # This field is only used by Cloud IAM.
1284 }
1285
1286 x__xgafv: string, V1 error format.
1287 Allowed values
1288 1 - v1 error format
1289 2 - v2 error format
1290
1291Returns:
1292 An object of the form:
1293
Dan O'Mearadd494642020-05-01 07:42:23 -07001294 { # An Identity and Access Management (IAM) policy, which specifies access
1295 # controls for Google Cloud resources.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001296 #
1297 #
Dan O'Mearadd494642020-05-01 07:42:23 -07001298 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
1299 # `members` to a single `role`. Members can be user accounts, service accounts,
1300 # Google groups, and domains (such as G Suite). A `role` is a named list of
1301 # permissions; each `role` can be an IAM predefined role or a user-created
1302 # custom role.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001303 #
Dan O'Mearadd494642020-05-01 07:42:23 -07001304 # Optionally, a `binding` can specify a `condition`, which is a logical
1305 # expression that allows access to a resource only if the expression evaluates
1306 # to `true`. A condition can add constraints based on attributes of the
1307 # request, the resource, or both.
1308 #
1309 # **JSON example:**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001310 #
1311 # {
Bu Sun Kim65020912020-05-20 12:08:20 -07001312 # &quot;bindings&quot;: [
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001313 # {
Bu Sun Kim65020912020-05-20 12:08:20 -07001314 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
1315 # &quot;members&quot;: [
1316 # &quot;user:mike@example.com&quot;,
1317 # &quot;group:admins@example.com&quot;,
1318 # &quot;domain:google.com&quot;,
1319 # &quot;serviceAccount:my-project-id@appspot.gserviceaccount.com&quot;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001320 # ]
1321 # },
1322 # {
Bu Sun Kim65020912020-05-20 12:08:20 -07001323 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
1324 # &quot;members&quot;: [&quot;user:eve@example.com&quot;],
1325 # &quot;condition&quot;: {
1326 # &quot;title&quot;: &quot;expirable access&quot;,
1327 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
1328 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
Dan O'Mearadd494642020-05-01 07:42:23 -07001329 # }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001330 # }
Dan O'Mearadd494642020-05-01 07:42:23 -07001331 # ],
Bu Sun Kim65020912020-05-20 12:08:20 -07001332 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
1333 # &quot;version&quot;: 3
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001334 # }
1335 #
Dan O'Mearadd494642020-05-01 07:42:23 -07001336 # **YAML example:**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001337 #
1338 # bindings:
1339 # - members:
1340 # - user:mike@example.com
1341 # - group:admins@example.com
1342 # - domain:google.com
Dan O'Mearadd494642020-05-01 07:42:23 -07001343 # - serviceAccount:my-project-id@appspot.gserviceaccount.com
1344 # role: roles/resourcemanager.organizationAdmin
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001345 # - members:
Dan O'Mearadd494642020-05-01 07:42:23 -07001346 # - user:eve@example.com
1347 # role: roles/resourcemanager.organizationViewer
1348 # condition:
1349 # title: expirable access
1350 # description: Does not grant access after Sep 2020
Bu Sun Kim65020912020-05-20 12:08:20 -07001351 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
Dan O'Mearadd494642020-05-01 07:42:23 -07001352 # - etag: BwWWja0YfJA=
1353 # - version: 3
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001354 #
1355 # For a description of IAM and its features, see the
Dan O'Mearadd494642020-05-01 07:42:23 -07001356 # [IAM documentation](https://cloud.google.com/iam/docs/).
Bu Sun Kim65020912020-05-20 12:08:20 -07001357 &quot;version&quot;: 42, # Specifies the format of the policy.
1358 #
1359 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
1360 # are rejected.
1361 #
1362 # Any operation that affects conditional role bindings must specify version
1363 # `3`. This requirement applies to the following operations:
1364 #
1365 # * Getting a policy that includes a conditional role binding
1366 # * Adding a conditional role binding to a policy
1367 # * Changing a conditional role binding in a policy
1368 # * Removing any role binding, with or without a condition, from a policy
1369 # that includes conditions
1370 #
1371 # **Important:** If you use IAM Conditions, you must include the `etag` field
1372 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
1373 # you to overwrite a version `3` policy with a version `1` policy, and all of
1374 # the conditions in the version `3` policy are lost.
1375 #
1376 # If a policy does not include any conditions, operations on that policy may
1377 # specify any valid version or leave the field unset.
1378 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
1379 { # Specifies the audit configuration for a service.
1380 # The configuration determines which permission types are logged, and what
1381 # identities, if any, are exempted from logging.
1382 # An AuditConfig must have one or more AuditLogConfigs.
1383 #
1384 # If there are AuditConfigs for both `allServices` and a specific service,
1385 # the union of the two AuditConfigs is used for that service: the log_types
1386 # specified in each AuditConfig are enabled, and the exempted_members in each
1387 # AuditLogConfig are exempted.
1388 #
1389 # Example Policy with multiple AuditConfigs:
1390 #
1391 # {
1392 # &quot;audit_configs&quot;: [
1393 # {
1394 # &quot;service&quot;: &quot;allServices&quot;
1395 # &quot;audit_log_configs&quot;: [
1396 # {
1397 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
1398 # &quot;exempted_members&quot;: [
1399 # &quot;user:jose@example.com&quot;
1400 # ]
1401 # },
1402 # {
1403 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
1404 # },
1405 # {
1406 # &quot;log_type&quot;: &quot;ADMIN_READ&quot;,
1407 # }
1408 # ]
1409 # },
1410 # {
1411 # &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;
1412 # &quot;audit_log_configs&quot;: [
1413 # {
1414 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
1415 # },
1416 # {
1417 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
1418 # &quot;exempted_members&quot;: [
1419 # &quot;user:aliya@example.com&quot;
1420 # ]
1421 # }
1422 # ]
1423 # }
1424 # ]
1425 # }
1426 #
1427 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
1428 # logging. It also exempts jose@example.com from DATA_READ logging, and
1429 # aliya@example.com from DATA_WRITE logging.
1430 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging.
1431 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
1432 # `allServices` is a special value that covers all services.
1433 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
1434 { # Provides the configuration for logging a type of permissions.
1435 # Example:
1436 #
1437 # {
1438 # &quot;audit_log_configs&quot;: [
1439 # {
1440 # &quot;log_type&quot;: &quot;DATA_READ&quot;,
1441 # &quot;exempted_members&quot;: [
1442 # &quot;user:jose@example.com&quot;
1443 # ]
1444 # },
1445 # {
1446 # &quot;log_type&quot;: &quot;DATA_WRITE&quot;,
1447 # }
1448 # ]
1449 # }
1450 #
1451 # This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting
1452 # jose@example.com from DATA_READ logging.
Bu Sun Kim65020912020-05-20 12:08:20 -07001453 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of
1454 # permission.
1455 # Follows the same format of Binding.members.
1456 &quot;A String&quot;,
1457 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001458 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
Bu Sun Kim65020912020-05-20 12:08:20 -07001459 },
1460 ],
1461 },
1462 ],
1463 &quot;bindings&quot;: [ # Associates a list of `members` to a `role`. Optionally, may specify a
Dan O'Mearadd494642020-05-01 07:42:23 -07001464 # `condition` that determines how and when the `bindings` are applied. Each
1465 # of the `bindings` must contain at least one member.
1466 { # Associates `members` with a `role`.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001467 &quot;members&quot;: [ # Specifies the identities requesting access for a Cloud Platform resource.
1468 # `members` can have the following values:
1469 #
1470 # * `allUsers`: A special identifier that represents anyone who is
1471 # on the internet; with or without a Google account.
1472 #
1473 # * `allAuthenticatedUsers`: A special identifier that represents anyone
1474 # who is authenticated with a Google account or a service account.
1475 #
1476 # * `user:{emailid}`: An email address that represents a specific Google
1477 # account. For example, `alice@example.com` .
1478 #
1479 #
1480 # * `serviceAccount:{emailid}`: An email address that represents a service
1481 # account. For example, `my-other-app@appspot.gserviceaccount.com`.
1482 #
1483 # * `group:{emailid}`: An email address that represents a Google group.
1484 # For example, `admins@example.com`.
1485 #
1486 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
1487 # identifier) representing a user that has been recently deleted. For
1488 # example, `alice@example.com?uid=123456789012345678901`. If the user is
1489 # recovered, this value reverts to `user:{emailid}` and the recovered user
1490 # retains the role in the binding.
1491 #
1492 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
1493 # unique identifier) representing a service account that has been recently
1494 # deleted. For example,
1495 # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
1496 # If the service account is undeleted, this value reverts to
1497 # `serviceAccount:{emailid}` and the undeleted service account retains the
1498 # role in the binding.
1499 #
1500 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
1501 # identifier) representing a Google group that has been recently
1502 # deleted. For example, `admins@example.com?uid=123456789012345678901`. If
1503 # the group is recovered, this value reverts to `group:{emailid}` and the
1504 # recovered group retains the role in the binding.
1505 #
1506 #
1507 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
1508 # users of that domain. For example, `google.com` or `example.com`.
1509 #
1510 &quot;A String&quot;,
1511 ],
Bu Sun Kim65020912020-05-20 12:08:20 -07001512 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to `members`.
Dan O'Mearadd494642020-05-01 07:42:23 -07001513 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
Bu Sun Kim65020912020-05-20 12:08:20 -07001514 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
1515 # NOTE: An unsatisfied condition will not allow user access via current
1516 # binding. Different bindings, including their conditions, are examined
1517 # independently.
1518 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
1519 # are documented at https://github.com/google/cel-spec.
1520 #
1521 # Example (Comparison):
1522 #
1523 # title: &quot;Summary size limit&quot;
1524 # description: &quot;Determines if a summary is less than 100 chars&quot;
1525 # expression: &quot;document.summary.size() &lt; 100&quot;
1526 #
1527 # Example (Equality):
1528 #
1529 # title: &quot;Requestor is owner&quot;
1530 # description: &quot;Determines if requestor is the document owner&quot;
1531 # expression: &quot;document.owner == request.auth.claims.email&quot;
1532 #
1533 # Example (Logic):
1534 #
1535 # title: &quot;Public documents&quot;
1536 # description: &quot;Determine whether the document should be publicly visible&quot;
1537 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
1538 #
1539 # Example (Data Manipulation):
1540 #
1541 # title: &quot;Notification string&quot;
1542 # description: &quot;Create a notification string with a timestamp.&quot;
1543 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
1544 #
1545 # The exact variables and functions that may be referenced within an expression
1546 # are determined by the service that evaluates it. See the service
1547 # documentation for additional information.
1548 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
1549 # its purpose. This can be used e.g. in UIs which allow to enter the
1550 # expression.
1551 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
1552 # reporting, e.g. a file name and a position in the file.
1553 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
1554 # describes the expression, e.g. when hovered over it in a UI.
1555 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
1556 # syntax.
1557 },
Dan O'Mearadd494642020-05-01 07:42:23 -07001558 },
1559 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001560 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help
1561 # prevent simultaneous updates of a policy from overwriting each other.
1562 # It is strongly suggested that systems make use of the `etag` in the
1563 # read-modify-write cycle to perform policy updates in order to avoid race
1564 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
1565 # systems are expected to put that etag in the request to `setIamPolicy` to
1566 # ensure that their change will be applied to the same version of the policy.
1567 #
1568 # **Important:** If you use IAM Conditions, you must include the `etag` field
1569 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
1570 # you to overwrite a version `3` policy with a version `1` policy, and all of
1571 # the conditions in the version `3` policy are lost.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001572 }</pre>
1573</div>
1574
1575<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -07001576 <code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001577 <pre>Returns permissions that a caller has on the specified resource.
1578If the resource does not exist, this will return an empty set of
1579permissions, not a NOT_FOUND error.
1580
1581Note: This operation is designed to be used for building permission-aware
1582UIs and command-line tools, not for authorization checking. This operation
Bu Sun Kim65020912020-05-20 12:08:20 -07001583may &quot;fail open&quot; without warning.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001584
1585Args:
1586 resource: string, REQUIRED: The resource for which the policy detail is being requested.
1587See the operation documentation for the appropriate value for this field. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -07001588 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001589 The object takes the form of:
1590
1591{ # Request message for `TestIamPermissions` method.
Bu Sun Kim65020912020-05-20 12:08:20 -07001592 &quot;permissions&quot;: [ # The set of permissions to check for the `resource`. Permissions with
1593 # wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed. For more
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001594 # information see
1595 # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
Bu Sun Kim65020912020-05-20 12:08:20 -07001596 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001597 ],
1598 }
1599
1600 x__xgafv: string, V1 error format.
1601 Allowed values
1602 1 - v1 error format
1603 2 - v2 error format
1604
1605Returns:
1606 An object of the form:
1607
1608 { # Response message for `TestIamPermissions` method.
Bu Sun Kim65020912020-05-20 12:08:20 -07001609 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001610 # allowed.
Bu Sun Kim65020912020-05-20 12:08:20 -07001611 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001612 ],
1613 }</pre>
1614</div>
1615
1616<div class="method">
1617 <code class="details" id="upgrade">upgrade(name, body=None, x__xgafv=None)</code>
1618 <pre>Upgrade a single Data Fusion instance.
1619At the end of an operation instance is fully upgraded.
1620
1621Args:
1622 name: string, Name of the Data Fusion instance which need to be upgraded in the form of
1623projects/{project}/locations/{location}/instances/{instance}
1624Instance will be upgraded with the latest stable version of the Data
1625Fusion. (required)
1626 body: object, The request body.
1627 The object takes the form of:
1628
1629{ # Request message for upgrading a Data Fusion instance.
1630 # To change the instance properties, instance update should be used.
1631 }
1632
1633 x__xgafv: string, V1 error format.
1634 Allowed values
1635 1 - v1 error format
1636 2 - v2 error format
1637
1638Returns:
1639 An object of the form:
1640
1641 { # This resource represents a long-running operation that is the result of a
1642 # network API call.
Bu Sun Kim65020912020-05-20 12:08:20 -07001643 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001644 # method returns no data on success, such as `Delete`, the response is
1645 # `google.protobuf.Empty`. If the original method is standard
1646 # `Get`/`Create`/`Update`, the response should be the resource. For other
1647 # methods, the response should have the type `XxxResponse`, where `Xxx`
1648 # is the original method name. For example, if the original method name
1649 # is `TakeSnapshot()`, the inferred response type is
1650 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -07001651 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001652 },
Bu Sun Kim65020912020-05-20 12:08:20 -07001653 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001654 # originally returns it. If you use the default HTTP mapping, the
1655 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim65020912020-05-20 12:08:20 -07001656 &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.
1657 # different programming environments, including REST APIs and RPC APIs. It is
1658 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1659 # three pieces of data: error code, error message, and error details.
1660 #
1661 # You can find out more about this error model and how to work with it in the
1662 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001663 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
1664 # user-facing error message should be localized and sent in the
1665 # google.rpc.Status.details field, or localized by the client.
Bu Sun Kim65020912020-05-20 12:08:20 -07001666 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
1667 # message types for APIs to use.
1668 {
1669 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1670 },
1671 ],
1672 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim65020912020-05-20 12:08:20 -07001673 },
1674 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
Dan O'Mearadd494642020-05-01 07:42:23 -07001675 # contains progress information and common metadata such as create time.
1676 # Some services might not provide such metadata. Any method that returns a
1677 # long-running operation should document the metadata type, if any.
Bu Sun Kim65020912020-05-20 12:08:20 -07001678 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Dan O'Mearadd494642020-05-01 07:42:23 -07001679 },
Bu Sun Kim65020912020-05-20 12:08:20 -07001680 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
1681 # If `true`, the operation is completed, and either `error` or `response` is
1682 # available.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001683 }</pre>
1684</div>
1685
1686</body></html>