• Home
• com.google.apis
• google-api-services-solar
• v1-rev20241211-2.0.0
• source code
• Solar.DataLayers.Get.html

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

target.apidocs.com.google.api.services.solar.v1.Solar.DataLayers.Get.html Maven / Gradle / Ivy

Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.solar.v1
Class Solar.DataLayers.Get



java.lang.Object


java.util.AbstractMap<String,Object>


com.google.api.client.util.GenericData


com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>


com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>


com.google.api.services.solar.v1.SolarRequest<DataLayers>


com.google.api.services.solar.v1.Solar.DataLayers.Get

















All Implemented Interfaces:
Cloneable, Map<String,Object>


Enclosing class:
Solar.DataLayers




public class Solar.DataLayers.Get
extends SolarRequest<DataLayers>











Nested Class Summary




Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
com.google.api.client.util.GenericData.Flags





Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>





Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>








Field Summary




Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
API_VERSION_HEADER, USER_AGENT_SUFFIX








Constructor Summary

Constructors 

Modifier
Constructor and Description


protected 
Get()
Gets solar information for a region surrounding a location.










Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


com.google.api.client.http.HttpRequest
buildHttpRequestUsingHead() 


com.google.api.client.http.HttpResponse
executeUsingHead() 


Boolean
getExactQualityRequired()
Optional.



List<String>
getExperiments()
Optional.



Double
getLocationLatitude()
The latitude in degrees.



Double
getLocationLongitude()
The longitude in degrees.



Float
getPixelSizeMeters()
Optional.



Float
getRadiusMeters()
Required.



String
getRequiredQuality()
Optional.



String
getView()
Optional.



Solar.DataLayers.Get
set(String parameterName,
   Object value) 


Solar.DataLayers.Get
set$Xgafv(String $Xgafv)
V1 error format.



Solar.DataLayers.Get
setAccessToken(String accessToken)
OAuth access token.



Solar.DataLayers.Get
setAlt(String alt)
Data format for response.



Solar.DataLayers.Get
setCallback(String callback)
JSONP



Solar.DataLayers.Get
setExactQualityRequired(Boolean exactQualityRequired)
Optional.



Solar.DataLayers.Get
setExperiments(List<String> experiments)
Optional.



Solar.DataLayers.Get
setFields(String fields)
Selector specifying which fields to include in a partial response.



Solar.DataLayers.Get
setKey(String key)
API key.



Solar.DataLayers.Get
setLocationLatitude(Double locationLatitude)
The latitude in degrees.



Solar.DataLayers.Get
setLocationLongitude(Double locationLongitude)
The longitude in degrees.



Solar.DataLayers.Get
setOauthToken(String oauthToken)
OAuth 2.0 token for the current user.



Solar.DataLayers.Get
setPixelSizeMeters(Float pixelSizeMeters)
Optional.



Solar.DataLayers.Get
setPrettyPrint(Boolean prettyPrint)
Returns response with indentations and line breaks.



Solar.DataLayers.Get
setQuotaUser(String quotaUser)
Available to use for quota purposes for server-side applications.



Solar.DataLayers.Get
setRadiusMeters(Float radiusMeters)
Required.



Solar.DataLayers.Get
setRequiredQuality(String requiredQuality)
Optional.



Solar.DataLayers.Get
setUploadProtocol(String uploadProtocol)
Upload protocol for media (e.g.



Solar.DataLayers.Get
setUploadType(String uploadType)
Legacy upload protocol for media (e.g.



Solar.DataLayers.Get
setView(String view)
Optional.







Methods inherited from class com.google.api.services.solar.v1.SolarRequest
get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, setDisableGZipContent, setRequestHeaders





Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest
getJsonContent, newExceptionOnError, queue





Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
buildHttpRequest, buildHttpRequestUrl, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream





Methods inherited from class com.google.api.client.util.GenericData
clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString





Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values





Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait





Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll














Constructor Detail





Get
protected Get()
Gets solar information for a region surrounding a location. Returns an error with code
 `NOT_FOUND` if the location is outside the coverage area.

 Create a request for the method "dataLayers.get".

 This request holds the parameters needed by the the solar server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation. 
 Solar.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be
 called to initialize this instance immediately after invoking the constructor. 

Since:
1.13










Method Detail





executeUsingHead
public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws IOException

Overrides:
executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<DataLayers>
Throws:
IOException








buildHttpRequestUsingHead
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException

Overrides:
buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<DataLayers>
Throws:
IOException








set$Xgafv
public Solar.DataLayers.Get set$Xgafv(String $Xgafv)
Description copied from class: SolarRequest
V1 error format.

Overrides:
set$Xgafv in class SolarRequest<DataLayers>








setAccessToken
public Solar.DataLayers.Get setAccessToken(String accessToken)
Description copied from class: SolarRequest
OAuth access token.

Overrides:
setAccessToken in class SolarRequest<DataLayers>








setAlt
public Solar.DataLayers.Get setAlt(String alt)
Description copied from class: SolarRequest
Data format for response.

Overrides:
setAlt in class SolarRequest<DataLayers>








setCallback
public Solar.DataLayers.Get setCallback(String callback)
Description copied from class: SolarRequest
JSONP

Overrides:
setCallback in class SolarRequest<DataLayers>








setFields
public Solar.DataLayers.Get setFields(String fields)
Description copied from class: SolarRequest
Selector specifying which fields to include in a partial response.

Overrides:
setFields in class SolarRequest<DataLayers>








setKey
public Solar.DataLayers.Get setKey(String key)
Description copied from class: SolarRequest
API key. Your API key identifies your project and provides you with API access, quota, and
 reports. Required unless you provide an OAuth 2.0 token.

Overrides:
setKey in class SolarRequest<DataLayers>








setOauthToken
public Solar.DataLayers.Get setOauthToken(String oauthToken)
Description copied from class: SolarRequest
OAuth 2.0 token for the current user.

Overrides:
setOauthToken in class SolarRequest<DataLayers>








setPrettyPrint
public Solar.DataLayers.Get setPrettyPrint(Boolean prettyPrint)
Description copied from class: SolarRequest
Returns response with indentations and line breaks.

Overrides:
setPrettyPrint in class SolarRequest<DataLayers>








setQuotaUser
public Solar.DataLayers.Get setQuotaUser(String quotaUser)
Description copied from class: SolarRequest
Available to use for quota purposes for server-side applications. Can be any arbitrary string
 assigned to a user, but should not exceed 40 characters.

Overrides:
setQuotaUser in class SolarRequest<DataLayers>








setUploadType
public Solar.DataLayers.Get setUploadType(String uploadType)
Description copied from class: SolarRequest
Legacy upload protocol for media (e.g. "media", "multipart").

Overrides:
setUploadType in class SolarRequest<DataLayers>








setUploadProtocol
public Solar.DataLayers.Get setUploadProtocol(String uploadProtocol)
Description copied from class: SolarRequest
Upload protocol for media (e.g. "raw", "multipart").

Overrides:
setUploadProtocol in class SolarRequest<DataLayers>








getExactQualityRequired
public Boolean getExactQualityRequired()
Optional. Whether to require exact quality of the imagery. If set to false, the `required_quality`
     field is interpreted as the minimum required quality, such that HIGH quality imagery may be
     returned when `required_quality` is set to MEDIUM. If set to true, `required_quality` is
     interpreted as the exact required quality and only `MEDIUM` quality imagery is returned if
     `required_quality` is set to `MEDIUM`.







setExactQualityRequired
public Solar.DataLayers.Get setExactQualityRequired(Boolean exactQualityRequired)
Optional. Whether to require exact quality of the imagery. If set to false, the
 `required_quality` field is interpreted as the minimum required quality, such that HIGH
 quality imagery may be returned when `required_quality` is set to MEDIUM. If set to true,
 `required_quality` is interpreted as the exact required quality and only `MEDIUM` quality
 imagery is returned if `required_quality` is set to `MEDIUM`.







getExperiments
public List<String> getExperiments()
Optional. Specifies the pre-GA experiments to enable.







setExperiments
public Solar.DataLayers.Get setExperiments(List<String> experiments)
Optional. Specifies the pre-GA experiments to enable.







getLocationLatitude
public Double getLocationLatitude()
The latitude in degrees. It must be in the range [-90.0, +90.0].







setLocationLatitude
public Solar.DataLayers.Get setLocationLatitude(Double locationLatitude)
The latitude in degrees. It must be in the range [-90.0, +90.0].







getLocationLongitude
public Double getLocationLongitude()
The longitude in degrees. It must be in the range [-180.0, +180.0].







setLocationLongitude
public Solar.DataLayers.Get setLocationLongitude(Double locationLongitude)
The longitude in degrees. It must be in the range [-180.0, +180.0].







getPixelSizeMeters
public Float getPixelSizeMeters()
Optional. The minimum scale, in meters per pixel, of the data to return. Values of 0.1 (the
     default, if this field is not set explicitly), 0.25, 0.5, and 1.0 are supported. Imagery components
     whose normal resolution is less than `pixel_size_meters` will be returned at the resolution
     specified by `pixel_size_meters`; imagery components whose normal resolution is equal to or greater
     than `pixel_size_meters` will be returned at that normal resolution.







setPixelSizeMeters
public Solar.DataLayers.Get setPixelSizeMeters(Float pixelSizeMeters)
Optional. The minimum scale, in meters per pixel, of the data to return. Values of 0.1 (the
 default, if this field is not set explicitly), 0.25, 0.5, and 1.0 are supported. Imagery
 components whose normal resolution is less than `pixel_size_meters` will be returned at the
 resolution specified by `pixel_size_meters`; imagery components whose normal resolution is
 equal to or greater than `pixel_size_meters` will be returned at that normal resolution.







getRadiusMeters
public Float getRadiusMeters()
Required. The radius, in meters, defining the region surrounding that centre point for which data
     should be returned. The limitations on this value are: * Any value up to 100m can always be
     specified. * Values over 100m can be specified, as long as `radius_meters` <= `pixel_size_meters *
     1000`. * However, for values over 175m, the `DataLayerView` in the request must not include monthly
     flux or hourly shade.







setRadiusMeters
public Solar.DataLayers.Get setRadiusMeters(Float radiusMeters)
Required. The radius, in meters, defining the region surrounding that centre point for
 which data should be returned. The limitations on this value are: * Any value up to 100m
 can always be specified. * Values over 100m can be specified, as long as `radius_meters` <=
 `pixel_size_meters * 1000`. * However, for values over 175m, the `DataLayerView` in the
 request must not include monthly flux or hourly shade.







getRequiredQuality
public String getRequiredQuality()
Optional. The minimum quality level allowed in the results. No result with lower quality than this
     will be returned. Not specifying this is equivalent to restricting to HIGH quality only.







setRequiredQuality
public Solar.DataLayers.Get setRequiredQuality(String requiredQuality)
Optional. The minimum quality level allowed in the results. No result with lower quality
 than this will be returned. Not specifying this is equivalent to restricting to HIGH
 quality only.







getView
public String getView()
Optional. The desired subset of the data to return.







setView
public Solar.DataLayers.Get setView(String view)
Optional. The desired subset of the data to return.







set
public Solar.DataLayers.Get set(String parameterName,
                                Object value)

Overrides:
set in class SolarRequest<DataLayers>














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2024 Google. All rights reserved.