@Generated(value="by gapic-generator-java")
See: Description
The interfaces provided are listed below, along with usage samples.
======================= AssistantServiceClient =======================
Service Description: Service for managing Assistant configuration and assisting users.
Sample for AssistantServiceClient:
// 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 (AssistantServiceClient assistantServiceClient = AssistantServiceClient.create()) {
StreamAssistRequest request =
StreamAssistRequest.newBuilder()
.setName(
AssistantName.of(
"[PROJECT]", "[LOCATION]", "[COLLECTION]", "[ENGINE]", "[ASSISTANT]")
.toString())
.setQuery(Query.newBuilder().build())
.setSession(
SessionName.ofProjectLocationDataStoreSessionName(
"[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SESSION]")
.toString())
.setUserMetadata(AssistUserMetadata.newBuilder().build())
.setToolsSpec(StreamAssistRequest.ToolsSpec.newBuilder().build())
.setGenerationSpec(StreamAssistRequest.GenerationSpec.newBuilder().build())
.build();
ServerStream<StreamAssistResponse> stream =
assistantServiceClient.streamAssistCallable().call(request);
for (StreamAssistResponse response : stream) {
// Do something when a response is received.
}
}
======================= CmekConfigServiceClient =======================
Service Description: Service for managing CMEK related tasks
Sample for CmekConfigServiceClient:
// 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 (CmekConfigServiceClient cmekConfigServiceClient = CmekConfigServiceClient.create()) {
CmekConfigName name = CmekConfigName.ofProjectLocationName("[PROJECT]", "[LOCATION]");
CmekConfig response = cmekConfigServiceClient.getCmekConfig(name);
}
======================= CompletionServiceClient =======================
Service Description: Service for Auto-Completion.
Sample for CompletionServiceClient:
// 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 (CompletionServiceClient completionServiceClient = CompletionServiceClient.create()) {
CompleteQueryRequest request =
CompleteQueryRequest.newBuilder()
.setDataStore(
DataStoreName.ofProjectLocationDataStoreName(
"[PROJECT]", "[LOCATION]", "[DATA_STORE]")
.toString())
.setQuery("query107944136")
.setQueryModel("queryModel-184930495")
.setUserPseudoId("userPseudoId-1155274652")
.setIncludeTailSuggestions(true)
.build();
CompleteQueryResponse response = completionServiceClient.completeQuery(request);
}
======================= ControlServiceClient =======================
Service Description: Service for performing CRUD operations on Controls. Controls allow for custom logic to be implemented in the serving path. Controls need to be attached to a Serving Config to be considered during a request.
Sample for ControlServiceClient:
// 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 (ControlServiceClient controlServiceClient = ControlServiceClient.create()) {
DataStoreName parent =
DataStoreName.ofProjectLocationDataStoreName("[PROJECT]", "[LOCATION]", "[DATA_STORE]");
Control control = Control.newBuilder().build();
String controlId = "controlId-395080872";
Control response = controlServiceClient.createControl(parent, control, controlId);
}
======================= ConversationalSearchServiceClient =======================
Service Description: Service for conversational search.
Sample for ConversationalSearchServiceClient:
// 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 (ConversationalSearchServiceClient conversationalSearchServiceClient =
ConversationalSearchServiceClient.create()) {
ConversationName name =
ConversationName.ofProjectLocationDataStoreConversationName(
"[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[CONVERSATION]");
TextInput query = TextInput.newBuilder().build();
ConverseConversationResponse response =
conversationalSearchServiceClient.converseConversation(name, query);
}
======================= DataStoreServiceClient =======================
Service Description: Service for managing [DataStore][google.cloud.discoveryengine.v1.DataStore] configuration.
Sample for DataStoreServiceClient:
// 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 (DataStoreServiceClient dataStoreServiceClient = DataStoreServiceClient.create()) {
DataStoreName name =
DataStoreName.ofProjectLocationDataStoreName("[PROJECT]", "[LOCATION]", "[DATA_STORE]");
DataStore response = dataStoreServiceClient.getDataStore(name);
}
======================= DocumentServiceClient =======================
Service Description: Service for ingesting [Document][google.cloud.discoveryengine.v1.Document] information of the customer's website.
Sample for DocumentServiceClient:
// 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 (DocumentServiceClient documentServiceClient = DocumentServiceClient.create()) {
DocumentName name =
DocumentName.ofProjectLocationDataStoreBranchDocumentName(
"[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[BRANCH]", "[DOCUMENT]");
Document response = documentServiceClient.getDocument(name);
}
======================= EngineServiceClient =======================
Service Description: Service for managing [Engine][google.cloud.discoveryengine.v1.Engine] configuration.
Sample for EngineServiceClient:
// 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 (EngineServiceClient engineServiceClient = EngineServiceClient.create()) {
Engine engine = Engine.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
Engine response = engineServiceClient.updateEngine(engine, updateMask);
}
======================= GroundedGenerationServiceClient =======================
Service Description: Service for grounded generation.
Sample for GroundedGenerationServiceClient:
// 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 (GroundedGenerationServiceClient groundedGenerationServiceClient =
GroundedGenerationServiceClient.create()) {
GenerateGroundedContentRequest request =
GenerateGroundedContentRequest.newBuilder()
.setLocation(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setSystemInstruction(GroundedGenerationContent.newBuilder().build())
.addAllContents(new ArrayList<GroundedGenerationContent>())
.setGenerationSpec(GenerateGroundedContentRequest.GenerationSpec.newBuilder().build())
.setGroundingSpec(GenerateGroundedContentRequest.GroundingSpec.newBuilder().build())
.putAllUserLabels(new HashMap<String, String>())
.build();
GenerateGroundedContentResponse response =
groundedGenerationServiceClient.generateGroundedContent(request);
}
======================= IdentityMappingStoreServiceClient =======================
Service Description: Service for managing Identity Mapping Stores.
Sample for IdentityMappingStoreServiceClient:
// 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 (IdentityMappingStoreServiceClient identityMappingStoreServiceClient =
IdentityMappingStoreServiceClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
IdentityMappingStore identityMappingStore = IdentityMappingStore.newBuilder().build();
String identityMappingStoreId = "identityMappingStoreId677904780";
IdentityMappingStore response =
identityMappingStoreServiceClient.createIdentityMappingStore(
parent, identityMappingStore, identityMappingStoreId);
}
======================= ProjectServiceClient =======================
Service Description: Service for operations on the [Project][google.cloud.discoveryengine.v1.Project].
Sample for ProjectServiceClient:
// 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 (ProjectServiceClient projectServiceClient = ProjectServiceClient.create()) {
ProjectName name = ProjectName.of("[PROJECT]");
Project response = projectServiceClient.provisionProjectAsync(name).get();
}
======================= RankServiceClient =======================
Service Description: Service for ranking text records.
Sample for RankServiceClient:
// 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 (RankServiceClient rankServiceClient = RankServiceClient.create()) {
RankRequest request =
RankRequest.newBuilder()
.setRankingConfig(
RankingConfigName.of("[PROJECT]", "[LOCATION]", "[RANKING_CONFIG]").toString())
.setModel("model104069929")
.setTopN(110545924)
.setQuery("query107944136")
.addAllRecords(new ArrayList<RankingRecord>())
.setIgnoreRecordDetailsInResponse(true)
.putAllUserLabels(new HashMap<String, String>())
.build();
RankResponse response = rankServiceClient.rank(request);
}
======================= RecommendationServiceClient =======================
Service Description: Service for making recommendations.
Sample for RecommendationServiceClient:
// 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 (RecommendationServiceClient recommendationServiceClient =
RecommendationServiceClient.create()) {
RecommendRequest request =
RecommendRequest.newBuilder()
.setServingConfig(
ServingConfigName.ofProjectLocationDataStoreServingConfigName(
"[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SERVING_CONFIG]")
.toString())
.setUserEvent(UserEvent.newBuilder().build())
.setPageSize(883849137)
.setFilter("filter-1274492040")
.setValidateOnly(true)
.putAllParams(new HashMap<String, Value>())
.putAllUserLabels(new HashMap<String, String>())
.build();
RecommendResponse response = recommendationServiceClient.recommend(request);
}
======================= SchemaServiceClient =======================
Service Description: Service for managing [Schema][google.cloud.discoveryengine.v1.Schema]s.
Sample for SchemaServiceClient:
// 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 (SchemaServiceClient schemaServiceClient = SchemaServiceClient.create()) {
SchemaName name =
SchemaName.ofProjectLocationDataStoreSchemaName(
"[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SCHEMA]");
Schema response = schemaServiceClient.getSchema(name);
}
======================= SearchServiceClient =======================
Service Description: Service for search.
Sample for SearchServiceClient:
// 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 (SearchServiceClient searchServiceClient = SearchServiceClient.create()) {
SearchRequest request =
SearchRequest.newBuilder()
.setServingConfig(
ServingConfigName.ofProjectLocationDataStoreServingConfigName(
"[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SERVING_CONFIG]")
.toString())
.setBranch(
BranchName.ofProjectLocationDataStoreBranchName(
"[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[BRANCH]")
.toString())
.setQuery("query107944136")
.addAllPageCategories(new ArrayList<String>())
.setImageQuery(SearchRequest.ImageQuery.newBuilder().build())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setOffset(-1019779949)
.setOneBoxPageSize(1988477988)
.addAllDataStoreSpecs(new ArrayList<SearchRequest.DataStoreSpec>())
.setFilter("filter-1274492040")
.setCanonicalFilter("canonicalFilter-722283124")
.setOrderBy("orderBy-1207110587")
.setUserInfo(UserInfo.newBuilder().build())
.setLanguageCode("languageCode-2092349083")
.addAllFacetSpecs(new ArrayList<SearchRequest.FacetSpec>())
.setBoostSpec(SearchRequest.BoostSpec.newBuilder().build())
.putAllParams(new HashMap<String, Value>())
.setQueryExpansionSpec(SearchRequest.QueryExpansionSpec.newBuilder().build())
.setSpellCorrectionSpec(SearchRequest.SpellCorrectionSpec.newBuilder().build())
.setUserPseudoId("userPseudoId-1155274652")
.setContentSearchSpec(SearchRequest.ContentSearchSpec.newBuilder().build())
.setRankingExpression("rankingExpression2110320494")
.setSafeSearch(true)
.putAllUserLabels(new HashMap<String, String>())
.setNaturalLanguageQueryUnderstandingSpec(
SearchRequest.NaturalLanguageQueryUnderstandingSpec.newBuilder().build())
.setSearchAsYouTypeSpec(SearchRequest.SearchAsYouTypeSpec.newBuilder().build())
.setDisplaySpec(SearchRequest.DisplaySpec.newBuilder().build())
.addAllCrowdingSpecs(new ArrayList<SearchRequest.CrowdingSpec>())
.setSession(
SessionName.ofProjectLocationDataStoreSessionName(
"[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[SESSION]")
.toString())
.setSessionSpec(SearchRequest.SessionSpec.newBuilder().build())
.setRelevanceScoreSpec(SearchRequest.RelevanceScoreSpec.newBuilder().build())
.build();
for (SearchResponse.SearchResult element : searchServiceClient.search(request).iterateAll()) {
// doThingsWith(element);
}
}
======================= SearchTuningServiceClient =======================
Service Description: Service for search tuning.
Sample for SearchTuningServiceClient:
// 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 (SearchTuningServiceClient searchTuningServiceClient = SearchTuningServiceClient.create()) {
ListCustomModelsRequest request =
ListCustomModelsRequest.newBuilder()
.setDataStore(
DataStoreName.ofProjectLocationCollectionDataStoreName(
"[PROJECT]", "[LOCATION]", "[COLLECTION]", "[DATA_STORE]")
.toString())
.build();
ListCustomModelsResponse response = searchTuningServiceClient.listCustomModels(request);
}
======================= ServingConfigServiceClient =======================
Service Description: Service for operations related to [ServingConfig][google.cloud.discoveryengine.v1.ServingConfig].
Sample for ServingConfigServiceClient:
// 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 (ServingConfigServiceClient servingConfigServiceClient =
ServingConfigServiceClient.create()) {
ServingConfig servingConfig = ServingConfig.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
ServingConfig response =
servingConfigServiceClient.updateServingConfig(servingConfig, updateMask);
}
======================= SessionServiceClient =======================
Service Description: Service for managing Sessions and Session-related resources.
Sample for SessionServiceClient:
// 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 (SessionServiceClient sessionServiceClient = SessionServiceClient.create()) {
DataStoreName parent =
DataStoreName.ofProjectLocationDataStoreName("[PROJECT]", "[LOCATION]", "[DATA_STORE]");
Session session = Session.newBuilder().build();
Session response = sessionServiceClient.createSession(parent, session);
}
======================= SiteSearchEngineServiceClient =======================
Service Description: Service for managing site search related resources.
Sample for SiteSearchEngineServiceClient:
// 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 (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
SiteSearchEngineServiceClient.create()) {
SiteSearchEngineName name =
SiteSearchEngineName.ofProjectLocationDataStoreName(
"[PROJECT]", "[LOCATION]", "[DATA_STORE]");
SiteSearchEngine response = siteSearchEngineServiceClient.getSiteSearchEngine(name);
}
======================= UserEventServiceClient =======================
Service Description: Service for ingesting end user actions on a website to Discovery Engine API.
Sample for UserEventServiceClient:
// 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 (UserEventServiceClient userEventServiceClient = UserEventServiceClient.create()) {
WriteUserEventRequest request =
WriteUserEventRequest.newBuilder()
.setParent(
DataStoreName.ofProjectLocationDataStoreName(
"[PROJECT]", "[LOCATION]", "[DATA_STORE]")
.toString())
.setUserEvent(UserEvent.newBuilder().build())
.setWriteAsync(true)
.build();
UserEvent response = userEventServiceClient.writeUserEvent(request);
}
======================= UserLicenseServiceClient =======================
Service Description: Service for managing User Licenses.
Sample for UserLicenseServiceClient:
// 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 (UserLicenseServiceClient userLicenseServiceClient = UserLicenseServiceClient.create()) {
UserStoreName parent = UserStoreName.of("[PROJECT]", "[LOCATION]", "[USER_STORE]");
for (UserLicense element : userLicenseServiceClient.listUserLicenses(parent).iterateAll()) {
// doThingsWith(element);
}
}
Copyright © 2026 Google LLC. All rights reserved.