Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / datafusion_v1beta1.projects.locations.instances.html
blob: e6d418ff71a8ba9d010ebac1f9d2f6377d291d55 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="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 -0700[diff] [blame^]78 <code><a href="#create">create(parent, body=None, instanceId=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]79<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 -0700[diff] [blame^]87 <code><a href="#getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]88<p class="firstline">Gets the access control policy for a resource.</p>
89<p class="toc_element">
90 <code><a href="#list">list(parent, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None, filter=None)</a></code></p>
91<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 -0700[diff] [blame^]96 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]97<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 -0700[diff] [blame^]102 <code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]103<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 -0700[diff] [blame^]105 <code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]106<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 -0700[diff] [blame^]112 <code class="details" id="create">create(parent, body=None, instanceId=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]113 <pre>Creates a new Data Fusion instance in the specified project and location.
114
115Args:
116 parent: string, The instance's project and location in the format
117projects/{project}/locations/{location}. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]118 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]119 The object takes the form of:
120
121{ # Represents a Data Fusion instance.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]122 # Next available ID: 23
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]123 "updateTime": "A String", # Output only. The time the instance was last updated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]124 "privateInstance": True or False, # Specifies whether the Data Fusion instance should be private. If set to
125 # true, all Data Fusion nodes will have private IP addresses and will not be
126 # able to access the public internet.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]127 "labels": { # The resource labels for instance to use to annotate any related underlying
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]128 # resources such as Compute Engine VMs. The character '=' is not allowed to
129 # be used within the labels.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]130 "a_key": "A String",
131 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]132 "apiEndpoint": "A String", # Output only. Endpoint on which the REST APIs is accessible.
133 "accelerators": [ # List of accelerators enabled for this CDF instance.
134 { # Identifies Data Fusion accelerators for an instance.
135 "acceleratorType": "A String", # The type of an accelator for a CDF instance.
136 },
137 ],
138 "gcsBucket": "A String", # Output only. Cloud Storage bucket generated by Data Fusion in the customer project.
139 "zone": "A String", # Name of the zone in which the Data Fusion instance will be created.
140 "serviceAccount": "A String", # Output only. Service account which will be used to access resources in
141 # the customer project."
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]142 "networkConfig": { # Network configuration for a Data Fusion instance. These configurations # Network configuration options. These are required when a private Data
143 # Fusion instance is to be created.
144 # are used for peering with the customer network. Configurations are optional
145 # when a public Data Fusion instance is to be created. However, providing
146 # these configurations allows several benefits, such as reduced network latency
147 # while accessing the customer resources from managed Data Fusion instance
148 # nodes, as well as access to the customer on-prem resources.
149 "network": "A String", # Name of the network in the customer project with which the Tenant Project
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]150 # will be peered for executing pipelines. In case of shared VPC where the
151 # network resides in another host project the network should specified in
152 # the form of projects/{host-project-id}/global/networks/{network}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]153 "ipAllocation": "A String", # The IP range in CIDR notation to use for the managed Data Fusion instance
154 # nodes. This range must not overlap with any other ranges used in the Data
155 # Fusion instance network.
156 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]157 "createTime": "A String", # Output only. The time the instance was created.
158 "state": "A String", # Output only. The current state of this Data Fusion instance.
159 "version": "A String", # Current version of Data Fusion.
160 "type": "A String", # Required. Instance type.
161 "description": "A String", # Optional. An optional description of this instance.
162 "enableStackdriverLogging": True or False, # Option to enable Stackdriver Logging.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]163 "stateMessage": "A String", # Output only. Additional information about the current state of this Data
164 # Fusion instance if available.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]165 "serviceEndpoint": "A String", # Output only. Endpoint on which the Data Fusion UI is accessible.
166 "displayName": "A String", # Display name for an instance.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]167 "name": "A String", # Output only. The name of this instance is in the form of
168 # projects/{project}/locations/{location}/instances/{instance}.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]169 "availableVersion": [ # Available versions that the instance can be upgraded to using
170 # UpdateInstanceRequest.
171 { # The Data Fusion version.
172 "versionNumber": "A String", # The version number of the Data Fusion instance, such as '6.0.1.0'.
173 },
174 ],
175 "enableStackdriverMonitoring": True or False, # Option to enable Stackdriver Monitoring.
176 "options": { # Map of additional options used to configure the behavior of
177 # Data Fusion instance.
178 "a_key": "A String",
179 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]180}
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 Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]193 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
194 # different programming environments, including REST APIs and RPC APIs. It is
195 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
196 # three pieces of data: error code, error message, and error details.
197 #
198 # You can find out more about this error model and how to work with it in the
199 # [API Design Guide](https://cloud.google.com/apis/design/errors).
200 "message": "A String", # A developer-facing error message, which should be in English. Any
201 # user-facing error message should be localized and sent in the
202 # google.rpc.Status.details field, or localized by the client.
203 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
204 "details": [ # A list of messages that carry the error details. There is a common set of
205 # message types for APIs to use.
206 {
207 "a_key": "", # Properties of the object. Contains field @type with type URL.
208 },
209 ],
210 },
211 "done": True or False, # If the value is `false`, it means the operation is still in progress.
212 # If `true`, the operation is completed, and either `error` or `response` is
213 # available.
214 "response": { # The normal response of the operation in case of success. If the original
215 # method returns no data on success, such as `Delete`, the response is
216 # `google.protobuf.Empty`. If the original method is standard
217 # `Get`/`Create`/`Update`, the response should be the resource. For other
218 # methods, the response should have the type `XxxResponse`, where `Xxx`
219 # is the original method name. For example, if the original method name
220 # is `TakeSnapshot()`, the inferred response type is
221 # `TakeSnapshotResponse`.
222 "a_key": "", # Properties of the object. Contains field @type with type URL.
223 },
224 "name": "A String", # The server-assigned name, which is only unique within the same service that
225 # originally returns it. If you use the default HTTP mapping, the
226 # `name` should be a resource name ending with `operations/{unique_id}`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]227 "metadata": { # Service-specific metadata associated with the operation. It typically
228 # contains progress information and common metadata such as create time.
229 # Some services might not provide such metadata. Any method that returns a
230 # long-running operation should document the metadata type, if any.
231 "a_key": "", # Properties of the object. Contains field @type with type URL.
232 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]233 }</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 Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]253 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
254 # different programming environments, including REST APIs and RPC APIs. It is
255 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
256 # three pieces of data: error code, error message, and error details.
257 #
258 # You can find out more about this error model and how to work with it in the
259 # [API Design Guide](https://cloud.google.com/apis/design/errors).
260 "message": "A String", # A developer-facing error message, which should be in English. Any
261 # user-facing error message should be localized and sent in the
262 # google.rpc.Status.details field, or localized by the client.
263 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
264 "details": [ # A list of messages that carry the error details. There is a common set of
265 # message types for APIs to use.
266 {
267 "a_key": "", # Properties of the object. Contains field @type with type URL.
268 },
269 ],
270 },
271 "done": True or False, # If the value is `false`, it means the operation is still in progress.
272 # If `true`, the operation is completed, and either `error` or `response` is
273 # available.
274 "response": { # The normal response of the operation in case of success. If the original
275 # method returns no data on success, such as `Delete`, the response is
276 # `google.protobuf.Empty`. If the original method is standard
277 # `Get`/`Create`/`Update`, the response should be the resource. For other
278 # methods, the response should have the type `XxxResponse`, where `Xxx`
279 # is the original method name. For example, if the original method name
280 # is `TakeSnapshot()`, the inferred response type is
281 # `TakeSnapshotResponse`.
282 "a_key": "", # Properties of the object. Contains field @type with type URL.
283 },
284 "name": "A String", # The server-assigned name, which is only unique within the same service that
285 # originally returns it. If you use the default HTTP mapping, the
286 # `name` should be a resource name ending with `operations/{unique_id}`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]287 "metadata": { # Service-specific metadata associated with the operation. It typically
288 # contains progress information and common metadata such as create time.
289 # Some services might not provide such metadata. Any method that returns a
290 # long-running operation should document the metadata type, if any.
291 "a_key": "", # Properties of the object. Contains field @type with type URL.
292 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]293 }</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 -0700[diff] [blame^]312 # Next available ID: 23
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]313 "updateTime": "A String", # Output only. The time the instance was last updated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]314 "privateInstance": True or False, # Specifies whether the Data Fusion instance should be private. If set to
315 # true, all Data Fusion nodes will have private IP addresses and will not be
316 # able to access the public internet.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]317 "labels": { # The resource labels for instance to use to annotate any related underlying
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]318 # resources such as Compute Engine VMs. The character '=' is not allowed to
319 # be used within the labels.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]320 "a_key": "A String",
321 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]322 "apiEndpoint": "A String", # Output only. Endpoint on which the REST APIs is accessible.
323 "accelerators": [ # List of accelerators enabled for this CDF instance.
324 { # Identifies Data Fusion accelerators for an instance.
325 "acceleratorType": "A String", # The type of an accelator for a CDF instance.
326 },
327 ],
328 "gcsBucket": "A String", # Output only. Cloud Storage bucket generated by Data Fusion in the customer project.
329 "zone": "A String", # Name of the zone in which the Data Fusion instance will be created.
330 "serviceAccount": "A String", # Output only. Service account which will be used to access resources in
331 # the customer project."
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]332 "networkConfig": { # Network configuration for a Data Fusion instance. These configurations # Network configuration options. These are required when a private Data
333 # Fusion instance is to be created.
334 # are used for peering with the customer network. Configurations are optional
335 # when a public Data Fusion instance is to be created. However, providing
336 # these configurations allows several benefits, such as reduced network latency
337 # while accessing the customer resources from managed Data Fusion instance
338 # nodes, as well as access to the customer on-prem resources.
339 "network": "A String", # Name of the network in the customer project with which the Tenant Project
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]340 # will be peered for executing pipelines. In case of shared VPC where the
341 # network resides in another host project the network should specified in
342 # the form of projects/{host-project-id}/global/networks/{network}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]343 "ipAllocation": "A String", # The IP range in CIDR notation to use for the managed Data Fusion instance
344 # nodes. This range must not overlap with any other ranges used in the Data
345 # Fusion instance network.
346 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]347 "createTime": "A String", # Output only. The time the instance was created.
348 "state": "A String", # Output only. The current state of this Data Fusion instance.
349 "version": "A String", # Current version of Data Fusion.
350 "type": "A String", # Required. Instance type.
351 "description": "A String", # Optional. An optional description of this instance.
352 "enableStackdriverLogging": True or False, # Option to enable Stackdriver Logging.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]353 "stateMessage": "A String", # Output only. Additional information about the current state of this Data
354 # Fusion instance if available.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]355 "serviceEndpoint": "A String", # Output only. Endpoint on which the Data Fusion UI is accessible.
356 "displayName": "A String", # Display name for an instance.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]357 "name": "A String", # Output only. The name of this instance is in the form of
358 # projects/{project}/locations/{location}/instances/{instance}.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]359 "availableVersion": [ # Available versions that the instance can be upgraded to using
360 # UpdateInstanceRequest.
361 { # The Data Fusion version.
362 "versionNumber": "A String", # The version number of the Data Fusion instance, such as '6.0.1.0'.
363 },
364 ],
365 "enableStackdriverMonitoring": True or False, # Option to enable Stackdriver Monitoring.
366 "options": { # Map of additional options used to configure the behavior of
367 # Data Fusion instance.
368 "a_key": "A String",
369 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]370 }</pre>
371</div>
372
373<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]374 <code class="details" id="getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]375 <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 -0700[diff] [blame^]382 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 -0700[diff] [blame]390 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 -0700[diff] [blame^]398 { # An Identity and Access Management (IAM) policy, which specifies access
399 # controls for Google Cloud resources.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]400 #
401 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]402 # 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 -0700[diff] [blame]407 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]408 # 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 -0700[diff] [blame]414 #
415 # {
416 # "bindings": [
417 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]418 # "role": "roles/resourcemanager.organizationAdmin",
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]419 # "members": [
420 # "user:mike@example.com",
421 # "group:admins@example.com",
422 # "domain:google.com",
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]423 # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]424 # ]
425 # },
426 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]427 # "role": "roles/resourcemanager.organizationViewer",
428 # "members": ["user:eve@example.com"],
429 # "condition": {
430 # "title": "expirable access",
431 # "description": "Does not grant access after Sep 2020",
432 # "expression": "request.time &lt; timestamp('2020-10-01T00:00:00.000Z')",
433 # }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]434 # }
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]435 # ],
436 # "etag": "BwWWja0YfJA=",
437 # "version": 3
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]438 # }
439 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]440 # **YAML example:**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]441 #
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 -0700[diff] [blame^]447 # - serviceAccount:my-project-id@appspot.gserviceaccount.com
448 # role: roles/resourcemanager.organizationAdmin
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]449 # - members:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]450 # - user:eve@example.com
451 # role: roles/resourcemanager.organizationViewer
452 # condition:
453 # title: expirable access
454 # description: Does not grant access after Sep 2020
455 # expression: request.time &lt; timestamp('2020-10-01T00:00:00.000Z')
456 # - etag: BwWWja0YfJA=
457 # - version: 3
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]458 #
459 # For a description of IAM and its features, see the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]460 # [IAM documentation](https://cloud.google.com/iam/docs/).
461 "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
462 # `condition` that determines how and when the `bindings` are applied. Each
463 # of the `bindings` must contain at least one member.
464 { # Associates `members` with a `role`.
465 "role": "A String", # Role that is assigned to `members`.
466 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
467 "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
468 # `members` can have the following values:
469 #
470 # * `allUsers`: A special identifier that represents anyone who is
471 # on the internet; with or without a Google account.
472 #
473 # * `allAuthenticatedUsers`: A special identifier that represents anyone
474 # who is authenticated with a Google account or a service account.
475 #
476 # * `user:{emailid}`: An email address that represents a specific Google
477 # account. For example, `alice@example.com` .
478 #
479 #
480 # * `serviceAccount:{emailid}`: An email address that represents a service
481 # account. For example, `my-other-app@appspot.gserviceaccount.com`.
482 #
483 # * `group:{emailid}`: An email address that represents a Google group.
484 # For example, `admins@example.com`.
485 #
486 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
487 # identifier) representing a user that has been recently deleted. For
488 # example, `alice@example.com?uid=123456789012345678901`. If the user is
489 # recovered, this value reverts to `user:{emailid}` and the recovered user
490 # retains the role in the binding.
491 #
492 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
493 # unique identifier) representing a service account that has been recently
494 # deleted. For example,
495 # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
496 # If the service account is undeleted, this value reverts to
497 # `serviceAccount:{emailid}` and the undeleted service account retains the
498 # role in the binding.
499 #
500 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
501 # identifier) representing a Google group that has been recently
502 # deleted. For example, `admins@example.com?uid=123456789012345678901`. If
503 # the group is recovered, this value reverts to `group:{emailid}` and the
504 # recovered group retains the role in the binding.
505 #
506 #
507 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
508 # users of that domain. For example, `google.com` or `example.com`.
509 #
510 "A String",
511 ],
512 "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
513 # NOTE: An unsatisfied condition will not allow user access via current
514 # binding. Different bindings, including their conditions, are examined
515 # independently.
516 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
517 # are documented at https://github.com/google/cel-spec.
518 #
519 # Example (Comparison):
520 #
521 # title: "Summary size limit"
522 # description: "Determines if a summary is less than 100 chars"
523 # expression: "document.summary.size() &lt; 100"
524 #
525 # Example (Equality):
526 #
527 # title: "Requestor is owner"
528 # description: "Determines if requestor is the document owner"
529 # expression: "document.owner == request.auth.claims.email"
530 #
531 # Example (Logic):
532 #
533 # title: "Public documents"
534 # description: "Determine whether the document should be publicly visible"
535 # expression: "document.type != 'private' &amp;&amp; document.type != 'internal'"
536 #
537 # Example (Data Manipulation):
538 #
539 # title: "Notification string"
540 # description: "Create a notification string with a timestamp."
541 # expression: "'New message received at ' + string(document.create_time)"
542 #
543 # The exact variables and functions that may be referenced within an expression
544 # are determined by the service that evaluates it. See the service
545 # documentation for additional information.
546 "description": "A String", # Optional. Description of the expression. This is a longer text which
547 # describes the expression, e.g. when hovered over it in a UI.
548 "expression": "A String", # Textual representation of an expression in Common Expression Language
549 # syntax.
550 "location": "A String", # Optional. String indicating the location of the expression for error
551 # reporting, e.g. a file name and a position in the file.
552 "title": "A String", # Optional. Title for the expression, i.e. a short string describing
553 # its purpose. This can be used e.g. in UIs which allow to enter the
554 # expression.
555 },
556 },
557 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]558 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
559 { # Specifies the audit configuration for a service.
560 # The configuration determines which permission types are logged, and what
561 # identities, if any, are exempted from logging.
562 # An AuditConfig must have one or more AuditLogConfigs.
563 #
564 # If there are AuditConfigs for both `allServices` and a specific service,
565 # the union of the two AuditConfigs is used for that service: the log_types
566 # specified in each AuditConfig are enabled, and the exempted_members in each
567 # AuditLogConfig are exempted.
568 #
569 # Example Policy with multiple AuditConfigs:
570 #
571 # {
572 # "audit_configs": [
573 # {
574 # "service": "allServices"
575 # "audit_log_configs": [
576 # {
577 # "log_type": "DATA_READ",
578 # "exempted_members": [
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]579 # "user:jose@example.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]580 # ]
581 # },
582 # {
583 # "log_type": "DATA_WRITE",
584 # },
585 # {
586 # "log_type": "ADMIN_READ",
587 # }
588 # ]
589 # },
590 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]591 # "service": "sampleservice.googleapis.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]592 # "audit_log_configs": [
593 # {
594 # "log_type": "DATA_READ",
595 # },
596 # {
597 # "log_type": "DATA_WRITE",
598 # "exempted_members": [
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]599 # "user:aliya@example.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]600 # ]
601 # }
602 # ]
603 # }
604 # ]
605 # }
606 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]607 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
608 # logging. It also exempts jose@example.com from DATA_READ logging, and
609 # aliya@example.com from DATA_WRITE logging.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]610 "auditLogConfigs": [ # The configuration for logging of each type of permission.
611 { # Provides the configuration for logging a type of permissions.
612 # Example:
613 #
614 # {
615 # "audit_log_configs": [
616 # {
617 # "log_type": "DATA_READ",
618 # "exempted_members": [
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]619 # "user:jose@example.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]620 # ]
621 # },
622 # {
623 # "log_type": "DATA_WRITE",
624 # }
625 # ]
626 # }
627 #
628 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]629 # jose@example.com from DATA_READ logging.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]630 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
631 # permission.
632 # Follows the same format of Binding.members.
633 "A String",
634 ],
635 "logType": "A String", # The log type that this config enables.
636 },
637 ],
638 "service": "A String", # Specifies a service that will be enabled for audit logging.
639 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
640 # `allServices` is a special value that covers all services.
641 },
642 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]643 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
644 # prevent simultaneous updates of a policy from overwriting each other.
645 # It is strongly suggested that systems make use of the `etag` in the
646 # read-modify-write cycle to perform policy updates in order to avoid race
647 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
648 # systems are expected to put that etag in the request to `setIamPolicy` to
649 # ensure that their change will be applied to the same version of the policy.
650 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]651 # **Important:** If you use IAM Conditions, you must include the `etag` field
652 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
653 # you to overwrite a version `3` policy with a version `1` policy, and all of
654 # the conditions in the version `3` policy are lost.
655 "version": 42, # Specifies the format of the policy.
656 #
657 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
658 # are rejected.
659 #
660 # Any operation that affects conditional role bindings must specify version
661 # `3`. This requirement applies to the following operations:
662 #
663 # * Getting a policy that includes a conditional role binding
664 # * Adding a conditional role binding to a policy
665 # * Changing a conditional role binding in a policy
666 # * Removing any role binding, with or without a condition, from a policy
667 # that includes conditions
668 #
669 # **Important:** If you use IAM Conditions, you must include the `etag` field
670 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
671 # you to overwrite a version `3` policy with a version `1` policy, and all of
672 # the conditions in the version `3` policy are lost.
673 #
674 # If a policy does not include any conditions, operations on that policy may
675 # specify any valid version or leave the field unset.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]676 }</pre>
677</div>
678
679<div class="method">
680 <code class="details" id="list">list(parent, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None, filter=None)</code>
681 <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
686specified as '-' (wildcard), then all regions available to the project
687are queried, and the results are aggregated. (required)
688 orderBy: string, Sort results. Supported values are "name", "name desc", or "" (unsorted).
689 pageSize: integer, The maximum number of items to return.
690 pageToken: string, The next_page_token value to use if there are additional
691results to retrieve for this list request.
692 x__xgafv: string, V1 error format.
693 Allowed values
694 1 - v1 error format
695 2 - v2 error format
696 filter: string, List filter.
697
698Returns:
699 An object of the form:
700
701 { # Response message for the list instance request.
702 "nextPageToken": "A String", # Token to retrieve the next page of results or empty if there are no more
703 # results in the list.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]704 "instances": [ # Represents a list of Data Fusion instances.
705 { # Represents a Data Fusion instance.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]706 # Next available ID: 23
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]707 "updateTime": "A String", # Output only. The time the instance was last updated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]708 "privateInstance": True or False, # Specifies whether the Data Fusion instance should be private. If set to
709 # true, all Data Fusion nodes will have private IP addresses and will not be
710 # able to access the public internet.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]711 "labels": { # The resource labels for instance to use to annotate any related underlying
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]712 # resources such as Compute Engine VMs. The character '=' is not allowed to
713 # be used within the labels.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]714 "a_key": "A String",
715 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]716 "apiEndpoint": "A String", # Output only. Endpoint on which the REST APIs is accessible.
717 "accelerators": [ # List of accelerators enabled for this CDF instance.
718 { # Identifies Data Fusion accelerators for an instance.
719 "acceleratorType": "A String", # The type of an accelator for a CDF instance.
720 },
721 ],
722 "gcsBucket": "A String", # Output only. Cloud Storage bucket generated by Data Fusion in the customer project.
723 "zone": "A String", # Name of the zone in which the Data Fusion instance will be created.
724 "serviceAccount": "A String", # Output only. Service account which will be used to access resources in
725 # the customer project."
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]726 "networkConfig": { # Network configuration for a Data Fusion instance. These configurations # Network configuration options. These are required when a private Data
727 # Fusion instance is to be created.
728 # are used for peering with the customer network. Configurations are optional
729 # when a public Data Fusion instance is to be created. However, providing
730 # these configurations allows several benefits, such as reduced network latency
731 # while accessing the customer resources from managed Data Fusion instance
732 # nodes, as well as access to the customer on-prem resources.
733 "network": "A String", # Name of the network in the customer project with which the Tenant Project
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]734 # will be peered for executing pipelines. In case of shared VPC where the
735 # network resides in another host project the network should specified in
736 # the form of projects/{host-project-id}/global/networks/{network}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]737 "ipAllocation": "A String", # The IP range in CIDR notation to use for the managed Data Fusion instance
738 # nodes. This range must not overlap with any other ranges used in the Data
739 # Fusion instance network.
740 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]741 "createTime": "A String", # Output only. The time the instance was created.
742 "state": "A String", # Output only. The current state of this Data Fusion instance.
743 "version": "A String", # Current version of Data Fusion.
744 "type": "A String", # Required. Instance type.
745 "description": "A String", # Optional. An optional description of this instance.
746 "enableStackdriverLogging": True or False, # Option to enable Stackdriver Logging.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]747 "stateMessage": "A String", # Output only. Additional information about the current state of this Data
748 # Fusion instance if available.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]749 "serviceEndpoint": "A String", # Output only. Endpoint on which the Data Fusion UI is accessible.
750 "displayName": "A String", # Display name for an instance.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]751 "name": "A String", # Output only. The name of this instance is in the form of
752 # projects/{project}/locations/{location}/instances/{instance}.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]753 "availableVersion": [ # Available versions that the instance can be upgraded to using
754 # UpdateInstanceRequest.
755 { # The Data Fusion version.
756 "versionNumber": "A String", # The version number of the Data Fusion instance, such as '6.0.1.0'.
757 },
758 ],
759 "enableStackdriverMonitoring": True or False, # Option to enable Stackdriver Monitoring.
760 "options": { # Map of additional options used to configure the behavior of
761 # Data Fusion instance.
762 "a_key": "A String",
763 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]764 },
765 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]766 "unreachable": [ # Locations that could not be reached.
767 "A String",
768 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]769 }</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:
781 A request object that you can call 'execute()' on to request the next
782 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 -0700[diff] [blame^]787 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]788 <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 -0700[diff] [blame^]793 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]794 The object takes the form of:
795
796{ # Represents a Data Fusion instance.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]797 # Next available ID: 23
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]798 "updateTime": "A String", # Output only. The time the instance was last updated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]799 "privateInstance": True or False, # Specifies whether the Data Fusion instance should be private. If set to
800 # true, all Data Fusion nodes will have private IP addresses and will not be
801 # able to access the public internet.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]802 "labels": { # The resource labels for instance to use to annotate any related underlying
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]803 # resources such as Compute Engine VMs. The character '=' is not allowed to
804 # be used within the labels.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]805 "a_key": "A String",
806 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]807 "apiEndpoint": "A String", # Output only. Endpoint on which the REST APIs is accessible.
808 "accelerators": [ # List of accelerators enabled for this CDF instance.
809 { # Identifies Data Fusion accelerators for an instance.
810 "acceleratorType": "A String", # The type of an accelator for a CDF instance.
811 },
812 ],
813 "gcsBucket": "A String", # Output only. Cloud Storage bucket generated by Data Fusion in the customer project.
814 "zone": "A String", # Name of the zone in which the Data Fusion instance will be created.
815 "serviceAccount": "A String", # Output only. Service account which will be used to access resources in
816 # the customer project."
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]817 "networkConfig": { # Network configuration for a Data Fusion instance. These configurations # Network configuration options. These are required when a private Data
818 # Fusion instance is to be created.
819 # are used for peering with the customer network. Configurations are optional
820 # when a public Data Fusion instance is to be created. However, providing
821 # these configurations allows several benefits, such as reduced network latency
822 # while accessing the customer resources from managed Data Fusion instance
823 # nodes, as well as access to the customer on-prem resources.
824 "network": "A String", # Name of the network in the customer project with which the Tenant Project
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]825 # will be peered for executing pipelines. In case of shared VPC where the
826 # network resides in another host project the network should specified in
827 # the form of projects/{host-project-id}/global/networks/{network}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]828 "ipAllocation": "A String", # The IP range in CIDR notation to use for the managed Data Fusion instance
829 # nodes. This range must not overlap with any other ranges used in the Data
830 # Fusion instance network.
831 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]832 "createTime": "A String", # Output only. The time the instance was created.
833 "state": "A String", # Output only. The current state of this Data Fusion instance.
834 "version": "A String", # Current version of Data Fusion.
835 "type": "A String", # Required. Instance type.
836 "description": "A String", # Optional. An optional description of this instance.
837 "enableStackdriverLogging": True or False, # Option to enable Stackdriver Logging.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]838 "stateMessage": "A String", # Output only. Additional information about the current state of this Data
839 # Fusion instance if available.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]840 "serviceEndpoint": "A String", # Output only. Endpoint on which the Data Fusion UI is accessible.
841 "displayName": "A String", # Display name for an instance.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]842 "name": "A String", # Output only. The name of this instance is in the form of
843 # projects/{project}/locations/{location}/instances/{instance}.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]844 "availableVersion": [ # Available versions that the instance can be upgraded to using
845 # UpdateInstanceRequest.
846 { # The Data Fusion version.
847 "versionNumber": "A String", # The version number of the Data Fusion instance, such as '6.0.1.0'.
848 },
849 ],
850 "enableStackdriverMonitoring": True or False, # Option to enable Stackdriver Monitoring.
851 "options": { # Map of additional options used to configure the behavior of
852 # Data Fusion instance.
853 "a_key": "A String",
854 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]855}
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 Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]873 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
874 # different programming environments, including REST APIs and RPC APIs. It is
875 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
876 # three pieces of data: error code, error message, and error details.
877 #
878 # You can find out more about this error model and how to work with it in the
879 # [API Design Guide](https://cloud.google.com/apis/design/errors).
880 "message": "A String", # A developer-facing error message, which should be in English. Any
881 # user-facing error message should be localized and sent in the
882 # google.rpc.Status.details field, or localized by the client.
883 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
884 "details": [ # A list of messages that carry the error details. There is a common set of
885 # message types for APIs to use.
886 {
887 "a_key": "", # Properties of the object. Contains field @type with type URL.
888 },
889 ],
890 },
891 "done": True or False, # If the value is `false`, it means the operation is still in progress.
892 # If `true`, the operation is completed, and either `error` or `response` is
893 # available.
894 "response": { # The normal response of the operation in case of success. If the original
895 # method returns no data on success, such as `Delete`, the response is
896 # `google.protobuf.Empty`. If the original method is standard
897 # `Get`/`Create`/`Update`, the response should be the resource. For other
898 # methods, the response should have the type `XxxResponse`, where `Xxx`
899 # is the original method name. For example, if the original method name
900 # is `TakeSnapshot()`, the inferred response type is
901 # `TakeSnapshotResponse`.
902 "a_key": "", # Properties of the object. Contains field @type with type URL.
903 },
904 "name": "A String", # The server-assigned name, which is only unique within the same service that
905 # originally returns it. If you use the default HTTP mapping, the
906 # `name` should be a resource name ending with `operations/{unique_id}`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]907 "metadata": { # Service-specific metadata associated with the operation. It typically
908 # contains progress information and common metadata such as create time.
909 # Some services might not provide such metadata. Any method that returns a
910 # long-running operation should document the metadata type, if any.
911 "a_key": "", # Properties of the object. Contains field @type with type URL.
912 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]913 }</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 Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]940 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
941 # different programming environments, including REST APIs and RPC APIs. It is
942 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
943 # three pieces of data: error code, error message, and error details.
944 #
945 # You can find out more about this error model and how to work with it in the
946 # [API Design Guide](https://cloud.google.com/apis/design/errors).
947 "message": "A String", # A developer-facing error message, which should be in English. Any
948 # user-facing error message should be localized and sent in the
949 # google.rpc.Status.details field, or localized by the client.
950 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
951 "details": [ # A list of messages that carry the error details. There is a common set of
952 # message types for APIs to use.
953 {
954 "a_key": "", # Properties of the object. Contains field @type with type URL.
955 },
956 ],
957 },
958 "done": True or False, # If the value is `false`, it means the operation is still in progress.
959 # If `true`, the operation is completed, and either `error` or `response` is
960 # available.
961 "response": { # The normal response of the operation in case of success. If the original
962 # method returns no data on success, such as `Delete`, the response is
963 # `google.protobuf.Empty`. If the original method is standard
964 # `Get`/`Create`/`Update`, the response should be the resource. For other
965 # methods, the response should have the type `XxxResponse`, where `Xxx`
966 # is the original method name. For example, if the original method name
967 # is `TakeSnapshot()`, the inferred response type is
968 # `TakeSnapshotResponse`.
969 "a_key": "", # Properties of the object. Contains field @type with type URL.
970 },
971 "name": "A String", # The server-assigned name, which is only unique within the same service that
972 # originally returns it. If you use the default HTTP mapping, the
973 # `name` should be a resource name ending with `operations/{unique_id}`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]974 "metadata": { # Service-specific metadata associated with the operation. It typically
975 # contains progress information and common metadata such as create time.
976 # Some services might not provide such metadata. Any method that returns a
977 # long-running operation should document the metadata type, if any.
978 "a_key": "", # Properties of the object. Contains field @type with type URL.
979 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]980 }</pre>
981</div>
982
983<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]984 <code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]985 <pre>Sets the access control policy on the specified resource. Replaces any
986existing policy.
987
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]988Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED
989
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]990Args:
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 -0700[diff] [blame^]993 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]994 The object takes the form of:
995
996{ # Request message for `SetIamPolicy` method.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]997 "policy": { # 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 -0700[diff] [blame]998 # 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 -0700[diff] [blame^]1001 # controls for Google Cloud resources.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1002 #
1003 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1004 # 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 -0700[diff] [blame]1009 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1010 # 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 -0700[diff] [blame]1016 #
1017 # {
1018 # "bindings": [
1019 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1020 # "role": "roles/resourcemanager.organizationAdmin",
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1021 # "members": [
1022 # "user:mike@example.com",
1023 # "group:admins@example.com",
1024 # "domain:google.com",
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1025 # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1026 # ]
1027 # },
1028 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1029 # "role": "roles/resourcemanager.organizationViewer",
1030 # "members": ["user:eve@example.com"],
1031 # "condition": {
1032 # "title": "expirable access",
1033 # "description": "Does not grant access after Sep 2020",
1034 # "expression": "request.time &lt; timestamp('2020-10-01T00:00:00.000Z')",
1035 # }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1036 # }
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1037 # ],
1038 # "etag": "BwWWja0YfJA=",
1039 # "version": 3
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1040 # }
1041 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1042 # **YAML example:**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1043 #
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 -0700[diff] [blame^]1049 # - serviceAccount:my-project-id@appspot.gserviceaccount.com
1050 # role: roles/resourcemanager.organizationAdmin
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1051 # - members:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1052 # - user:eve@example.com
1053 # role: roles/resourcemanager.organizationViewer
1054 # condition:
1055 # title: expirable access
1056 # description: Does not grant access after Sep 2020
1057 # expression: request.time &lt; timestamp('2020-10-01T00:00:00.000Z')
1058 # - etag: BwWWja0YfJA=
1059 # - version: 3
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1060 #
1061 # For a description of IAM and its features, see the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1062 # [IAM documentation](https://cloud.google.com/iam/docs/).
1063 "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
1064 # `condition` that determines how and when the `bindings` are applied. Each
1065 # of the `bindings` must contain at least one member.
1066 { # Associates `members` with a `role`.
1067 "role": "A String", # Role that is assigned to `members`.
1068 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
1069 "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
1070 # `members` can have the following values:
1071 #
1072 # * `allUsers`: A special identifier that represents anyone who is
1073 # on the internet; with or without a Google account.
1074 #
1075 # * `allAuthenticatedUsers`: A special identifier that represents anyone
1076 # who is authenticated with a Google account or a service account.
1077 #
1078 # * `user:{emailid}`: An email address that represents a specific Google
1079 # account. For example, `alice@example.com` .
1080 #
1081 #
1082 # * `serviceAccount:{emailid}`: An email address that represents a service
1083 # account. For example, `my-other-app@appspot.gserviceaccount.com`.
1084 #
1085 # * `group:{emailid}`: An email address that represents a Google group.
1086 # For example, `admins@example.com`.
1087 #
1088 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
1089 # identifier) representing a user that has been recently deleted. For
1090 # example, `alice@example.com?uid=123456789012345678901`. If the user is
1091 # recovered, this value reverts to `user:{emailid}` and the recovered user
1092 # retains the role in the binding.
1093 #
1094 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
1095 # unique identifier) representing a service account that has been recently
1096 # deleted. For example,
1097 # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
1098 # If the service account is undeleted, this value reverts to
1099 # `serviceAccount:{emailid}` and the undeleted service account retains the
1100 # role in the binding.
1101 #
1102 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
1103 # identifier) representing a Google group that has been recently
1104 # deleted. For example, `admins@example.com?uid=123456789012345678901`. If
1105 # the group is recovered, this value reverts to `group:{emailid}` and the
1106 # recovered group retains the role in the binding.
1107 #
1108 #
1109 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
1110 # users of that domain. For example, `google.com` or `example.com`.
1111 #
1112 "A String",
1113 ],
1114 "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
1115 # NOTE: An unsatisfied condition will not allow user access via current
1116 # binding. Different bindings, including their conditions, are examined
1117 # independently.
1118 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
1119 # are documented at https://github.com/google/cel-spec.
1120 #
1121 # Example (Comparison):
1122 #
1123 # title: "Summary size limit"
1124 # description: "Determines if a summary is less than 100 chars"
1125 # expression: "document.summary.size() &lt; 100"
1126 #
1127 # Example (Equality):
1128 #
1129 # title: "Requestor is owner"
1130 # description: "Determines if requestor is the document owner"
1131 # expression: "document.owner == request.auth.claims.email"
1132 #
1133 # Example (Logic):
1134 #
1135 # title: "Public documents"
1136 # description: "Determine whether the document should be publicly visible"
1137 # expression: "document.type != 'private' &amp;&amp; document.type != 'internal'"
1138 #
1139 # Example (Data Manipulation):
1140 #
1141 # title: "Notification string"
1142 # description: "Create a notification string with a timestamp."
1143 # expression: "'New message received at ' + string(document.create_time)"
1144 #
1145 # The exact variables and functions that may be referenced within an expression
1146 # are determined by the service that evaluates it. See the service
1147 # documentation for additional information.
1148 "description": "A String", # Optional. Description of the expression. This is a longer text which
1149 # describes the expression, e.g. when hovered over it in a UI.
1150 "expression": "A String", # Textual representation of an expression in Common Expression Language
1151 # syntax.
1152 "location": "A String", # Optional. String indicating the location of the expression for error
1153 # reporting, e.g. a file name and a position in the file.
1154 "title": "A String", # Optional. Title for the expression, i.e. a short string describing
1155 # its purpose. This can be used e.g. in UIs which allow to enter the
1156 # expression.
1157 },
1158 },
1159 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1160 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
1161 { # Specifies the audit configuration for a service.
1162 # The configuration determines which permission types are logged, and what
1163 # identities, if any, are exempted from logging.
1164 # An AuditConfig must have one or more AuditLogConfigs.
1165 #
1166 # If there are AuditConfigs for both `allServices` and a specific service,
1167 # the union of the two AuditConfigs is used for that service: the log_types
1168 # specified in each AuditConfig are enabled, and the exempted_members in each
1169 # AuditLogConfig are exempted.
1170 #
1171 # Example Policy with multiple AuditConfigs:
1172 #
1173 # {
1174 # "audit_configs": [
1175 # {
1176 # "service": "allServices"
1177 # "audit_log_configs": [
1178 # {
1179 # "log_type": "DATA_READ",
1180 # "exempted_members": [
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1181 # "user:jose@example.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1182 # ]
1183 # },
1184 # {
1185 # "log_type": "DATA_WRITE",
1186 # },
1187 # {
1188 # "log_type": "ADMIN_READ",
1189 # }
1190 # ]
1191 # },
1192 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1193 # "service": "sampleservice.googleapis.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1194 # "audit_log_configs": [
1195 # {
1196 # "log_type": "DATA_READ",
1197 # },
1198 # {
1199 # "log_type": "DATA_WRITE",
1200 # "exempted_members": [
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1201 # "user:aliya@example.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1202 # ]
1203 # }
1204 # ]
1205 # }
1206 # ]
1207 # }
1208 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1209 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
1210 # logging. It also exempts jose@example.com from DATA_READ logging, and
1211 # aliya@example.com from DATA_WRITE logging.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1212 "auditLogConfigs": [ # The configuration for logging of each type of permission.
1213 { # Provides the configuration for logging a type of permissions.
1214 # Example:
1215 #
1216 # {
1217 # "audit_log_configs": [
1218 # {
1219 # "log_type": "DATA_READ",
1220 # "exempted_members": [
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1221 # "user:jose@example.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1222 # ]
1223 # },
1224 # {
1225 # "log_type": "DATA_WRITE",
1226 # }
1227 # ]
1228 # }
1229 #
1230 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1231 # jose@example.com from DATA_READ logging.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1232 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
1233 # permission.
1234 # Follows the same format of Binding.members.
1235 "A String",
1236 ],
1237 "logType": "A String", # The log type that this config enables.
1238 },
1239 ],
1240 "service": "A String", # Specifies a service that will be enabled for audit logging.
1241 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
1242 # `allServices` is a special value that covers all services.
1243 },
1244 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1245 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
1246 # prevent simultaneous updates of a policy from overwriting each other.
1247 # It is strongly suggested that systems make use of the `etag` in the
1248 # read-modify-write cycle to perform policy updates in order to avoid race
1249 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
1250 # systems are expected to put that etag in the request to `setIamPolicy` to
1251 # ensure that their change will be applied to the same version of the policy.
1252 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1253 # **Important:** If you use IAM Conditions, you must include the `etag` field
1254 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
1255 # you to overwrite a version `3` policy with a version `1` policy, and all of
1256 # the conditions in the version `3` policy are lost.
1257 "version": 42, # Specifies the format of the policy.
1258 #
1259 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
1260 # are rejected.
1261 #
1262 # Any operation that affects conditional role bindings must specify version
1263 # `3`. This requirement applies to the following operations:
1264 #
1265 # * Getting a policy that includes a conditional role binding
1266 # * Adding a conditional role binding to a policy
1267 # * Changing a conditional role binding in a policy
1268 # * Removing any role binding, with or without a condition, from a policy
1269 # that includes conditions
1270 #
1271 # **Important:** If you use IAM Conditions, you must include the `etag` field
1272 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
1273 # you to overwrite a version `3` policy with a version `1` policy, and all of
1274 # the conditions in the version `3` policy are lost.
1275 #
1276 # If a policy does not include any conditions, operations on that policy may
1277 # specify any valid version or leave the field unset.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1278 },
1279 "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
1280 # the fields in the mask will be modified. If no mask is provided, the
1281 # following default mask is used:
1282 # paths: "bindings, etag"
1283 # 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 -0700[diff] [blame^]1294 { # An Identity and Access Management (IAM) policy, which specifies access
1295 # controls for Google Cloud resources.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1296 #
1297 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1298 # 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 -0700[diff] [blame]1303 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1304 # 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 -0700[diff] [blame]1310 #
1311 # {
1312 # "bindings": [
1313 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1314 # "role": "roles/resourcemanager.organizationAdmin",
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1315 # "members": [
1316 # "user:mike@example.com",
1317 # "group:admins@example.com",
1318 # "domain:google.com",
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1319 # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1320 # ]
1321 # },
1322 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1323 # "role": "roles/resourcemanager.organizationViewer",
1324 # "members": ["user:eve@example.com"],
1325 # "condition": {
1326 # "title": "expirable access",
1327 # "description": "Does not grant access after Sep 2020",
1328 # "expression": "request.time &lt; timestamp('2020-10-01T00:00:00.000Z')",
1329 # }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1330 # }
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1331 # ],
1332 # "etag": "BwWWja0YfJA=",
1333 # "version": 3
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1334 # }
1335 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1336 # **YAML example:**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1337 #
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 -0700[diff] [blame^]1343 # - serviceAccount:my-project-id@appspot.gserviceaccount.com
1344 # role: roles/resourcemanager.organizationAdmin
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1345 # - members:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1346 # - user:eve@example.com
1347 # role: roles/resourcemanager.organizationViewer
1348 # condition:
1349 # title: expirable access
1350 # description: Does not grant access after Sep 2020
1351 # expression: request.time &lt; timestamp('2020-10-01T00:00:00.000Z')
1352 # - etag: BwWWja0YfJA=
1353 # - version: 3
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1354 #
1355 # For a description of IAM and its features, see the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1356 # [IAM documentation](https://cloud.google.com/iam/docs/).
1357 "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
1358 # `condition` that determines how and when the `bindings` are applied. Each
1359 # of the `bindings` must contain at least one member.
1360 { # Associates `members` with a `role`.
1361 "role": "A String", # Role that is assigned to `members`.
1362 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
1363 "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
1364 # `members` can have the following values:
1365 #
1366 # * `allUsers`: A special identifier that represents anyone who is
1367 # on the internet; with or without a Google account.
1368 #
1369 # * `allAuthenticatedUsers`: A special identifier that represents anyone
1370 # who is authenticated with a Google account or a service account.
1371 #
1372 # * `user:{emailid}`: An email address that represents a specific Google
1373 # account. For example, `alice@example.com` .
1374 #
1375 #
1376 # * `serviceAccount:{emailid}`: An email address that represents a service
1377 # account. For example, `my-other-app@appspot.gserviceaccount.com`.
1378 #
1379 # * `group:{emailid}`: An email address that represents a Google group.
1380 # For example, `admins@example.com`.
1381 #
1382 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
1383 # identifier) representing a user that has been recently deleted. For
1384 # example, `alice@example.com?uid=123456789012345678901`. If the user is
1385 # recovered, this value reverts to `user:{emailid}` and the recovered user
1386 # retains the role in the binding.
1387 #
1388 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
1389 # unique identifier) representing a service account that has been recently
1390 # deleted. For example,
1391 # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
1392 # If the service account is undeleted, this value reverts to
1393 # `serviceAccount:{emailid}` and the undeleted service account retains the
1394 # role in the binding.
1395 #
1396 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
1397 # identifier) representing a Google group that has been recently
1398 # deleted. For example, `admins@example.com?uid=123456789012345678901`. If
1399 # the group is recovered, this value reverts to `group:{emailid}` and the
1400 # recovered group retains the role in the binding.
1401 #
1402 #
1403 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
1404 # users of that domain. For example, `google.com` or `example.com`.
1405 #
1406 "A String",
1407 ],
1408 "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
1409 # NOTE: An unsatisfied condition will not allow user access via current
1410 # binding. Different bindings, including their conditions, are examined
1411 # independently.
1412 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
1413 # are documented at https://github.com/google/cel-spec.
1414 #
1415 # Example (Comparison):
1416 #
1417 # title: "Summary size limit"
1418 # description: "Determines if a summary is less than 100 chars"
1419 # expression: "document.summary.size() &lt; 100"
1420 #
1421 # Example (Equality):
1422 #
1423 # title: "Requestor is owner"
1424 # description: "Determines if requestor is the document owner"
1425 # expression: "document.owner == request.auth.claims.email"
1426 #
1427 # Example (Logic):
1428 #
1429 # title: "Public documents"
1430 # description: "Determine whether the document should be publicly visible"
1431 # expression: "document.type != 'private' &amp;&amp; document.type != 'internal'"
1432 #
1433 # Example (Data Manipulation):
1434 #
1435 # title: "Notification string"
1436 # description: "Create a notification string with a timestamp."
1437 # expression: "'New message received at ' + string(document.create_time)"
1438 #
1439 # The exact variables and functions that may be referenced within an expression
1440 # are determined by the service that evaluates it. See the service
1441 # documentation for additional information.
1442 "description": "A String", # Optional. Description of the expression. This is a longer text which
1443 # describes the expression, e.g. when hovered over it in a UI.
1444 "expression": "A String", # Textual representation of an expression in Common Expression Language
1445 # syntax.
1446 "location": "A String", # Optional. String indicating the location of the expression for error
1447 # reporting, e.g. a file name and a position in the file.
1448 "title": "A String", # Optional. Title for the expression, i.e. a short string describing
1449 # its purpose. This can be used e.g. in UIs which allow to enter the
1450 # expression.
1451 },
1452 },
1453 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1454 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
1455 { # Specifies the audit configuration for a service.
1456 # The configuration determines which permission types are logged, and what
1457 # identities, if any, are exempted from logging.
1458 # An AuditConfig must have one or more AuditLogConfigs.
1459 #
1460 # If there are AuditConfigs for both `allServices` and a specific service,
1461 # the union of the two AuditConfigs is used for that service: the log_types
1462 # specified in each AuditConfig are enabled, and the exempted_members in each
1463 # AuditLogConfig are exempted.
1464 #
1465 # Example Policy with multiple AuditConfigs:
1466 #
1467 # {
1468 # "audit_configs": [
1469 # {
1470 # "service": "allServices"
1471 # "audit_log_configs": [
1472 # {
1473 # "log_type": "DATA_READ",
1474 # "exempted_members": [
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1475 # "user:jose@example.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1476 # ]
1477 # },
1478 # {
1479 # "log_type": "DATA_WRITE",
1480 # },
1481 # {
1482 # "log_type": "ADMIN_READ",
1483 # }
1484 # ]
1485 # },
1486 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1487 # "service": "sampleservice.googleapis.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1488 # "audit_log_configs": [
1489 # {
1490 # "log_type": "DATA_READ",
1491 # },
1492 # {
1493 # "log_type": "DATA_WRITE",
1494 # "exempted_members": [
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1495 # "user:aliya@example.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1496 # ]
1497 # }
1498 # ]
1499 # }
1500 # ]
1501 # }
1502 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1503 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
1504 # logging. It also exempts jose@example.com from DATA_READ logging, and
1505 # aliya@example.com from DATA_WRITE logging.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1506 "auditLogConfigs": [ # The configuration for logging of each type of permission.
1507 { # Provides the configuration for logging a type of permissions.
1508 # Example:
1509 #
1510 # {
1511 # "audit_log_configs": [
1512 # {
1513 # "log_type": "DATA_READ",
1514 # "exempted_members": [
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1515 # "user:jose@example.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1516 # ]
1517 # },
1518 # {
1519 # "log_type": "DATA_WRITE",
1520 # }
1521 # ]
1522 # }
1523 #
1524 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1525 # jose@example.com from DATA_READ logging.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1526 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
1527 # permission.
1528 # Follows the same format of Binding.members.
1529 "A String",
1530 ],
1531 "logType": "A String", # The log type that this config enables.
1532 },
1533 ],
1534 "service": "A String", # Specifies a service that will be enabled for audit logging.
1535 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
1536 # `allServices` is a special value that covers all services.
1537 },
1538 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1539 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
1540 # prevent simultaneous updates of a policy from overwriting each other.
1541 # It is strongly suggested that systems make use of the `etag` in the
1542 # read-modify-write cycle to perform policy updates in order to avoid race
1543 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
1544 # systems are expected to put that etag in the request to `setIamPolicy` to
1545 # ensure that their change will be applied to the same version of the policy.
1546 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1547 # **Important:** If you use IAM Conditions, you must include the `etag` field
1548 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
1549 # you to overwrite a version `3` policy with a version `1` policy, and all of
1550 # the conditions in the version `3` policy are lost.
1551 "version": 42, # Specifies the format of the policy.
1552 #
1553 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
1554 # are rejected.
1555 #
1556 # Any operation that affects conditional role bindings must specify version
1557 # `3`. This requirement applies to the following operations:
1558 #
1559 # * Getting a policy that includes a conditional role binding
1560 # * Adding a conditional role binding to a policy
1561 # * Changing a conditional role binding in a policy
1562 # * Removing any role binding, with or without a condition, from a policy
1563 # that includes conditions
1564 #
1565 # **Important:** If you use IAM Conditions, you must include the `etag` field
1566 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
1567 # you to overwrite a version `3` policy with a version `1` policy, and all of
1568 # the conditions in the version `3` policy are lost.
1569 #
1570 # If a policy does not include any conditions, operations on that policy may
1571 # specify any valid version or leave the field unset.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1572 }</pre>
1573</div>
1574
1575<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1576 <code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1577 <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
1583may "fail open" without warning.
1584
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 -0700[diff] [blame^]1588 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1589 The object takes the form of:
1590
1591{ # Request message for `TestIamPermissions` method.
1592 "permissions": [ # The set of permissions to check for the `resource`. Permissions with
1593 # wildcards (such as '*' or 'storage.*') are not allowed. For more
1594 # information see
1595 # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
1596 "A String",
1597 ],
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.
1609 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
1610 # allowed.
1611 "A String",
1612 ],
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 Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1643 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
1644 # different programming environments, including REST APIs and RPC APIs. It is
1645 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
1646 # three pieces of data: error code, error message, and error details.
1647 #
1648 # You can find out more about this error model and how to work with it in the
1649 # [API Design Guide](https://cloud.google.com/apis/design/errors).
1650 "message": "A String", # A developer-facing error message, which should be in English. Any
1651 # user-facing error message should be localized and sent in the
1652 # google.rpc.Status.details field, or localized by the client.
1653 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
1654 "details": [ # A list of messages that carry the error details. There is a common set of
1655 # message types for APIs to use.
1656 {
1657 "a_key": "", # Properties of the object. Contains field @type with type URL.
1658 },
1659 ],
1660 },
1661 "done": True or False, # If the value is `false`, it means the operation is still in progress.
1662 # If `true`, the operation is completed, and either `error` or `response` is
1663 # available.
1664 "response": { # The normal response of the operation in case of success. If the original
1665 # method returns no data on success, such as `Delete`, the response is
1666 # `google.protobuf.Empty`. If the original method is standard
1667 # `Get`/`Create`/`Update`, the response should be the resource. For other
1668 # methods, the response should have the type `XxxResponse`, where `Xxx`
1669 # is the original method name. For example, if the original method name
1670 # is `TakeSnapshot()`, the inferred response type is
1671 # `TakeSnapshotResponse`.
1672 "a_key": "", # Properties of the object. Contains field @type with type URL.
1673 },
1674 "name": "A String", # The server-assigned name, which is only unique within the same service that
1675 # originally returns it. If you use the default HTTP mapping, the
1676 # `name` should be a resource name ending with `operations/{unique_id}`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1677 "metadata": { # Service-specific metadata associated with the operation. It typically
1678 # contains progress information and common metadata such as create time.
1679 # Some services might not provide such metadata. Any method that returns a
1680 # long-running operation should document the metadata type, if any.
1681 "a_key": "", # Properties of the object. Contains field @type with type URL.
1682 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1683 }</pre>
1684</div>
1685
1686</body></html>