Skip to content

Commit 222030d

Browse files
feat(documentai): update the api
#### documentai:v1 The following keys were deleted: - resources.operations.methods.cancel (Total Keys: 12) - resources.operations.methods.list (Total Keys: 18) - schemas.GoogleLongrunningCancelOperationRequest (Total Keys: 2) The following keys were added: - resources.projects.resources.locations.resources.operations.methods.cancelOperation (Total Keys: 11) - resources.projects.resources.locations.resources.operations.methods.list (Total Keys: 18) - resources.uiv1beta3.resources.projects.resources.locations.resources.operations.methods.cancelOperation (Total Keys: 11) - resources.uiv1beta3.resources.projects.resources.locations.resources.operations.methods.list (Total Keys: 18) #### documentai:v1beta3 The following keys were added: - resources.projects.resources.locations.resources.operations.methods.cancelOperation (Total Keys: 11) - resources.projects.resources.locations.resources.operations.methods.list (Total Keys: 18) - schemas.GoogleLongrunningListOperationsResponse (Total Keys: 5)
1 parent 7e3d1c4 commit 222030d

8 files changed

+473
-170
lines changed

docs/dyn/documentai_v1.operations.html

Lines changed: 0 additions & 90 deletions
Original file line numberDiff line numberDiff line change
@@ -74,46 +74,13 @@
7474

7575
<h1><a href="documentai_v1.html">Cloud Document AI API</a> . <a href="documentai_v1.operations.html">operations</a></h1>
7676
<h2>Instance Methods</h2>
77-
<p class="toc_element">
78-
<code><a href="#cancel">cancel(name, body=None, x__xgafv=None)</a></code></p>
79-
<p class="firstline">Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.</p>
8077
<p class="toc_element">
8178
<code><a href="#close">close()</a></code></p>
8279
<p class="firstline">Close httplib2 connections.</p>
8380
<p class="toc_element">
8481
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
8582
<p class="firstline">Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.</p>
86-
<p class="toc_element">
87-
<code><a href="#list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
88-
<p class="firstline">Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.</p>
89-
<p class="toc_element">
90-
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91-
<p class="firstline">Retrieves the next page of results.</p>
9283
<h3>Method Details</h3>
93-
<div class="method">
94-
<code class="details" id="cancel">cancel(name, body=None, x__xgafv=None)</code>
95-
<pre>Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn&#x27;t support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
96-
97-
Args:
98-
name: string, The name of the operation resource to be cancelled. (required)
99-
body: object, The request body.
100-
The object takes the form of:
101-
102-
{ # The request message for Operations.CancelOperation.
103-
}
104-
105-
x__xgafv: string, V1 error format.
106-
Allowed values
107-
1 - v1 error format
108-
2 - v2 error format
109-
110-
Returns:
111-
An object of the form:
112-
113-
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
114-
}</pre>
115-
</div>
116-
11784
<div class="method">
11885
<code class="details" id="close">close()</code>
11986
<pre>Close httplib2 connections.</pre>
@@ -137,61 +104,4 @@ <h3>Method Details</h3>
137104
}</pre>
138105
</div>
139106

140-
<div class="method">
141-
<code class="details" id="list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
142-
<pre>Lists operations that match the specified filter in the request. If the server doesn&#x27;t support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `&quot;/v1/{name=users/*}/operations&quot;` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
143-
144-
Args:
145-
name: string, The name of the operation&#x27;s parent resource. (required)
146-
filter: string, The standard list filter.
147-
pageSize: integer, The standard list page size.
148-
pageToken: string, The standard list page token.
149-
x__xgafv: string, V1 error format.
150-
Allowed values
151-
1 - v1 error format
152-
2 - v2 error format
153-
154-
Returns:
155-
An object of the form:
156-
157-
{ # The response message for Operations.ListOperations.
158-
&quot;nextPageToken&quot;: &quot;A String&quot;, # The standard List next-page token.
159-
&quot;operations&quot;: [ # A list of operations that matches the specified filter in the request.
160-
{ # This resource represents a long-running operation that is the result of a network API call.
161-
&quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
162-
&quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
163-
&quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
164-
&quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
165-
{
166-
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
167-
},
168-
],
169-
&quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
170-
},
171-
&quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
172-
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
173-
},
174-
&quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
175-
&quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
176-
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
177-
},
178-
},
179-
],
180-
}</pre>
181-
</div>
182-
183-
<div class="method">
184-
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
185-
<pre>Retrieves the next page of results.
186-
187-
Args:
188-
previous_request: The request for the previous page. (required)
189-
previous_response: The response from the request for the previous page. (required)
190-
191-
Returns:
192-
A request object that you can call &#x27;execute()&#x27; on to request the next
193-
page. Returns None if there are no more items in the collection.
194-
</pre>
195-
</div>
196-
197107
</body></html>

docs/dyn/documentai_v1.projects.locations.operations.html

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,13 +74,40 @@
7474

7575
<h1><a href="documentai_v1.html">Cloud Document AI API</a> . <a href="documentai_v1.projects.html">projects</a> . <a href="documentai_v1.projects.locations.html">locations</a> . <a href="documentai_v1.projects.locations.operations.html">operations</a></h1>
7676
<h2>Instance Methods</h2>
77+
<p class="toc_element">
78+
<code><a href="#cancelOperation">cancelOperation(name, x__xgafv=None)</a></code></p>
79+
<p class="firstline">Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.</p>
7780
<p class="toc_element">
7881
<code><a href="#close">close()</a></code></p>
7982
<p class="firstline">Close httplib2 connections.</p>
8083
<p class="toc_element">
8184
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
8285
<p class="firstline">Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.</p>
86+
<p class="toc_element">
87+
<code><a href="#list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
88+
<p class="firstline">Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.</p>
89+
<p class="toc_element">
90+
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91+
<p class="firstline">Retrieves the next page of results.</p>
8392
<h3>Method Details</h3>
93+
<div class="method">
94+
<code class="details" id="cancelOperation">cancelOperation(name, x__xgafv=None)</code>
95+
<pre>Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn&#x27;t support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
96+
97+
Args:
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+
104+
Returns:
105+
An object of the form:
106+
107+
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
108+
}</pre>
109+
</div>
110+
84111
<div class="method">
85112
<code class="details" id="close">close()</code>
86113
<pre>Close httplib2 connections.</pre>
@@ -121,4 +148,61 @@ <h3>Method Details</h3>
121148
}</pre>
122149
</div>
123150

151+
<div class="method">
152+
<code class="details" id="list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
153+
<pre>Lists operations that match the specified filter in the request. If the server doesn&#x27;t support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `&quot;/v1/{name=users/*}/operations&quot;` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
154+
155+
Args:
156+
name: string, The name of the operation&#x27;s parent resource. (required)
157+
filter: string, The standard list filter.
158+
pageSize: integer, The standard list page size.
159+
pageToken: string, The standard list page token.
160+
x__xgafv: string, V1 error format.
161+
Allowed values
162+
1 - v1 error format
163+
2 - v2 error format
164+
165+
Returns:
166+
An object of the form:
167+
168+
{ # The response message for Operations.ListOperations.
169+
&quot;nextPageToken&quot;: &quot;A String&quot;, # The standard List next-page token.
170+
&quot;operations&quot;: [ # A list of operations that matches the specified filter in the request.
171+
{ # This resource represents a long-running operation that is the result of a network API call.
172+
&quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
173+
&quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
174+
&quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
175+
&quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
176+
{
177+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
178+
},
179+
],
180+
&quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
181+
},
182+
&quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
183+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
184+
},
185+
&quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
186+
&quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
187+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
188+
},
189+
},
190+
],
191+
}</pre>
192+
</div>
193+
194+
<div class="method">
195+
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
196+
<pre>Retrieves the next page of results.
197+
198+
Args:
199+
previous_request: The request for the previous page. (required)
200+
previous_response: The response from the request for the previous page. (required)
201+
202+
Returns:
203+
A request object that you can call &#x27;execute()&#x27; on to request the next
204+
page. Returns None if there are no more items in the collection.
205+
</pre>
206+
</div>
207+
124208
</body></html>

0 commit comments

Comments
 (0)