com.google.maps.solar.v1.SolarClient Maven / Gradle / Ivy
Show all versions of google-maps-solar Show documentation
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.maps.solar.v1;
import com.google.api.HttpBody;
import com.google.api.gax.core.BackgroundResource;
import com.google.api.gax.rpc.UnaryCallable;
import com.google.maps.solar.v1.stub.SolarStub;
import com.google.maps.solar.v1.stub.SolarStubSettings;
import java.io.IOException;
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;
// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
* Service Description: Service definition for the Solar API.
*
* This class provides the ability to make remote calls to the backing service through method
* calls that map to API methods. Sample code to get started:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SolarClient solarClient = SolarClient.create()) {
* FindClosestBuildingInsightsRequest request =
* FindClosestBuildingInsightsRequest.newBuilder()
* .setLocation(LatLng.newBuilder().build())
* .setRequiredQuality(ImageryQuality.forNumber(0))
* .setExactQualityRequired(true)
* .build();
* BuildingInsights response = solarClient.findClosestBuildingInsights(request);
* }
* }
*
* Note: close() needs to be called on the SolarClient object to clean up resources such as
* threads. In the example above, try-with-resources is used, which automatically calls close().
*
*
* Methods
*
* Method
* Description
* Method Variants
*
*
* FindClosestBuildingInsights
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.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* findClosestBuildingInsights(FindClosestBuildingInsightsRequest request)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* findClosestBuildingInsightsCallable()
*
*
*
*
* GetDataLayers
Gets solar information for a region surrounding a location. Returns an error with code `NOT_FOUND` if the location is outside the coverage area.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* getDataLayers(GetDataLayersRequest request)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* getDataLayersCallable()
*
*
*
*
* GetGeoTiff
Returns an image by its ID.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* getGeoTiff(GetGeoTiffRequest request)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* getGeoTiffCallable()
*
*
*
*
*
* See the individual methods for example code.
*
*
Many parameters require resource names to be formatted in a particular way. To assist with
* these names, this class includes a format method for each type of name, and additionally a parse
* method to extract the individual identifiers contained within names that are returned.
*
*
This class can be customized by passing in a custom instance of SolarSettings to create(). For
* example:
*
*
To customize credentials:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* SolarSettings solarSettings =
* SolarSettings.newBuilder()
* .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
* .build();
* SolarClient solarClient = SolarClient.create(solarSettings);
* }
*
* To customize the endpoint:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* SolarSettings solarSettings = SolarSettings.newBuilder().setEndpoint(myEndpoint).build();
* SolarClient solarClient = SolarClient.create(solarSettings);
* }
*
* To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over
* the wire:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* SolarSettings solarSettings = SolarSettings.newHttpJsonBuilder().build();
* SolarClient solarClient = SolarClient.create(solarSettings);
* }
*
* Please refer to the GitHub repository's samples for more quickstart code snippets.
*/
@Generated("by gapic-generator-java")
public class SolarClient implements BackgroundResource {
private final SolarSettings settings;
private final SolarStub stub;
/** Constructs an instance of SolarClient with default settings. */
public static final SolarClient create() throws IOException {
return create(SolarSettings.newBuilder().build());
}
/**
* Constructs an instance of SolarClient, using the given settings. The channels are created based
* on the settings passed in, or defaults for any settings that are not set.
*/
public static final SolarClient create(SolarSettings settings) throws IOException {
return new SolarClient(settings);
}
/**
* Constructs an instance of SolarClient, using the given stub for making calls. This is for
* advanced usage - prefer using create(SolarSettings).
*/
public static final SolarClient create(SolarStub stub) {
return new SolarClient(stub);
}
/**
* Constructs an instance of SolarClient, using the given settings. This is protected so that it
* is easy to make a subclass, but otherwise, the static factory methods should be preferred.
*/
protected SolarClient(SolarSettings settings) throws IOException {
this.settings = settings;
this.stub = ((SolarStubSettings) settings.getStubSettings()).createStub();
}
protected SolarClient(SolarStub stub) {
this.settings = null;
this.stub = stub;
}
public final SolarSettings getSettings() {
return settings;
}
public SolarStub getStub() {
return stub;
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* 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.
*
*
Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SolarClient solarClient = SolarClient.create()) {
* FindClosestBuildingInsightsRequest request =
* FindClosestBuildingInsightsRequest.newBuilder()
* .setLocation(LatLng.newBuilder().build())
* .setRequiredQuality(ImageryQuality.forNumber(0))
* .setExactQualityRequired(true)
* .build();
* BuildingInsights response = solarClient.findClosestBuildingInsights(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final BuildingInsights findClosestBuildingInsights(
FindClosestBuildingInsightsRequest request) {
return findClosestBuildingInsightsCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* 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.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SolarClient solarClient = SolarClient.create()) {
* FindClosestBuildingInsightsRequest request =
* FindClosestBuildingInsightsRequest.newBuilder()
* .setLocation(LatLng.newBuilder().build())
* .setRequiredQuality(ImageryQuality.forNumber(0))
* .setExactQualityRequired(true)
* .build();
* ApiFuture future =
* solarClient.findClosestBuildingInsightsCallable().futureCall(request);
* // Do something.
* BuildingInsights response = future.get();
* }
* }
*/
public final UnaryCallable
findClosestBuildingInsightsCallable() {
return stub.findClosestBuildingInsightsCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets solar information for a region surrounding a location. Returns an error with code
* `NOT_FOUND` if the location is outside the coverage area.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SolarClient solarClient = SolarClient.create()) {
* GetDataLayersRequest request =
* GetDataLayersRequest.newBuilder()
* .setLocation(LatLng.newBuilder().build())
* .setRadiusMeters(1254190679)
* .setView(DataLayerView.forNumber(0))
* .setRequiredQuality(ImageryQuality.forNumber(0))
* .setPixelSizeMeters(-1623742513)
* .setExactQualityRequired(true)
* .build();
* DataLayers response = solarClient.getDataLayers(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final DataLayers getDataLayers(GetDataLayersRequest request) {
return getDataLayersCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets solar information for a region surrounding a location. Returns an error with code
* `NOT_FOUND` if the location is outside the coverage area.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SolarClient solarClient = SolarClient.create()) {
* GetDataLayersRequest request =
* GetDataLayersRequest.newBuilder()
* .setLocation(LatLng.newBuilder().build())
* .setRadiusMeters(1254190679)
* .setView(DataLayerView.forNumber(0))
* .setRequiredQuality(ImageryQuality.forNumber(0))
* .setPixelSizeMeters(-1623742513)
* .setExactQualityRequired(true)
* .build();
* ApiFuture future = solarClient.getDataLayersCallable().futureCall(request);
* // Do something.
* DataLayers response = future.get();
* }
* }
*/
public final UnaryCallable getDataLayersCallable() {
return stub.getDataLayersCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns an image by its ID.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SolarClient solarClient = SolarClient.create()) {
* GetGeoTiffRequest request = GetGeoTiffRequest.newBuilder().setId("id3355").build();
* HttpBody response = solarClient.getGeoTiff(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final HttpBody getGeoTiff(GetGeoTiffRequest request) {
return getGeoTiffCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns an image by its ID.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SolarClient solarClient = SolarClient.create()) {
* GetGeoTiffRequest request = GetGeoTiffRequest.newBuilder().setId("id3355").build();
* ApiFuture future = solarClient.getGeoTiffCallable().futureCall(request);
* // Do something.
* HttpBody response = future.get();
* }
* }
*/
public final UnaryCallable getGeoTiffCallable() {
return stub.getGeoTiffCallable();
}
@Override
public final void close() {
stub.close();
}
@Override
public void shutdown() {
stub.shutdown();
}
@Override
public boolean isShutdown() {
return stub.isShutdown();
}
@Override
public boolean isTerminated() {
return stub.isTerminated();
}
@Override
public void shutdownNow() {
stub.shutdownNow();
}
@Override
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException {
return stub.awaitTermination(duration, unit);
}
}