feat: [google-maps-solar] Add experiments param to endpoints for access to pre-GA features (#14242)

BEGIN_COMMIT_OVERRIDE
feat: Add `experiments` param to endpoints for access to pre-GA features
feat: Add new `ImageryQuality` tier for allowing satellite-based Solar
API results
docs: Add more detailed descriptions for each `ImageryQuality` tier
END_COMMIT_OVERRIDE

- [ ] Regenerate this pull request now.

feat: Add new `ImageryQuality` tier for allowing satellite-based Solar
API results
docs: Add more detailed descriptions for each `ImageryQuality` tier

PiperOrigin-RevId: 795589896

Source-Link:
googleapis/googleapis@74853d7

Source-Link:
googleapis/googleapis-gen@4390cc0
Copy-Tag:
eyJwIjoicGFja2FnZXMvZ29vZ2xlLW1hcHMtc29sYXIvLk93bEJvdC55YW1sIiwiaCI6IjQzOTBjYzBmZTljYmRmZGVhZWM3NDdiMDFhMDFhMDVmMThiOWIwMDMifQ==

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
Co-authored-by: ohmayr <[email protected]>

Author: gcf-owl-bot[bot]

packages/google-maps-solar/google/maps/solar/__init__.py

@@ -25,6 +25,7 @@
     CashPurchaseSavings,
     DataLayers,
     DataLayerView,
+    Experiment,
     FinancedPurchaseSavings,
     FinancialAnalysis,
     FinancialDetails,
@@ -66,6 +67,7 @@
     "SolarPanelConfig",
     "SolarPotential",
     "DataLayerView",
+    "Experiment",
     "ImageryQuality",
     "SolarPanelOrientation",
 )

packages/google-maps-solar/google/maps/solar/gapic_version.py

@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-__version__ = "0.1.8"  # {x-release-please-version}
+__version__ = "0.0.0"  # {x-release-please-version}

packages/google-maps-solar/google/maps/solar_v1/__init__.py

@@ -24,6 +24,7 @@
     CashPurchaseSavings,
     DataLayers,
     DataLayerView,
+    Experiment,
     FinancedPurchaseSavings,
     FinancialAnalysis,
     FinancialDetails,
@@ -49,6 +50,7 @@
     "CashPurchaseSavings",
     "DataLayerView",
     "DataLayers",
+    "Experiment",
     "FinancedPurchaseSavings",
     "FinancialAnalysis",
     "FinancialDetails",

packages/google-maps-solar/google/maps/solar_v1/gapic_version.py

@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-__version__ = "0.1.8"  # {x-release-please-version}
+__version__ = "0.0.0"  # {x-release-please-version}

packages/google-maps-solar/google/maps/solar_v1/services/solar/async_client.py

@@ -289,9 +289,9 @@ async def find_closest_building_insights(
         timeout: Union[float, object] = gapic_v1.method.DEFAULT,
         metadata: Sequence[Tuple[str, Union[str, bytes]]] = (),
     ) -> solar_service.BuildingInsights:
-        r"""Locates the closest building to a query point. Returns an error
-        with code ``NOT_FOUND`` if there are no buildings within
-        approximately 50m of the query point.
+        r"""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.
 
         .. code-block:: python
 

packages/google-maps-solar/google/maps/solar_v1/services/solar/client.py

@@ -697,9 +697,9 @@ def find_closest_building_insights(
         timeout: Union[float, object] = gapic_v1.method.DEFAULT,
         metadata: Sequence[Tuple[str, Union[str, bytes]]] = (),
     ) -> solar_service.BuildingInsights:
-        r"""Locates the closest building to a query point. Returns an error
-        with code ``NOT_FOUND`` if there are no buildings within
-        approximately 50m of the query point.
+        r"""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.
 
         .. code-block:: python
 

packages/google-maps-solar/google/maps/solar_v1/services/solar/transports/grpc.py

@@ -329,9 +329,9 @@ def find_closest_building_insights(
     ]:
         r"""Return a callable for the find closest building insights method over gRPC.
 
-        Locates the closest building to a query point. Returns an error
-        with code ``NOT_FOUND`` if there are no buildings within
-        approximately 50m of the query point.
+        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.
 
         Returns:
             Callable[[~.FindClosestBuildingInsightsRequest],

packages/google-maps-solar/google/maps/solar_v1/services/solar/transports/grpc_asyncio.py

@@ -337,9 +337,9 @@ def find_closest_building_insights(
     ]:
         r"""Return a callable for the find closest building insights method over gRPC.
 
-        Locates the closest building to a query point. Returns an error
-        with code ``NOT_FOUND`` if there are no buildings within
-        approximately 50m of the query point.
+        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.
 
         Returns:
             Callable[[~.FindClosestBuildingInsightsRequest],

packages/google-maps-solar/google/maps/solar_v1/types/__init__.py

@@ -18,6 +18,7 @@
     CashPurchaseSavings,
     DataLayers,
     DataLayerView,
+    Experiment,
     FinancedPurchaseSavings,
     FinancialAnalysis,
     FinancialDetails,
@@ -57,6 +58,7 @@
     "SolarPanelConfig",
     "SolarPotential",
     "DataLayerView",
+    "Experiment",
     "ImageryQuality",
     "SolarPanelOrientation",
 )

packages/google-maps-solar/google/maps/solar_v1/types/solar_service.py

@@ -28,6 +28,7 @@
         "DataLayerView",
         "ImageryQuality",
         "SolarPanelOrientation",
+        "Experiment",
         "FindClosestBuildingInsightsRequest",
         "LatLngBox",
         "BuildingInsights",
@@ -88,19 +89,25 @@ class ImageryQuality(proto.Enum):
         IMAGERY_QUALITY_UNSPECIFIED (0):
             No quality is known.
         HIGH (1):
-            The underlying imagery and DSM data were
-            processed at 0.1 m/pixel.
+            Solar data is derived from aerial imagery
+            captured at low-altitude and processed at 0.1
+            m/pixel.
         MEDIUM (2):
-            The underlying imagery and DSM data were
-            processed at 0.25 m/pixel.
+            Solar data is derived from enhanced aerial
+            imagery captured at high-altitude and processed
+            at 0.25 m/pixel.
         LOW (3):
-            The underlying imagery and DSM data were
-            processed at 0.5 m/pixel.
+            Solar data is derived from enhanced satellite
+            imagery processed at 0.25 m/pixel.
+        BASE (4):
+            Solar data is derived from enhanced satellite
+            imagery processed at 0.25 m/pixel.
     """
     IMAGERY_QUALITY_UNSPECIFIED = 0
     HIGH = 1
     MEDIUM = 2
     LOW = 3
+    BASE = 4
 
 
 class SolarPanelOrientation(proto.Enum):
@@ -123,6 +130,21 @@ class SolarPanelOrientation(proto.Enum):
     PORTRAIT = 2
 
 
+class Experiment(proto.Enum):
+    r"""Specifies pre-GA experiments that can be enabled in the API.
+
+    Values:
+        EXPERIMENT_UNSPECIFIED (0):
+            No experiments are specified.
+        EXPANDED_COVERAGE (1):
+            Expands the geographic region available for querying solar
+            data. For more information, see `Expanded
+            Coverage <https://developers.google.com/maps/documentation/solar/expanded-coverage>`__.
+    """
+    EXPERIMENT_UNSPECIFIED = 0
+    EXPANDED_COVERAGE = 1
+
+
 class FindClosestBuildingInsightsRequest(proto.Message):
     r"""Request message for ``Solar.FindClosestBuildingInsights``.
 
@@ -146,6 +168,9 @@ class FindClosestBuildingInsightsRequest(proto.Message):
             interpreted as the exact required quality and only
             ``MEDIUM`` quality imagery is returned if
             ``required_quality`` is set to ``MEDIUM``.
+        experiments (MutableSequence[google.maps.solar_v1.types.Experiment]):
+            Optional. Specifies the pre-GA features to
+            enable.
     """
 
     location: latlng_pb2.LatLng = proto.Field(
@@ -162,6 +187,11 @@ class FindClosestBuildingInsightsRequest(proto.Message):
         proto.BOOL,
         number=4,
     )
+    experiments: MutableSequence["Experiment"] = proto.RepeatedField(
+        proto.ENUM,
+        number=5,
+        enum="Experiment",
+    )
 
 
 class LatLngBox(proto.Message):
@@ -194,7 +224,7 @@ class BuildingInsights(proto.Message):
     Attributes:
         name (str):
             The resource name for the building, of the format
-            ``building/<place ID>``.
+            ``buildings/{place_id}``.
         center (google.type.latlng_pb2.LatLng):
             A point near the center of the building.
         bounding_box (google.maps.solar_v1.types.LatLngBox):
@@ -1123,6 +1153,9 @@ class GetDataLayersRequest(proto.Message):
             interpreted as the exact required quality and only
             ``MEDIUM`` quality imagery is returned if
             ``required_quality`` is set to ``MEDIUM``.
+        experiments (MutableSequence[google.maps.solar_v1.types.Experiment]):
+            Optional. Specifies the pre-GA experiments to
+            enable.
     """
 
     location: latlng_pb2.LatLng = proto.Field(
@@ -1152,6 +1185,11 @@ class GetDataLayersRequest(proto.Message):
         proto.BOOL,
         number=7,
     )
+    experiments: MutableSequence["Experiment"] = proto.RepeatedField(
+        proto.ENUM,
+        number=8,
+        enum="Experiment",
+    )
 
 
 class DataLayers(proto.Message):