SampleQueryServiceClient (Google Discovery Engine API 0.52.0 API)

java.lang.Object
- com.google.cloud.discoveryengine.v1alpha.SampleQueryServiceClient

All Implemented Interfaces:: com.google.api.gax.core.BackgroundResource, AutoCloseable

@BetaApi
 @Generated(value="by gapic-generator-java")
public class SampleQueryServiceClient
extends Object
implements com.google.api.gax.core.BackgroundResource

Service Description: Service for managing [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s,

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 (SampleQueryServiceClient sampleQueryServiceClient = SampleQueryServiceClient.create()) {
   SampleQueryName name =
       SampleQueryName.of("[PROJECT]", "[LOCATION]", "[SAMPLE_QUERY_SET]", "[SAMPLE_QUERY]");
   SampleQuery response = sampleQueryServiceClient.getSampleQuery(name);
 }

Note: close() needs to be called on the SampleQueryServiceClient 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
GetSampleQuery	Gets a [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery].	Request object method variants only take one parameter, a request object, which must be constructed before the call. getSampleQuery(GetSampleQueryRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getSampleQuery(SampleQueryName name) getSampleQuery(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getSampleQueryCallable()
ListSampleQueries	Gets a list of [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listSampleQueries(ListSampleQueriesRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listSampleQueries(SampleQuerySetName parent) listSampleQueries(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listSampleQueriesPagedCallable() listSampleQueriesCallable()
CreateSampleQuery	Creates a [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]	Request object method variants only take one parameter, a request object, which must be constructed before the call. createSampleQuery(CreateSampleQueryRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. createSampleQuery(SampleQuerySetName parent, SampleQuery sampleQuery, String sampleQueryId) createSampleQuery(String parent, SampleQuery sampleQuery, String sampleQueryId) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createSampleQueryCallable()
UpdateSampleQuery	Updates a [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery].	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateSampleQuery(UpdateSampleQueryRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updateSampleQuery(SampleQuery sampleQuery, FieldMask updateMask) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateSampleQueryCallable()
DeleteSampleQuery	Deletes a [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery].	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteSampleQuery(DeleteSampleQueryRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. deleteSampleQuery(SampleQueryName name) deleteSampleQuery(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteSampleQueryCallable()
ImportSampleQueries	Bulk import of multiple [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s. Sample queries that already exist may be deleted. Note: It is possible for a subset of the [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s to be successfully imported.	Request object method variants only take one parameter, a request object, which must be constructed before the call. importSampleQueriesAsync(ImportSampleQueriesRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. importSampleQueriesOperationCallable() importSampleQueriesCallable()

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 SampleQueryServiceSettings 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
 SampleQueryServiceSettings sampleQueryServiceSettings =
     SampleQueryServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 SampleQueryServiceClient sampleQueryServiceClient =
     SampleQueryServiceClient.create(sampleQueryServiceSettings);

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
 SampleQueryServiceSettings sampleQueryServiceSettings =
     SampleQueryServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 SampleQueryServiceClient sampleQueryServiceClient =
     SampleQueryServiceClient.create(sampleQueryServiceSettings);

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
 SampleQueryServiceSettings sampleQueryServiceSettings =
     SampleQueryServiceSettings.newHttpJsonBuilder().build();
 SampleQueryServiceClient sampleQueryServiceClient =
     SampleQueryServiceClient.create(sampleQueryServiceSettings);

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

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`SampleQueryServiceClient.ListSampleQueriesFixedSizeCollection`
`static class`	`SampleQueryServiceClient.ListSampleQueriesPage`
`static class`	`SampleQueryServiceClient.ListSampleQueriesPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`SampleQueryServiceClient(SampleQueryServiceSettings settings)` Constructs an instance of SampleQueryServiceClient, using the given settings.
`protected`	`SampleQueryServiceClient(SampleQueryServiceStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static SampleQueryServiceClient`	`create()` Constructs an instance of SampleQueryServiceClient with default settings.
`static SampleQueryServiceClient`	`create(SampleQueryServiceSettings settings)` Constructs an instance of SampleQueryServiceClient, using the given settings.
`static SampleQueryServiceClient`	`create(SampleQueryServiceStub stub)` Constructs an instance of SampleQueryServiceClient, using the given stub for making calls.
`SampleQuery`	`createSampleQuery(CreateSampleQueryRequest request)` Creates a [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery] 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 (SampleQueryServiceClient sampleQueryServiceClient = SampleQueryServiceClient.create()) { CreateSampleQueryRequest request = CreateSampleQueryRequest.newBuilder() .setParent( SampleQuerySetName.of("[PROJECT]", "[LOCATION]", "[SAMPLE_QUERY_SET]").toString()) .setSampleQuery(SampleQuery.newBuilder().build()) .setSampleQueryId("sampleQueryId1739022073") .build(); SampleQuery response = sampleQueryServiceClient.createSampleQuery(request); }
`SampleQuery`	`createSampleQuery(SampleQuerySetName parent, SampleQuery sampleQuery, String sampleQueryId)` Creates a [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery] 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 (SampleQueryServiceClient sampleQueryServiceClient = SampleQueryServiceClient.create()) { SampleQuerySetName parent = SampleQuerySetName.of("[PROJECT]", "[LOCATION]", "[SAMPLE_QUERY_SET]"); SampleQuery sampleQuery = SampleQuery.newBuilder().build(); String sampleQueryId = "sampleQueryId1739022073"; SampleQuery response = sampleQueryServiceClient.createSampleQuery(parent, sampleQuery, sampleQueryId); }
`SampleQuery`	`createSampleQuery(String parent, SampleQuery sampleQuery, String sampleQueryId)` Creates a [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery] 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 (SampleQueryServiceClient sampleQueryServiceClient = SampleQueryServiceClient.create()) { String parent = SampleQuerySetName.of("[PROJECT]", "[LOCATION]", "[SAMPLE_QUERY_SET]").toString(); SampleQuery sampleQuery = SampleQuery.newBuilder().build(); String sampleQueryId = "sampleQueryId1739022073"; SampleQuery response = sampleQueryServiceClient.createSampleQuery(parent, sampleQuery, sampleQueryId); }
`com.google.api.gax.rpc.UnaryCallable<CreateSampleQueryRequest,SampleQuery>`	`createSampleQueryCallable()` Creates a [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery] 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 (SampleQueryServiceClient sampleQueryServiceClient = SampleQueryServiceClient.create()) { CreateSampleQueryRequest request = CreateSampleQueryRequest.newBuilder() .setParent( SampleQuerySetName.of("[PROJECT]", "[LOCATION]", "[SAMPLE_QUERY_SET]").toString()) .setSampleQuery(SampleQuery.newBuilder().build()) .setSampleQueryId("sampleQueryId1739022073") .build(); ApiFuture future = sampleQueryServiceClient.createSampleQueryCallable().futureCall(request); // Do something.
`void`	`deleteSampleQuery(DeleteSampleQueryRequest request)` Deletes a [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery].
`void`	`deleteSampleQuery(SampleQueryName name)` Deletes a [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery].
`void`	`deleteSampleQuery(String name)` Deletes a [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery].
`com.google.api.gax.rpc.UnaryCallable<DeleteSampleQueryRequest,com.google.protobuf.Empty>`	`deleteSampleQueryCallable()` Deletes a [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery].
`com.google.api.gax.httpjson.longrunning.OperationsClient`	`getHttpJsonOperationsClient()` Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
`com.google.longrunning.OperationsClient`	`getOperationsClient()` Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
`SampleQuery`	`getSampleQuery(GetSampleQueryRequest request)` Gets a [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery].
`SampleQuery`	`getSampleQuery(SampleQueryName name)` Gets a [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery].
`SampleQuery`	`getSampleQuery(String name)` Gets a [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery].
`com.google.api.gax.rpc.UnaryCallable<GetSampleQueryRequest,SampleQuery>`	`getSampleQueryCallable()` Gets a [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery].
`SampleQueryServiceSettings`	`getSettings()`
`SampleQueryServiceStub`	`getStub()`
`com.google.api.gax.longrunning.OperationFuture<ImportSampleQueriesResponse,ImportSampleQueriesMetadata>`	`importSampleQueriesAsync(ImportSampleQueriesRequest request)` Bulk import of multiple [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s.
`com.google.api.gax.rpc.UnaryCallable<ImportSampleQueriesRequest,com.google.longrunning.Operation>`	`importSampleQueriesCallable()` Bulk import of multiple [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s.
`com.google.api.gax.rpc.OperationCallable<ImportSampleQueriesRequest,ImportSampleQueriesResponse,ImportSampleQueriesMetadata>`	`importSampleQueriesOperationCallable()` Bulk import of multiple [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s.
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`SampleQueryServiceClient.ListSampleQueriesPagedResponse`	`listSampleQueries(ListSampleQueriesRequest request)` Gets a list of [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s.
`SampleQueryServiceClient.ListSampleQueriesPagedResponse`	`listSampleQueries(SampleQuerySetName parent)` Gets a list of [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s.
`SampleQueryServiceClient.ListSampleQueriesPagedResponse`	`listSampleQueries(String parent)` Gets a list of [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s.
`com.google.api.gax.rpc.UnaryCallable<ListSampleQueriesRequest,ListSampleQueriesResponse>`	`listSampleQueriesCallable()` Gets a list of [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s.
`com.google.api.gax.rpc.UnaryCallable<ListSampleQueriesRequest,SampleQueryServiceClient.ListSampleQueriesPagedResponse>`	`listSampleQueriesPagedCallable()` Gets a list of [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery]s.
`void`	`shutdown()`
`void`	`shutdownNow()`
`SampleQuery`	`updateSampleQuery(SampleQuery sampleQuery, com.google.protobuf.FieldMask updateMask)` Updates a [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery].
`SampleQuery`	`updateSampleQuery(UpdateSampleQueryRequest request)` Updates a [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery].
`com.google.api.gax.rpc.UnaryCallable<UpdateSampleQueryRequest,SampleQuery>`	`updateSampleQueryCallable()` Updates a [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery].

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- SampleQueryServiceClient
```
protected SampleQueryServiceClient(SampleQueryServiceSettings settings)
                            throws IOException
```
  Constructs an instance of SampleQueryServiceClient, 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
- SampleQueryServiceClient
```
protected SampleQueryServiceClient(SampleQueryServiceStub stub)
```

Method Detail

create

public static final SampleQueryServiceClient create()
                                             throws IOException

Constructs an instance of SampleQueryServiceClient with default settings.

Throws:: IOException

create
```
public static final SampleQueryServiceClient create(SampleQueryServiceSettings settings)
                                             throws IOException
```
Constructs an instance of SampleQueryServiceClient, 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 SampleQueryServiceClient create(SampleQueryServiceStub stub)
```
Constructs an instance of SampleQueryServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(SampleQueryServiceSettings).

getSettings

public final SampleQueryServiceSettings getSettings()

getStub

public SampleQueryServiceStub getStub()

getOperationsClient
```
public final com.google.longrunning.OperationsClient getOperationsClient()
```
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

getHttpJsonOperationsClient
```
@BetaApi
public final com.google.api.gax.httpjson.longrunning.OperationsClient getHttpJsonOperationsClient()
```
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

getSampleQuery

public final SampleQuery getSampleQuery(SampleQueryName name)

Gets a [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery].

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 (SampleQueryServiceClient sampleQueryServiceClient = SampleQueryServiceClient.create()) {
   SampleQueryName name =
       SampleQueryName.of("[PROJECT]", "[LOCATION]", "[SAMPLE_QUERY_SET]", "[SAMPLE_QUERY]");
   SampleQuery response = sampleQueryServiceClient.getSampleQuery(name);
 }

Parameters:

name - Required. Full resource name of [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery], such as `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`.

If the caller does not have permission to access the [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the requested [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery] does not exist, a NOT_FOUND error is returned.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getSampleQuery

public final SampleQuery getSampleQuery(String name)

Gets a [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery].

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 (SampleQueryServiceClient sampleQueryServiceClient = SampleQueryServiceClient.create()) {
   String name =
       SampleQueryName.of("[PROJECT]", "[LOCATION]", "[SAMPLE_QUERY_SET]", "[SAMPLE_QUERY]")
           .toString();
   SampleQuery response = sampleQueryServiceClient.getSampleQuery(name);
 }

Parameters:

If the caller does not have permission to access the [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the requested [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery] does not exist, a NOT_FOUND error is returned.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getSampleQuery

public final SampleQuery getSampleQuery(GetSampleQueryRequest request)

Gets a [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery].

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 (SampleQueryServiceClient sampleQueryServiceClient = SampleQueryServiceClient.create()) {
   GetSampleQueryRequest request =
       GetSampleQueryRequest.newBuilder()
           .setName(
               SampleQueryName.of(
                       "[PROJECT]", "[LOCATION]", "[SAMPLE_QUERY_SET]", "[SAMPLE_QUERY]")
                   .toString())
           .build();
   SampleQuery response = sampleQueryServiceClient.getSampleQuery(request);
 }

Parameters:: 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

getSampleQueryCallable

public final com.google.api.gax.rpc.UnaryCallable<GetSampleQueryRequest,SampleQuery> getSampleQueryCallable()

Gets a [SampleQuery][google.cloud.discoveryengine.v1alpha.SampleQuery].

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 (SampleQueryServiceClient sampleQueryServiceClient = SampleQueryServiceClient.create()) {
   GetSampleQueryRequest request =
       GetSampleQueryRequest.newBuilder()
           .setName(
               SampleQueryName.of(
                       "[PROJECT]", "[LOCATION]", "[SAMPLE_QUERY_SET]", "[SAMPLE_QUERY]")
                   .toString())
           .build();
   ApiFuture<SampleQuery> future =
       sampleQueryServiceClient.getSampleQueryCallable().futureCall(request);
   // Do something.
   SampleQuery response = future.get();
 }