GoogleApi.Solar.V1.Api.DataLayers (google_api_solar v0.4.2)

View Source

API calls for all endpoints tagged DataLayers.

Summary

Functions

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

Functions

solar_data_layers_get(connection, optional_params \\ [], opts \\ [])

@spec solar_data_layers_get(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.Solar.V1.Model.DataLayers.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Solar.V1.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :exactQualityRequired (type: boolean()) - 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.
    • :experiments (type: list(String.t)) - Optional. Specifies the pre-GA experiments to enable.
    • :"location.latitude" (type: float()) - The latitude in degrees. It must be in the range [-90.0, +90.0].
    • :"location.longitude" (type: float()) - The longitude in degrees. It must be in the range [-180.0, +180.0].
    • :pixelSizeMeters (type: number()) - 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.
    • :radiusMeters (type: number()) - 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.
    • :requiredQuality (type: String.t) - 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.
    • :view (type: String.t) - Optional. The desired subset of the data to return.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Solar.V1.Model.DataLayers{}} on success
  • {:error, info} on failure