Package com.google.cloud.vectorsearch.v1beta

Class DataObjectSearchServiceClient

java.lang.Object
com.google.cloud.vectorsearch.v1beta.DataObjectSearchServiceClient
All Implemented Interfaces:
BackgroundResource, AutoCloseable
@BetaApi @Generated("by gapic-generator-java") public class DataObjectSearchServiceClient extends Object implements BackgroundResource
Service Description: Service for searching data objects.

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: 


 // 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 (DataObjectSearchServiceClient dataObjectSearchServiceClient =
     DataObjectSearchServiceClient.create()) {
   AggregateDataObjectsRequest request =
       AggregateDataObjectsRequest.newBuilder()
           .setParent(CollectionName.of("[PROJECT]", "[LOCATION]", "[COLLECTION]").toString())
           .setFilter(Struct.newBuilder().build())
           .setAggregate(AggregationMethod.forNumber(0))
           .build();
   AggregateDataObjectsResponse response =
       dataObjectSearchServiceClient.aggregateDataObjects(request);
 }

Note: close() needs to be called on the DataObjectSearchServiceClient 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

SearchDataObjects

Searches data objects.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • searchDataObjects(SearchDataObjectsRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • searchDataObjectsPagedCallable()

  • searchDataObjectsCallable()

QueryDataObjects

Queries data objects.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • queryDataObjects(QueryDataObjectsRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • queryDataObjectsPagedCallable()

  • queryDataObjectsCallable()

AggregateDataObjects

Aggregates data objects.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • aggregateDataObjects(AggregateDataObjectsRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • aggregateDataObjectsCallable()

BatchSearchDataObjects

Batch searches data objects.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • batchSearchDataObjects(BatchSearchDataObjectsRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • batchSearchDataObjectsCallable()

ListLocations

Lists information about the supported locations for this service.

This method lists locations based on the resource scope provided inthe [ListLocationsRequest.name] field:

* **Global locations**: If `name` is empty, the method lists thepublic locations available to all projects. * **Project-specificlocations**: If `name` follows the format`projects/{project}`, the method lists locations visible to thatspecific project. This includes public, private, or otherproject-specific locations enabled for the project.

For gRPC and client library implementations, the resource name ispassed as the `name` field. For direct service calls, the resourcename isincorporated into the request path based on the specific serviceimplementation and version.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listLocations(ListLocationsRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listLocationsPagedCallable()

  • listLocationsCallable()

GetLocation

Gets information about a location.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getLocation(GetLocationRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getLocationCallable()

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 DataObjectSearchServiceSettings to create(). For example:

To customize credentials: 


 // 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
 DataObjectSearchServiceSettings dataObjectSearchServiceSettings =
     DataObjectSearchServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 DataObjectSearchServiceClient dataObjectSearchServiceClient =
     DataObjectSearchServiceClient.create(dataObjectSearchServiceSettings);

To customize the endpoint: 


 // 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
 DataObjectSearchServiceSettings dataObjectSearchServiceSettings =
     DataObjectSearchServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 DataObjectSearchServiceClient dataObjectSearchServiceClient =
     DataObjectSearchServiceClient.create(dataObjectSearchServiceSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire: 


 // 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
 DataObjectSearchServiceSettings dataObjectSearchServiceSettings =
     DataObjectSearchServiceSettings.newHttpJsonBuilder().build();
 DataObjectSearchServiceClient dataObjectSearchServiceClient =
     DataObjectSearchServiceClient.create(dataObjectSearchServiceSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

  • Constructor Details

    • DataObjectSearchServiceClient

      protected DataObjectSearchServiceClient(DataObjectSearchServiceSettings settings) throws IOException
      Constructs an instance of DataObjectSearchServiceClient, 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.
      Throws:
      IOException

    • DataObjectSearchServiceClient

      protected DataObjectSearchServiceClient(DataObjectSearchServiceStub stub)

  • Method Details

    • create

      public static final DataObjectSearchServiceClient create() throws IOException
      Constructs an instance of DataObjectSearchServiceClient with default settings.
      Throws:
      IOException

    • create

      public static final DataObjectSearchServiceClient create(DataObjectSearchServiceSettings settings) throws IOException
      Constructs an instance of DataObjectSearchServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.
      Throws:
      IOException

    • create

      public static final DataObjectSearchServiceClient create(DataObjectSearchServiceStub stub)
      Constructs an instance of DataObjectSearchServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(DataObjectSearchServiceSettings).

    • getSettings

      public final DataObjectSearchServiceSettings getSettings()

    • getStub

      public DataObjectSearchServiceStub getStub()

    • searchDataObjects

      public final DataObjectSearchServiceClient.SearchDataObjectsPagedResponse searchDataObjects(SearchDataObjectsRequest request)
      Searches data objects.

      Sample 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 (DataObjectSearchServiceClient dataObjectSearchServiceClient =
     DataObjectSearchServiceClient.create()) {
   SearchDataObjectsRequest request =
       SearchDataObjectsRequest.newBuilder()
           .setParent(CollectionName.of("[PROJECT]", "[LOCATION]", "[COLLECTION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (SearchResult element :
       dataObjectSearchServiceClient.searchDataObjects(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • searchDataObjectsPagedCallable

      public final UnaryCallable<SearchDataObjectsRequest,DataObjectSearchServiceClient.SearchDataObjectsPagedResponse> searchDataObjectsPagedCallable()
      Searches data objects.

      Sample 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 (DataObjectSearchServiceClient dataObjectSearchServiceClient =
     DataObjectSearchServiceClient.create()) {
   SearchDataObjectsRequest request =
       SearchDataObjectsRequest.newBuilder()
           .setParent(CollectionName.of("[PROJECT]", "[LOCATION]", "[COLLECTION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<SearchResult> future =
       dataObjectSearchServiceClient.searchDataObjectsPagedCallable().futureCall(request);
   // Do something.
   for (SearchResult element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

    • searchDataObjectsCallable

      public final UnaryCallable<SearchDataObjectsRequest,SearchDataObjectsResponse> searchDataObjectsCallable()
      Searches data objects.

      Sample 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 (DataObjectSearchServiceClient dataObjectSearchServiceClient =
     DataObjectSearchServiceClient.create()) {
   SearchDataObjectsRequest request =
       SearchDataObjectsRequest.newBuilder()
           .setParent(CollectionName.of("[PROJECT]", "[LOCATION]", "[COLLECTION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     SearchDataObjectsResponse response =
         dataObjectSearchServiceClient.searchDataObjectsCallable().call(request);
     for (SearchResult element : response.getResultsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

    • queryDataObjects

      public final DataObjectSearchServiceClient.QueryDataObjectsPagedResponse queryDataObjects(QueryDataObjectsRequest request)
      Queries data objects.

      Sample 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 (DataObjectSearchServiceClient dataObjectSearchServiceClient =
     DataObjectSearchServiceClient.create()) {
   QueryDataObjectsRequest request =
       QueryDataObjectsRequest.newBuilder()
           .setParent(CollectionName.of("[PROJECT]", "[LOCATION]", "[COLLECTION]").toString())
           .setFilter(Struct.newBuilder().build())
           .setOutputFields(OutputFields.newBuilder().build())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (DataObject element :
       dataObjectSearchServiceClient.queryDataObjects(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • queryDataObjectsPagedCallable

      public final UnaryCallable<QueryDataObjectsRequest,DataObjectSearchServiceClient.QueryDataObjectsPagedResponse> queryDataObjectsPagedCallable()
      Queries data objects.

      Sample 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 (DataObjectSearchServiceClient dataObjectSearchServiceClient =
     DataObjectSearchServiceClient.create()) {
   QueryDataObjectsRequest request =
       QueryDataObjectsRequest.newBuilder()
           .setParent(CollectionName.of("[PROJECT]", "[LOCATION]", "[COLLECTION]").toString())
           .setFilter(Struct.newBuilder().build())
           .setOutputFields(OutputFields.newBuilder().build())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<DataObject> future =
       dataObjectSearchServiceClient.queryDataObjectsPagedCallable().futureCall(request);
   // Do something.
   for (DataObject element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

    • queryDataObjectsCallable

      public final UnaryCallable<QueryDataObjectsRequest,QueryDataObjectsResponse> queryDataObjectsCallable()
      Queries data objects.

      Sample 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 (DataObjectSearchServiceClient dataObjectSearchServiceClient =
     DataObjectSearchServiceClient.create()) {
   QueryDataObjectsRequest request =
       QueryDataObjectsRequest.newBuilder()
           .setParent(CollectionName.of("[PROJECT]", "[LOCATION]", "[COLLECTION]").toString())
           .setFilter(Struct.newBuilder().build())
           .setOutputFields(OutputFields.newBuilder().build())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     QueryDataObjectsResponse response =
         dataObjectSearchServiceClient.queryDataObjectsCallable().call(request);
     for (DataObject element : response.getDataObjectsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

    • aggregateDataObjects

      public final AggregateDataObjectsResponse aggregateDataObjects(AggregateDataObjectsRequest request)
      Aggregates data objects.

      Sample 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 (DataObjectSearchServiceClient dataObjectSearchServiceClient =
     DataObjectSearchServiceClient.create()) {
   AggregateDataObjectsRequest request =
       AggregateDataObjectsRequest.newBuilder()
           .setParent(CollectionName.of("[PROJECT]", "[LOCATION]", "[COLLECTION]").toString())
           .setFilter(Struct.newBuilder().build())
           .setAggregate(AggregationMethod.forNumber(0))
           .build();
   AggregateDataObjectsResponse response =
       dataObjectSearchServiceClient.aggregateDataObjects(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • aggregateDataObjectsCallable

      public final UnaryCallable<AggregateDataObjectsRequest,AggregateDataObjectsResponse> aggregateDataObjectsCallable()
      Aggregates data objects.

      Sample 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 (DataObjectSearchServiceClient dataObjectSearchServiceClient =
     DataObjectSearchServiceClient.create()) {
   AggregateDataObjectsRequest request =
       AggregateDataObjectsRequest.newBuilder()
           .setParent(CollectionName.of("[PROJECT]", "[LOCATION]", "[COLLECTION]").toString())
           .setFilter(Struct.newBuilder().build())
           .setAggregate(AggregationMethod.forNumber(0))
           .build();
   ApiFuture<AggregateDataObjectsResponse> future =
       dataObjectSearchServiceClient.aggregateDataObjectsCallable().futureCall(request);
   // Do something.
   AggregateDataObjectsResponse response = future.get();
 }

    • batchSearchDataObjects

      public final BatchSearchDataObjectsResponse batchSearchDataObjects(BatchSearchDataObjectsRequest request)
      Batch searches data objects.

      Sample 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 (DataObjectSearchServiceClient dataObjectSearchServiceClient =
     DataObjectSearchServiceClient.create()) {
   BatchSearchDataObjectsRequest request =
       BatchSearchDataObjectsRequest.newBuilder()
           .setParent(CollectionName.of("[PROJECT]", "[LOCATION]", "[COLLECTION]").toString())
           .addAllSearches(new ArrayList<Search>())
           .setCombine(BatchSearchDataObjectsRequest.CombineResultsOptions.newBuilder().build())
           .build();
   BatchSearchDataObjectsResponse response =
       dataObjectSearchServiceClient.batchSearchDataObjects(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • batchSearchDataObjectsCallable

      public final UnaryCallable<BatchSearchDataObjectsRequest,BatchSearchDataObjectsResponse> batchSearchDataObjectsCallable()
      Batch searches data objects.

      Sample 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 (DataObjectSearchServiceClient dataObjectSearchServiceClient =
     DataObjectSearchServiceClient.create()) {
   BatchSearchDataObjectsRequest request =
       BatchSearchDataObjectsRequest.newBuilder()
           .setParent(CollectionName.of("[PROJECT]", "[LOCATION]", "[COLLECTION]").toString())
           .addAllSearches(new ArrayList<Search>())
           .setCombine(BatchSearchDataObjectsRequest.CombineResultsOptions.newBuilder().build())
           .build();
   ApiFuture<BatchSearchDataObjectsResponse> future =
       dataObjectSearchServiceClient.batchSearchDataObjectsCallable().futureCall(request);
   // Do something.
   BatchSearchDataObjectsResponse response = future.get();
 }

    • listLocations

      public final DataObjectSearchServiceClient.ListLocationsPagedResponse listLocations(ListLocationsRequest request)
      Lists information about the supported locations for this service.

      This method lists locations based on the resource scope provided inthe [ListLocationsRequest.name] field:

      * **Global locations**: If `name` is empty, the method lists thepublic locations available to all projects. * **Project-specificlocations**: If `name` follows the format`projects/{project}`, the method lists locations visible to thatspecific project. This includes public, private, or otherproject-specific locations enabled for the project.

      For gRPC and client library implementations, the resource name ispassed as the `name` field. For direct service calls, the resourcename isincorporated into the request path based on the specific serviceimplementation and version.

      Sample 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 (DataObjectSearchServiceClient dataObjectSearchServiceClient =
     DataObjectSearchServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Location element : dataObjectSearchServiceClient.listLocations(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • listLocationsPagedCallable

      public final UnaryCallable<ListLocationsRequest,DataObjectSearchServiceClient.ListLocationsPagedResponse> listLocationsPagedCallable()
      Lists information about the supported locations for this service.

      This method lists locations based on the resource scope provided inthe [ListLocationsRequest.name] field:

      * **Global locations**: If `name` is empty, the method lists thepublic locations available to all projects. * **Project-specificlocations**: If `name` follows the format`projects/{project}`, the method lists locations visible to thatspecific project. This includes public, private, or otherproject-specific locations enabled for the project.

      For gRPC and client library implementations, the resource name ispassed as the `name` field. For direct service calls, the resourcename isincorporated into the request path based on the specific serviceimplementation and version.

      Sample 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 (DataObjectSearchServiceClient dataObjectSearchServiceClient =
     DataObjectSearchServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Location> future =
       dataObjectSearchServiceClient.listLocationsPagedCallable().futureCall(request);
   // Do something.
   for (Location element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

    • listLocationsCallable

      public final UnaryCallable<ListLocationsRequest,ListLocationsResponse> listLocationsCallable()
      Lists information about the supported locations for this service.

      This method lists locations based on the resource scope provided inthe [ListLocationsRequest.name] field:

      * **Global locations**: If `name` is empty, the method lists thepublic locations available to all projects. * **Project-specificlocations**: If `name` follows the format`projects/{project}`, the method lists locations visible to thatspecific project. This includes public, private, or otherproject-specific locations enabled for the project.

      For gRPC and client library implementations, the resource name ispassed as the `name` field. For direct service calls, the resourcename isincorporated into the request path based on the specific serviceimplementation and version.

      Sample 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 (DataObjectSearchServiceClient dataObjectSearchServiceClient =
     DataObjectSearchServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListLocationsResponse response =
         dataObjectSearchServiceClient.listLocationsCallable().call(request);
     for (Location element : response.getLocationsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

    • getLocation

      public final Location getLocation(GetLocationRequest request)
      Gets information about a location.

      Sample 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 (DataObjectSearchServiceClient dataObjectSearchServiceClient =
     DataObjectSearchServiceClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = dataObjectSearchServiceClient.getLocation(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • getLocationCallable

      public final UnaryCallable<GetLocationRequest,Location> getLocationCallable()
      Gets information about a location.

      Sample 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 (DataObjectSearchServiceClient dataObjectSearchServiceClient =
     DataObjectSearchServiceClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Location> future =
       dataObjectSearchServiceClient.getLocationCallable().futureCall(request);
   // Do something.
   Location response = future.get();
 }

    • close

      public final void close()
      Specified by:
      close in interface AutoCloseable

    • shutdown

      public void shutdown()
      Specified by:
      shutdown in interface BackgroundResource

    • isShutdown

      public boolean isShutdown()
      Specified by:
      isShutdown in interface BackgroundResource

    • isTerminated

      public boolean isTerminated()
      Specified by:
      isTerminated in interface BackgroundResource

    • shutdownNow

      public void shutdownNow()
      Specified by:
      shutdownNow in interface BackgroundResource

    • awaitTermination

      public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException
      Specified by:
      awaitTermination in interface BackgroundResource
      Throws:
      InterruptedException