[e3d4e0a] | 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 |
|
---|
| 18 | namespace Google\Service\SemanticTile\Resource;
|
---|
| 19 |
|
---|
| 20 | use Google\Service\SemanticTile\FeatureTile;
|
---|
| 21 |
|
---|
| 22 | /**
|
---|
| 23 | * The "featuretiles" collection of methods.
|
---|
| 24 | * Typical usage is:
|
---|
| 25 | * <code>
|
---|
| 26 | * $vectortileService = new Google\Service\SemanticTile(...);
|
---|
| 27 | * $featuretiles = $vectortileService->featuretiles;
|
---|
| 28 | * </code>
|
---|
| 29 | */
|
---|
| 30 | class Featuretiles extends \Google\Service\Resource
|
---|
| 31 | {
|
---|
| 32 | /**
|
---|
| 33 | * Gets a feature tile by its tile resource name. (featuretiles.get)
|
---|
| 34 | *
|
---|
| 35 | * @param string $name Required. Resource name of the tile. The tile resource
|
---|
| 36 | * name is prefixed by its collection ID `tiles/` followed by the resource ID,
|
---|
| 37 | * which encodes the tile's global x and y coordinates and zoom level as `@,,z`.
|
---|
| 38 | * For example, `tiles/@1,2,3z`.
|
---|
| 39 | * @param array $optParams Optional parameters.
|
---|
| 40 | *
|
---|
| 41 | * @opt_param bool alwaysIncludeBuildingFootprints Flag indicating whether the
|
---|
| 42 | * returned tile will always contain 2.5D footprints for structures. If
|
---|
| 43 | * enabled_modeled_volumes is set, this will mean that structures will have both
|
---|
| 44 | * their 3D models and 2.5D footprints returned.
|
---|
| 45 | * @opt_param string clientInfo.apiClient API client name and version. For
|
---|
| 46 | * example, the SDK calling the API. The exact format is up to the client.
|
---|
| 47 | * @opt_param string clientInfo.applicationId Application ID, such as the
|
---|
| 48 | * package name on Android and the bundle identifier on iOS platforms.
|
---|
| 49 | * @opt_param string clientInfo.applicationVersion Application version number,
|
---|
| 50 | * such as "1.2.3". The exact format is application-dependent.
|
---|
| 51 | * @opt_param string clientInfo.deviceModel Device model as reported by the
|
---|
| 52 | * device. The exact format is platform-dependent.
|
---|
| 53 | * @opt_param string clientInfo.operatingSystem Operating system name and
|
---|
| 54 | * version as reported by the OS. For example, "Mac OS X 10.10.4". The exact
|
---|
| 55 | * format is platform-dependent.
|
---|
| 56 | * @opt_param string clientInfo.platform Platform where the application is
|
---|
| 57 | * running.
|
---|
| 58 | * @opt_param string clientInfo.userId Required. A client-generated user ID. The
|
---|
| 59 | * ID should be generated and persisted during the first user session or
|
---|
| 60 | * whenever a pre-existing ID is not found. The exact format is up to the
|
---|
| 61 | * client. This must be non-empty in a GetFeatureTileRequest (whether via the
|
---|
| 62 | * header or GetFeatureTileRequest.client_info).
|
---|
| 63 | * @opt_param string clientTileVersionId Optional version id identifying the
|
---|
| 64 | * tile that is already in the client's cache. This field should be populated
|
---|
| 65 | * with the most recent version_id value returned by the API for the requested
|
---|
| 66 | * tile. If the version id is empty the server always returns a newly rendered
|
---|
| 67 | * tile. If it is provided the server checks if the tile contents would be
|
---|
| 68 | * identical to one that's already on the client, and if so, returns a stripped-
|
---|
| 69 | * down response tile with STATUS_OK_DATA_UNCHANGED instead.
|
---|
| 70 | * @opt_param bool enableDetailedHighwayTypes Flag indicating whether detailed
|
---|
| 71 | * highway types should be returned. If this is set, the
|
---|
| 72 | * CONTROLLED_ACCESS_HIGHWAY type may be returned. If not, then these highways
|
---|
| 73 | * will have the generic HIGHWAY type. This exists for backwards compatibility
|
---|
| 74 | * reasons.
|
---|
| 75 | * @opt_param bool enableFeatureNames Flag indicating whether human-readable
|
---|
| 76 | * names should be returned for features. If this is set, the display_name field
|
---|
| 77 | * on the feature will be filled out.
|
---|
| 78 | * @opt_param bool enableModeledVolumes Flag indicating whether 3D building
|
---|
| 79 | * models should be enabled. If this is set structures will be returned as 3D
|
---|
| 80 | * modeled volumes rather than 2.5D extruded areas where possible.
|
---|
| 81 | * @opt_param bool enablePoliticalFeatures Flag indicating whether political
|
---|
| 82 | * features should be returned.
|
---|
| 83 | * @opt_param bool enablePrivateRoads Flag indicating whether the returned tile
|
---|
| 84 | * will contain road features that are marked private. Private roads are
|
---|
| 85 | * indicated by the Feature.segment_info.road_info.is_private field.
|
---|
| 86 | * @opt_param bool enableUnclippedBuildings Flag indicating whether unclipped
|
---|
| 87 | * buildings should be returned. If this is set, building render ops will extend
|
---|
| 88 | * beyond the tile boundary. Buildings will only be returned on the tile that
|
---|
| 89 | * contains their centroid.
|
---|
| 90 | * @opt_param string languageCode Required. The BCP-47 language code
|
---|
| 91 | * corresponding to the language in which the name was requested, such as "en-
|
---|
| 92 | * US" or "sr-Latn". For more information, see
|
---|
| 93 | * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
|
---|
| 94 | * @opt_param string regionCode Required. The Unicode country/region code (CLDR)
|
---|
| 95 | * of the location from which the request is coming from, such as "US" and
|
---|
| 96 | * "419". For more information, see
|
---|
| 97 | * http://www.unicode.org/reports/tr35/#unicode_region_subtag.
|
---|
| 98 | * @return FeatureTile
|
---|
| 99 | */
|
---|
| 100 | public function get($name, $optParams = [])
|
---|
| 101 | {
|
---|
| 102 | $params = ['name' => $name];
|
---|
| 103 | $params = array_merge($params, $optParams);
|
---|
| 104 | return $this->call('get', [$params], FeatureTile::class);
|
---|
| 105 | }
|
---|
| 106 | }
|
---|
| 107 |
|
---|
| 108 | // Adding a class alias for backwards compatibility with the previous class name.
|
---|
| 109 | class_alias(Featuretiles::class, 'Google_Service_SemanticTile_Resource_Featuretiles');
|
---|