com.google.cloud.aiplatform.v1beta1

Class ExampleStoreServiceClient

java.lang.Object

com.google.cloud.aiplatform.v1beta1.ExampleStoreServiceClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable

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

Service Description: A service for managing and retrieving few-shot examples.

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 (ExampleStoreServiceClient exampleStoreServiceClient = ExampleStoreServiceClient.create()) {
   ExampleStoreName name = ExampleStoreName.of("[PROJECT]", "[LOCATION]", "[EXAMPLE_STORE]");
   ExampleStore response = exampleStoreServiceClient.getExampleStore(name);
 }
 

Note: close() needs to be called on the ExampleStoreServiceClient 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
CreateExampleStore	Create an ExampleStore.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createExampleStoreAsync(CreateExampleStoreRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. createExampleStoreAsync(LocationName parent, ExampleStore exampleStore) createExampleStoreAsync(String parent, ExampleStore exampleStore) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createExampleStoreOperationCallable() createExampleStoreCallable()
GetExampleStore	Get an ExampleStore.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getExampleStore(GetExampleStoreRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getExampleStore(ExampleStoreName name) getExampleStore(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. getExampleStoreCallable()
UpdateExampleStore	Update an ExampleStore.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateExampleStoreAsync(UpdateExampleStoreRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. updateExampleStoreAsync(ExampleStore exampleStore, 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. updateExampleStoreOperationCallable() updateExampleStoreCallable()
DeleteExampleStore	Delete an ExampleStore.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteExampleStoreAsync(DeleteExampleStoreRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. deleteExampleStoreAsync(ExampleStoreName name) deleteExampleStoreAsync(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. deleteExampleStoreOperationCallable() deleteExampleStoreCallable()
ListExampleStores	List ExampleStores in a Location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listExampleStores(ListExampleStoresRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listExampleStores(LocationName parent) listExampleStores(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. listExampleStoresPagedCallable() listExampleStoresCallable()
UpsertExamples	Create or update Examples in the Example Store.	Request object method variants only take one parameter, a request object, which must be constructed before the call. upsertExamples(UpsertExamplesRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. upsertExamplesCallable()
RemoveExamples	Remove Examples from the Example Store.	Request object method variants only take one parameter, a request object, which must be constructed before the call. removeExamples(RemoveExamplesRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. removeExamplesCallable()
SearchExamples	Search for similar Examples for given selection criteria.	Request object method variants only take one parameter, a request object, which must be constructed before the call. searchExamples(SearchExamplesRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. searchExamplesCallable()
FetchExamples	Get Examples from the Example Store.	Request object method variants only take one parameter, a request object, which must be constructed before the call. fetchExamples(FetchExamplesRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. fetchExamplesPagedCallable() fetchExamplesCallable()
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()
SetIamPolicy	Sets the access control policy on the specified resource. Replacesany existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.	Request object method variants only take one parameter, a request object, which must be constructed before the call. setIamPolicy(SetIamPolicyRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. setIamPolicyCallable()
GetIamPolicy	Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getIamPolicy(GetIamPolicyRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getIamPolicyCallable()
TestIamPermissions	Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.	Request object method variants only take one parameter, a request object, which must be constructed before the call. testIamPermissions(TestIamPermissionsRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. testIamPermissionsCallable()

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 ExampleStoreServiceSettings 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
 ExampleStoreServiceSettings exampleStoreServiceSettings =
     ExampleStoreServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ExampleStoreServiceClient exampleStoreServiceClient =
     ExampleStoreServiceClient.create(exampleStoreServiceSettings);
 

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
 ExampleStoreServiceSettings exampleStoreServiceSettings =
     ExampleStoreServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 ExampleStoreServiceClient exampleStoreServiceClient =
     ExampleStoreServiceClient.create(exampleStoreServiceSettings);
 

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	ExampleStoreServiceClient.FetchExamplesFixedSizeCollection
static class	ExampleStoreServiceClient.FetchExamplesPage
static class	ExampleStoreServiceClient.FetchExamplesPagedResponse
static class	ExampleStoreServiceClient.ListExampleStoresFixedSizeCollection
static class	ExampleStoreServiceClient.ListExampleStoresPage
static class	ExampleStoreServiceClient.ListExampleStoresPagedResponse
static class	ExampleStoreServiceClient.ListLocationsFixedSizeCollection
static class	ExampleStoreServiceClient.ListLocationsPage
static class	ExampleStoreServiceClient.ListLocationsPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ExampleStoreServiceClient(ExampleStoreServiceSettings settings) Constructs an instance of ExampleStoreServiceClient, using the given settings.
protected	ExampleStoreServiceClient(ExampleStoreServiceStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static ExampleStoreServiceClient	create() Constructs an instance of ExampleStoreServiceClient with default settings.
static ExampleStoreServiceClient	create(ExampleStoreServiceSettings settings) Constructs an instance of ExampleStoreServiceClient, using the given settings.
static ExampleStoreServiceClient	create(ExampleStoreServiceStub stub) Constructs an instance of ExampleStoreServiceClient, using the given stub for making calls.
com.google.api.gax.longrunning.OperationFuture<ExampleStore,CreateExampleStoreOperationMetadata>	createExampleStoreAsync(CreateExampleStoreRequest request) Create an ExampleStore.
com.google.api.gax.longrunning.OperationFuture<ExampleStore,CreateExampleStoreOperationMetadata>	createExampleStoreAsync(LocationName parent, ExampleStore exampleStore) Create an ExampleStore.
com.google.api.gax.longrunning.OperationFuture<ExampleStore,CreateExampleStoreOperationMetadata>	createExampleStoreAsync(String parent, ExampleStore exampleStore) Create an ExampleStore.
com.google.api.gax.rpc.UnaryCallable<CreateExampleStoreRequest,com.google.longrunning.Operation>	createExampleStoreCallable() Create an ExampleStore.
com.google.api.gax.rpc.OperationCallable<CreateExampleStoreRequest,ExampleStore,CreateExampleStoreOperationMetadata>	createExampleStoreOperationCallable() Create an ExampleStore.
com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteExampleStoreOperationMetadata>	deleteExampleStoreAsync(DeleteExampleStoreRequest request) Delete an ExampleStore.
com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteExampleStoreOperationMetadata>	deleteExampleStoreAsync(ExampleStoreName name) Delete an ExampleStore.
com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteExampleStoreOperationMetadata>	deleteExampleStoreAsync(String name) Delete an ExampleStore.
com.google.api.gax.rpc.UnaryCallable<DeleteExampleStoreRequest,com.google.longrunning.Operation>	deleteExampleStoreCallable() Delete an ExampleStore.
com.google.api.gax.rpc.OperationCallable<DeleteExampleStoreRequest,com.google.protobuf.Empty,DeleteExampleStoreOperationMetadata>	deleteExampleStoreOperationCallable() Delete an ExampleStore.
ExampleStoreServiceClient.FetchExamplesPagedResponse	fetchExamples(FetchExamplesRequest request) Get Examples from the Example Store.
com.google.api.gax.rpc.UnaryCallable<FetchExamplesRequest,FetchExamplesResponse>	fetchExamplesCallable() Get Examples from the Example Store.
com.google.api.gax.rpc.UnaryCallable<FetchExamplesRequest,ExampleStoreServiceClient.FetchExamplesPagedResponse>	fetchExamplesPagedCallable() Get Examples from the Example Store.
ExampleStore	getExampleStore(ExampleStoreName name) Get an ExampleStore.
ExampleStore	getExampleStore(GetExampleStoreRequest request) Get an ExampleStore.
ExampleStore	getExampleStore(String name) Get an ExampleStore.
com.google.api.gax.rpc.UnaryCallable<GetExampleStoreRequest,ExampleStore>	getExampleStoreCallable() Get an ExampleStore.
com.google.iam.v1.Policy	getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request) Gets the access control policy for a resource.
com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>	getIamPolicyCallable() Gets the access control policy for a resource.
com.google.cloud.location.Location	getLocation(com.google.cloud.location.GetLocationRequest request) Gets information about a location.
com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>	getLocationCallable() Gets information about a location.
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.
ExampleStoreServiceSettings	getSettings()
ExampleStoreServiceStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
ExampleStoreServiceClient.ListExampleStoresPagedResponse	listExampleStores(ListExampleStoresRequest request) List ExampleStores in a Location.
ExampleStoreServiceClient.ListExampleStoresPagedResponse	listExampleStores(LocationName parent) List ExampleStores in a Location.
ExampleStoreServiceClient.ListExampleStoresPagedResponse	listExampleStores(String parent) List ExampleStores in a Location.
com.google.api.gax.rpc.UnaryCallable<ListExampleStoresRequest,ListExampleStoresResponse>	listExampleStoresCallable() List ExampleStores in a Location.
com.google.api.gax.rpc.UnaryCallable<ListExampleStoresRequest,ExampleStoreServiceClient.ListExampleStoresPagedResponse>	listExampleStoresPagedCallable() List ExampleStores in a Location.
ExampleStoreServiceClient.ListLocationsPagedResponse	listLocations(com.google.cloud.location.ListLocationsRequest request) Lists information about the supported locations for this service.
com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>	listLocationsCallable() Lists information about the supported locations for this service.
com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,ExampleStoreServiceClient.ListLocationsPagedResponse>	listLocationsPagedCallable() Lists information about the supported locations for this service.
RemoveExamplesResponse	removeExamples(RemoveExamplesRequest request) Remove Examples from the Example Store.
com.google.api.gax.rpc.UnaryCallable<RemoveExamplesRequest,RemoveExamplesResponse>	removeExamplesCallable() Remove Examples from the Example Store.
SearchExamplesResponse	searchExamples(SearchExamplesRequest request) Search for similar Examples for given selection criteria.
com.google.api.gax.rpc.UnaryCallable<SearchExamplesRequest,SearchExamplesResponse>	searchExamplesCallable() Search for similar Examples for given selection criteria.
com.google.iam.v1.Policy	setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request) Sets the access control policy on the specified resource.
com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>	setIamPolicyCallable() Sets the access control policy on the specified resource.
void	shutdown()
void	shutdownNow()
com.google.iam.v1.TestIamPermissionsResponse	testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request) Returns permissions that a caller has on the specified resource.
com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>	testIamPermissionsCallable() Returns permissions that a caller has on the specified resource.
com.google.api.gax.longrunning.OperationFuture<ExampleStore,UpdateExampleStoreOperationMetadata>	updateExampleStoreAsync(ExampleStore exampleStore, com.google.protobuf.FieldMask updateMask) Update an ExampleStore.
com.google.api.gax.longrunning.OperationFuture<ExampleStore,UpdateExampleStoreOperationMetadata>	updateExampleStoreAsync(UpdateExampleStoreRequest request) Update an ExampleStore.
com.google.api.gax.rpc.UnaryCallable<UpdateExampleStoreRequest,com.google.longrunning.Operation>	updateExampleStoreCallable() Update an ExampleStore.
com.google.api.gax.rpc.OperationCallable<UpdateExampleStoreRequest,ExampleStore,UpdateExampleStoreOperationMetadata>	updateExampleStoreOperationCallable() Update an ExampleStore.
UpsertExamplesResponse	upsertExamples(UpsertExamplesRequest request) Create or update Examples in the Example Store.
com.google.api.gax.rpc.UnaryCallable<UpsertExamplesRequest,UpsertExamplesResponse>	upsertExamplesCallable() Create or update Examples in the Example Store.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExampleStoreServiceClient

protected ExampleStoreServiceClient(ExampleStoreServiceSettings settings)
                             throws IOException

Constructs an instance of ExampleStoreServiceClient, 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

ExampleStoreServiceClient

protected ExampleStoreServiceClient(ExampleStoreServiceStub stub)

Method Detail

create

public static final ExampleStoreServiceClient create()
                                              throws IOException

Constructs an instance of ExampleStoreServiceClient with default settings.

Throws:

IOException

create

public static final ExampleStoreServiceClient create(ExampleStoreServiceSettings settings)
                                              throws IOException

Constructs an instance of ExampleStoreServiceClient, 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 ExampleStoreServiceClient create(ExampleStoreServiceStub stub)

Constructs an instance of ExampleStoreServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(ExampleStoreServiceSettings).

getSettings

public final ExampleStoreServiceSettings getSettings()

getStub

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

createExampleStoreAsync

public final com.google.api.gax.longrunning.OperationFuture<ExampleStore,CreateExampleStoreOperationMetadata> createExampleStoreAsync(LocationName parent,
                                                                                                                                      ExampleStore exampleStore)

Create an ExampleStore.

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 (ExampleStoreServiceClient exampleStoreServiceClient = ExampleStoreServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   ExampleStore exampleStore = ExampleStore.newBuilder().build();
   ExampleStore response =
       exampleStoreServiceClient.createExampleStoreAsync(parent, exampleStore).get();
 }
 

Parameters:

parent - Required. The resource name of the Location to create the ExampleStore in. Format: `projects/{project}/locations/{location}`

exampleStore - Required. The Example Store to be created.

Throws:

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

createExampleStoreAsync

public final com.google.api.gax.longrunning.OperationFuture<ExampleStore,CreateExampleStoreOperationMetadata> createExampleStoreAsync(String parent,
                                                                                                                                      ExampleStore exampleStore)

Create an ExampleStore.

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 (ExampleStoreServiceClient exampleStoreServiceClient = ExampleStoreServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   ExampleStore exampleStore = ExampleStore.newBuilder().build();
   ExampleStore response =
       exampleStoreServiceClient.createExampleStoreAsync(parent, exampleStore).get();
 }
 

Parameters:

parent - Required. The resource name of the Location to create the ExampleStore in. Format: `projects/{project}/locations/{location}`

exampleStore - Required. The Example Store to be created.

Throws:

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

createExampleStoreAsync

public final com.google.api.gax.longrunning.OperationFuture<ExampleStore,CreateExampleStoreOperationMetadata> createExampleStoreAsync(CreateExampleStoreRequest request)

Create an ExampleStore.

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 (ExampleStoreServiceClient exampleStoreServiceClient = ExampleStoreServiceClient.create()) {
   CreateExampleStoreRequest request =
       CreateExampleStoreRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setExampleStore(ExampleStore.newBuilder().build())
           .build();
   ExampleStore response = exampleStoreServiceClient.createExampleStoreAsync(request).get();
 }
 

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

createExampleStoreOperationCallable

public final com.google.api.gax.rpc.OperationCallable<CreateExampleStoreRequest,ExampleStore,CreateExampleStoreOperationMetadata> createExampleStoreOperationCallable()

Create an ExampleStore.

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 (ExampleStoreServiceClient exampleStoreServiceClient = ExampleStoreServiceClient.create()) {
   CreateExampleStoreRequest request =
       CreateExampleStoreRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setExampleStore(ExampleStore.newBuilder().build())
           .build();
   OperationFuture<ExampleStore, CreateExampleStoreOperationMetadata> future =
       exampleStoreServiceClient.createExampleStoreOperationCallable().futureCall(request);
   // Do something.
   ExampleStore response = future.get();
 }
 

createExampleStoreCallable

public final com.google.api.gax.rpc.UnaryCallable<CreateExampleStoreRequest,com.google.longrunning.Operation> createExampleStoreCallable()

Create an ExampleStore.

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 (ExampleStoreServiceClient exampleStoreServiceClient = ExampleStoreServiceClient.create()) {
   CreateExampleStoreRequest request =
       CreateExampleStoreRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setExampleStore(ExampleStore.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       exampleStoreServiceClient.createExampleStoreCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

getExampleStore

public final ExampleStore getExampleStore(ExampleStoreName name)

Get an ExampleStore.

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 (ExampleStoreServiceClient exampleStoreServiceClient = ExampleStoreServiceClient.create()) {
   ExampleStoreName name = ExampleStoreName.of("[PROJECT]", "[LOCATION]", "[EXAMPLE_STORE]");
   ExampleStore response = exampleStoreServiceClient.getExampleStore(name);
 }
 

Parameters:

name - Required. The resource name of the ExampleStore. Format: `projects/{project}/locations/{location}/exampleStores/{example_store}`

Throws:

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

getExampleStore

public final ExampleStore getExampleStore(String name)

Get an ExampleStore.

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 (ExampleStoreServiceClient exampleStoreServiceClient = ExampleStoreServiceClient.create()) {
   String name = ExampleStoreName.of("[PROJECT]", "[LOCATION]", "[EXAMPLE_STORE]").toString();
   ExampleStore response = exampleStoreServiceClient.getExampleStore(name);
 }
 

Parameters:

name - Required. The resource name of the ExampleStore. Format: `projects/{project}/locations/{location}/exampleStores/{example_store}`

Throws:

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

getExampleStore

public final ExampleStore getExampleStore(GetExampleStoreRequest request)

Get an ExampleStore.

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 (ExampleStoreServiceClient exampleStoreServiceClient = ExampleStoreServiceClient.create()) {
   GetExampleStoreRequest request =
       GetExampleStoreRequest.newBuilder()
           .setName(ExampleStoreName.of("[PROJECT]", "[LOCATION]", "[EXAMPLE_STORE]").toString())
           .build();
   ExampleStore response = exampleStoreServiceClient.getExampleStore(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

getExampleStoreCallable

public final com.google.api.gax.rpc.UnaryCallable<GetExampleStoreRequest,ExampleStore> getExampleStoreCallable()

Get an ExampleStore.

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 (ExampleStoreServiceClient exampleStoreServiceClient = ExampleStoreServiceClient.create()) {
   GetExampleStoreRequest request =
       GetExampleStoreRequest.newBuilder()
           .setName(ExampleStoreName.of("[PROJECT]", "[LOCATION]", "[EXAMPLE_STORE]").toString())
           .build();
   ApiFuture<ExampleStore> future =
       exampleStoreServiceClient.getExampleStoreCallable().futureCall(request);
   // Do something.
   ExampleStore response = future.get();
 }
 

updateExampleStoreAsync

public final com.google.api.gax.longrunning.OperationFuture<ExampleStore,UpdateExampleStoreOperationMetadata> updateExampleStoreAsync(ExampleStore exampleStore,
                                                                                                                                      com.google.protobuf.FieldMask updateMask)

Update an ExampleStore.

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 (ExampleStoreServiceClient exampleStoreServiceClient = ExampleStoreServiceClient.create()) {
   ExampleStore exampleStore = ExampleStore.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   ExampleStore response =
       exampleStoreServiceClient.updateExampleStoreAsync(exampleStore, updateMask).get();
 }
 

Parameters:

exampleStore - Required. The Example Store which replaces the resource on the server.

updateMask - Optional. Mask specifying which fields to update. Supported fields:

* `display_name` * `description`

Throws:

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

updateExampleStoreAsync

public final com.google.api.gax.longrunning.OperationFuture<ExampleStore,UpdateExampleStoreOperationMetadata> updateExampleStoreAsync(UpdateExampleStoreRequest request)

Update an ExampleStore.

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 (ExampleStoreServiceClient exampleStoreServiceClient = ExampleStoreServiceClient.create()) {
   UpdateExampleStoreRequest request =
       UpdateExampleStoreRequest.newBuilder()
           .setExampleStore(ExampleStore.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ExampleStore response = exampleStoreServiceClient.updateExampleStoreAsync(request).get();
 }
 

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

updateExampleStoreOperationCallable

public final com.google.api.gax.rpc.OperationCallable<UpdateExampleStoreRequest,ExampleStore,UpdateExampleStoreOperationMetadata> updateExampleStoreOperationCallable()

Update an ExampleStore.

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 (ExampleStoreServiceClient exampleStoreServiceClient = ExampleStoreServiceClient.create()) {
   UpdateExampleStoreRequest request =
       UpdateExampleStoreRequest.newBuilder()
           .setExampleStore(ExampleStore.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   OperationFuture<ExampleStore, UpdateExampleStoreOperationMetadata> future =
       exampleStoreServiceClient.updateExampleStoreOperationCallable().futureCall(request);
   // Do something.
   ExampleStore response = future.get();
 }
 

updateExampleStoreCallable

public final com.google.api.gax.rpc.UnaryCallable<UpdateExampleStoreRequest,com.google.longrunning.Operation> updateExampleStoreCallable()

Update an ExampleStore.

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 (ExampleStoreServiceClient exampleStoreServiceClient = ExampleStoreServiceClient.create()) {
   UpdateExampleStoreRequest request =
       UpdateExampleStoreRequest.newBuilder()
           .setExampleStore(ExampleStore.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       exampleStoreServiceClient.updateExampleStoreCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

deleteExampleStoreAsync

public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteExampleStoreOperationMetadata> deleteExampleStoreAsync(ExampleStoreName name)

Delete an ExampleStore.

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 (ExampleStoreServiceClient exampleStoreServiceClient = ExampleStoreServiceClient.create()) {
   ExampleStoreName name = ExampleStoreName.of("[PROJECT]", "[LOCATION]", "[EXAMPLE_STORE]");
   exampleStoreServiceClient.deleteExampleStoreAsync(name).get();
 }
 

Parameters:

name - Required. The resource name of the ExampleStore to be deleted. Format: `projects/{project}/locations/{location}/exampleStores/{example_store}`

Throws:

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

deleteExampleStoreAsync

public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteExampleStoreOperationMetadata> deleteExampleStoreAsync(String name)

Delete an ExampleStore.

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 (ExampleStoreServiceClient exampleStoreServiceClient = ExampleStoreServiceClient.create()) {
   String name = ExampleStoreName.of("[PROJECT]", "[LOCATION]", "[EXAMPLE_STORE]").toString();
   exampleStoreServiceClient.deleteExampleStoreAsync(name).get();
 }
 

Parameters:

name - Required. The resource name of the ExampleStore to be deleted. Format: `projects/{project}/locations/{location}/exampleStores/{example_store}`

Throws:

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

deleteExampleStoreAsync

public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,DeleteExampleStoreOperationMetadata> deleteExampleStoreAsync(DeleteExampleStoreRequest request)

Delete an ExampleStore.

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 (ExampleStoreServiceClient exampleStoreServiceClient = ExampleStoreServiceClient.create()) {
   DeleteExampleStoreRequest request =
       DeleteExampleStoreRequest.newBuilder()
           .setName(ExampleStoreName.of("[PROJECT]", "[LOCATION]", "[EXAMPLE_STORE]").toString())
           .build();
   exampleStoreServiceClient.deleteExampleStoreAsync(request).get();
 }
 

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

deleteExampleStoreOperationCallable

public final com.google.api.gax.rpc.OperationCallable<DeleteExampleStoreRequest,com.google.protobuf.Empty,DeleteExampleStoreOperationMetadata> deleteExampleStoreOperationCallable()

Delete an ExampleStore.

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 (ExampleStoreServiceClient exampleStoreServiceClient = ExampleStoreServiceClient.create()) {
   DeleteExampleStoreRequest request =
       DeleteExampleStoreRequest.newBuilder()
           .setName(ExampleStoreName.of("[PROJECT]", "[LOCATION]", "[EXAMPLE_STORE]").toString())
           .build();
   OperationFuture<Empty, DeleteExampleStoreOperationMetadata> future =
       exampleStoreServiceClient.deleteExampleStoreOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 

deleteExampleStoreCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteExampleStoreRequest,com.google.longrunning.Operation> deleteExampleStoreCallable()

Delete an ExampleStore.

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 (ExampleStoreServiceClient exampleStoreServiceClient = ExampleStoreServiceClient.create()) {
   DeleteExampleStoreRequest request =
       DeleteExampleStoreRequest.newBuilder()
           .setName(ExampleStoreName.of("[PROJECT]", "[LOCATION]", "[EXAMPLE_STORE]").toString())
           .build();
   ApiFuture<Operation> future =
       exampleStoreServiceClient.deleteExampleStoreCallable().futureCall(request);
   // Do something.
   future.get();
 }
 

listExampleStores

public final ExampleStoreServiceClient.ListExampleStoresPagedResponse listExampleStores(LocationName parent)

List ExampleStores in 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 (ExampleStoreServiceClient exampleStoreServiceClient = ExampleStoreServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (ExampleStore element :
       exampleStoreServiceClient.listExampleStores(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. The resource name of the Location to list the ExampleStores from. Format: `projects/{project}/locations/{location}`

Throws:

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

listExampleStores

public final ExampleStoreServiceClient.ListExampleStoresPagedResponse listExampleStores(String parent)

List ExampleStores in 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 (ExampleStoreServiceClient exampleStoreServiceClient = ExampleStoreServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (ExampleStore element :
       exampleStoreServiceClient.listExampleStores(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. The resource name of the Location to list the ExampleStores from. Format: `projects/{project}/locations/{location}`

Throws:

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

listExampleStores

public final ExampleStoreServiceClient.ListExampleStoresPagedResponse listExampleStores(ListExampleStoresRequest request)

List ExampleStores in 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 (ExampleStoreServiceClient exampleStoreServiceClient = ExampleStoreServiceClient.create()) {
   ListExampleStoresRequest request =
       ListExampleStoresRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (ExampleStore element :
       exampleStoreServiceClient.listExampleStores(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

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

listExampleStoresPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListExampleStoresRequest,ExampleStoreServiceClient.ListExampleStoresPagedResponse> listExampleStoresPagedCallable()

List ExampleStores in 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 (ExampleStoreServiceClient exampleStoreServiceClient = ExampleStoreServiceClient.create()) {
   ListExampleStoresRequest request =
       ListExampleStoresRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<ExampleStore> future =
       exampleStoreServiceClient.listExampleStoresPagedCallable().futureCall(request);
   // Do something.
   for (ExampleStore element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listExampleStoresCallable

public final com.google.api.gax.rpc.UnaryCallable<ListExampleStoresRequest,ListExampleStoresResponse> listExampleStoresCallable()

List ExampleStores in 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 (ExampleStoreServiceClient exampleStoreServiceClient = ExampleStoreServiceClient.create()) {
   ListExampleStoresRequest request =
       ListExampleStoresRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListExampleStoresResponse response =
         exampleStoreServiceClient.listExampleStoresCallable().call(request);
     for (ExampleStore element : response.getExampleStoresList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

upsertExamples

public final UpsertExamplesResponse upsertExamples(UpsertExamplesRequest request)

Create or update Examples in the Example Store.

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 (ExampleStoreServiceClient exampleStoreServiceClient = ExampleStoreServiceClient.create()) {
   UpsertExamplesRequest request =
       UpsertExamplesRequest.newBuilder()
           .setExampleStore(
               ExampleStoreName.of("[PROJECT]", "[LOCATION]", "[EXAMPLE_STORE]").toString())
           .addAllExamples(new ArrayList<Example>())
           .setOverwrite(true)
           .build();
   UpsertExamplesResponse response = exampleStoreServiceClient.upsertExamples(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

upsertExamplesCallable

public final com.google.api.gax.rpc.UnaryCallable<UpsertExamplesRequest,UpsertExamplesResponse> upsertExamplesCallable()

Create or update Examples in the Example Store.

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 (ExampleStoreServiceClient exampleStoreServiceClient = ExampleStoreServiceClient.create()) {
   UpsertExamplesRequest request =
       UpsertExamplesRequest.newBuilder()
           .setExampleStore(
               ExampleStoreName.of("[PROJECT]", "[LOCATION]", "[EXAMPLE_STORE]").toString())
           .addAllExamples(new ArrayList<Example>())
           .setOverwrite(true)
           .build();
   ApiFuture<UpsertExamplesResponse> future =
       exampleStoreServiceClient.upsertExamplesCallable().futureCall(request);
   // Do something.
   UpsertExamplesResponse response = future.get();
 }
 

removeExamples

public final RemoveExamplesResponse removeExamples(RemoveExamplesRequest request)

Remove Examples from the Example Store.

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 (ExampleStoreServiceClient exampleStoreServiceClient = ExampleStoreServiceClient.create()) {
   RemoveExamplesRequest request =
       RemoveExamplesRequest.newBuilder()
           .setExampleStore(
               ExampleStoreName.of("[PROJECT]", "[LOCATION]", "[EXAMPLE_STORE]").toString())
           .addAllExampleIds(new ArrayList<String>())
           .build();
   RemoveExamplesResponse response = exampleStoreServiceClient.removeExamples(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

removeExamplesCallable

public final com.google.api.gax.rpc.UnaryCallable<RemoveExamplesRequest,RemoveExamplesResponse> removeExamplesCallable()

Remove Examples from the Example Store.

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 (ExampleStoreServiceClient exampleStoreServiceClient = ExampleStoreServiceClient.create()) {
   RemoveExamplesRequest request =
       RemoveExamplesRequest.newBuilder()
           .setExampleStore(
               ExampleStoreName.of("[PROJECT]", "[LOCATION]", "[EXAMPLE_STORE]").toString())
           .addAllExampleIds(new ArrayList<String>())
           .build();
   ApiFuture<RemoveExamplesResponse> future =
       exampleStoreServiceClient.removeExamplesCallable().futureCall(request);
   // Do something.
   RemoveExamplesResponse response = future.get();
 }
 

searchExamples

public final SearchExamplesResponse searchExamples(SearchExamplesRequest request)

Search for similar Examples for given selection criteria.

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 (ExampleStoreServiceClient exampleStoreServiceClient = ExampleStoreServiceClient.create()) {
   SearchExamplesRequest request =
       SearchExamplesRequest.newBuilder()
           .setExampleStore(
               ExampleStoreName.of("[PROJECT]", "[LOCATION]", "[EXAMPLE_STORE]").toString())
           .setTopK(110545921)
           .build();
   SearchExamplesResponse response = exampleStoreServiceClient.searchExamples(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

searchExamplesCallable

public final com.google.api.gax.rpc.UnaryCallable<SearchExamplesRequest,SearchExamplesResponse> searchExamplesCallable()

Search for similar Examples for given selection criteria.

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 (ExampleStoreServiceClient exampleStoreServiceClient = ExampleStoreServiceClient.create()) {
   SearchExamplesRequest request =
       SearchExamplesRequest.newBuilder()
           .setExampleStore(
               ExampleStoreName.of("[PROJECT]", "[LOCATION]", "[EXAMPLE_STORE]").toString())
           .setTopK(110545921)
           .build();
   ApiFuture<SearchExamplesResponse> future =
       exampleStoreServiceClient.searchExamplesCallable().futureCall(request);
   // Do something.
   SearchExamplesResponse response = future.get();
 }
 

fetchExamples

public final ExampleStoreServiceClient.FetchExamplesPagedResponse fetchExamples(FetchExamplesRequest request)

Get Examples from the Example Store.

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 (ExampleStoreServiceClient exampleStoreServiceClient = ExampleStoreServiceClient.create()) {
   FetchExamplesRequest request =
       FetchExamplesRequest.newBuilder()
           .setExampleStore(
               ExampleStoreName.of("[PROJECT]", "[LOCATION]", "[EXAMPLE_STORE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .addAllExampleIds(new ArrayList<String>())
           .build();
   for (Example element : exampleStoreServiceClient.fetchExamples(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

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

fetchExamplesPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<FetchExamplesRequest,ExampleStoreServiceClient.FetchExamplesPagedResponse> fetchExamplesPagedCallable()

Get Examples from the Example Store.

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 (ExampleStoreServiceClient exampleStoreServiceClient = ExampleStoreServiceClient.create()) {
   FetchExamplesRequest request =
       FetchExamplesRequest.newBuilder()
           .setExampleStore(
               ExampleStoreName.of("[PROJECT]", "[LOCATION]", "[EXAMPLE_STORE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .addAllExampleIds(new ArrayList<String>())
           .build();
   ApiFuture<Example> future =
       exampleStoreServiceClient.fetchExamplesPagedCallable().futureCall(request);
   // Do something.
   for (Example element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

fetchExamplesCallable

public final com.google.api.gax.rpc.UnaryCallable<FetchExamplesRequest,FetchExamplesResponse> fetchExamplesCallable()

Get Examples from the Example Store.

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 (ExampleStoreServiceClient exampleStoreServiceClient = ExampleStoreServiceClient.create()) {
   FetchExamplesRequest request =
       FetchExamplesRequest.newBuilder()
           .setExampleStore(
               ExampleStoreName.of("[PROJECT]", "[LOCATION]", "[EXAMPLE_STORE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .addAllExampleIds(new ArrayList<String>())
           .build();
   while (true) {
     FetchExamplesResponse response =
         exampleStoreServiceClient.fetchExamplesCallable().call(request);
     for (Example element : response.getExamplesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

listLocations

public final ExampleStoreServiceClient.ListLocationsPagedResponse listLocations(com.google.cloud.location.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 (ExampleStoreServiceClient exampleStoreServiceClient = ExampleStoreServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Location element : exampleStoreServiceClient.listLocations(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

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

listLocationsPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,ExampleStoreServiceClient.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 (ExampleStoreServiceClient exampleStoreServiceClient = ExampleStoreServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Location> future =
       exampleStoreServiceClient.listLocationsPagedCallable().futureCall(request);
   // Do something.
   for (Location element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listLocationsCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.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 (ExampleStoreServiceClient exampleStoreServiceClient = ExampleStoreServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListLocationsResponse response =
         exampleStoreServiceClient.listLocationsCallable().call(request);
     for (Location element : response.getLocationsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

getLocation

public final com.google.cloud.location.Location getLocation(com.google.cloud.location.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 (ExampleStoreServiceClient exampleStoreServiceClient = ExampleStoreServiceClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = exampleStoreServiceClient.getLocation(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

getLocationCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.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 (ExampleStoreServiceClient exampleStoreServiceClient = ExampleStoreServiceClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Location> future =
       exampleStoreServiceClient.getLocationCallable().futureCall(request);
   // Do something.
   Location response = future.get();
 }
 

setIamPolicy

public final com.google.iam.v1.Policy setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request)

Sets the access control policy on the specified resource. Replacesany existing policy.

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

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 (ExampleStoreServiceClient exampleStoreServiceClient = ExampleStoreServiceClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Policy response = exampleStoreServiceClient.setIamPolicy(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

setIamPolicyCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> setIamPolicyCallable()

Sets the access control policy on the specified resource. Replacesany existing policy.

Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.

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 (ExampleStoreServiceClient exampleStoreServiceClient = ExampleStoreServiceClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Policy> future =
       exampleStoreServiceClient.setIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }
 

getIamPolicy

public final com.google.iam.v1.Policy getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request)

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

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 (ExampleStoreServiceClient exampleStoreServiceClient = ExampleStoreServiceClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   Policy response = exampleStoreServiceClient.getIamPolicy(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

getIamPolicyCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy> getIamPolicyCallable()

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

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 (ExampleStoreServiceClient exampleStoreServiceClient = ExampleStoreServiceClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   ApiFuture<Policy> future =
       exampleStoreServiceClient.getIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }
 

testIamPermissions

public final com.google.iam.v1.TestIamPermissionsResponse testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request)

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error.

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

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 (ExampleStoreServiceClient exampleStoreServiceClient = ExampleStoreServiceClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   TestIamPermissionsResponse response = exampleStoreServiceClient.testIamPermissions(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

testIamPermissionsCallable

public final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> testIamPermissionsCallable()

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error.

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

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 (ExampleStoreServiceClient exampleStoreServiceClient = ExampleStoreServiceClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   ApiFuture<TestIamPermissionsResponse> future =
       exampleStoreServiceClient.testIamPermissionsCallable().futureCall(request);
   // Do something.
   TestIamPermissionsResponse response = future.get();
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:

awaitTermination in interface com.google.api.gax.core.BackgroundResource

Throws:

InterruptedException