Show / Hide Table of Contents

Class DataLayersResource.GetRequest

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

Inheritance
object
ClientServiceRequest
ClientServiceRequest<DataLayers>
SolarBaseServiceRequest<DataLayers>
DataLayersResource.GetRequest
Implements
IClientServiceRequest<DataLayers>
IClientServiceRequest
Inherited Members
SolarBaseServiceRequest<DataLayers>.Xgafv
SolarBaseServiceRequest<DataLayers>.AccessToken
SolarBaseServiceRequest<DataLayers>.Alt
SolarBaseServiceRequest<DataLayers>.Callback
SolarBaseServiceRequest<DataLayers>.Fields
SolarBaseServiceRequest<DataLayers>.Key
SolarBaseServiceRequest<DataLayers>.OauthToken
SolarBaseServiceRequest<DataLayers>.PrettyPrint
SolarBaseServiceRequest<DataLayers>.QuotaUser
SolarBaseServiceRequest<DataLayers>.UploadType
SolarBaseServiceRequest<DataLayers>.UploadProtocol
ClientServiceRequest<DataLayers>.Execute()
ClientServiceRequest<DataLayers>.ExecuteAsStream()
ClientServiceRequest<DataLayers>.ExecuteAsync()
ClientServiceRequest<DataLayers>.ExecuteAsync(CancellationToken)
ClientServiceRequest<DataLayers>.ExecuteAsStreamAsync()
ClientServiceRequest<DataLayers>.ExecuteAsStreamAsync(CancellationToken)
ClientServiceRequest<DataLayers>.CreateRequest(bool?)
ClientServiceRequest<DataLayers>.GenerateRequestUri()
ClientServiceRequest<DataLayers>.GetBody()
ClientServiceRequest<DataLayers>.GetDefaultETagAction(string)
ClientServiceRequest<DataLayers>.ETagAction
ClientServiceRequest<DataLayers>.ModifyRequest
ClientServiceRequest<DataLayers>.ValidateParameters
ClientServiceRequest<DataLayers>.ApiVersion
ClientServiceRequest<DataLayers>.RequestParameters
ClientServiceRequest<DataLayers>.Service
ClientServiceRequest._unsuccessfulResponseHandlers
ClientServiceRequest._exceptionHandlers
ClientServiceRequest._executeInterceptors
ClientServiceRequest.AddUnsuccessfulResponseHandler(IHttpUnsuccessfulResponseHandler)
ClientServiceRequest.AddExceptionHandler(IHttpExceptionHandler)
ClientServiceRequest.AddExecuteInterceptor(IHttpExecuteInterceptor)
ClientServiceRequest.Credential
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Solar.v1
Assembly: Google.Apis.Solar.v1.dll
Syntax
public class DataLayersResource.GetRequest : SolarBaseServiceRequest<DataLayers>, IClientServiceRequest<DataLayers>, IClientServiceRequest

Constructors

GetRequest(IClientService)

Constructs a new Get request.

Declaration
public GetRequest(IClientService service)
Parameters
Type Name Description
IClientService service

Properties

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.

Declaration
[RequestParameter("exactQualityRequired", RequestParameterType.Query)]
public virtual bool? ExactQualityRequired { get; set; }
Property Value
Type Description
bool?

Experiments

Optional. Specifies the pre-GA experiments to enable.

Declaration
[RequestParameter("experiments", RequestParameterType.Query)]
public virtual DataLayersResource.GetRequest.ExperimentsEnum? Experiments { get; set; }
Property Value
Type Description
DataLayersResource.GetRequest.ExperimentsEnum?
Remarks

Use this property to set a single value for the parameter, or ExperimentsList to set multiple values. Do not set both properties.

ExperimentsList

Optional. Specifies the pre-GA experiments to enable.

Declaration
[RequestParameter("experiments", RequestParameterType.Query)]
public virtual Repeatable<DataLayersResource.GetRequest.ExperimentsEnum> ExperimentsList { get; set; }
Property Value
Type Description
Repeatable<DataLayersResource.GetRequest.ExperimentsEnum>
Remarks

Use this property to set one or more values for the parameter. Do not set both this property and Experiments.

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides
ClientServiceRequest<DataLayers>.HttpMethod

LocationLatitude

The latitude in degrees. It must be in the range [-90.0, +90.0].

Declaration
[RequestParameter("location.latitude", RequestParameterType.Query)]
public virtual double? LocationLatitude { get; set; }
Property Value
Type Description
double?

LocationLongitude

The longitude in degrees. It must be in the range [-180.0, +180.0].

Declaration
[RequestParameter("location.longitude", RequestParameterType.Query)]
public virtual double? LocationLongitude { get; set; }
Property Value
Type Description
double?

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides
ClientServiceRequest<DataLayers>.MethodName

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.

Declaration
[RequestParameter("pixelSizeMeters", RequestParameterType.Query)]
public virtual float? PixelSizeMeters { get; set; }
Property Value
Type Description
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 &lt;= pixel_size_meters * 1000. * However, for values over 175m, the DataLayerView in the request must not include monthly flux or hourly shade.

Declaration
[RequestParameter("radiusMeters", RequestParameterType.Query)]
public virtual float? RadiusMeters { get; set; }
Property Value
Type Description
float?

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.

Declaration
[RequestParameter("requiredQuality", RequestParameterType.Query)]
public virtual DataLayersResource.GetRequest.RequiredQualityEnum? RequiredQuality { get; set; }
Property Value
Type Description
DataLayersResource.GetRequest.RequiredQualityEnum?

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides
ClientServiceRequest<DataLayers>.RestPath

View

Optional. The desired subset of the data to return.

Declaration
[RequestParameter("view", RequestParameterType.Query)]
public virtual DataLayersResource.GetRequest.ViewEnum? View { get; set; }
Property Value
Type Description
DataLayersResource.GetRequest.ViewEnum?

Methods

InitParameters()

Initializes Get parameter list.

Declaration
protected override void InitParameters()
Overrides
SolarBaseServiceRequest<DataLayers>.InitParameters()

Implements

IClientServiceRequest<TResponse>
IClientServiceRequest
In this article
Back to top Generated by DocFX