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="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.processors.html">processors()</a></code> 84</p> 85<p class="firstline">Returns the processors Resource.</p> 86 87<p class="toc_element"> 88 <code><a href="#close">close()</a></code></p> 89<p class="firstline">Close httplib2 connections.</p> 90<p class="toc_element"> 91 <code><a href="#fetchProcessorTypes">fetchProcessorTypes(parent, x__xgafv=None)</a></code></p> 92<p class="firstline">Fetches processor types.</p> 93<p class="toc_element"> 94 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 95<p class="firstline">Gets information about a location.</p> 96<p class="toc_element"> 97 <code><a href="#list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 98<p class="firstline">Lists information about the supported locations for this service.</p> 99<p class="toc_element"> 100 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 101<p class="firstline">Retrieves the next page of results.</p> 102<h3>Method Details</h3> 103<div class="method"> 104 <code class="details" id="close">close()</code> 105 <pre>Close httplib2 connections.</pre> 106</div> 107 108<div class="method"> 109 <code class="details" id="fetchProcessorTypes">fetchProcessorTypes(parent, x__xgafv=None)</code> 110 <pre>Fetches processor types. 111 112Args: 113 parent: string, Required. The project of processor type to list. The available processor types may depend on the allow-listing on projects. Format: `projects/{project}/locations/{location}` (required) 114 x__xgafv: string, V1 error format. 115 Allowed values 116 1 - v1 error format 117 2 - v2 error format 118 119Returns: 120 An object of the form: 121 122 { # Response message for fetch processor types. 123 "processorTypes": [ # The list of processor types. 124 { # A processor type is responsible for performing a certain document understanding task on a certain type of document. 125 "allowCreation": 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. 126 "availableLocations": [ # The locations in which this processor is available. 127 { # The location information about where the processor is available. 128 "locationId": "A String", # The location id, currently must be one of [us, eu]. 129 }, 130 ], 131 "category": "A String", # The processor category, used by UI to group processor types. 132 "launchStage": "A String", # Launch stage of the processor type 133 "name": "A String", # The resource name of the processor type. Format: projects/{project}/processorTypes/{processor_type} 134 "type": "A String", # The type of the processor, e.g., "invoice_parsing". 135 }, 136 ], 137}</pre> 138</div> 139 140<div class="method"> 141 <code class="details" id="get">get(name, x__xgafv=None)</code> 142 <pre>Gets information about a location. 143 144Args: 145 name: string, Resource name for the location. (required) 146 x__xgafv: string, V1 error format. 147 Allowed values 148 1 - v1 error format 149 2 - v2 error format 150 151Returns: 152 An object of the form: 153 154 { # A resource that represents Google Cloud Platform location. 155 "displayName": "A String", # The friendly name for this location, typically a nearby city name. For example, "Tokyo". 156 "labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} 157 "a_key": "A String", 158 }, 159 "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`. 160 "metadata": { # Service-specific metadata. For example the available capacity at the given location. 161 "a_key": "", # Properties of the object. Contains field @type with type URL. 162 }, 163 "name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` 164}</pre> 165</div> 166 167<div class="method"> 168 <code class="details" id="list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code> 169 <pre>Lists information about the supported locations for this service. 170 171Args: 172 name: string, The resource that owns the locations collection, if applicable. (required) 173 filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in [AIP-160](https://google.aip.dev/160). 174 pageSize: integer, The maximum number of results to return. If not set, the service selects a default. 175 pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. 176 x__xgafv: string, V1 error format. 177 Allowed values 178 1 - v1 error format 179 2 - v2 error format 180 181Returns: 182 An object of the form: 183 184 { # The response message for Locations.ListLocations. 185 "locations": [ # A list of locations that matches the specified filter in the request. 186 { # A resource that represents Google Cloud Platform location. 187 "displayName": "A String", # The friendly name for this location, typically a nearby city name. For example, "Tokyo". 188 "labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} 189 "a_key": "A String", 190 }, 191 "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`. 192 "metadata": { # Service-specific metadata. For example the available capacity at the given location. 193 "a_key": "", # Properties of the object. Contains field @type with type URL. 194 }, 195 "name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` 196 }, 197 ], 198 "nextPageToken": "A String", # The standard List next-page token. 199}</pre> 200</div> 201 202<div class="method"> 203 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 204 <pre>Retrieves the next page of results. 205 206Args: 207 previous_request: The request for the previous page. (required) 208 previous_response: The response from the request for the previous page. (required) 209 210Returns: 211 A request object that you can call 'execute()' on to request the next 212 page. Returns None if there are no more items in the collection. 213 </pre> 214</div> 215 216</body></html>