Class DataObjectSearchServiceClient (0.1.0)

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.	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.

Inheritance

java.lang.Object > DataObjectSearchServiceClient

Static Methods

create()

public static final DataObjectSearchServiceClient create()

Constructs an instance of DataObjectSearchServiceClient with default settings.

Returns
Type	Description
`DataObjectSearchServiceClient`

Exceptions
Type	Description
`IOException`

create(DataObjectSearchServiceSettings settings)

public static final DataObjectSearchServiceClient create(DataObjectSearchServiceSettings settings)

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.

Parameter
Name	Description
`settings`	`DataObjectSearchServiceSettings`

Returns
Type	Description
`DataObjectSearchServiceClient`

Exceptions
Type	Description
`IOException`

create(DataObjectSearchServiceStub stub)

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).

Parameter
Name	Description
`stub`	`DataObjectSearchServiceStub`

Returns
Type	Description
`DataObjectSearchServiceClient`

Constructors

DataObjectSearchServiceClient(DataObjectSearchServiceSettings settings)

protected DataObjectSearchServiceClient(DataObjectSearchServiceSettings settings)

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.

Parameter
Name	Description
`settings`	`DataObjectSearchServiceSettings`

DataObjectSearchServiceClient(DataObjectSearchServiceStub stub)

protected DataObjectSearchServiceClient(DataObjectSearchServiceStub stub)

Parameter
Name	Description
`stub`	`DataObjectSearchServiceStub`

Methods

aggregateDataObjects(AggregateDataObjectsRequest request)

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);
 }

Parameter
Name	Description
`request`	`AggregateDataObjectsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`AggregateDataObjectsResponse`

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();
 }

Returns
Type	Description
`UnaryCallable<AggregateDataObjectsRequest,AggregateDataObjectsResponse>`

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters
Name	Description
`duration`	`long`
`unit`	`TimeUnit`

Returns
Type	Description
`boolean`

Exceptions
Type	Description
`InterruptedException`

batchSearchDataObjects(BatchSearchDataObjectsRequest request)

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);
 }

Parameter
Name	Description
`request`	`BatchSearchDataObjectsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`BatchSearchDataObjectsResponse`

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();
 }

Returns
Type	Description
`UnaryCallable<BatchSearchDataObjectsRequest,BatchSearchDataObjectsResponse>`

close()

public final void close()

getLocation(GetLocationRequest request)

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);
 }

Parameter
Name	Description
`request`	`com.google.cloud.location.GetLocationRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`com.google.cloud.location.Location`

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();
 }

Returns
Type	Description
`UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>`

getSettings()

public final DataObjectSearchServiceSettings getSettings()

Returns
Type	Description
`DataObjectSearchServiceSettings`

getStub()

public DataObjectSearchServiceStub getStub()

Returns
Type	Description
`DataObjectSearchServiceStub`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

listLocations(ListLocationsRequest request)

public final DataObjectSearchServiceClient.ListLocationsPagedResponse listLocations(ListLocationsRequest request)

Lists information about the supported locations for this service.

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);
   }
 }

Parameter
Name	Description
`request`	`com.google.cloud.location.ListLocationsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`DataObjectSearchServiceClient.ListLocationsPagedResponse`

listLocationsCallable()

public final UnaryCallable<ListLocationsRequest,ListLocationsResponse> listLocationsCallable()

Lists information about the supported locations for this service.

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;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>`

listLocationsPagedCallable()

public final UnaryCallable<ListLocationsRequest,DataObjectSearchServiceClient.ListLocationsPagedResponse> listLocationsPagedCallable()

Lists information about the supported locations for this service.

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);
   }
 }

Returns
Type	Description
`UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse>`

queryDataObjects(QueryDataObjectsRequest request)

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);
   }
 }

Parameter
Name	Description
`request`	`QueryDataObjectsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`DataObjectSearchServiceClient.QueryDataObjectsPagedResponse`

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;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<QueryDataObjectsRequest,QueryDataObjectsResponse>`

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);
   }
 }

Returns
Type	Description
`UnaryCallable<QueryDataObjectsRequest,QueryDataObjectsPagedResponse>`

searchDataObjects(SearchDataObjectsRequest request)

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);
   }
 }

Parameter
Name	Description
`request`	`SearchDataObjectsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`DataObjectSearchServiceClient.SearchDataObjectsPagedResponse`

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;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<SearchDataObjectsRequest,SearchDataObjectsResponse>`

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);
   }
 }

Returns
Type	Description
`UnaryCallable<SearchDataObjectsRequest,SearchDataObjectsPagedResponse>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

Class DataObjectSearchServiceClient (0.1.0) Stay organized with collections Save and categorize content based on your preferences.

Inheritance

Static Methods

create()

create(DataObjectSearchServiceSettings settings)

create(DataObjectSearchServiceStub stub)

Constructors

DataObjectSearchServiceClient(DataObjectSearchServiceSettings settings)

DataObjectSearchServiceClient(DataObjectSearchServiceStub stub)

Methods

aggregateDataObjects(AggregateDataObjectsRequest request)

aggregateDataObjectsCallable()

awaitTermination(long duration, TimeUnit unit)

batchSearchDataObjects(BatchSearchDataObjectsRequest request)

batchSearchDataObjectsCallable()

close()

getLocation(GetLocationRequest request)

getLocationCallable()

getSettings()

getStub()

isShutdown()

isTerminated()

listLocations(ListLocationsRequest request)

listLocationsCallable()

listLocationsPagedCallable()

queryDataObjects(QueryDataObjectsRequest request)

queryDataObjectsCallable()

queryDataObjectsPagedCallable()

searchDataObjects(SearchDataObjectsRequest request)

searchDataObjectsCallable()

searchDataObjectsPagedCallable()

shutdown()

shutdownNow()

Class DataObjectSearchServiceClient (0.1.0)