Class SampleQueryServiceClient (0.49.0)

Version 0.49.0

• 0.50.0 (latest)
• 0.49.0
• 0.48.0
• 0.47.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

GitHub Repository

Product Reference

Service Description: Service for managing SampleQuerys,

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.	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 SampleQuerys.	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	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.	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.	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 SampleQuerys. Sample queries that already exist may be deleted. Note: It is possible for a subset of the SampleQuerys 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.

Inheritance

java.lang.Object > SampleQueryServiceClient

Static Methods

create()

public static final SampleQueryServiceClient create()

Constructs an instance of SampleQueryServiceClient with default settings.

Returns
Type	Description
SampleQueryServiceClient

Exceptions
Type	Description
IOException

create(SampleQueryServiceSettings settings)

public static final SampleQueryServiceClient create(SampleQueryServiceSettings settings)

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.

Parameter
Name	Description
settings	SampleQueryServiceSettings

Returns
Type	Description
SampleQueryServiceClient

Exceptions
Type	Description
IOException

create(SampleQueryServiceStub stub)

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

Parameter
Name	Description
stub	SampleQueryServiceStub

Returns
Type	Description
SampleQueryServiceClient

Constructors

SampleQueryServiceClient(SampleQueryServiceSettings settings)

protected SampleQueryServiceClient(SampleQueryServiceSettings settings)

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.

Parameter
Name	Description
settings	SampleQueryServiceSettings

SampleQueryServiceClient(SampleQueryServiceStub stub)

protected SampleQueryServiceClient(SampleQueryServiceStub stub)

Parameter
Name	Description
stub	SampleQueryServiceStub

Methods

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

close()

public final void close()

createSampleQuery(CreateSampleQueryRequest request)

public final SampleQuery createSampleQuery(CreateSampleQueryRequest request)

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

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

Returns
Type	Description
SampleQuery

createSampleQuery(SampleQuerySetName parent, SampleQuery sampleQuery, String sampleQueryId)

public final SampleQuery createSampleQuery(SampleQuerySetName parent, SampleQuery sampleQuery, String sampleQueryId)

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

Parameters
Name	Description
parent	SampleQuerySetName Required. The parent resource name, such as projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}.
sampleQuery	SampleQuery Required. The SampleQuery to create.
sampleQueryId	String Required. The ID to use for the SampleQuery, which will become the final component of the SampleQuery.name. If the caller does not have permission to create the SampleQuery, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. This field must be unique among all SampleQuerys with the same parent. Otherwise, an ALREADY_EXISTS error is returned. This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Returns
Type	Description
SampleQuery

createSampleQuery(String parent, SampleQuery sampleQuery, String sampleQueryId)

public final SampleQuery createSampleQuery(String parent, SampleQuery sampleQuery, String sampleQueryId)

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

Parameters
Name	Description
parent	String Required. The parent resource name, such as projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}.
sampleQuery	SampleQuery Required. The SampleQuery to create.
sampleQueryId	String Required. The ID to use for the SampleQuery, which will become the final component of the SampleQuery.name. If the caller does not have permission to create the SampleQuery, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. This field must be unique among all SampleQuerys with the same parent. Otherwise, an ALREADY_EXISTS error is returned. This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Returns
Type	Description
SampleQuery

createSampleQueryCallable()

public final UnaryCallable<CreateSampleQueryRequest,SampleQuery> createSampleQueryCallable()

Creates a 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();
   ApiFuture<SampleQuery> future =
       sampleQueryServiceClient.createSampleQueryCallable().futureCall(request);
   // Do something.
   SampleQuery response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<CreateSampleQueryRequest,SampleQuery>

deleteSampleQuery(DeleteSampleQueryRequest request)

public final void deleteSampleQuery(DeleteSampleQueryRequest request)

Deletes a 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()) {
   DeleteSampleQueryRequest request =
       DeleteSampleQueryRequest.newBuilder()
           .setName(
               SampleQueryName.of(
                       "[PROJECT]", "[LOCATION]", "[SAMPLE_QUERY_SET]", "[SAMPLE_QUERY]")
                   .toString())
           .build();
   sampleQueryServiceClient.deleteSampleQuery(request);
 }
 

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

deleteSampleQuery(SampleQueryName name)

public final void deleteSampleQuery(SampleQueryName name)

Deletes a 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]");
   sampleQueryServiceClient.deleteSampleQuery(name);
 }
 

Parameter
Name	Description
name	SampleQueryName Required. Full resource name of SampleQuery, such as projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}. If the caller does not have permission to delete the SampleQuery, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the SampleQuery to delete does not exist, a NOT_FOUND error is returned.

deleteSampleQuery(String name)

public final void deleteSampleQuery(String name)

Deletes a 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();
   sampleQueryServiceClient.deleteSampleQuery(name);
 }
 

Parameter
Name	Description
name	String Required. Full resource name of SampleQuery, such as projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}. If the caller does not have permission to delete the SampleQuery, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the SampleQuery to delete does not exist, a NOT_FOUND error is returned.

deleteSampleQueryCallable()

public final UnaryCallable<DeleteSampleQueryRequest,Empty> deleteSampleQueryCallable()

Deletes a 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()) {
   DeleteSampleQueryRequest request =
       DeleteSampleQueryRequest.newBuilder()
           .setName(
               SampleQueryName.of(
                       "[PROJECT]", "[LOCATION]", "[SAMPLE_QUERY_SET]", "[SAMPLE_QUERY]")
                   .toString())
           .build();
   ApiFuture<Empty> future =
       sampleQueryServiceClient.deleteSampleQueryCallable().futureCall(request);
   // Do something.
   future.get();
 }
 

Returns
Type	Description
UnaryCallable<DeleteSampleQueryRequest,Empty>

getHttpJsonOperationsClient()

public final OperationsClient getHttpJsonOperationsClient()

Beta

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns
Type	Description
OperationsClient

getOperationsClient()

public final OperationsClient getOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns
Type	Description
OperationsClient

getSampleQuery(GetSampleQueryRequest request)

public final SampleQuery getSampleQuery(GetSampleQueryRequest request)

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

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

Returns
Type	Description
SampleQuery

getSampleQuery(SampleQueryName name)

public final SampleQuery getSampleQuery(SampleQueryName name)

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

Parameter
Name	Description
name	SampleQueryName Required. Full resource name of 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, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuery does not exist, a NOT_FOUND error is returned.

Returns
Type	Description
SampleQuery

getSampleQuery(String name)

public final SampleQuery getSampleQuery(String name)

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

Parameter
Name	Description
name	String Required. Full resource name of 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, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuery does not exist, a NOT_FOUND error is returned.

Returns
Type	Description
SampleQuery

getSampleQueryCallable()

public final UnaryCallable<GetSampleQueryRequest,SampleQuery> getSampleQueryCallable()

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

Returns
Type	Description
UnaryCallable<GetSampleQueryRequest,SampleQuery>

getSettings()

public final SampleQueryServiceSettings getSettings()

Returns
Type	Description
SampleQueryServiceSettings

getStub()

public SampleQueryServiceStub getStub()

Returns
Type	Description
SampleQueryServiceStub

importSampleQueriesAsync(ImportSampleQueriesRequest request)

public final OperationFuture<ImportSampleQueriesResponse,ImportSampleQueriesMetadata> importSampleQueriesAsync(ImportSampleQueriesRequest request)

Bulk import of multiple SampleQuerys. Sample queries that already exist may be deleted.

Note: It is possible for a subset of the SampleQuerys to be successfully imported.

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()) {
   ImportSampleQueriesRequest request =
       ImportSampleQueriesRequest.newBuilder()
           .setParent(
               SampleQuerySetName.of("[PROJECT]", "[LOCATION]", "[SAMPLE_QUERY_SET]").toString())
           .setErrorConfig(ImportErrorConfig.newBuilder().build())
           .build();
   ImportSampleQueriesResponse response =
       sampleQueryServiceClient.importSampleQueriesAsync(request).get();
 }
 

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

Returns
Type	Description
OperationFuture<ImportSampleQueriesResponse,ImportSampleQueriesMetadata>

importSampleQueriesCallable()

public final UnaryCallable<ImportSampleQueriesRequest,Operation> importSampleQueriesCallable()

Bulk import of multiple SampleQuerys. Sample queries that already exist may be deleted.

Note: It is possible for a subset of the SampleQuerys to be successfully imported.

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()) {
   ImportSampleQueriesRequest request =
       ImportSampleQueriesRequest.newBuilder()
           .setParent(
               SampleQuerySetName.of("[PROJECT]", "[LOCATION]", "[SAMPLE_QUERY_SET]").toString())
           .setErrorConfig(ImportErrorConfig.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       sampleQueryServiceClient.importSampleQueriesCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<ImportSampleQueriesRequest,Operation>

importSampleQueriesOperationCallable()

public final OperationCallable<ImportSampleQueriesRequest,ImportSampleQueriesResponse,ImportSampleQueriesMetadata> importSampleQueriesOperationCallable()

Bulk import of multiple SampleQuerys. Sample queries that already exist may be deleted.

Note: It is possible for a subset of the SampleQuerys to be successfully imported.

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()) {
   ImportSampleQueriesRequest request =
       ImportSampleQueriesRequest.newBuilder()
           .setParent(
               SampleQuerySetName.of("[PROJECT]", "[LOCATION]", "[SAMPLE_QUERY_SET]").toString())
           .setErrorConfig(ImportErrorConfig.newBuilder().build())
           .build();
   OperationFuture<ImportSampleQueriesResponse, ImportSampleQueriesMetadata> future =
       sampleQueryServiceClient.importSampleQueriesOperationCallable().futureCall(request);
   // Do something.
   ImportSampleQueriesResponse response = future.get();
 }
 

Returns
Type	Description
OperationCallable<ImportSampleQueriesRequest,ImportSampleQueriesResponse,ImportSampleQueriesMetadata>

isShutdown()

public boolean isShutdown()

Returns
Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns
Type	Description
boolean

listSampleQueries(ListSampleQueriesRequest request)

public final SampleQueryServiceClient.ListSampleQueriesPagedResponse listSampleQueries(ListSampleQueriesRequest request)

Gets a list of SampleQuerys.

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()) {
   ListSampleQueriesRequest request =
       ListSampleQueriesRequest.newBuilder()
           .setParent(
               SampleQuerySetName.of("[PROJECT]", "[LOCATION]", "[SAMPLE_QUERY_SET]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (SampleQuery element : sampleQueryServiceClient.listSampleQueries(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

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

Returns
Type	Description
SampleQueryServiceClient.ListSampleQueriesPagedResponse

listSampleQueries(SampleQuerySetName parent)

public final SampleQueryServiceClient.ListSampleQueriesPagedResponse listSampleQueries(SampleQuerySetName parent)

Gets a list of SampleQuerys.

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]");
   for (SampleQuery element : sampleQueryServiceClient.listSampleQueries(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter
Name	Description
parent	SampleQuerySetName Required. The parent sample query set resource name, such as projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}. If the caller does not have permission to list SampleQuerys under this sample query set, regardless of whether or not this sample query set exists, a PERMISSION_DENIED error is returned.

Returns
Type	Description
SampleQueryServiceClient.ListSampleQueriesPagedResponse

listSampleQueries(String parent)

public final SampleQueryServiceClient.ListSampleQueriesPagedResponse listSampleQueries(String parent)

Gets a list of SampleQuerys.

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();
   for (SampleQuery element : sampleQueryServiceClient.listSampleQueries(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter
Name	Description
parent	String Required. The parent sample query set resource name, such as projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}. If the caller does not have permission to list SampleQuerys under this sample query set, regardless of whether or not this sample query set exists, a PERMISSION_DENIED error is returned.

Returns
Type	Description
SampleQueryServiceClient.ListSampleQueriesPagedResponse

listSampleQueriesCallable()

public final UnaryCallable<ListSampleQueriesRequest,ListSampleQueriesResponse> listSampleQueriesCallable()

Gets a list of SampleQuerys.

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()) {
   ListSampleQueriesRequest request =
       ListSampleQueriesRequest.newBuilder()
           .setParent(
               SampleQuerySetName.of("[PROJECT]", "[LOCATION]", "[SAMPLE_QUERY_SET]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListSampleQueriesResponse response =
         sampleQueryServiceClient.listSampleQueriesCallable().call(request);
     for (SampleQuery element : response.getSampleQueriesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns
Type	Description
UnaryCallable<ListSampleQueriesRequest,ListSampleQueriesResponse>

listSampleQueriesPagedCallable()

public final UnaryCallable<ListSampleQueriesRequest,SampleQueryServiceClient.ListSampleQueriesPagedResponse> listSampleQueriesPagedCallable()

Gets a list of SampleQuerys.

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()) {
   ListSampleQueriesRequest request =
       ListSampleQueriesRequest.newBuilder()
           .setParent(
               SampleQuerySetName.of("[PROJECT]", "[LOCATION]", "[SAMPLE_QUERY_SET]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<SampleQuery> future =
       sampleQueryServiceClient.listSampleQueriesPagedCallable().futureCall(request);
   // Do something.
   for (SampleQuery element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns
Type	Description
UnaryCallable<ListSampleQueriesRequest,ListSampleQueriesPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateSampleQuery(SampleQuery sampleQuery, FieldMask updateMask)

public final SampleQuery updateSampleQuery(SampleQuery sampleQuery, FieldMask updateMask)

Updates a 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()) {
   SampleQuery sampleQuery = SampleQuery.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   SampleQuery response = sampleQueryServiceClient.updateSampleQuery(sampleQuery, updateMask);
 }
 

Parameters
Name	Description
sampleQuery	SampleQuery Required. The simple query to update. If the caller does not have permission to update the SampleQuery, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the SampleQuery to update does not exist a NOT_FOUND error is returned.
updateMask	FieldMask Indicates which fields in the provided imported 'simple query' to update. If not set, will by default update all fields.

Returns
Type	Description
SampleQuery

updateSampleQuery(UpdateSampleQueryRequest request)

public final SampleQuery updateSampleQuery(UpdateSampleQueryRequest request)

Updates a 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()) {
   UpdateSampleQueryRequest request =
       UpdateSampleQueryRequest.newBuilder()
           .setSampleQuery(SampleQuery.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   SampleQuery response = sampleQueryServiceClient.updateSampleQuery(request);
 }
 

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

Returns
Type	Description
SampleQuery

updateSampleQueryCallable()

public final UnaryCallable<UpdateSampleQueryRequest,SampleQuery> updateSampleQueryCallable()

Updates a 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()) {
   UpdateSampleQueryRequest request =
       UpdateSampleQueryRequest.newBuilder()
           .setSampleQuery(SampleQuery.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<SampleQuery> future =
       sampleQueryServiceClient.updateSampleQueryCallable().futureCall(request);
   // Do something.
   SampleQuery response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<UpdateSampleQueryRequest,SampleQuery>