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