Debian Codegraph @

docs/dyn/documentai_v1.projects.locations.html

raw
1 <html><body>
2 <style>
3
4 body, 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
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, 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="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></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="documentai_v1.projects.locations.operations.html">operations()</a></code>
79 </p>
80 <p class="firstline">Returns the operations Resource.</p>
81
82 <p class="toc_element">
83 <code><a href="documentai_v1.projects.locations.processorTypes.html">processorTypes()</a></code>
84 </p>
85 <p class="firstline">Returns the processorTypes Resource.</p>
86
87 <p class="toc_element">
88 <code><a href="documentai_v1.projects.locations.processors.html">processors()</a></code>
89 </p>
90 <p class="firstline">Returns the processors Resource.</p>
91
92 <p class="toc_element">
93 <code><a href="documentai_v1.projects.locations.schemas.html">schemas()</a></code>
94 </p>
95 <p class="firstline">Returns the schemas Resource.</p>
96
97 <p class="toc_element">
98 <code><a href="#close">close()</a></code></p>
99 <p class="firstline">Close httplib2 connections.</p>
100 <p class="toc_element">
101 <code><a href="#fetchProcessorTypes">fetchProcessorTypes(parent, x__xgafv=None)</a></code></p>
102 <p class="firstline">Fetches processor types. Note that we don't use ListProcessorTypes here, because it isn't paginated.</p>
103 <p class="toc_element">
104 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
105 <p class="firstline">Gets information about a location.</p>
106 <p class="toc_element">
107 <code><a href="#list">list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
108 <p class="firstline">Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.</p>
109 <p class="toc_element">
110 <code><a href="#list_next">list_next()</a></code></p>
111 <p class="firstline">Retrieves the next page of results.</p>
112 <h3>Method Details</h3>
113 <div class="method">
114 <code class="details" id="close">close()</code>
115 <pre>Close httplib2 connections.</pre>
116 </div>
117
118 <div class="method">
119 <code class="details" id="fetchProcessorTypes">fetchProcessorTypes(parent, x__xgafv=None)</code>
120 <pre>Fetches processor types. Note that we don&#x27;t use ListProcessorTypes here, because it isn&#x27;t paginated.
121
122 Args:
123 parent: string, Required. The location of processor types to list. Format: `projects/{project}/locations/{location}`. (required)
124 x__xgafv: string, V1 error format.
125 Allowed values
126 1 - v1 error format
127 2 - v2 error format
128
129 Returns:
130 An object of the form:
131
132 { # Response message for the FetchProcessorTypes method.
133 &quot;processorTypes&quot;: [ # The list of processor types.
134 { # A processor type is responsible for performing a certain document understanding task on a certain type of document.
135 &quot;allowCreation&quot;: True or False, # Whether the processor type allows creation. If true, users can create a processor of this processor type. Otherwise, users need to request access.
136 &quot;availableLocations&quot;: [ # The locations in which this processor is available.
137 { # The location information about where the processor is available.
138 &quot;locationId&quot;: &quot;A String&quot;, # The location ID. For supported locations, refer to [regional and multi-regional support](/document-ai/docs/regions).
139 },
140 ],
141 &quot;category&quot;: &quot;A String&quot;, # The processor category, used by UI to group processor types.
142 &quot;launchStage&quot;: &quot;A String&quot;, # Launch stage of the processor type
143 &quot;name&quot;: &quot;A String&quot;, # The resource name of the processor type. Format: `projects/{project}/processorTypes/{processor_type}`
144 &quot;sampleDocumentUris&quot;: [ # A set of Cloud Storage URIs of sample documents for this processor.
145 &quot;A String&quot;,
146 ],
147 &quot;type&quot;: &quot;A String&quot;, # The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`.
148 },
149 ],
150 }</pre>
151 </div>
152
153 <div class="method">
154 <code class="details" id="get">get(name, x__xgafv=None)</code>
155 <pre>Gets information about a location.
156
157 Args:
158 name: string, Resource name for the location. (required)
159 x__xgafv: string, V1 error format.
160 Allowed values
161 1 - v1 error format
162 2 - v2 error format
163
164 Returns:
165 An object of the form:
166
167 { # A resource that represents a Google Cloud location.
168 &quot;displayName&quot;: &quot;A String&quot;, # The friendly name for this location, typically a nearby city name. For example, &quot;Tokyo&quot;.
169 &quot;labels&quot;: { # Cross-service attributes for the location. For example {&quot;cloud.googleapis.com/region&quot;: &quot;us-east1&quot;}
170 &quot;a_key&quot;: &quot;A String&quot;,
171 },
172 &quot;locationId&quot;: &quot;A String&quot;, # The canonical id for this location. For example: `&quot;us-east1&quot;`.
173 &quot;metadata&quot;: { # Service-specific metadata. For example the available capacity at the given location.
174 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
175 },
176 &quot;name&quot;: &quot;A String&quot;, # Resource name for the location, which may vary between implementations. For example: `&quot;projects/example-project/locations/us-east1&quot;`
177 }</pre>
178 </div>
179
180 <div class="method">
181 <code class="details" id="list">list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
182 <pre>Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
183
184 Args:
185 name: string, The resource that owns the locations collection, if applicable. (required)
186 extraLocationTypes: string, Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
187 filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `&quot;displayName=tokyo&quot;`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
188 pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
189 pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
190 x__xgafv: string, V1 error format.
191 Allowed values
192 1 - v1 error format
193 2 - v2 error format
194
195 Returns:
196 An object of the form:
197
198 { # The response message for Locations.ListLocations.
199 &quot;locations&quot;: [ # A list of locations that matches the specified filter in the request.
200 { # A resource that represents a Google Cloud location.
201 &quot;displayName&quot;: &quot;A String&quot;, # The friendly name for this location, typically a nearby city name. For example, &quot;Tokyo&quot;.
202 &quot;labels&quot;: { # Cross-service attributes for the location. For example {&quot;cloud.googleapis.com/region&quot;: &quot;us-east1&quot;}
203 &quot;a_key&quot;: &quot;A String&quot;,
204 },
205 &quot;locationId&quot;: &quot;A String&quot;, # The canonical id for this location. For example: `&quot;us-east1&quot;`.
206 &quot;metadata&quot;: { # Service-specific metadata. For example the available capacity at the given location.
207 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
208 },
209 &quot;name&quot;: &quot;A String&quot;, # Resource name for the location, which may vary between implementations. For example: `&quot;projects/example-project/locations/us-east1&quot;`
210 },
211 ],
212 &quot;nextPageToken&quot;: &quot;A String&quot;, # The standard List next-page token.
213 }</pre>
214 </div>
215
216 <div class="method">
217 <code class="details" id="list_next">list_next()</code>
218 <pre>Retrieves the next page of results.
219
220 Args:
221 previous_request: The request for the previous page. (required)
222 previous_response: The response from the request for the previous page. (required)
223
224 Returns:
225 A request object that you can call &#x27;execute()&#x27; on to request the next
226 page. Returns None if there are no more items in the collection.
227 </pre>
228 </div>
229
230 </body></html>