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

View Source

API calls for all endpoints tagged BuildingInsights.

Summary

Functions

Locates the building whose centroid is closest to a query point. Returns an error with code NOT_FOUND if there are no buildings within approximately 50m of the query point.

Functions

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

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

Locates the building whose centroid is closest to a query point. Returns an error with code NOT_FOUND if there are no buildings within approximately 50m of the query point.

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").
    • :experiments (type: list(String.t)) - Optional. Specifies the pre-GA features 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].
    • :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.
  • opts (type: keyword()) - Call options

Returns

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