blob: 09a6ae4f41893b64580cb610698f1ec70c643ad9 [file] [log] [blame]
Bu Sun Kim65020912020-05-20 12:08:20 -07001<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="ml_v1.html">AI Platform Training & Prediction API</a> . <a href="ml_v1.projects.html">projects</a> . <a href="ml_v1.projects.locations.html">locations</a> . <a href="ml_v1.projects.locations.operations.html">operations</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#cancel">cancel(name, x__xgafv=None)</a></code></p>
79<p class="firstline">Starts asynchronous cancellation on a long-running operation. The server</p>
80<p class="toc_element">
81 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
82<p class="firstline">Gets the latest state of a long-running operation. Clients can use this</p>
83<h3>Method Details</h3>
84<div class="method">
85 <code class="details" id="cancel">cancel(name, x__xgafv=None)</code>
86 <pre>Starts asynchronous cancellation on a long-running operation. The server
87makes a best effort to cancel the operation, but success is not
88guaranteed. If the server doesn&#x27;t support this method, it returns
89`google.rpc.Code.UNIMPLEMENTED`. Clients can use
90Operations.GetOperation or
91other methods to check whether the cancellation succeeded or whether the
92operation completed despite cancellation. On successful cancellation,
93the operation is not deleted; instead, it becomes an operation with
94an Operation.error value with a google.rpc.Status.code of 1,
95corresponding to `Code.CANCELLED`.
96
97Args:
98 name: string, The name of the operation resource to be cancelled. (required)
99 x__xgafv: string, V1 error format.
100 Allowed values
101 1 - v1 error format
102 2 - v2 error format
103
104Returns:
105 An object of the form:
106
107 { # A generic empty message that you can re-use to avoid defining duplicated
108 # empty messages in your APIs. A typical example is to use it as the request
109 # or the response type of an API method. For instance:
110 #
111 # service Foo {
112 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
113 # }
114 #
115 # The JSON representation for `Empty` is empty JSON object `{}`.
116 }</pre>
117</div>
118
119<div class="method">
120 <code class="details" id="get">get(name, x__xgafv=None)</code>
121 <pre>Gets the latest state of a long-running operation. Clients can use this
122method to poll the operation result at intervals as recommended by the API
123service.
124
125Args:
126 name: string, The name of the operation resource. (required)
127 x__xgafv: string, V1 error format.
128 Allowed values
129 1 - v1 error format
130 2 - v2 error format
131
132Returns:
133 An object of the form:
134
135 { # This resource represents a long-running operation that is the result of a
136 # network API call.
Bu Sun Kim65020912020-05-20 12:08:20 -0700137 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
138 # originally returns it. If you use the default HTTP mapping, the
139 # `name` should be a resource name ending with `operations/{unique_id}`.
140 &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.
141 # different programming environments, including REST APIs and RPC APIs. It is
142 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
143 # three pieces of data: error code, error message, and error details.
144 #
145 # You can find out more about this error model and how to work with it in the
146 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700147 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
148 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
149 # user-facing error message should be localized and sent in the
150 # google.rpc.Status.details field, or localized by the client.
Bu Sun Kim65020912020-05-20 12:08:20 -0700151 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
152 # message types for APIs to use.
153 {
154 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
155 },
156 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700157 },
158 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
159 # contains progress information and common metadata such as create time.
160 # Some services might not provide such metadata. Any method that returns a
161 # long-running operation should document the metadata type, if any.
162 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
163 },
164 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
165 # If `true`, the operation is completed, and either `error` or `response` is
166 # available.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700167 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
168 # method returns no data on success, such as `Delete`, the response is
169 # `google.protobuf.Empty`. If the original method is standard
170 # `Get`/`Create`/`Update`, the response should be the resource. For other
171 # methods, the response should have the type `XxxResponse`, where `Xxx`
172 # is the original method name. For example, if the original method name
173 # is `TakeSnapshot()`, the inferred response type is
174 # `TakeSnapshotResponse`.
175 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
176 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700177 }</pre>
178</div>
179
180</body></html>