source: vendor/google/apiclient-services/src/Solar/Resource/DataLayers.php

Last change on this file was e3d4e0a, checked in by Vlado 222039 <vlado.popovski@…>, 12 days ago

Upload project files

  • Property mode set to 100644
File size: 3.6 KB
Line 
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\Solar\Resource;
19
20use Google\Service\Solar\DataLayers as DataLayersModel;
21
22/**
23 * The "dataLayers" collection of methods.
24 * Typical usage is:
25 * <code>
26 * $solarService = new Google\Service\Solar(...);
27 * $dataLayers = $solarService->dataLayers;
28 * </code>
29 */
30class DataLayers extends \Google\Service\Resource
31{
32 /**
33 * Gets solar information for a region surrounding a location. Returns an error
34 * with code `NOT_FOUND` if the location is outside the coverage area.
35 * (dataLayers.get)
36 *
37 * @param array $optParams Optional parameters.
38 *
39 * @opt_param bool exactQualityRequired Optional. Whether to require exact
40 * quality of the imagery. If set to false, the `required_quality` field is
41 * interpreted as the minimum required quality, such that HIGH quality imagery
42 * may be returned when `required_quality` is set to MEDIUM. If set to true,
43 * `required_quality` is interpreted as the exact required quality and only
44 * `MEDIUM` quality imagery is returned if `required_quality` is set to
45 * `MEDIUM`.
46 * @opt_param string experiments Optional. Specifies the pre-GA experiments to
47 * enable.
48 * @opt_param double location.latitude The latitude in degrees. It must be in
49 * the range [-90.0, +90.0].
50 * @opt_param double location.longitude The longitude in degrees. It must be in
51 * the range [-180.0, +180.0].
52 * @opt_param float pixelSizeMeters Optional. The minimum scale, in meters per
53 * pixel, of the data to return. Values of 0.1 (the default, if this field is
54 * not set explicitly), 0.25, 0.5, and 1.0 are supported. Imagery components
55 * whose normal resolution is less than `pixel_size_meters` will be returned at
56 * the resolution specified by `pixel_size_meters`; imagery components whose
57 * normal resolution is equal to or greater than `pixel_size_meters` will be
58 * returned at that normal resolution.
59 * @opt_param float radiusMeters Required. The radius, in meters, defining the
60 * region surrounding that centre point for which data should be returned. The
61 * limitations on this value are: * Any value up to 100m can always be
62 * specified. * Values over 100m can be specified, as long as `radius_meters` <=
63 * `pixel_size_meters * 1000`. * However, for values over 175m, the
64 * `DataLayerView` in the request must not include monthly flux or hourly shade.
65 * @opt_param string requiredQuality Optional. The minimum quality level allowed
66 * in the results. No result with lower quality than this will be returned. Not
67 * specifying this is equivalent to restricting to HIGH quality only.
68 * @opt_param string view Optional. The desired subset of the data to return.
69 * @return DataLayersModel
70 * @throws \Google\Service\Exception
71 */
72 public function get($optParams = [])
73 {
74 $params = [];
75 $params = array_merge($params, $optParams);
76 return $this->call('get', [$params], DataLayersModel::class);
77 }
78}
79
80// Adding a class alias for backwards compatibility with the previous class name.
81class_alias(DataLayers::class, 'Google_Service_Solar_Resource_DataLayers');
Note: See TracBrowser for help on using the repository browser.