Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / f3348f98bf91a88a28bf61b12b95e391cc3be1ff / . / docs / dyn / remotebuildexecution_v2.operations.html
blob: 38d7122e5900821dc65c6fceaf0e73a9bd949e06 [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_v2.html">Remote Build Execution API</a> . <a href="remotebuildexecution_v2.operations.html">operations</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#waitExecution">waitExecution(name, body=None, x__xgafv=None)</a></code></p>
79<p class="firstline">Wait for an execution operation to complete. When the client initially</p>
80<h3>Method Details</h3>
81<div class="method">
82 <code class="details" id="waitExecution">waitExecution(name, body=None, x__xgafv=None)</code>
83 <pre>Wait for an execution operation to complete. When the client initially
84makes the request, the server immediately responds with the current status
85of the execution. The server will leave the request stream open until the
86operation completes, and then respond with the completed operation. The
87server MAY choose to stream additional updates as execution progresses,
88such as to provide an update as to the state of the execution.
89
90Args:
91 name: string, The name of the Operation
92returned by Execute. (required)
93 body: object, The request body.
94 The object takes the form of:
95
96{ # A request message for
97 # WaitExecution.
98 }
99
100 x__xgafv: string, V1 error format.
101 Allowed values
102 1 - v1 error format
103 2 - v2 error format
104
105Returns:
106 An object of the form:
107
108 { # This resource represents a long-running operation that is the result of a
109 # network API call.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]110 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
111 # If `true`, the operation is completed, and either `error` or `response` is
112 # available.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]113 &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]114 # method returns no data on success, such as `Delete`, the response is
115 # `google.protobuf.Empty`. If the original method is standard
116 # `Get`/`Create`/`Update`, the response should be the resource. For other
117 # methods, the response should have the type `XxxResponse`, where `Xxx`
118 # is the original method name. For example, if the original method name
119 # is `TakeSnapshot()`, the inferred response type is
120 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]121 &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]122 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]123 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]124 # originally returns it. If you use the default HTTP mapping, the
125 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]126 &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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]127 # different programming environments, including REST APIs and RPC APIs. It is
128 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
129 # three pieces of data: error code, error message, and error details.
130 #
131 # You can find out more about this error model and how to work with it in the
132 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]133 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]134 # message types for APIs to use.
135 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]136 &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]137 },
138 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]139 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
140 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
141 # user-facing error message should be localized and sent in the
142 # google.rpc.Status.details field, or localized by the client.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]143 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]144 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
145 # contains progress information and common metadata such as create time.
146 # Some services might not provide such metadata. Any method that returns a
147 # long-running operation should document the metadata type, if any.
148 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
149 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]150 }</pre>
151</div>
152
153</body></html>