blob: cd8fee124e8961c0d7719adf2188323e00374b30 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -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="dialogflow_v2.html">Dialogflow API</a> . <a href="dialogflow_v2.projects.html">projects</a> . <a href="dialogflow_v2.projects.operations.html">operations</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
79<p class="firstline">Gets the latest state of a long-running operation. Clients can use this</p>
80<h3>Method Details</h3>
81<div class="method">
82 <code class="details" id="get">get(name, x__xgafv=None)</code>
83 <pre>Gets the latest state of a long-running operation. Clients can use this
84method to poll the operation result at intervals as recommended by the API
85service.
86
87Args:
88 name: string, The name of the operation resource. (required)
89 x__xgafv: string, V1 error format.
90 Allowed values
91 1 - v1 error format
92 2 - v2 error format
93
94Returns:
95 An object of the form:
96
97 { # This resource represents a long-running operation that is the result of a
98 # network API call.
99 "metadata": { # Service-specific metadata associated with the operation. It typically
100 # contains progress information and common metadata such as create time.
101 # Some services might not provide such metadata. Any method that returns a
102 # long-running operation should document the metadata type, if any.
103 "a_key": "", # Properties of the object. Contains field @type with type URL.
104 },
105 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
106 # different programming environments, including REST APIs and RPC APIs. It is
107 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
108 # three pieces of data: error code, error message, and error details.
109 #
110 # You can find out more about this error model and how to work with it in the
111 # [API Design Guide](https://cloud.google.com/apis/design/errors).
112 "message": "A String", # A developer-facing error message, which should be in English. Any
113 # user-facing error message should be localized and sent in the
114 # google.rpc.Status.details field, or localized by the client.
115 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
116 "details": [ # A list of messages that carry the error details. There is a common set of
117 # message types for APIs to use.
118 {
119 "a_key": "", # Properties of the object. Contains field @type with type URL.
120 },
121 ],
122 },
123 "done": True or False, # If the value is `false`, it means the operation is still in progress.
124 # If `true`, the operation is completed, and either `error` or `response` is
125 # available.
126 "response": { # The normal response of the operation in case of success. If the original
127 # method returns no data on success, such as `Delete`, the response is
128 # `google.protobuf.Empty`. If the original method is standard
129 # `Get`/`Create`/`Update`, the response should be the resource. For other
130 # methods, the response should have the type `XxxResponse`, where `Xxx`
131 # is the original method name. For example, if the original method name
132 # is `TakeSnapshot()`, the inferred response type is
133 # `TakeSnapshotResponse`.
134 "a_key": "", # Properties of the object. Contains field @type with type URL.
135 },
136 "name": "A String", # The server-assigned name, which is only unique within the same service that
137 # originally returns it. If you use the default HTTP mapping, the
138 # `name` should be a resource name ending with `operations/{unique_id}`.
139 }</pre>
140</div>
141
142</body></html>