Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / f3348f98bf91a88a28bf61b12b95e391cc3be1ff / . / docs / dyn / remotebuildexecution_v1alpha.projects.instances.html
blob: 636d149e40c3c9daeeb1e59ece1cf96d6ecb3097 [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="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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]83 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]84<p class="firstline">Creates a new instance in the specified region.</p>
85<p class="toc_element">
86 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
87<p class="firstline">Deletes the specified instance.</p>
88<p class="toc_element">
89 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
90<p class="firstline">Returns the specified instance.</p>
91<p class="toc_element">
92 <code><a href="#list">list(parent, x__xgafv=None)</a></code></p>
93<p class="firstline">Lists instances in a project.</p>
94<h3>Method Details</h3>
95<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]96 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]97 <pre>Creates a new instance in the specified region.
98Returns a long running operation which contains an instance on completion.
99While the long running operation is in progress, any call to `GetInstance`
100returns an instance in state `CREATING`.
101
102Args:
103 parent: string, Resource name of the project containing the instance.
104Format: `projects/[PROJECT_ID]`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]105 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]106 The object takes the form of:
107
108{ # The request used for `CreateInstance`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]109 &quot;parent&quot;: &quot;A String&quot;, # Resource name of the project containing the instance.
110 # Format: `projects/[PROJECT_ID]`.
111 &quot;instanceId&quot;: &quot;A String&quot;, # ID of the created instance.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]112 # A valid `instance_id` must:
113 # be 6-50 characters long,
114 # contain only lowercase letters, digits, hyphens and underscores,
115 # start with a lowercase letter, and
116 # end with a lowercase letter or a digit.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]117 &quot;instance&quot;: { # Instance conceptually encapsulates all Remote Build Execution resources # Specifies the instance to create.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]118 # The name in the instance, if specified in the instance, is ignored.
119 # for remote builds.
120 # An instance consists of storage and compute resources (for example,
121 # `ContentAddressableStorage`, `ActionCache`, `WorkerPools`) used for
122 # running remote builds.
123 # All Remote Build Execution API calls are scoped to an instance.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]124 &quot;location&quot;: &quot;A String&quot;, # The location is a GCP region. Currently only `us-central1` is supported.
125 &quot;state&quot;: &quot;A String&quot;, # Output only. State of the instance.
126 &quot;loggingEnabled&quot;: True or False, # Output only. Whether stack driver logging is enabled for the instance.
127 &quot;name&quot;: &quot;A String&quot;, # Output only. Instance resource name formatted as:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]128 # `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`.
129 # Name should not be populated when creating an instance since it is provided
130 # in the `instance_id` field.
131 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]132 }
133
134 x__xgafv: string, V1 error format.
135 Allowed values
136 1 - v1 error format
137 2 - v2 error format
138
139Returns:
140 An object of the form:
141
142 { # This resource represents a long-running operation that is the result of a
143 # network API call.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]144 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
145 # originally returns it. If you use the default HTTP mapping, the
146 # `name` should be a resource name ending with `operations/{unique_id}`.
147 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
148 # different programming environments, including REST APIs and RPC APIs. It is
149 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
150 # three pieces of data: error code, error message, and error details.
151 #
152 # You can find out more about this error model and how to work with it in the
153 # [API Design Guide](https://cloud.google.com/apis/design/errors).
154 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
155 # message types for APIs to use.
156 {
157 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
158 },
159 ],
160 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
161 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
162 # user-facing error message should be localized and sent in the
163 # google.rpc.Status.details field, or localized by the client.
164 },
165 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
166 # contains progress information and common metadata such as create time.
167 # Some services might not provide such metadata. Any method that returns a
168 # long-running operation should document the metadata type, if any.
169 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
170 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]171 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]172 # If `true`, the operation is completed, and either `error` or `response` is
173 # available.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]174 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]175 # method returns no data on success, such as `Delete`, the response is
176 # `google.protobuf.Empty`. If the original method is standard
177 # `Get`/`Create`/`Update`, the response should be the resource. For other
178 # methods, the response should have the type `XxxResponse`, where `Xxx`
179 # is the original method name. For example, if the original method name
180 # is `TakeSnapshot()`, the inferred response type is
181 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]182 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]183 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]184 }</pre>
185</div>
186
187<div class="method">
188 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
189 <pre>Deletes the specified instance.
190Returns a long running operation which contains a `google.protobuf.Empty`
191response on completion.
192Deleting an instance with worker pools in it will delete these worker
193pools.
194
195Args:
196 name: string, Name of the instance to delete.
197Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. (required)
198 x__xgafv: string, V1 error format.
199 Allowed values
200 1 - v1 error format
201 2 - v2 error format
202
203Returns:
204 An object of the form:
205
206 { # This resource represents a long-running operation that is the result of a
207 # network API call.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]208 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
209 # originally returns it. If you use the default HTTP mapping, the
210 # `name` should be a resource name ending with `operations/{unique_id}`.
211 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
212 # different programming environments, including REST APIs and RPC APIs. It is
213 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
214 # three pieces of data: error code, error message, and error details.
215 #
216 # You can find out more about this error model and how to work with it in the
217 # [API Design Guide](https://cloud.google.com/apis/design/errors).
218 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
219 # message types for APIs to use.
220 {
221 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
222 },
223 ],
224 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
225 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
226 # user-facing error message should be localized and sent in the
227 # google.rpc.Status.details field, or localized by the client.
228 },
229 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
230 # contains progress information and common metadata such as create time.
231 # Some services might not provide such metadata. Any method that returns a
232 # long-running operation should document the metadata type, if any.
233 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
234 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]235 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]236 # If `true`, the operation is completed, and either `error` or `response` is
237 # available.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]238 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]239 # method returns no data on success, such as `Delete`, the response is
240 # `google.protobuf.Empty`. If the original method is standard
241 # `Get`/`Create`/`Update`, the response should be the resource. For other
242 # methods, the response should have the type `XxxResponse`, where `Xxx`
243 # is the original method name. For example, if the original method name
244 # is `TakeSnapshot()`, the inferred response type is
245 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]246 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]247 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]248 }</pre>
249</div>
250
251<div class="method">
252 <code class="details" id="get">get(name, x__xgafv=None)</code>
253 <pre>Returns the specified instance.
254
255Args:
256 name: string, Name of the instance to retrieve.
257Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. (required)
258 x__xgafv: string, V1 error format.
259 Allowed values
260 1 - v1 error format
261 2 - v2 error format
262
263Returns:
264 An object of the form:
265
266 { # Instance conceptually encapsulates all Remote Build Execution resources
267 # for remote builds.
268 # An instance consists of storage and compute resources (for example,
269 # `ContentAddressableStorage`, `ActionCache`, `WorkerPools`) used for
270 # running remote builds.
271 # All Remote Build Execution API calls are scoped to an instance.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]272 &quot;location&quot;: &quot;A String&quot;, # The location is a GCP region. Currently only `us-central1` is supported.
273 &quot;state&quot;: &quot;A String&quot;, # Output only. State of the instance.
274 &quot;loggingEnabled&quot;: True or False, # Output only. Whether stack driver logging is enabled for the instance.
275 &quot;name&quot;: &quot;A String&quot;, # Output only. Instance resource name formatted as:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]276 # `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`.
277 # Name should not be populated when creating an instance since it is provided
278 # in the `instance_id` field.
279 }</pre>
280</div>
281
282<div class="method">
283 <code class="details" id="list">list(parent, x__xgafv=None)</code>
284 <pre>Lists instances in a project.
285
286Args:
287 parent: string, Resource name of the project.
288Format: `projects/[PROJECT_ID]`. (required)
289 x__xgafv: string, V1 error format.
290 Allowed values
291 1 - v1 error format
292 2 - v2 error format
293
294Returns:
295 An object of the form:
296
297 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]298 &quot;instances&quot;: [ # The list of instances in a given project.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]299 { # Instance conceptually encapsulates all Remote Build Execution resources
300 # for remote builds.
301 # An instance consists of storage and compute resources (for example,
302 # `ContentAddressableStorage`, `ActionCache`, `WorkerPools`) used for
303 # running remote builds.
304 # All Remote Build Execution API calls are scoped to an instance.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]305 &quot;location&quot;: &quot;A String&quot;, # The location is a GCP region. Currently only `us-central1` is supported.
306 &quot;state&quot;: &quot;A String&quot;, # Output only. State of the instance.
307 &quot;loggingEnabled&quot;: True or False, # Output only. Whether stack driver logging is enabled for the instance.
308 &quot;name&quot;: &quot;A String&quot;, # Output only. Instance resource name formatted as:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]309 # `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`.
310 # Name should not be populated when creating an instance since it is provided
311 # in the `instance_id` field.
312 },
313 ],
314 }</pre>
315</div>
316
317</body></html>