File: remotebuildexecution_v1alpha.projects.instances.html

package info (click to toggle)
python-googleapi 2.182.0-1
  • links: PTS
  • area: main
  • in suites: forky, sid
  • size: 533,852 kB
  • sloc: python: 11,076; javascript: 249; sh: 114; makefile: 59
file content (490 lines) | stat: -rw-r--r-- 36,387 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="remotebuildexecution_v1alpha.html">Remote Build Execution API</a> . <a href="remotebuildexecution_v1alpha.projects.html">projects</a> . <a href="remotebuildexecution_v1alpha.projects.instances.html">instances</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="remotebuildexecution_v1alpha.projects.instances.workerpools.html">workerpools()</a></code>
</p>
<p class="firstline">Returns the workerpools Resource.</p>

<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new instance in the specified region. Returns a long running operation which contains an instance on completion. While the long running operation is in progress, any call to `GetInstance` returns an instance in state `CREATING`.</p>
<p class="toc_element">
  <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes the specified instance. Returns a long running operation which contains a `google.protobuf.Empty` response on completion. Deleting an instance with worker pools in it will delete these worker pools.</p>
<p class="toc_element">
  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Returns the specified instance.</p>
<p class="toc_element">
  <code><a href="#list">list(parent, x__xgafv=None)</a></code></p>
<p class="firstline">Lists instances in a project.</p>
<p class="toc_element">
  <code><a href="#patch">patch(name, body=None, loggingEnabled=None, name1=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the specified instance. Returns a long running operation which contains the updated instance in the response on completion.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
  <pre>Creates a new instance in the specified region. Returns a long running operation which contains an instance on completion. While the long running operation is in progress, any call to `GetInstance` returns an instance in state `CREATING`.

Args:
  parent: string, Resource name of the project containing the instance. Format: `projects/[PROJECT_ID]`. (required)
  body: object, The request body.
    The object takes the form of:

{ # The request used for `CreateInstance`.
  &quot;instance&quot;: { # Instance conceptually encapsulates all Remote Build Execution resources for remote builds. An instance consists of storage and compute resources (for example, `ContentAddressableStorage`, `ActionCache`, `WorkerPools`) used for running remote builds. All Remote Build Execution API calls are scoped to an instance. # Specifies the instance to create. The name in the instance, if specified in the instance, is ignored.
    &quot;featurePolicy&quot;: { # FeaturePolicy defines features allowed to be used on RBE instances, as well as instance-wide behavior changes that take effect without opt-in or opt-out at usage time. # The policy to define whether or not RBE features can be used or how they can be used.
      &quot;containerImageSources&quot;: { # Defines whether a feature can be used or what values are accepted. # Which container image sources are allowed. Currently only RBE-supported registry (gcr.io) is allowed. One can allow all repositories under a project or one specific repository only. E.g. container_image_sources { policy: RESTRICTED allowed_values: [ &quot;gcr.io/project-foo&quot;, &quot;gcr.io/project-bar/repo-baz&quot;, ] } will allow any repositories under &quot;gcr.io/project-foo&quot; plus the repository &quot;gcr.io/project-bar/repo-baz&quot;. Default (UNSPECIFIED) is equivalent to any source is allowed.
        &quot;allowedValues&quot;: [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.
          &quot;A String&quot;,
        ],
        &quot;policy&quot;: &quot;A String&quot;, # The policy of the feature.
      },
      &quot;dockerAddCapabilities&quot;: { # Defines whether a feature can be used or what values are accepted. # Whether dockerAddCapabilities can be used or what capabilities are allowed.
        &quot;allowedValues&quot;: [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.
          &quot;A String&quot;,
        ],
        &quot;policy&quot;: &quot;A String&quot;, # The policy of the feature.
      },
      &quot;dockerChrootPath&quot;: { # Defines whether a feature can be used or what values are accepted. # Whether dockerChrootPath can be used.
        &quot;allowedValues&quot;: [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.
          &quot;A String&quot;,
        ],
        &quot;policy&quot;: &quot;A String&quot;, # The policy of the feature.
      },
      &quot;dockerNetwork&quot;: { # Defines whether a feature can be used or what values are accepted. # Whether dockerNetwork can be used or what network modes are allowed. E.g. one may allow `off` value only via `allowed_values`.
        &quot;allowedValues&quot;: [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.
          &quot;A String&quot;,
        ],
        &quot;policy&quot;: &quot;A String&quot;, # The policy of the feature.
      },
      &quot;dockerPrivileged&quot;: { # Defines whether a feature can be used or what values are accepted. # Whether dockerPrivileged can be used.
        &quot;allowedValues&quot;: [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.
          &quot;A String&quot;,
        ],
        &quot;policy&quot;: &quot;A String&quot;, # The policy of the feature.
      },
      &quot;dockerRunAsRoot&quot;: { # Defines whether a feature can be used or what values are accepted. # Whether dockerRunAsRoot can be used.
        &quot;allowedValues&quot;: [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.
          &quot;A String&quot;,
        ],
        &quot;policy&quot;: &quot;A String&quot;, # The policy of the feature.
      },
      &quot;dockerRuntime&quot;: { # Defines whether a feature can be used or what values are accepted. # Whether dockerRuntime is allowed to be set or what runtimes are allowed. Note linux_isolation takes precedence, and if set, docker_runtime values may be rejected if they are incompatible with the selected isolation.
        &quot;allowedValues&quot;: [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.
          &quot;A String&quot;,
        ],
        &quot;policy&quot;: &quot;A String&quot;, # The policy of the feature.
      },
      &quot;dockerSiblingContainers&quot;: { # Defines whether a feature can be used or what values are accepted. # Whether dockerSiblingContainers can be used.
        &quot;allowedValues&quot;: [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.
          &quot;A String&quot;,
        ],
        &quot;policy&quot;: &quot;A String&quot;, # The policy of the feature.
      },
      &quot;linuxIsolation&quot;: &quot;A String&quot;, # linux_isolation allows overriding the docker runtime used for containers started on Linux.
    },
    &quot;location&quot;: &quot;A String&quot;, # The location is a GCP region. Currently only `us-central1` is supported.
    &quot;loggingEnabled&quot;: True or False, # Output only. Whether stack driver logging is enabled for the instance.
    &quot;name&quot;: &quot;A String&quot;, # Output only. Instance resource name formatted as: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. Name should not be populated when creating an instance since it is provided in the `instance_id` field.
    &quot;state&quot;: &quot;A String&quot;, # Output only. State of the instance.
  },
  &quot;instanceId&quot;: &quot;A String&quot;, # ID of the created instance. A valid `instance_id` must: be 6-50 characters long, contain only lowercase letters, digits, hyphens and underscores, start with a lowercase letter, and end with a lowercase letter or a digit.
  &quot;parent&quot;: &quot;A String&quot;, # Resource name of the project containing the instance. Format: `projects/[PROJECT_ID]`.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  &quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="delete">delete(name, x__xgafv=None)</code>
  <pre>Deletes the specified instance. Returns a long running operation which contains a `google.protobuf.Empty` response on completion. Deleting an instance with worker pools in it will delete these worker pools.

Args:
  name: string, Name of the instance to delete. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  &quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="get">get(name, x__xgafv=None)</code>
  <pre>Returns the specified instance.

Args:
  name: string, Name of the instance to retrieve. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Instance conceptually encapsulates all Remote Build Execution resources for remote builds. An instance consists of storage and compute resources (for example, `ContentAddressableStorage`, `ActionCache`, `WorkerPools`) used for running remote builds. All Remote Build Execution API calls are scoped to an instance.
  &quot;featurePolicy&quot;: { # FeaturePolicy defines features allowed to be used on RBE instances, as well as instance-wide behavior changes that take effect without opt-in or opt-out at usage time. # The policy to define whether or not RBE features can be used or how they can be used.
    &quot;containerImageSources&quot;: { # Defines whether a feature can be used or what values are accepted. # Which container image sources are allowed. Currently only RBE-supported registry (gcr.io) is allowed. One can allow all repositories under a project or one specific repository only. E.g. container_image_sources { policy: RESTRICTED allowed_values: [ &quot;gcr.io/project-foo&quot;, &quot;gcr.io/project-bar/repo-baz&quot;, ] } will allow any repositories under &quot;gcr.io/project-foo&quot; plus the repository &quot;gcr.io/project-bar/repo-baz&quot;. Default (UNSPECIFIED) is equivalent to any source is allowed.
      &quot;allowedValues&quot;: [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.
        &quot;A String&quot;,
      ],
      &quot;policy&quot;: &quot;A String&quot;, # The policy of the feature.
    },
    &quot;dockerAddCapabilities&quot;: { # Defines whether a feature can be used or what values are accepted. # Whether dockerAddCapabilities can be used or what capabilities are allowed.
      &quot;allowedValues&quot;: [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.
        &quot;A String&quot;,
      ],
      &quot;policy&quot;: &quot;A String&quot;, # The policy of the feature.
    },
    &quot;dockerChrootPath&quot;: { # Defines whether a feature can be used or what values are accepted. # Whether dockerChrootPath can be used.
      &quot;allowedValues&quot;: [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.
        &quot;A String&quot;,
      ],
      &quot;policy&quot;: &quot;A String&quot;, # The policy of the feature.
    },
    &quot;dockerNetwork&quot;: { # Defines whether a feature can be used or what values are accepted. # Whether dockerNetwork can be used or what network modes are allowed. E.g. one may allow `off` value only via `allowed_values`.
      &quot;allowedValues&quot;: [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.
        &quot;A String&quot;,
      ],
      &quot;policy&quot;: &quot;A String&quot;, # The policy of the feature.
    },
    &quot;dockerPrivileged&quot;: { # Defines whether a feature can be used or what values are accepted. # Whether dockerPrivileged can be used.
      &quot;allowedValues&quot;: [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.
        &quot;A String&quot;,
      ],
      &quot;policy&quot;: &quot;A String&quot;, # The policy of the feature.
    },
    &quot;dockerRunAsRoot&quot;: { # Defines whether a feature can be used or what values are accepted. # Whether dockerRunAsRoot can be used.
      &quot;allowedValues&quot;: [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.
        &quot;A String&quot;,
      ],
      &quot;policy&quot;: &quot;A String&quot;, # The policy of the feature.
    },
    &quot;dockerRuntime&quot;: { # Defines whether a feature can be used or what values are accepted. # Whether dockerRuntime is allowed to be set or what runtimes are allowed. Note linux_isolation takes precedence, and if set, docker_runtime values may be rejected if they are incompatible with the selected isolation.
      &quot;allowedValues&quot;: [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.
        &quot;A String&quot;,
      ],
      &quot;policy&quot;: &quot;A String&quot;, # The policy of the feature.
    },
    &quot;dockerSiblingContainers&quot;: { # Defines whether a feature can be used or what values are accepted. # Whether dockerSiblingContainers can be used.
      &quot;allowedValues&quot;: [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.
        &quot;A String&quot;,
      ],
      &quot;policy&quot;: &quot;A String&quot;, # The policy of the feature.
    },
    &quot;linuxIsolation&quot;: &quot;A String&quot;, # linux_isolation allows overriding the docker runtime used for containers started on Linux.
  },
  &quot;location&quot;: &quot;A String&quot;, # The location is a GCP region. Currently only `us-central1` is supported.
  &quot;loggingEnabled&quot;: True or False, # Output only. Whether stack driver logging is enabled for the instance.
  &quot;name&quot;: &quot;A String&quot;, # Output only. Instance resource name formatted as: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. Name should not be populated when creating an instance since it is provided in the `instance_id` field.
  &quot;state&quot;: &quot;A String&quot;, # Output only. State of the instance.
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(parent, x__xgafv=None)</code>
  <pre>Lists instances in a project.

Args:
  parent: string, Resource name of the project. Format: `projects/[PROJECT_ID]`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  &quot;instances&quot;: [ # The list of instances in a given project.
    { # Instance conceptually encapsulates all Remote Build Execution resources for remote builds. An instance consists of storage and compute resources (for example, `ContentAddressableStorage`, `ActionCache`, `WorkerPools`) used for running remote builds. All Remote Build Execution API calls are scoped to an instance.
      &quot;featurePolicy&quot;: { # FeaturePolicy defines features allowed to be used on RBE instances, as well as instance-wide behavior changes that take effect without opt-in or opt-out at usage time. # The policy to define whether or not RBE features can be used or how they can be used.
        &quot;containerImageSources&quot;: { # Defines whether a feature can be used or what values are accepted. # Which container image sources are allowed. Currently only RBE-supported registry (gcr.io) is allowed. One can allow all repositories under a project or one specific repository only. E.g. container_image_sources { policy: RESTRICTED allowed_values: [ &quot;gcr.io/project-foo&quot;, &quot;gcr.io/project-bar/repo-baz&quot;, ] } will allow any repositories under &quot;gcr.io/project-foo&quot; plus the repository &quot;gcr.io/project-bar/repo-baz&quot;. Default (UNSPECIFIED) is equivalent to any source is allowed.
          &quot;allowedValues&quot;: [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.
            &quot;A String&quot;,
          ],
          &quot;policy&quot;: &quot;A String&quot;, # The policy of the feature.
        },
        &quot;dockerAddCapabilities&quot;: { # Defines whether a feature can be used or what values are accepted. # Whether dockerAddCapabilities can be used or what capabilities are allowed.
          &quot;allowedValues&quot;: [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.
            &quot;A String&quot;,
          ],
          &quot;policy&quot;: &quot;A String&quot;, # The policy of the feature.
        },
        &quot;dockerChrootPath&quot;: { # Defines whether a feature can be used or what values are accepted. # Whether dockerChrootPath can be used.
          &quot;allowedValues&quot;: [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.
            &quot;A String&quot;,
          ],
          &quot;policy&quot;: &quot;A String&quot;, # The policy of the feature.
        },
        &quot;dockerNetwork&quot;: { # Defines whether a feature can be used or what values are accepted. # Whether dockerNetwork can be used or what network modes are allowed. E.g. one may allow `off` value only via `allowed_values`.
          &quot;allowedValues&quot;: [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.
            &quot;A String&quot;,
          ],
          &quot;policy&quot;: &quot;A String&quot;, # The policy of the feature.
        },
        &quot;dockerPrivileged&quot;: { # Defines whether a feature can be used or what values are accepted. # Whether dockerPrivileged can be used.
          &quot;allowedValues&quot;: [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.
            &quot;A String&quot;,
          ],
          &quot;policy&quot;: &quot;A String&quot;, # The policy of the feature.
        },
        &quot;dockerRunAsRoot&quot;: { # Defines whether a feature can be used or what values are accepted. # Whether dockerRunAsRoot can be used.
          &quot;allowedValues&quot;: [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.
            &quot;A String&quot;,
          ],
          &quot;policy&quot;: &quot;A String&quot;, # The policy of the feature.
        },
        &quot;dockerRuntime&quot;: { # Defines whether a feature can be used or what values are accepted. # Whether dockerRuntime is allowed to be set or what runtimes are allowed. Note linux_isolation takes precedence, and if set, docker_runtime values may be rejected if they are incompatible with the selected isolation.
          &quot;allowedValues&quot;: [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.
            &quot;A String&quot;,
          ],
          &quot;policy&quot;: &quot;A String&quot;, # The policy of the feature.
        },
        &quot;dockerSiblingContainers&quot;: { # Defines whether a feature can be used or what values are accepted. # Whether dockerSiblingContainers can be used.
          &quot;allowedValues&quot;: [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.
            &quot;A String&quot;,
          ],
          &quot;policy&quot;: &quot;A String&quot;, # The policy of the feature.
        },
        &quot;linuxIsolation&quot;: &quot;A String&quot;, # linux_isolation allows overriding the docker runtime used for containers started on Linux.
      },
      &quot;location&quot;: &quot;A String&quot;, # The location is a GCP region. Currently only `us-central1` is supported.
      &quot;loggingEnabled&quot;: True or False, # Output only. Whether stack driver logging is enabled for the instance.
      &quot;name&quot;: &quot;A String&quot;, # Output only. Instance resource name formatted as: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. Name should not be populated when creating an instance since it is provided in the `instance_id` field.
      &quot;state&quot;: &quot;A String&quot;, # Output only. State of the instance.
    },
  ],
}</pre>
</div>

<div class="method">
    <code class="details" id="patch">patch(name, body=None, loggingEnabled=None, name1=None, updateMask=None, x__xgafv=None)</code>
  <pre>Updates the specified instance. Returns a long running operation which contains the updated instance in the response on completion.

Args:
  name: string, Output only. Instance resource name formatted as: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. Name should not be populated when creating an instance since it is provided in the `instance_id` field. (required)
  body: object, The request body.
    The object takes the form of:

{ # Instance conceptually encapsulates all Remote Build Execution resources for remote builds. An instance consists of storage and compute resources (for example, `ContentAddressableStorage`, `ActionCache`, `WorkerPools`) used for running remote builds. All Remote Build Execution API calls are scoped to an instance.
  &quot;featurePolicy&quot;: { # FeaturePolicy defines features allowed to be used on RBE instances, as well as instance-wide behavior changes that take effect without opt-in or opt-out at usage time. # The policy to define whether or not RBE features can be used or how they can be used.
    &quot;containerImageSources&quot;: { # Defines whether a feature can be used or what values are accepted. # Which container image sources are allowed. Currently only RBE-supported registry (gcr.io) is allowed. One can allow all repositories under a project or one specific repository only. E.g. container_image_sources { policy: RESTRICTED allowed_values: [ &quot;gcr.io/project-foo&quot;, &quot;gcr.io/project-bar/repo-baz&quot;, ] } will allow any repositories under &quot;gcr.io/project-foo&quot; plus the repository &quot;gcr.io/project-bar/repo-baz&quot;. Default (UNSPECIFIED) is equivalent to any source is allowed.
      &quot;allowedValues&quot;: [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.
        &quot;A String&quot;,
      ],
      &quot;policy&quot;: &quot;A String&quot;, # The policy of the feature.
    },
    &quot;dockerAddCapabilities&quot;: { # Defines whether a feature can be used or what values are accepted. # Whether dockerAddCapabilities can be used or what capabilities are allowed.
      &quot;allowedValues&quot;: [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.
        &quot;A String&quot;,
      ],
      &quot;policy&quot;: &quot;A String&quot;, # The policy of the feature.
    },
    &quot;dockerChrootPath&quot;: { # Defines whether a feature can be used or what values are accepted. # Whether dockerChrootPath can be used.
      &quot;allowedValues&quot;: [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.
        &quot;A String&quot;,
      ],
      &quot;policy&quot;: &quot;A String&quot;, # The policy of the feature.
    },
    &quot;dockerNetwork&quot;: { # Defines whether a feature can be used or what values are accepted. # Whether dockerNetwork can be used or what network modes are allowed. E.g. one may allow `off` value only via `allowed_values`.
      &quot;allowedValues&quot;: [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.
        &quot;A String&quot;,
      ],
      &quot;policy&quot;: &quot;A String&quot;, # The policy of the feature.
    },
    &quot;dockerPrivileged&quot;: { # Defines whether a feature can be used or what values are accepted. # Whether dockerPrivileged can be used.
      &quot;allowedValues&quot;: [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.
        &quot;A String&quot;,
      ],
      &quot;policy&quot;: &quot;A String&quot;, # The policy of the feature.
    },
    &quot;dockerRunAsRoot&quot;: { # Defines whether a feature can be used or what values are accepted. # Whether dockerRunAsRoot can be used.
      &quot;allowedValues&quot;: [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.
        &quot;A String&quot;,
      ],
      &quot;policy&quot;: &quot;A String&quot;, # The policy of the feature.
    },
    &quot;dockerRuntime&quot;: { # Defines whether a feature can be used or what values are accepted. # Whether dockerRuntime is allowed to be set or what runtimes are allowed. Note linux_isolation takes precedence, and if set, docker_runtime values may be rejected if they are incompatible with the selected isolation.
      &quot;allowedValues&quot;: [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.
        &quot;A String&quot;,
      ],
      &quot;policy&quot;: &quot;A String&quot;, # The policy of the feature.
    },
    &quot;dockerSiblingContainers&quot;: { # Defines whether a feature can be used or what values are accepted. # Whether dockerSiblingContainers can be used.
      &quot;allowedValues&quot;: [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.
        &quot;A String&quot;,
      ],
      &quot;policy&quot;: &quot;A String&quot;, # The policy of the feature.
    },
    &quot;linuxIsolation&quot;: &quot;A String&quot;, # linux_isolation allows overriding the docker runtime used for containers started on Linux.
  },
  &quot;location&quot;: &quot;A String&quot;, # The location is a GCP region. Currently only `us-central1` is supported.
  &quot;loggingEnabled&quot;: True or False, # Output only. Whether stack driver logging is enabled for the instance.
  &quot;name&quot;: &quot;A String&quot;, # Output only. Instance resource name formatted as: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. Name should not be populated when creating an instance since it is provided in the `instance_id` field.
  &quot;state&quot;: &quot;A String&quot;, # Output only. State of the instance.
}

  loggingEnabled: boolean, Deprecated, use instance.logging_enabled instead. Whether to enable Stackdriver logging for this instance.
  name1: string, Deprecated, use instance.Name instead. Name of the instance to update. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`.
  updateMask: string, The update mask applies to instance. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask If an empty update_mask is provided, only the non-default valued field in the worker pool field will be updated. Note that in order to update a field to the default value (zero, false, empty string) an explicit update_mask must be provided.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  &quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

</body></html>