1<?php
2/*
3 * Copyright 2014 Google Inc.
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
6 * use this file except in compliance with the License. You may obtain a copy of
7 * the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
13 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
14 * License for the specific language governing permissions and limitations under
15 * the License.
16 */
17
18namespace Google\Service\Document\Resource;
19
20use Google\Service\Document\GoogleCloudDocumentaiV1FetchProcessorTypesResponse;
21use Google\Service\Document\GoogleCloudLocationListLocationsResponse;
22use Google\Service\Document\GoogleCloudLocationLocation;
23
24/**
25 * The "locations" collection of methods.
26 * Typical usage is:
27 *  <code>
28 *   $documentaiService = new Google\Service\Document(...);
29 *   $locations = $documentaiService->locations;
30 *  </code>
31 */
32class ProjectsLocations extends \Google\Service\Resource
33{
34  /**
35   * Fetches processor types. Note that we do not use ListProcessorTypes here
36   * because it is not paginated. (locations.fetchProcessorTypes)
37   *
38   * @param string $parent Required. The project of processor type to list. The
39   * available processor types may depend on the allow-listing on projects.
40   * Format: `projects/{project}/locations/{location}`
41   * @param array $optParams Optional parameters.
42   * @return GoogleCloudDocumentaiV1FetchProcessorTypesResponse
43   */
44  public function fetchProcessorTypes($parent, $optParams = [])
45  {
46    $params = ['parent' => $parent];
47    $params = array_merge($params, $optParams);
48    return $this->call('fetchProcessorTypes', [$params], GoogleCloudDocumentaiV1FetchProcessorTypesResponse::class);
49  }
50  /**
51   * Gets information about a location. (locations.get)
52   *
53   * @param string $name Resource name for the location.
54   * @param array $optParams Optional parameters.
55   * @return GoogleCloudLocationLocation
56   */
57  public function get($name, $optParams = [])
58  {
59    $params = ['name' => $name];
60    $params = array_merge($params, $optParams);
61    return $this->call('get', [$params], GoogleCloudLocationLocation::class);
62  }
63  /**
64   * Lists information about the supported locations for this service.
65   * (locations.listProjectsLocations)
66   *
67   * @param string $name The resource that owns the locations collection, if
68   * applicable.
69   * @param array $optParams Optional parameters.
70   *
71   * @opt_param string filter A filter to narrow down results to a preferred
72   * subset. The filtering language accepts strings like `"displayName=tokyo"`,
73   * and is documented in more detail in [AIP-160](https://google.aip.dev/160).
74   * @opt_param int pageSize The maximum number of results to return. If not set,
75   * the service selects a default.
76   * @opt_param string pageToken A page token received from the `next_page_token`
77   * field in the response. Send that page token to receive the subsequent page.
78   * @return GoogleCloudLocationListLocationsResponse
79   */
80  public function listProjectsLocations($name, $optParams = [])
81  {
82    $params = ['name' => $name];
83    $params = array_merge($params, $optParams);
84    return $this->call('list', [$params], GoogleCloudLocationListLocationsResponse::class);
85  }
86}
87
88// Adding a class alias for backwards compatibility with the previous class name.
89class_alias(ProjectsLocations::class, 'Google_Service_Document_Resource_ProjectsLocations');
90