com.google.cloud.discoveryengine.v1beta.SiteSearchEngineServiceClient Maven / Gradle / Ivy
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.cloud.discoveryengine.v1beta;
import com.google.api.core.ApiFuture;
import com.google.api.core.ApiFutures;
import com.google.api.core.BetaApi;
import com.google.api.gax.core.BackgroundResource;
import com.google.api.gax.httpjson.longrunning.OperationsClient;
import com.google.api.gax.longrunning.OperationFuture;
import com.google.api.gax.paging.AbstractFixedSizeCollection;
import com.google.api.gax.paging.AbstractPage;
import com.google.api.gax.paging.AbstractPagedListResponse;
import com.google.api.gax.rpc.OperationCallable;
import com.google.api.gax.rpc.PageContext;
import com.google.api.gax.rpc.UnaryCallable;
import com.google.cloud.discoveryengine.v1beta.stub.SiteSearchEngineServiceStub;
import com.google.cloud.discoveryengine.v1beta.stub.SiteSearchEngineServiceStubSettings;
import com.google.common.util.concurrent.MoreExecutors;
import com.google.longrunning.Operation;
import com.google.protobuf.Empty;
import java.io.IOException;
import java.util.List;
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;
// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
* Service Description: Service for managing site search related resources.
*
* 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:
*
*
{@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 (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
* SiteSearchEngineServiceClient.create()) {
* SiteSearchEngineName name =
* SiteSearchEngineName.ofProjectLocationDataStoreName(
* "[PROJECT]", "[LOCATION]", "[DATA_STORE]");
* SiteSearchEngine response = siteSearchEngineServiceClient.getSiteSearchEngine(name);
* }
* }
*
* Note: close() needs to be called on the SiteSearchEngineServiceClient 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
*
*
* GetSiteSearchEngine
Gets the [SiteSearchEngine][google.cloud.discoveryengine.v1beta.SiteSearchEngine].
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* getSiteSearchEngine(GetSiteSearchEngineRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* getSiteSearchEngine(SiteSearchEngineName name)
*
getSiteSearchEngine(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.
*
* getSiteSearchEngineCallable()
*
*
*
*
* CreateTargetSite
Creates a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* createTargetSiteAsync(CreateTargetSiteRequest request)
*
* Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
*
* createTargetSiteAsync(SiteSearchEngineName parent, TargetSite targetSite)
*
createTargetSiteAsync(String parent, TargetSite targetSite)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* createTargetSiteOperationCallable()
*
createTargetSiteCallable()
*
*
*
*
* BatchCreateTargetSites
Creates [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite] in a batch.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* batchCreateTargetSitesAsync(BatchCreateTargetSitesRequest request)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* batchCreateTargetSitesOperationCallable()
*
batchCreateTargetSitesCallable()
*
*
*
*
* GetTargetSite
Gets a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* getTargetSite(GetTargetSiteRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* getTargetSite(TargetSiteName name)
*
getTargetSite(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.
*
* getTargetSiteCallable()
*
*
*
*
* UpdateTargetSite
Updates a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* updateTargetSiteAsync(UpdateTargetSiteRequest request)
*
* Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
*
* updateTargetSiteAsync(TargetSite targetSite)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* updateTargetSiteOperationCallable()
*
updateTargetSiteCallable()
*
*
*
*
* DeleteTargetSite
Deletes a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* deleteTargetSiteAsync(DeleteTargetSiteRequest request)
*
* Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.
*
* deleteTargetSiteAsync(TargetSiteName name)
*
deleteTargetSiteAsync(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.
*
* deleteTargetSiteOperationCallable()
*
deleteTargetSiteCallable()
*
*
*
*
* ListTargetSites
Gets a list of [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite]s.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* listTargetSites(ListTargetSitesRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* listTargetSites(SiteSearchEngineName parent)
*
listTargetSites(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.
*
* listTargetSitesPagedCallable()
*
listTargetSitesCallable()
*
*
*
*
* EnableAdvancedSiteSearch
Upgrade from basic site search to advanced site search.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* enableAdvancedSiteSearchAsync(EnableAdvancedSiteSearchRequest request)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* enableAdvancedSiteSearchOperationCallable()
*
enableAdvancedSiteSearchCallable()
*
*
*
*
* DisableAdvancedSiteSearch
Downgrade from advanced site search to basic site search.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* disableAdvancedSiteSearchAsync(DisableAdvancedSiteSearchRequest request)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* disableAdvancedSiteSearchOperationCallable()
*
disableAdvancedSiteSearchCallable()
*
*
*
*
* RecrawlUris
Request on-demand recrawl for a list of URIs.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* recrawlUrisAsync(RecrawlUrisRequest request)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* recrawlUrisOperationCallable()
*
recrawlUrisCallable()
*
*
*
*
* BatchVerifyTargetSites
Verify target sites' ownership and validity. This API sends all the target sites under site search engine for verification.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* batchVerifyTargetSitesAsync(BatchVerifyTargetSitesRequest request)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* batchVerifyTargetSitesOperationCallable()
*
batchVerifyTargetSitesCallable()
*
*
*
*
* FetchDomainVerificationStatus
Returns list of target sites with its domain verification status. This method can only be called under data store with BASIC_SITE_SEARCH state at the moment.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* fetchDomainVerificationStatus(FetchDomainVerificationStatusRequest request)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* fetchDomainVerificationStatusPagedCallable()
*
fetchDomainVerificationStatusCallable()
*
*
*
*
*
* 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
* SiteSearchEngineServiceSettings to create(). For example:
*
*
To customize credentials:
*
*
{@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
* SiteSearchEngineServiceSettings siteSearchEngineServiceSettings =
* SiteSearchEngineServiceSettings.newBuilder()
* .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
* .build();
* SiteSearchEngineServiceClient siteSearchEngineServiceClient =
* SiteSearchEngineServiceClient.create(siteSearchEngineServiceSettings);
* }
*
* To customize the endpoint:
*
*
{@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
* SiteSearchEngineServiceSettings siteSearchEngineServiceSettings =
* SiteSearchEngineServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
* SiteSearchEngineServiceClient siteSearchEngineServiceClient =
* SiteSearchEngineServiceClient.create(siteSearchEngineServiceSettings);
* }
*
* To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over
* the wire:
*
*
{@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
* SiteSearchEngineServiceSettings siteSearchEngineServiceSettings =
* SiteSearchEngineServiceSettings.newHttpJsonBuilder().build();
* SiteSearchEngineServiceClient siteSearchEngineServiceClient =
* SiteSearchEngineServiceClient.create(siteSearchEngineServiceSettings);
* }
*
* Please refer to the GitHub repository's samples for more quickstart code snippets.
*/
@BetaApi
@Generated("by gapic-generator-java")
public class SiteSearchEngineServiceClient implements BackgroundResource {
private final SiteSearchEngineServiceSettings settings;
private final SiteSearchEngineServiceStub stub;
private final OperationsClient httpJsonOperationsClient;
private final com.google.longrunning.OperationsClient operationsClient;
/** Constructs an instance of SiteSearchEngineServiceClient with default settings. */
public static final SiteSearchEngineServiceClient create() throws IOException {
return create(SiteSearchEngineServiceSettings.newBuilder().build());
}
/**
* Constructs an instance of SiteSearchEngineServiceClient, using the given settings. The channels
* are created based on the settings passed in, or defaults for any settings that are not set.
*/
public static final SiteSearchEngineServiceClient create(SiteSearchEngineServiceSettings settings)
throws IOException {
return new SiteSearchEngineServiceClient(settings);
}
/**
* Constructs an instance of SiteSearchEngineServiceClient, using the given stub for making calls.
* This is for advanced usage - prefer using create(SiteSearchEngineServiceSettings).
*/
public static final SiteSearchEngineServiceClient create(SiteSearchEngineServiceStub stub) {
return new SiteSearchEngineServiceClient(stub);
}
/**
* Constructs an instance of SiteSearchEngineServiceClient, 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.
*/
protected SiteSearchEngineServiceClient(SiteSearchEngineServiceSettings settings)
throws IOException {
this.settings = settings;
this.stub = ((SiteSearchEngineServiceStubSettings) settings.getStubSettings()).createStub();
this.operationsClient =
com.google.longrunning.OperationsClient.create(this.stub.getOperationsStub());
this.httpJsonOperationsClient = OperationsClient.create(this.stub.getHttpJsonOperationsStub());
}
protected SiteSearchEngineServiceClient(SiteSearchEngineServiceStub stub) {
this.settings = null;
this.stub = stub;
this.operationsClient =
com.google.longrunning.OperationsClient.create(this.stub.getOperationsStub());
this.httpJsonOperationsClient = OperationsClient.create(this.stub.getHttpJsonOperationsStub());
}
public final SiteSearchEngineServiceSettings getSettings() {
return settings;
}
public SiteSearchEngineServiceStub getStub() {
return stub;
}
/**
* Returns the OperationsClient that can be used to query the status of a long-running operation
* returned by another API method call.
*/
public final com.google.longrunning.OperationsClient getOperationsClient() {
return operationsClient;
}
/**
* Returns the OperationsClient that can be used to query the status of a long-running operation
* returned by another API method call.
*/
@BetaApi
public final OperationsClient getHttpJsonOperationsClient() {
return httpJsonOperationsClient;
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets the [SiteSearchEngine][google.cloud.discoveryengine.v1beta.SiteSearchEngine].
*
*
Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
* SiteSearchEngineServiceClient.create()) {
* SiteSearchEngineName name =
* SiteSearchEngineName.ofProjectLocationDataStoreName(
* "[PROJECT]", "[LOCATION]", "[DATA_STORE]");
* SiteSearchEngine response = siteSearchEngineServiceClient.getSiteSearchEngine(name);
* }
* }
*
* @param name Required. Resource name of
* [SiteSearchEngine][google.cloud.discoveryengine.v1beta.SiteSearchEngine], such as
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
* If the caller does not have permission to access the [SiteSearchEngine], regardless of
* whether or not it exists, a PERMISSION_DENIED error is returned.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final SiteSearchEngine getSiteSearchEngine(SiteSearchEngineName name) {
GetSiteSearchEngineRequest request =
GetSiteSearchEngineRequest.newBuilder()
.setName(name == null ? null : name.toString())
.build();
return getSiteSearchEngine(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets the [SiteSearchEngine][google.cloud.discoveryengine.v1beta.SiteSearchEngine].
*
*
Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
* SiteSearchEngineServiceClient.create()) {
* String name =
* SiteSearchEngineName.ofProjectLocationDataStoreName(
* "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
* .toString();
* SiteSearchEngine response = siteSearchEngineServiceClient.getSiteSearchEngine(name);
* }
* }
*
* @param name Required. Resource name of
* [SiteSearchEngine][google.cloud.discoveryengine.v1beta.SiteSearchEngine], such as
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
* If the caller does not have permission to access the [SiteSearchEngine], regardless of
* whether or not it exists, a PERMISSION_DENIED error is returned.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final SiteSearchEngine getSiteSearchEngine(String name) {
GetSiteSearchEngineRequest request =
GetSiteSearchEngineRequest.newBuilder().setName(name).build();
return getSiteSearchEngine(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets the [SiteSearchEngine][google.cloud.discoveryengine.v1beta.SiteSearchEngine].
*
*
Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
* SiteSearchEngineServiceClient.create()) {
* GetSiteSearchEngineRequest request =
* GetSiteSearchEngineRequest.newBuilder()
* .setName(
* SiteSearchEngineName.ofProjectLocationDataStoreName(
* "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
* .toString())
* .build();
* SiteSearchEngine response = siteSearchEngineServiceClient.getSiteSearchEngine(request);
* }
* }
*
* @param 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
*/
public final SiteSearchEngine getSiteSearchEngine(GetSiteSearchEngineRequest request) {
return getSiteSearchEngineCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets the [SiteSearchEngine][google.cloud.discoveryengine.v1beta.SiteSearchEngine].
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
* SiteSearchEngineServiceClient.create()) {
* GetSiteSearchEngineRequest request =
* GetSiteSearchEngineRequest.newBuilder()
* .setName(
* SiteSearchEngineName.ofProjectLocationDataStoreName(
* "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
* .toString())
* .build();
* ApiFuture future =
* siteSearchEngineServiceClient.getSiteSearchEngineCallable().futureCall(request);
* // Do something.
* SiteSearchEngine response = future.get();
* }
* }
*/
public final UnaryCallable
getSiteSearchEngineCallable() {
return stub.getSiteSearchEngineCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
* SiteSearchEngineServiceClient.create()) {
* SiteSearchEngineName parent =
* SiteSearchEngineName.ofProjectLocationDataStoreName(
* "[PROJECT]", "[LOCATION]", "[DATA_STORE]");
* TargetSite targetSite = TargetSite.newBuilder().build();
* TargetSite response =
* siteSearchEngineServiceClient.createTargetSiteAsync(parent, targetSite).get();
* }
* }
*
* @param parent Required. Parent resource name of
* [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite], such as
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
* @param targetSite Required. The [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite] to
* create.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture createTargetSiteAsync(
SiteSearchEngineName parent, TargetSite targetSite) {
CreateTargetSiteRequest request =
CreateTargetSiteRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.setTargetSite(targetSite)
.build();
return createTargetSiteAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
* SiteSearchEngineServiceClient.create()) {
* String parent =
* SiteSearchEngineName.ofProjectLocationDataStoreName(
* "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
* .toString();
* TargetSite targetSite = TargetSite.newBuilder().build();
* TargetSite response =
* siteSearchEngineServiceClient.createTargetSiteAsync(parent, targetSite).get();
* }
* }
*
* @param parent Required. Parent resource name of
* [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite], such as
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
* @param targetSite Required. The [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite] to
* create.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture createTargetSiteAsync(
String parent, TargetSite targetSite) {
CreateTargetSiteRequest request =
CreateTargetSiteRequest.newBuilder().setParent(parent).setTargetSite(targetSite).build();
return createTargetSiteAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
* SiteSearchEngineServiceClient.create()) {
* CreateTargetSiteRequest request =
* CreateTargetSiteRequest.newBuilder()
* .setParent(
* SiteSearchEngineName.ofProjectLocationDataStoreName(
* "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
* .toString())
* .setTargetSite(TargetSite.newBuilder().build())
* .build();
* TargetSite response = siteSearchEngineServiceClient.createTargetSiteAsync(request).get();
* }
* }
*
* @param 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
*/
public final OperationFuture createTargetSiteAsync(
CreateTargetSiteRequest request) {
return createTargetSiteOperationCallable().futureCall(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
* SiteSearchEngineServiceClient.create()) {
* CreateTargetSiteRequest request =
* CreateTargetSiteRequest.newBuilder()
* .setParent(
* SiteSearchEngineName.ofProjectLocationDataStoreName(
* "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
* .toString())
* .setTargetSite(TargetSite.newBuilder().build())
* .build();
* OperationFuture future =
* siteSearchEngineServiceClient.createTargetSiteOperationCallable().futureCall(request);
* // Do something.
* TargetSite response = future.get();
* }
* }
*/
public final OperationCallable
createTargetSiteOperationCallable() {
return stub.createTargetSiteOperationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
* SiteSearchEngineServiceClient.create()) {
* CreateTargetSiteRequest request =
* CreateTargetSiteRequest.newBuilder()
* .setParent(
* SiteSearchEngineName.ofProjectLocationDataStoreName(
* "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
* .toString())
* .setTargetSite(TargetSite.newBuilder().build())
* .build();
* ApiFuture future =
* siteSearchEngineServiceClient.createTargetSiteCallable().futureCall(request);
* // Do something.
* Operation response = future.get();
* }
* }
*/
public final UnaryCallable createTargetSiteCallable() {
return stub.createTargetSiteCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite] in a batch.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
* SiteSearchEngineServiceClient.create()) {
* BatchCreateTargetSitesRequest request =
* BatchCreateTargetSitesRequest.newBuilder()
* .setParent(
* SiteSearchEngineName.ofProjectLocationDataStoreName(
* "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
* .toString())
* .addAllRequests(new ArrayList())
* .build();
* BatchCreateTargetSitesResponse response =
* siteSearchEngineServiceClient.batchCreateTargetSitesAsync(request).get();
* }
* }
*
* @param 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
*/
public final OperationFuture
batchCreateTargetSitesAsync(BatchCreateTargetSitesRequest request) {
return batchCreateTargetSitesOperationCallable().futureCall(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite] in a batch.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
* SiteSearchEngineServiceClient.create()) {
* BatchCreateTargetSitesRequest request =
* BatchCreateTargetSitesRequest.newBuilder()
* .setParent(
* SiteSearchEngineName.ofProjectLocationDataStoreName(
* "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
* .toString())
* .addAllRequests(new ArrayList())
* .build();
* OperationFuture future =
* siteSearchEngineServiceClient
* .batchCreateTargetSitesOperationCallable()
* .futureCall(request);
* // Do something.
* BatchCreateTargetSitesResponse response = future.get();
* }
* }
*/
public final OperationCallable<
BatchCreateTargetSitesRequest,
BatchCreateTargetSitesResponse,
BatchCreateTargetSiteMetadata>
batchCreateTargetSitesOperationCallable() {
return stub.batchCreateTargetSitesOperationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite] in a batch.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
* SiteSearchEngineServiceClient.create()) {
* BatchCreateTargetSitesRequest request =
* BatchCreateTargetSitesRequest.newBuilder()
* .setParent(
* SiteSearchEngineName.ofProjectLocationDataStoreName(
* "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
* .toString())
* .addAllRequests(new ArrayList())
* .build();
* ApiFuture future =
* siteSearchEngineServiceClient.batchCreateTargetSitesCallable().futureCall(request);
* // Do something.
* Operation response = future.get();
* }
* }
*/
public final UnaryCallable
batchCreateTargetSitesCallable() {
return stub.batchCreateTargetSitesCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
* SiteSearchEngineServiceClient.create()) {
* TargetSiteName name =
* TargetSiteName.ofProjectLocationDataStoreTargetSiteName(
* "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[TARGET_SITE]");
* TargetSite response = siteSearchEngineServiceClient.getTargetSite(name);
* }
* }
*
* @param name Required. Full resource name of
* [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite], such as
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`.
* If the caller does not have permission to access the
* [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite], regardless of whether or not
* it exists, a PERMISSION_DENIED error is returned.
*
If the requested [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite] does not
* exist, a NOT_FOUND error is returned.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TargetSite getTargetSite(TargetSiteName name) {
GetTargetSiteRequest request =
GetTargetSiteRequest.newBuilder().setName(name == null ? null : name.toString()).build();
return getTargetSite(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].
*
*
Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
* SiteSearchEngineServiceClient.create()) {
* String name =
* TargetSiteName.ofProjectLocationDataStoreTargetSiteName(
* "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[TARGET_SITE]")
* .toString();
* TargetSite response = siteSearchEngineServiceClient.getTargetSite(name);
* }
* }
*
* @param name Required. Full resource name of
* [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite], such as
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`.
* If the caller does not have permission to access the
* [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite], regardless of whether or not
* it exists, a PERMISSION_DENIED error is returned.
*
If the requested [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite] does not
* exist, a NOT_FOUND error is returned.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final TargetSite getTargetSite(String name) {
GetTargetSiteRequest request = GetTargetSiteRequest.newBuilder().setName(name).build();
return getTargetSite(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].
*
*
Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
* SiteSearchEngineServiceClient.create()) {
* GetTargetSiteRequest request =
* GetTargetSiteRequest.newBuilder()
* .setName(
* TargetSiteName.ofProjectLocationDataStoreTargetSiteName(
* "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[TARGET_SITE]")
* .toString())
* .build();
* TargetSite response = siteSearchEngineServiceClient.getTargetSite(request);
* }
* }
*
* @param 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
*/
public final TargetSite getTargetSite(GetTargetSiteRequest request) {
return getTargetSiteCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
* SiteSearchEngineServiceClient.create()) {
* GetTargetSiteRequest request =
* GetTargetSiteRequest.newBuilder()
* .setName(
* TargetSiteName.ofProjectLocationDataStoreTargetSiteName(
* "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[TARGET_SITE]")
* .toString())
* .build();
* ApiFuture future =
* siteSearchEngineServiceClient.getTargetSiteCallable().futureCall(request);
* // Do something.
* TargetSite response = future.get();
* }
* }
*/
public final UnaryCallable getTargetSiteCallable() {
return stub.getTargetSiteCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
* SiteSearchEngineServiceClient.create()) {
* TargetSite targetSite = TargetSite.newBuilder().build();
* TargetSite response = siteSearchEngineServiceClient.updateTargetSiteAsync(targetSite).get();
* }
* }
*
* @param targetSite Required. The target site to update. If the caller does not have permission
* to update the [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite], regardless of
* whether or not it exists, a PERMISSION_DENIED error is returned.
* If the [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite] to update does not
* exist, a NOT_FOUND error is returned.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture updateTargetSiteAsync(
TargetSite targetSite) {
UpdateTargetSiteRequest request =
UpdateTargetSiteRequest.newBuilder().setTargetSite(targetSite).build();
return updateTargetSiteAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
* SiteSearchEngineServiceClient.create()) {
* UpdateTargetSiteRequest request =
* UpdateTargetSiteRequest.newBuilder()
* .setTargetSite(TargetSite.newBuilder().build())
* .build();
* TargetSite response = siteSearchEngineServiceClient.updateTargetSiteAsync(request).get();
* }
* }
*
* @param 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
*/
public final OperationFuture updateTargetSiteAsync(
UpdateTargetSiteRequest request) {
return updateTargetSiteOperationCallable().futureCall(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
* SiteSearchEngineServiceClient.create()) {
* UpdateTargetSiteRequest request =
* UpdateTargetSiteRequest.newBuilder()
* .setTargetSite(TargetSite.newBuilder().build())
* .build();
* OperationFuture future =
* siteSearchEngineServiceClient.updateTargetSiteOperationCallable().futureCall(request);
* // Do something.
* TargetSite response = future.get();
* }
* }
*/
public final OperationCallable
updateTargetSiteOperationCallable() {
return stub.updateTargetSiteOperationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
* SiteSearchEngineServiceClient.create()) {
* UpdateTargetSiteRequest request =
* UpdateTargetSiteRequest.newBuilder()
* .setTargetSite(TargetSite.newBuilder().build())
* .build();
* ApiFuture future =
* siteSearchEngineServiceClient.updateTargetSiteCallable().futureCall(request);
* // Do something.
* Operation response = future.get();
* }
* }
*/
public final UnaryCallable updateTargetSiteCallable() {
return stub.updateTargetSiteCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
* SiteSearchEngineServiceClient.create()) {
* TargetSiteName name =
* TargetSiteName.ofProjectLocationDataStoreTargetSiteName(
* "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[TARGET_SITE]");
* siteSearchEngineServiceClient.deleteTargetSiteAsync(name).get();
* }
* }
*
* @param name Required. Full resource name of
* [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite], such as
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`.
* If the caller does not have permission to access the
* [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite], regardless of whether or not
* it exists, a PERMISSION_DENIED error is returned.
*
If the requested [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite] does not
* exist, a NOT_FOUND error is returned.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture deleteTargetSiteAsync(
TargetSiteName name) {
DeleteTargetSiteRequest request =
DeleteTargetSiteRequest.newBuilder().setName(name == null ? null : name.toString()).build();
return deleteTargetSiteAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
* SiteSearchEngineServiceClient.create()) {
* String name =
* TargetSiteName.ofProjectLocationDataStoreTargetSiteName(
* "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[TARGET_SITE]")
* .toString();
* siteSearchEngineServiceClient.deleteTargetSiteAsync(name).get();
* }
* }
*
* @param name Required. Full resource name of
* [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite], such as
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`.
* If the caller does not have permission to access the
* [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite], regardless of whether or not
* it exists, a PERMISSION_DENIED error is returned.
*
If the requested [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite] does not
* exist, a NOT_FOUND error is returned.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture deleteTargetSiteAsync(String name) {
DeleteTargetSiteRequest request = DeleteTargetSiteRequest.newBuilder().setName(name).build();
return deleteTargetSiteAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
* SiteSearchEngineServiceClient.create()) {
* DeleteTargetSiteRequest request =
* DeleteTargetSiteRequest.newBuilder()
* .setName(
* TargetSiteName.ofProjectLocationDataStoreTargetSiteName(
* "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[TARGET_SITE]")
* .toString())
* .build();
* siteSearchEngineServiceClient.deleteTargetSiteAsync(request).get();
* }
* }
*
* @param 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
*/
public final OperationFuture deleteTargetSiteAsync(
DeleteTargetSiteRequest request) {
return deleteTargetSiteOperationCallable().futureCall(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
* SiteSearchEngineServiceClient.create()) {
* DeleteTargetSiteRequest request =
* DeleteTargetSiteRequest.newBuilder()
* .setName(
* TargetSiteName.ofProjectLocationDataStoreTargetSiteName(
* "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[TARGET_SITE]")
* .toString())
* .build();
* OperationFuture future =
* siteSearchEngineServiceClient.deleteTargetSiteOperationCallable().futureCall(request);
* // Do something.
* future.get();
* }
* }
*/
public final OperationCallable
deleteTargetSiteOperationCallable() {
return stub.deleteTargetSiteOperationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes a [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
* SiteSearchEngineServiceClient.create()) {
* DeleteTargetSiteRequest request =
* DeleteTargetSiteRequest.newBuilder()
* .setName(
* TargetSiteName.ofProjectLocationDataStoreTargetSiteName(
* "[PROJECT]", "[LOCATION]", "[DATA_STORE]", "[TARGET_SITE]")
* .toString())
* .build();
* ApiFuture future =
* siteSearchEngineServiceClient.deleteTargetSiteCallable().futureCall(request);
* // Do something.
* future.get();
* }
* }
*/
public final UnaryCallable deleteTargetSiteCallable() {
return stub.deleteTargetSiteCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets a list of [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite]s.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
* SiteSearchEngineServiceClient.create()) {
* SiteSearchEngineName parent =
* SiteSearchEngineName.ofProjectLocationDataStoreName(
* "[PROJECT]", "[LOCATION]", "[DATA_STORE]");
* for (TargetSite element :
* siteSearchEngineServiceClient.listTargetSites(parent).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param parent Required. The parent site search engine resource name, such as
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
* If the caller does not have permission to list
* [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite]s under this site search
* engine, regardless of whether or not this branch exists, a PERMISSION_DENIED error is
* returned.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListTargetSitesPagedResponse listTargetSites(SiteSearchEngineName parent) {
ListTargetSitesRequest request =
ListTargetSitesRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.build();
return listTargetSites(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets a list of [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite]s.
*
*
Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
* SiteSearchEngineServiceClient.create()) {
* String parent =
* SiteSearchEngineName.ofProjectLocationDataStoreName(
* "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
* .toString();
* for (TargetSite element :
* siteSearchEngineServiceClient.listTargetSites(parent).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param parent Required. The parent site search engine resource name, such as
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.
* If the caller does not have permission to list
* [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite]s under this site search
* engine, regardless of whether or not this branch exists, a PERMISSION_DENIED error is
* returned.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListTargetSitesPagedResponse listTargetSites(String parent) {
ListTargetSitesRequest request = ListTargetSitesRequest.newBuilder().setParent(parent).build();
return listTargetSites(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets a list of [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite]s.
*
*
Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
* SiteSearchEngineServiceClient.create()) {
* ListTargetSitesRequest request =
* ListTargetSitesRequest.newBuilder()
* .setParent(
* SiteSearchEngineName.ofProjectLocationDataStoreName(
* "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
* .toString())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* for (TargetSite element :
* siteSearchEngineServiceClient.listTargetSites(request).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param 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
*/
public final ListTargetSitesPagedResponse listTargetSites(ListTargetSitesRequest request) {
return listTargetSitesPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets a list of [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite]s.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
* SiteSearchEngineServiceClient.create()) {
* ListTargetSitesRequest request =
* ListTargetSitesRequest.newBuilder()
* .setParent(
* SiteSearchEngineName.ofProjectLocationDataStoreName(
* "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
* .toString())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* ApiFuture future =
* siteSearchEngineServiceClient.listTargetSitesPagedCallable().futureCall(request);
* // Do something.
* for (TargetSite element : future.get().iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*/
public final UnaryCallable
listTargetSitesPagedCallable() {
return stub.listTargetSitesPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets a list of [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite]s.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
* SiteSearchEngineServiceClient.create()) {
* ListTargetSitesRequest request =
* ListTargetSitesRequest.newBuilder()
* .setParent(
* SiteSearchEngineName.ofProjectLocationDataStoreName(
* "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
* .toString())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* while (true) {
* ListTargetSitesResponse response =
* siteSearchEngineServiceClient.listTargetSitesCallable().call(request);
* for (TargetSite element : response.getTargetSitesList()) {
* // doThingsWith(element);
* }
* String nextPageToken = response.getNextPageToken();
* if (!Strings.isNullOrEmpty(nextPageToken)) {
* request = request.toBuilder().setPageToken(nextPageToken).build();
* } else {
* break;
* }
* }
* }
* }
*/
public final UnaryCallable
listTargetSitesCallable() {
return stub.listTargetSitesCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Upgrade from basic site search to advanced site search.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
* SiteSearchEngineServiceClient.create()) {
* EnableAdvancedSiteSearchRequest request =
* EnableAdvancedSiteSearchRequest.newBuilder()
* .setSiteSearchEngine(
* SiteSearchEngineName.ofProjectLocationDataStoreName(
* "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
* .toString())
* .build();
* EnableAdvancedSiteSearchResponse response =
* siteSearchEngineServiceClient.enableAdvancedSiteSearchAsync(request).get();
* }
* }
*
* @param 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
*/
public final OperationFuture
enableAdvancedSiteSearchAsync(EnableAdvancedSiteSearchRequest request) {
return enableAdvancedSiteSearchOperationCallable().futureCall(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Upgrade from basic site search to advanced site search.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
* SiteSearchEngineServiceClient.create()) {
* EnableAdvancedSiteSearchRequest request =
* EnableAdvancedSiteSearchRequest.newBuilder()
* .setSiteSearchEngine(
* SiteSearchEngineName.ofProjectLocationDataStoreName(
* "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
* .toString())
* .build();
* OperationFuture future =
* siteSearchEngineServiceClient
* .enableAdvancedSiteSearchOperationCallable()
* .futureCall(request);
* // Do something.
* EnableAdvancedSiteSearchResponse response = future.get();
* }
* }
*/
public final OperationCallable<
EnableAdvancedSiteSearchRequest,
EnableAdvancedSiteSearchResponse,
EnableAdvancedSiteSearchMetadata>
enableAdvancedSiteSearchOperationCallable() {
return stub.enableAdvancedSiteSearchOperationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Upgrade from basic site search to advanced site search.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
* SiteSearchEngineServiceClient.create()) {
* EnableAdvancedSiteSearchRequest request =
* EnableAdvancedSiteSearchRequest.newBuilder()
* .setSiteSearchEngine(
* SiteSearchEngineName.ofProjectLocationDataStoreName(
* "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
* .toString())
* .build();
* ApiFuture future =
* siteSearchEngineServiceClient.enableAdvancedSiteSearchCallable().futureCall(request);
* // Do something.
* Operation response = future.get();
* }
* }
*/
public final UnaryCallable
enableAdvancedSiteSearchCallable() {
return stub.enableAdvancedSiteSearchCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Downgrade from advanced site search to basic site search.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
* SiteSearchEngineServiceClient.create()) {
* DisableAdvancedSiteSearchRequest request =
* DisableAdvancedSiteSearchRequest.newBuilder()
* .setSiteSearchEngine(
* SiteSearchEngineName.ofProjectLocationDataStoreName(
* "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
* .toString())
* .build();
* DisableAdvancedSiteSearchResponse response =
* siteSearchEngineServiceClient.disableAdvancedSiteSearchAsync(request).get();
* }
* }
*
* @param 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
*/
public final OperationFuture
disableAdvancedSiteSearchAsync(DisableAdvancedSiteSearchRequest request) {
return disableAdvancedSiteSearchOperationCallable().futureCall(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Downgrade from advanced site search to basic site search.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
* SiteSearchEngineServiceClient.create()) {
* DisableAdvancedSiteSearchRequest request =
* DisableAdvancedSiteSearchRequest.newBuilder()
* .setSiteSearchEngine(
* SiteSearchEngineName.ofProjectLocationDataStoreName(
* "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
* .toString())
* .build();
* OperationFuture future =
* siteSearchEngineServiceClient
* .disableAdvancedSiteSearchOperationCallable()
* .futureCall(request);
* // Do something.
* DisableAdvancedSiteSearchResponse response = future.get();
* }
* }
*/
public final OperationCallable<
DisableAdvancedSiteSearchRequest,
DisableAdvancedSiteSearchResponse,
DisableAdvancedSiteSearchMetadata>
disableAdvancedSiteSearchOperationCallable() {
return stub.disableAdvancedSiteSearchOperationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Downgrade from advanced site search to basic site search.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
* SiteSearchEngineServiceClient.create()) {
* DisableAdvancedSiteSearchRequest request =
* DisableAdvancedSiteSearchRequest.newBuilder()
* .setSiteSearchEngine(
* SiteSearchEngineName.ofProjectLocationDataStoreName(
* "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
* .toString())
* .build();
* ApiFuture future =
* siteSearchEngineServiceClient.disableAdvancedSiteSearchCallable().futureCall(request);
* // Do something.
* Operation response = future.get();
* }
* }
*/
public final UnaryCallable
disableAdvancedSiteSearchCallable() {
return stub.disableAdvancedSiteSearchCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Request on-demand recrawl for a list of URIs.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
* SiteSearchEngineServiceClient.create()) {
* RecrawlUrisRequest request =
* RecrawlUrisRequest.newBuilder()
* .setSiteSearchEngine(
* SiteSearchEngineName.ofProjectLocationDataStoreName(
* "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
* .toString())
* .addAllUris(new ArrayList())
* .build();
* RecrawlUrisResponse response = siteSearchEngineServiceClient.recrawlUrisAsync(request).get();
* }
* }
*
* @param 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
*/
public final OperationFuture recrawlUrisAsync(
RecrawlUrisRequest request) {
return recrawlUrisOperationCallable().futureCall(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Request on-demand recrawl for a list of URIs.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
* SiteSearchEngineServiceClient.create()) {
* RecrawlUrisRequest request =
* RecrawlUrisRequest.newBuilder()
* .setSiteSearchEngine(
* SiteSearchEngineName.ofProjectLocationDataStoreName(
* "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
* .toString())
* .addAllUris(new ArrayList())
* .build();
* OperationFuture future =
* siteSearchEngineServiceClient.recrawlUrisOperationCallable().futureCall(request);
* // Do something.
* RecrawlUrisResponse response = future.get();
* }
* }
*/
public final OperationCallable
recrawlUrisOperationCallable() {
return stub.recrawlUrisOperationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Request on-demand recrawl for a list of URIs.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
* SiteSearchEngineServiceClient.create()) {
* RecrawlUrisRequest request =
* RecrawlUrisRequest.newBuilder()
* .setSiteSearchEngine(
* SiteSearchEngineName.ofProjectLocationDataStoreName(
* "[PROJECT]", "[LOCATION]", "[DATA_STORE]")
* .toString())
* .addAllUris(new ArrayList())
* .build();
* ApiFuture future =
* siteSearchEngineServiceClient.recrawlUrisCallable().futureCall(request);
* // Do something.
* Operation response = future.get();
* }
* }
*/
public final UnaryCallable recrawlUrisCallable() {
return stub.recrawlUrisCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Verify target sites' ownership and validity. This API sends all the target sites under site
* search engine for verification.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
* SiteSearchEngineServiceClient.create()) {
* BatchVerifyTargetSitesRequest request =
* BatchVerifyTargetSitesRequest.newBuilder()
* .setParent(
* SiteSearchEngineName.ofProjectLocationCollectionDataStoreName(
* "[PROJECT]", "[LOCATION]", "[COLLECTION]", "[DATA_STORE]")
* .toString())
* .build();
* BatchVerifyTargetSitesResponse response =
* siteSearchEngineServiceClient.batchVerifyTargetSitesAsync(request).get();
* }
* }
*
* @param 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
*/
public final OperationFuture
batchVerifyTargetSitesAsync(BatchVerifyTargetSitesRequest request) {
return batchVerifyTargetSitesOperationCallable().futureCall(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Verify target sites' ownership and validity. This API sends all the target sites under site
* search engine for verification.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
* SiteSearchEngineServiceClient.create()) {
* BatchVerifyTargetSitesRequest request =
* BatchVerifyTargetSitesRequest.newBuilder()
* .setParent(
* SiteSearchEngineName.ofProjectLocationCollectionDataStoreName(
* "[PROJECT]", "[LOCATION]", "[COLLECTION]", "[DATA_STORE]")
* .toString())
* .build();
* OperationFuture future =
* siteSearchEngineServiceClient
* .batchVerifyTargetSitesOperationCallable()
* .futureCall(request);
* // Do something.
* BatchVerifyTargetSitesResponse response = future.get();
* }
* }
*/
public final OperationCallable<
BatchVerifyTargetSitesRequest,
BatchVerifyTargetSitesResponse,
BatchVerifyTargetSitesMetadata>
batchVerifyTargetSitesOperationCallable() {
return stub.batchVerifyTargetSitesOperationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Verify target sites' ownership and validity. This API sends all the target sites under site
* search engine for verification.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
* SiteSearchEngineServiceClient.create()) {
* BatchVerifyTargetSitesRequest request =
* BatchVerifyTargetSitesRequest.newBuilder()
* .setParent(
* SiteSearchEngineName.ofProjectLocationCollectionDataStoreName(
* "[PROJECT]", "[LOCATION]", "[COLLECTION]", "[DATA_STORE]")
* .toString())
* .build();
* ApiFuture future =
* siteSearchEngineServiceClient.batchVerifyTargetSitesCallable().futureCall(request);
* // Do something.
* Operation response = future.get();
* }
* }
*/
public final UnaryCallable
batchVerifyTargetSitesCallable() {
return stub.batchVerifyTargetSitesCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns list of target sites with its domain verification status. This method can only be
* called under data store with BASIC_SITE_SEARCH state at the moment.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
* SiteSearchEngineServiceClient.create()) {
* FetchDomainVerificationStatusRequest request =
* FetchDomainVerificationStatusRequest.newBuilder()
* .setSiteSearchEngine(
* SiteSearchEngineName.ofProjectLocationCollectionDataStoreName(
* "[PROJECT]", "[LOCATION]", "[COLLECTION]", "[DATA_STORE]")
* .toString())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* for (TargetSite element :
* siteSearchEngineServiceClient.fetchDomainVerificationStatus(request).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*
* @param 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
*/
public final FetchDomainVerificationStatusPagedResponse fetchDomainVerificationStatus(
FetchDomainVerificationStatusRequest request) {
return fetchDomainVerificationStatusPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns list of target sites with its domain verification status. This method can only be
* called under data store with BASIC_SITE_SEARCH state at the moment.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
* SiteSearchEngineServiceClient.create()) {
* FetchDomainVerificationStatusRequest request =
* FetchDomainVerificationStatusRequest.newBuilder()
* .setSiteSearchEngine(
* SiteSearchEngineName.ofProjectLocationCollectionDataStoreName(
* "[PROJECT]", "[LOCATION]", "[COLLECTION]", "[DATA_STORE]")
* .toString())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* ApiFuture future =
* siteSearchEngineServiceClient
* .fetchDomainVerificationStatusPagedCallable()
* .futureCall(request);
* // Do something.
* for (TargetSite element : future.get().iterateAll()) {
* // doThingsWith(element);
* }
* }
* }
*/
public final UnaryCallable<
FetchDomainVerificationStatusRequest, FetchDomainVerificationStatusPagedResponse>
fetchDomainVerificationStatusPagedCallable() {
return stub.fetchDomainVerificationStatusPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns list of target sites with its domain verification status. This method can only be
* called under data store with BASIC_SITE_SEARCH state at the moment.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SiteSearchEngineServiceClient siteSearchEngineServiceClient =
* SiteSearchEngineServiceClient.create()) {
* FetchDomainVerificationStatusRequest request =
* FetchDomainVerificationStatusRequest.newBuilder()
* .setSiteSearchEngine(
* SiteSearchEngineName.ofProjectLocationCollectionDataStoreName(
* "[PROJECT]", "[LOCATION]", "[COLLECTION]", "[DATA_STORE]")
* .toString())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .build();
* while (true) {
* FetchDomainVerificationStatusResponse response =
* siteSearchEngineServiceClient.fetchDomainVerificationStatusCallable().call(request);
* for (TargetSite element : response.getTargetSitesList()) {
* // doThingsWith(element);
* }
* String nextPageToken = response.getNextPageToken();
* if (!Strings.isNullOrEmpty(nextPageToken)) {
* request = request.toBuilder().setPageToken(nextPageToken).build();
* } else {
* break;
* }
* }
* }
* }
*/
public final UnaryCallable<
FetchDomainVerificationStatusRequest, FetchDomainVerificationStatusResponse>
fetchDomainVerificationStatusCallable() {
return stub.fetchDomainVerificationStatusCallable();
}
@Override
public final void close() {
stub.close();
}
@Override
public void shutdown() {
stub.shutdown();
}
@Override
public boolean isShutdown() {
return stub.isShutdown();
}
@Override
public boolean isTerminated() {
return stub.isTerminated();
}
@Override
public void shutdownNow() {
stub.shutdownNow();
}
@Override
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException {
return stub.awaitTermination(duration, unit);
}
public static class ListTargetSitesPagedResponse
extends AbstractPagedListResponse<
ListTargetSitesRequest,
ListTargetSitesResponse,
TargetSite,
ListTargetSitesPage,
ListTargetSitesFixedSizeCollection> {
public static ApiFuture createAsync(
PageContext context,
ApiFuture futureResponse) {
ApiFuture futurePage =
ListTargetSitesPage.createEmptyPage().createPageAsync(context, futureResponse);
return ApiFutures.transform(
futurePage,
input -> new ListTargetSitesPagedResponse(input),
MoreExecutors.directExecutor());
}
private ListTargetSitesPagedResponse(ListTargetSitesPage page) {
super(page, ListTargetSitesFixedSizeCollection.createEmptyCollection());
}
}
public static class ListTargetSitesPage
extends AbstractPage<
ListTargetSitesRequest, ListTargetSitesResponse, TargetSite, ListTargetSitesPage> {
private ListTargetSitesPage(
PageContext context,
ListTargetSitesResponse response) {
super(context, response);
}
private static ListTargetSitesPage createEmptyPage() {
return new ListTargetSitesPage(null, null);
}
@Override
protected ListTargetSitesPage createPage(
PageContext context,
ListTargetSitesResponse response) {
return new ListTargetSitesPage(context, response);
}
@Override
public ApiFuture createPageAsync(
PageContext context,
ApiFuture futureResponse) {
return super.createPageAsync(context, futureResponse);
}
}
public static class ListTargetSitesFixedSizeCollection
extends AbstractFixedSizeCollection<
ListTargetSitesRequest,
ListTargetSitesResponse,
TargetSite,
ListTargetSitesPage,
ListTargetSitesFixedSizeCollection> {
private ListTargetSitesFixedSizeCollection(
List pages, int collectionSize) {
super(pages, collectionSize);
}
private static ListTargetSitesFixedSizeCollection createEmptyCollection() {
return new ListTargetSitesFixedSizeCollection(null, 0);
}
@Override
protected ListTargetSitesFixedSizeCollection createCollection(
List pages, int collectionSize) {
return new ListTargetSitesFixedSizeCollection(pages, collectionSize);
}
}
public static class FetchDomainVerificationStatusPagedResponse
extends AbstractPagedListResponse<
FetchDomainVerificationStatusRequest,
FetchDomainVerificationStatusResponse,
TargetSite,
FetchDomainVerificationStatusPage,
FetchDomainVerificationStatusFixedSizeCollection> {
public static ApiFuture createAsync(
PageContext<
FetchDomainVerificationStatusRequest,
FetchDomainVerificationStatusResponse,
TargetSite>
context,
ApiFuture futureResponse) {
ApiFuture futurePage =
FetchDomainVerificationStatusPage.createEmptyPage()
.createPageAsync(context, futureResponse);
return ApiFutures.transform(
futurePage,
input -> new FetchDomainVerificationStatusPagedResponse(input),
MoreExecutors.directExecutor());
}
private FetchDomainVerificationStatusPagedResponse(FetchDomainVerificationStatusPage page) {
super(page, FetchDomainVerificationStatusFixedSizeCollection.createEmptyCollection());
}
}
public static class FetchDomainVerificationStatusPage
extends AbstractPage<
FetchDomainVerificationStatusRequest,
FetchDomainVerificationStatusResponse,
TargetSite,
FetchDomainVerificationStatusPage> {
private FetchDomainVerificationStatusPage(
PageContext<
FetchDomainVerificationStatusRequest,
FetchDomainVerificationStatusResponse,
TargetSite>
context,
FetchDomainVerificationStatusResponse response) {
super(context, response);
}
private static FetchDomainVerificationStatusPage createEmptyPage() {
return new FetchDomainVerificationStatusPage(null, null);
}
@Override
protected FetchDomainVerificationStatusPage createPage(
PageContext<
FetchDomainVerificationStatusRequest,
FetchDomainVerificationStatusResponse,
TargetSite>
context,
FetchDomainVerificationStatusResponse response) {
return new FetchDomainVerificationStatusPage(context, response);
}
@Override
public ApiFuture createPageAsync(
PageContext<
FetchDomainVerificationStatusRequest,
FetchDomainVerificationStatusResponse,
TargetSite>
context,
ApiFuture futureResponse) {
return super.createPageAsync(context, futureResponse);
}
}
public static class FetchDomainVerificationStatusFixedSizeCollection
extends AbstractFixedSizeCollection<
FetchDomainVerificationStatusRequest,
FetchDomainVerificationStatusResponse,
TargetSite,
FetchDomainVerificationStatusPage,
FetchDomainVerificationStatusFixedSizeCollection> {
private FetchDomainVerificationStatusFixedSizeCollection(
List pages, int collectionSize) {
super(pages, collectionSize);
}
private static FetchDomainVerificationStatusFixedSizeCollection createEmptyCollection() {
return new FetchDomainVerificationStatusFixedSizeCollection(null, 0);
}
@Override
protected FetchDomainVerificationStatusFixedSizeCollection createCollection(
List pages, int collectionSize) {
return new FetchDomainVerificationStatusFixedSizeCollection(pages, collectionSize);
}
}
}