• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5  margin: 0;
6  padding: 0;
7  border: 0;
8  font-weight: inherit;
9  font-style: inherit;
10  font-size: 100%;
11  font-family: inherit;
12  vertical-align: baseline;
13}
14
15body {
16  font-size: 13px;
17  padding: 1em;
18}
19
20h1 {
21  font-size: 26px;
22  margin-bottom: 1em;
23}
24
25h2 {
26  font-size: 24px;
27  margin-bottom: 1em;
28}
29
30h3 {
31  font-size: 20px;
32  margin-bottom: 1em;
33  margin-top: 1em;
34}
35
36pre, code {
37  line-height: 1.5;
38  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42  margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46  font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50  border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54  margin-top: 0.5em;
55}
56
57.firstline {
58  margin-left: 2 em;
59}
60
61.method  {
62  margin-top: 1em;
63  border: solid 1px #CCC;
64  padding: 1em;
65  background: #EEE;
66}
67
68.details {
69  font-weight: bold;
70  font-size: 14px;
71}
72
73</style>
74
75<h1><a href="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>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="remotebuildexecution_v1alpha.projects.instances.workerpools.html">workerpools()</a></code>
79</p>
80<p class="firstline">Returns the workerpools Resource.</p>
81
82<p class="toc_element">
83  <code><a href="#close">close()</a></code></p>
84<p class="firstline">Close httplib2 connections.</p>
85<p class="toc_element">
86  <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
87<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>
88<p class="toc_element">
89  <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
90<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>
91<p class="toc_element">
92  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
93<p class="firstline">Returns the specified instance.</p>
94<p class="toc_element">
95  <code><a href="#list">list(parent, x__xgafv=None)</a></code></p>
96<p class="firstline">Lists instances in a project.</p>
97<p class="toc_element">
98  <code><a href="#patch">patch(name, body=None, loggingEnabled=None, name1=None, updateMask=None, x__xgafv=None)</a></code></p>
99<p class="firstline">Updates the specified instance. Returns a long running operation which contains the updated instance in the response on completion.</p>
100<h3>Method Details</h3>
101<div class="method">
102    <code class="details" id="close">close()</code>
103  <pre>Close httplib2 connections.</pre>
104</div>
105
106<div class="method">
107    <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
108  <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`.
109
110Args:
111  parent: string, Resource name of the project containing the instance. Format: `projects/[PROJECT_ID]`. (required)
112  body: object, The request body.
113    The object takes the form of:
114
115{ # The request used for `CreateInstance`.
116  &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.
117    &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.
118      &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.
119        &quot;allowedValues&quot;: [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.
120          &quot;A String&quot;,
121        ],
122        &quot;policy&quot;: &quot;A String&quot;, # The policy of the feature.
123      },
124      &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.
125        &quot;allowedValues&quot;: [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.
126          &quot;A String&quot;,
127        ],
128        &quot;policy&quot;: &quot;A String&quot;, # The policy of the feature.
129      },
130      &quot;dockerChrootPath&quot;: { # Defines whether a feature can be used or what values are accepted. # Whether dockerChrootPath can be used.
131        &quot;allowedValues&quot;: [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.
132          &quot;A String&quot;,
133        ],
134        &quot;policy&quot;: &quot;A String&quot;, # The policy of the feature.
135      },
136      &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`.
137        &quot;allowedValues&quot;: [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.
138          &quot;A String&quot;,
139        ],
140        &quot;policy&quot;: &quot;A String&quot;, # The policy of the feature.
141      },
142      &quot;dockerPrivileged&quot;: { # Defines whether a feature can be used or what values are accepted. # Whether dockerPrivileged can be used.
143        &quot;allowedValues&quot;: [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.
144          &quot;A String&quot;,
145        ],
146        &quot;policy&quot;: &quot;A String&quot;, # The policy of the feature.
147      },
148      &quot;dockerRunAsRoot&quot;: { # Defines whether a feature can be used or what values are accepted. # Whether dockerRunAsRoot can be used.
149        &quot;allowedValues&quot;: [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.
150          &quot;A String&quot;,
151        ],
152        &quot;policy&quot;: &quot;A String&quot;, # The policy of the feature.
153      },
154      &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.
155        &quot;allowedValues&quot;: [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.
156          &quot;A String&quot;,
157        ],
158        &quot;policy&quot;: &quot;A String&quot;, # The policy of the feature.
159      },
160      &quot;dockerSiblingContainers&quot;: { # Defines whether a feature can be used or what values are accepted. # Whether dockerSiblingContainers can be used.
161        &quot;allowedValues&quot;: [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.
162          &quot;A String&quot;,
163        ],
164        &quot;policy&quot;: &quot;A String&quot;, # The policy of the feature.
165      },
166      &quot;linuxIsolation&quot;: &quot;A String&quot;, # linux_isolation allows overriding the docker runtime used for containers started on Linux.
167    },
168    &quot;location&quot;: &quot;A String&quot;, # The location is a GCP region. Currently only `us-central1` is supported.
169    &quot;loggingEnabled&quot;: True or False, # Output only. Whether stack driver logging is enabled for the instance.
170    &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.
171    &quot;state&quot;: &quot;A String&quot;, # Output only. State of the instance.
172  },
173  &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.
174  &quot;parent&quot;: &quot;A String&quot;, # Resource name of the project containing the instance. Format: `projects/[PROJECT_ID]`.
175}
176
177  x__xgafv: string, V1 error format.
178    Allowed values
179      1 - v1 error format
180      2 - v2 error format
181
182Returns:
183  An object of the form:
184
185    { # This resource represents a long-running operation that is the result of a network API call.
186  &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.
187  &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.
188    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
189    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
190      {
191        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
192      },
193    ],
194    &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.
195  },
196  &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.
197    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
198  },
199  &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}`.
200  &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`.
201    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
202  },
203}</pre>
204</div>
205
206<div class="method">
207    <code class="details" id="delete">delete(name, x__xgafv=None)</code>
208  <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.
209
210Args:
211  name: string, Name of the instance to delete. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. (required)
212  x__xgafv: string, V1 error format.
213    Allowed values
214      1 - v1 error format
215      2 - v2 error format
216
217Returns:
218  An object of the form:
219
220    { # This resource represents a long-running operation that is the result of a network API call.
221  &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.
222  &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.
223    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
224    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
225      {
226        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
227      },
228    ],
229    &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.
230  },
231  &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.
232    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
233  },
234  &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}`.
235  &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`.
236    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
237  },
238}</pre>
239</div>
240
241<div class="method">
242    <code class="details" id="get">get(name, x__xgafv=None)</code>
243  <pre>Returns the specified instance.
244
245Args:
246  name: string, Name of the instance to retrieve. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. (required)
247  x__xgafv: string, V1 error format.
248    Allowed values
249      1 - v1 error format
250      2 - v2 error format
251
252Returns:
253  An object of the form:
254
255    { # 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.
256  &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.
257    &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.
258      &quot;allowedValues&quot;: [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.
259        &quot;A String&quot;,
260      ],
261      &quot;policy&quot;: &quot;A String&quot;, # The policy of the feature.
262    },
263    &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.
264      &quot;allowedValues&quot;: [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.
265        &quot;A String&quot;,
266      ],
267      &quot;policy&quot;: &quot;A String&quot;, # The policy of the feature.
268    },
269    &quot;dockerChrootPath&quot;: { # Defines whether a feature can be used or what values are accepted. # Whether dockerChrootPath can be used.
270      &quot;allowedValues&quot;: [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.
271        &quot;A String&quot;,
272      ],
273      &quot;policy&quot;: &quot;A String&quot;, # The policy of the feature.
274    },
275    &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`.
276      &quot;allowedValues&quot;: [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.
277        &quot;A String&quot;,
278      ],
279      &quot;policy&quot;: &quot;A String&quot;, # The policy of the feature.
280    },
281    &quot;dockerPrivileged&quot;: { # Defines whether a feature can be used or what values are accepted. # Whether dockerPrivileged can be used.
282      &quot;allowedValues&quot;: [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.
283        &quot;A String&quot;,
284      ],
285      &quot;policy&quot;: &quot;A String&quot;, # The policy of the feature.
286    },
287    &quot;dockerRunAsRoot&quot;: { # Defines whether a feature can be used or what values are accepted. # Whether dockerRunAsRoot can be used.
288      &quot;allowedValues&quot;: [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.
289        &quot;A String&quot;,
290      ],
291      &quot;policy&quot;: &quot;A String&quot;, # The policy of the feature.
292    },
293    &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.
294      &quot;allowedValues&quot;: [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.
295        &quot;A String&quot;,
296      ],
297      &quot;policy&quot;: &quot;A String&quot;, # The policy of the feature.
298    },
299    &quot;dockerSiblingContainers&quot;: { # Defines whether a feature can be used or what values are accepted. # Whether dockerSiblingContainers can be used.
300      &quot;allowedValues&quot;: [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.
301        &quot;A String&quot;,
302      ],
303      &quot;policy&quot;: &quot;A String&quot;, # The policy of the feature.
304    },
305    &quot;linuxIsolation&quot;: &quot;A String&quot;, # linux_isolation allows overriding the docker runtime used for containers started on Linux.
306  },
307  &quot;location&quot;: &quot;A String&quot;, # The location is a GCP region. Currently only `us-central1` is supported.
308  &quot;loggingEnabled&quot;: True or False, # Output only. Whether stack driver logging is enabled for the instance.
309  &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.
310  &quot;state&quot;: &quot;A String&quot;, # Output only. State of the instance.
311}</pre>
312</div>
313
314<div class="method">
315    <code class="details" id="list">list(parent, x__xgafv=None)</code>
316  <pre>Lists instances in a project.
317
318Args:
319  parent: string, Resource name of the project. Format: `projects/[PROJECT_ID]`. (required)
320  x__xgafv: string, V1 error format.
321    Allowed values
322      1 - v1 error format
323      2 - v2 error format
324
325Returns:
326  An object of the form:
327
328    {
329  &quot;instances&quot;: [ # The list of instances in a given project.
330    { # 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.
331      &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.
332        &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.
333          &quot;allowedValues&quot;: [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.
334            &quot;A String&quot;,
335          ],
336          &quot;policy&quot;: &quot;A String&quot;, # The policy of the feature.
337        },
338        &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.
339          &quot;allowedValues&quot;: [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.
340            &quot;A String&quot;,
341          ],
342          &quot;policy&quot;: &quot;A String&quot;, # The policy of the feature.
343        },
344        &quot;dockerChrootPath&quot;: { # Defines whether a feature can be used or what values are accepted. # Whether dockerChrootPath can be used.
345          &quot;allowedValues&quot;: [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.
346            &quot;A String&quot;,
347          ],
348          &quot;policy&quot;: &quot;A String&quot;, # The policy of the feature.
349        },
350        &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`.
351          &quot;allowedValues&quot;: [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.
352            &quot;A String&quot;,
353          ],
354          &quot;policy&quot;: &quot;A String&quot;, # The policy of the feature.
355        },
356        &quot;dockerPrivileged&quot;: { # Defines whether a feature can be used or what values are accepted. # Whether dockerPrivileged can be used.
357          &quot;allowedValues&quot;: [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.
358            &quot;A String&quot;,
359          ],
360          &quot;policy&quot;: &quot;A String&quot;, # The policy of the feature.
361        },
362        &quot;dockerRunAsRoot&quot;: { # Defines whether a feature can be used or what values are accepted. # Whether dockerRunAsRoot can be used.
363          &quot;allowedValues&quot;: [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.
364            &quot;A String&quot;,
365          ],
366          &quot;policy&quot;: &quot;A String&quot;, # The policy of the feature.
367        },
368        &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.
369          &quot;allowedValues&quot;: [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.
370            &quot;A String&quot;,
371          ],
372          &quot;policy&quot;: &quot;A String&quot;, # The policy of the feature.
373        },
374        &quot;dockerSiblingContainers&quot;: { # Defines whether a feature can be used or what values are accepted. # Whether dockerSiblingContainers can be used.
375          &quot;allowedValues&quot;: [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.
376            &quot;A String&quot;,
377          ],
378          &quot;policy&quot;: &quot;A String&quot;, # The policy of the feature.
379        },
380        &quot;linuxIsolation&quot;: &quot;A String&quot;, # linux_isolation allows overriding the docker runtime used for containers started on Linux.
381      },
382      &quot;location&quot;: &quot;A String&quot;, # The location is a GCP region. Currently only `us-central1` is supported.
383      &quot;loggingEnabled&quot;: True or False, # Output only. Whether stack driver logging is enabled for the instance.
384      &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.
385      &quot;state&quot;: &quot;A String&quot;, # Output only. State of the instance.
386    },
387  ],
388}</pre>
389</div>
390
391<div class="method">
392    <code class="details" id="patch">patch(name, body=None, loggingEnabled=None, name1=None, updateMask=None, x__xgafv=None)</code>
393  <pre>Updates the specified instance. Returns a long running operation which contains the updated instance in the response on completion.
394
395Args:
396  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)
397  body: object, The request body.
398    The object takes the form of:
399
400{ # 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.
401  &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.
402    &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.
403      &quot;allowedValues&quot;: [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.
404        &quot;A String&quot;,
405      ],
406      &quot;policy&quot;: &quot;A String&quot;, # The policy of the feature.
407    },
408    &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.
409      &quot;allowedValues&quot;: [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.
410        &quot;A String&quot;,
411      ],
412      &quot;policy&quot;: &quot;A String&quot;, # The policy of the feature.
413    },
414    &quot;dockerChrootPath&quot;: { # Defines whether a feature can be used or what values are accepted. # Whether dockerChrootPath can be used.
415      &quot;allowedValues&quot;: [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.
416        &quot;A String&quot;,
417      ],
418      &quot;policy&quot;: &quot;A String&quot;, # The policy of the feature.
419    },
420    &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`.
421      &quot;allowedValues&quot;: [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.
422        &quot;A String&quot;,
423      ],
424      &quot;policy&quot;: &quot;A String&quot;, # The policy of the feature.
425    },
426    &quot;dockerPrivileged&quot;: { # Defines whether a feature can be used or what values are accepted. # Whether dockerPrivileged can be used.
427      &quot;allowedValues&quot;: [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.
428        &quot;A String&quot;,
429      ],
430      &quot;policy&quot;: &quot;A String&quot;, # The policy of the feature.
431    },
432    &quot;dockerRunAsRoot&quot;: { # Defines whether a feature can be used or what values are accepted. # Whether dockerRunAsRoot can be used.
433      &quot;allowedValues&quot;: [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.
434        &quot;A String&quot;,
435      ],
436      &quot;policy&quot;: &quot;A String&quot;, # The policy of the feature.
437    },
438    &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.
439      &quot;allowedValues&quot;: [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.
440        &quot;A String&quot;,
441      ],
442      &quot;policy&quot;: &quot;A String&quot;, # The policy of the feature.
443    },
444    &quot;dockerSiblingContainers&quot;: { # Defines whether a feature can be used or what values are accepted. # Whether dockerSiblingContainers can be used.
445      &quot;allowedValues&quot;: [ # A list of acceptable values. Only effective when the policy is `RESTRICTED`.
446        &quot;A String&quot;,
447      ],
448      &quot;policy&quot;: &quot;A String&quot;, # The policy of the feature.
449    },
450    &quot;linuxIsolation&quot;: &quot;A String&quot;, # linux_isolation allows overriding the docker runtime used for containers started on Linux.
451  },
452  &quot;location&quot;: &quot;A String&quot;, # The location is a GCP region. Currently only `us-central1` is supported.
453  &quot;loggingEnabled&quot;: True or False, # Output only. Whether stack driver logging is enabled for the instance.
454  &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.
455  &quot;state&quot;: &quot;A String&quot;, # Output only. State of the instance.
456}
457
458  loggingEnabled: boolean, Deprecated, use instance.logging_enabled instead. Whether to enable Stackdriver logging for this instance.
459  name1: string, Deprecated, use instance.Name instead. Name of the instance to update. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`.
460  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.
461  x__xgafv: string, V1 error format.
462    Allowed values
463      1 - v1 error format
464      2 - v2 error format
465
466Returns:
467  An object of the form:
468
469    { # This resource represents a long-running operation that is the result of a network API call.
470  &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.
471  &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.
472    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
473    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
474      {
475        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
476      },
477    ],
478    &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.
479  },
480  &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.
481    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
482  },
483  &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}`.
484  &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`.
485    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
486  },
487}</pre>
488</div>
489
490</body></html>