com.google.cloud.discoveryengine.v1beta.stub

Class SiteSearchEngineServiceStubSettings

java.lang.Object

com.google.api.gax.rpc.StubSettings<SiteSearchEngineServiceStubSettings>

com.google.cloud.discoveryengine.v1beta.stub.SiteSearchEngineServiceStubSettings

@BetaApi
 @Generated(value="by gapic-generator-java")
public class SiteSearchEngineServiceStubSettings
extends com.google.api.gax.rpc.StubSettings<SiteSearchEngineServiceStubSettings>

Settings class to configure an instance of SiteSearchEngineServiceStub.

The default instance has everything set to sensible defaults:

• The default service address (discoveryengine.googleapis.com) and default port (443) are used.
• Credentials are acquired automatically through Application Default Credentials.
• Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the [RetrySettings](https://cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.RetrySettings) of getSiteSearchEngine:

 // 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
 SiteSearchEngineServiceStubSettings.Builder siteSearchEngineServiceSettingsBuilder =
     SiteSearchEngineServiceStubSettings.newBuilder();
 siteSearchEngineServiceSettingsBuilder
     .getSiteSearchEngineSettings()
     .setRetrySettings(
         siteSearchEngineServiceSettingsBuilder
             .getSiteSearchEngineSettings()
             .getRetrySettings()
             .toBuilder()
             .setInitialRetryDelayDuration(Duration.ofSeconds(1))
             .setInitialRpcTimeoutDuration(Duration.ofSeconds(5))
             .setMaxAttempts(5)
             .setMaxRetryDelayDuration(Duration.ofSeconds(30))
             .setMaxRpcTimeoutDuration(Duration.ofSeconds(60))
             .setRetryDelayMultiplier(1.3)
             .setRpcTimeoutMultiplier(1.5)
             .setTotalTimeoutDuration(Duration.ofSeconds(300))
             .build());
 SiteSearchEngineServiceStubSettings siteSearchEngineServiceSettings =
     siteSearchEngineServiceSettingsBuilder.build();
 

Please refer to the [Client Side Retry Guide](https://github.com/googleapis/google-cloud-java/blob/main/docs/client_retries.md) for additional support in setting retries.

To configure the RetrySettings of a Long Running Operation method, create an OperationTimedPollAlgorithm object and update the RPC's polling algorithm. For example, to configure the RetrySettings for createTargetSite:

 // 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
 SiteSearchEngineServiceStubSettings.Builder siteSearchEngineServiceSettingsBuilder =
     SiteSearchEngineServiceStubSettings.newBuilder();
 TimedRetryAlgorithm timedRetryAlgorithm =
     OperationalTimedPollAlgorithm.create(
         RetrySettings.newBuilder()
             .setInitialRetryDelayDuration(Duration.ofMillis(500))
             .setRetryDelayMultiplier(1.5)
             .setMaxRetryDelayDuration(Duration.ofMillis(5000))
             .setTotalTimeoutDuration(Duration.ofHours(24))
             .build());
 siteSearchEngineServiceSettingsBuilder
     .createClusterOperationSettings()
     .setPollingAlgorithm(timedRetryAlgorithm)
     .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SiteSearchEngineServiceStubSettings.Builder Builder for SiteSearchEngineServiceStubSettings.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SiteSearchEngineServiceStubSettings(SiteSearchEngineServiceStubSettings.Builder settingsBuilder)

Method Summary

Modifier and Type	Method and Description
com.google.api.gax.rpc.OperationCallSettings<BatchCreateTargetSitesRequest,BatchCreateTargetSitesResponse,BatchCreateTargetSiteMetadata>	batchCreateTargetSitesOperationSettings() Returns the object with the settings used for calls to batchCreateTargetSites.
com.google.api.gax.rpc.UnaryCallSettings<BatchCreateTargetSitesRequest,com.google.longrunning.Operation>	batchCreateTargetSitesSettings() Returns the object with the settings used for calls to batchCreateTargetSites.
com.google.api.gax.rpc.OperationCallSettings<BatchVerifyTargetSitesRequest,BatchVerifyTargetSitesResponse,BatchVerifyTargetSitesMetadata>	batchVerifyTargetSitesOperationSettings() Returns the object with the settings used for calls to batchVerifyTargetSites.
com.google.api.gax.rpc.UnaryCallSettings<BatchVerifyTargetSitesRequest,com.google.longrunning.Operation>	batchVerifyTargetSitesSettings() Returns the object with the settings used for calls to batchVerifyTargetSites.
com.google.api.gax.rpc.OperationCallSettings<CreateSitemapRequest,Sitemap,CreateSitemapMetadata>	createSitemapOperationSettings() Returns the object with the settings used for calls to createSitemap.
com.google.api.gax.rpc.UnaryCallSettings<CreateSitemapRequest,com.google.longrunning.Operation>	createSitemapSettings() Returns the object with the settings used for calls to createSitemap.
SiteSearchEngineServiceStub	createStub()
com.google.api.gax.rpc.OperationCallSettings<CreateTargetSiteRequest,TargetSite,CreateTargetSiteMetadata>	createTargetSiteOperationSettings() Returns the object with the settings used for calls to createTargetSite.
com.google.api.gax.rpc.UnaryCallSettings<CreateTargetSiteRequest,com.google.longrunning.Operation>	createTargetSiteSettings() Returns the object with the settings used for calls to createTargetSite.
static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder	defaultApiClientHeaderProviderBuilder()
static com.google.api.gax.core.GoogleCredentialsProvider.Builder	defaultCredentialsProviderBuilder() Returns a builder for the default credentials for this service.
static com.google.api.gax.core.InstantiatingExecutorProvider.Builder	defaultExecutorProviderBuilder() Returns a builder for the default ExecutorProvider for this service.
static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder	defaultGrpcApiClientHeaderProviderBuilder()
static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder	defaultGrpcTransportProviderBuilder() Returns a builder for the default gRPC ChannelProvider for this service.
static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder	defaultHttpJsonApiClientHeaderProviderBuilder()
static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder	defaultHttpJsonTransportProviderBuilder() Returns a builder for the default REST ChannelProvider for this service.
static com.google.api.gax.rpc.TransportChannelProvider	defaultTransportChannelProvider()
com.google.api.gax.rpc.OperationCallSettings<DeleteSitemapRequest,com.google.protobuf.Empty,DeleteSitemapMetadata>	deleteSitemapOperationSettings() Returns the object with the settings used for calls to deleteSitemap.
com.google.api.gax.rpc.UnaryCallSettings<DeleteSitemapRequest,com.google.longrunning.Operation>	deleteSitemapSettings() Returns the object with the settings used for calls to deleteSitemap.
com.google.api.gax.rpc.OperationCallSettings<DeleteTargetSiteRequest,com.google.protobuf.Empty,DeleteTargetSiteMetadata>	deleteTargetSiteOperationSettings() Returns the object with the settings used for calls to deleteTargetSite.
com.google.api.gax.rpc.UnaryCallSettings<DeleteTargetSiteRequest,com.google.longrunning.Operation>	deleteTargetSiteSettings() Returns the object with the settings used for calls to deleteTargetSite.
com.google.api.gax.rpc.OperationCallSettings<DisableAdvancedSiteSearchRequest,DisableAdvancedSiteSearchResponse,DisableAdvancedSiteSearchMetadata>	disableAdvancedSiteSearchOperationSettings() Returns the object with the settings used for calls to disableAdvancedSiteSearch.
com.google.api.gax.rpc.UnaryCallSettings<DisableAdvancedSiteSearchRequest,com.google.longrunning.Operation>	disableAdvancedSiteSearchSettings() Returns the object with the settings used for calls to disableAdvancedSiteSearch.
com.google.api.gax.rpc.OperationCallSettings<EnableAdvancedSiteSearchRequest,EnableAdvancedSiteSearchResponse,EnableAdvancedSiteSearchMetadata>	enableAdvancedSiteSearchOperationSettings() Returns the object with the settings used for calls to enableAdvancedSiteSearch.
com.google.api.gax.rpc.UnaryCallSettings<EnableAdvancedSiteSearchRequest,com.google.longrunning.Operation>	enableAdvancedSiteSearchSettings() Returns the object with the settings used for calls to enableAdvancedSiteSearch.
com.google.api.gax.rpc.PagedCallSettings<FetchDomainVerificationStatusRequest,FetchDomainVerificationStatusResponse,SiteSearchEngineServiceClient.FetchDomainVerificationStatusPagedResponse>	fetchDomainVerificationStatusSettings() Returns the object with the settings used for calls to fetchDomainVerificationStatus.
com.google.api.gax.rpc.UnaryCallSettings<FetchSitemapsRequest,FetchSitemapsResponse>	fetchSitemapsSettings() Returns the object with the settings used for calls to fetchSitemaps.
static String	getDefaultEndpoint() Returns the default service endpoint.
static String	getDefaultMtlsEndpoint() Returns the default mTLS service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
String	getServiceName() Returns the default service name.
com.google.api.gax.rpc.UnaryCallSettings<GetSiteSearchEngineRequest,SiteSearchEngine>	getSiteSearchEngineSettings() Returns the object with the settings used for calls to getSiteSearchEngine.
com.google.api.gax.rpc.UnaryCallSettings<GetTargetSiteRequest,TargetSite>	getTargetSiteSettings() Returns the object with the settings used for calls to getTargetSite.
com.google.api.gax.rpc.PagedCallSettings<ListTargetSitesRequest,ListTargetSitesResponse,SiteSearchEngineServiceClient.ListTargetSitesPagedResponse>	listTargetSitesSettings() Returns the object with the settings used for calls to listTargetSites.
static SiteSearchEngineServiceStubSettings.Builder	newBuilder() Returns a new gRPC builder for this class.
static SiteSearchEngineServiceStubSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
static SiteSearchEngineServiceStubSettings.Builder	newHttpJsonBuilder() Returns a new REST builder for this class.
com.google.api.gax.rpc.OperationCallSettings<RecrawlUrisRequest,RecrawlUrisResponse,RecrawlUrisMetadata>	recrawlUrisOperationSettings() Returns the object with the settings used for calls to recrawlUris.
com.google.api.gax.rpc.UnaryCallSettings<RecrawlUrisRequest,com.google.longrunning.Operation>	recrawlUrisSettings() Returns the object with the settings used for calls to recrawlUris.
SiteSearchEngineServiceStubSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
com.google.api.gax.rpc.OperationCallSettings<UpdateTargetSiteRequest,TargetSite,UpdateTargetSiteMetadata>	updateTargetSiteOperationSettings() Returns the object with the settings used for calls to updateTargetSite.
com.google.api.gax.rpc.UnaryCallSettings<UpdateTargetSiteRequest,com.google.longrunning.Operation>	updateTargetSiteSettings() Returns the object with the settings used for calls to updateTargetSite.

Methods inherited from class com.google.api.gax.rpc.StubSettings

getApiKey, getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getMtlsEndpoint, getQuotaProjectId, getStreamWatchdogCheckInterval, getStreamWatchdogCheckIntervalDuration, getStreamWatchdogProvider, getTracerFactory, getTransportChannelProvider, getUniverseDomain, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

SiteSearchEngineServiceStubSettings

protected SiteSearchEngineServiceStubSettings(SiteSearchEngineServiceStubSettings.Builder settingsBuilder)
                                       throws IOException

Throws:

IOException

Method Detail

getSiteSearchEngineSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetSiteSearchEngineRequest,SiteSearchEngine> getSiteSearchEngineSettings()

Returns the object with the settings used for calls to getSiteSearchEngine.

createTargetSiteSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateTargetSiteRequest,com.google.longrunning.Operation> createTargetSiteSettings()

Returns the object with the settings used for calls to createTargetSite.

createTargetSiteOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<CreateTargetSiteRequest,TargetSite,CreateTargetSiteMetadata> createTargetSiteOperationSettings()

Returns the object with the settings used for calls to createTargetSite.

batchCreateTargetSitesSettings

public com.google.api.gax.rpc.UnaryCallSettings<BatchCreateTargetSitesRequest,com.google.longrunning.Operation> batchCreateTargetSitesSettings()

Returns the object with the settings used for calls to batchCreateTargetSites.

batchCreateTargetSitesOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<BatchCreateTargetSitesRequest,BatchCreateTargetSitesResponse,BatchCreateTargetSiteMetadata> batchCreateTargetSitesOperationSettings()

Returns the object with the settings used for calls to batchCreateTargetSites.

getTargetSiteSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetTargetSiteRequest,TargetSite> getTargetSiteSettings()

Returns the object with the settings used for calls to getTargetSite.

updateTargetSiteSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateTargetSiteRequest,com.google.longrunning.Operation> updateTargetSiteSettings()

Returns the object with the settings used for calls to updateTargetSite.

updateTargetSiteOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<UpdateTargetSiteRequest,TargetSite,UpdateTargetSiteMetadata> updateTargetSiteOperationSettings()

Returns the object with the settings used for calls to updateTargetSite.

deleteTargetSiteSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteTargetSiteRequest,com.google.longrunning.Operation> deleteTargetSiteSettings()

Returns the object with the settings used for calls to deleteTargetSite.

deleteTargetSiteOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<DeleteTargetSiteRequest,com.google.protobuf.Empty,DeleteTargetSiteMetadata> deleteTargetSiteOperationSettings()

Returns the object with the settings used for calls to deleteTargetSite.

listTargetSitesSettings

public com.google.api.gax.rpc.PagedCallSettings<ListTargetSitesRequest,ListTargetSitesResponse,SiteSearchEngineServiceClient.ListTargetSitesPagedResponse> listTargetSitesSettings()

Returns the object with the settings used for calls to listTargetSites.

createSitemapSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateSitemapRequest,com.google.longrunning.Operation> createSitemapSettings()

Returns the object with the settings used for calls to createSitemap.

createSitemapOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<CreateSitemapRequest,Sitemap,CreateSitemapMetadata> createSitemapOperationSettings()

Returns the object with the settings used for calls to createSitemap.

deleteSitemapSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteSitemapRequest,com.google.longrunning.Operation> deleteSitemapSettings()

Returns the object with the settings used for calls to deleteSitemap.

deleteSitemapOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<DeleteSitemapRequest,com.google.protobuf.Empty,DeleteSitemapMetadata> deleteSitemapOperationSettings()

Returns the object with the settings used for calls to deleteSitemap.

fetchSitemapsSettings

public com.google.api.gax.rpc.UnaryCallSettings<FetchSitemapsRequest,FetchSitemapsResponse> fetchSitemapsSettings()

Returns the object with the settings used for calls to fetchSitemaps.

enableAdvancedSiteSearchSettings

public com.google.api.gax.rpc.UnaryCallSettings<EnableAdvancedSiteSearchRequest,com.google.longrunning.Operation> enableAdvancedSiteSearchSettings()

Returns the object with the settings used for calls to enableAdvancedSiteSearch.

enableAdvancedSiteSearchOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<EnableAdvancedSiteSearchRequest,EnableAdvancedSiteSearchResponse,EnableAdvancedSiteSearchMetadata> enableAdvancedSiteSearchOperationSettings()

Returns the object with the settings used for calls to enableAdvancedSiteSearch.

disableAdvancedSiteSearchSettings

public com.google.api.gax.rpc.UnaryCallSettings<DisableAdvancedSiteSearchRequest,com.google.longrunning.Operation> disableAdvancedSiteSearchSettings()

Returns the object with the settings used for calls to disableAdvancedSiteSearch.

disableAdvancedSiteSearchOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<DisableAdvancedSiteSearchRequest,DisableAdvancedSiteSearchResponse,DisableAdvancedSiteSearchMetadata> disableAdvancedSiteSearchOperationSettings()

Returns the object with the settings used for calls to disableAdvancedSiteSearch.

recrawlUrisSettings

public com.google.api.gax.rpc.UnaryCallSettings<RecrawlUrisRequest,com.google.longrunning.Operation> recrawlUrisSettings()

Returns the object with the settings used for calls to recrawlUris.

recrawlUrisOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<RecrawlUrisRequest,RecrawlUrisResponse,RecrawlUrisMetadata> recrawlUrisOperationSettings()

Returns the object with the settings used for calls to recrawlUris.

batchVerifyTargetSitesSettings

public com.google.api.gax.rpc.UnaryCallSettings<BatchVerifyTargetSitesRequest,com.google.longrunning.Operation> batchVerifyTargetSitesSettings()

Returns the object with the settings used for calls to batchVerifyTargetSites.

batchVerifyTargetSitesOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<BatchVerifyTargetSitesRequest,BatchVerifyTargetSitesResponse,BatchVerifyTargetSitesMetadata> batchVerifyTargetSitesOperationSettings()

Returns the object with the settings used for calls to batchVerifyTargetSites.

fetchDomainVerificationStatusSettings

public com.google.api.gax.rpc.PagedCallSettings<FetchDomainVerificationStatusRequest,FetchDomainVerificationStatusResponse,SiteSearchEngineServiceClient.FetchDomainVerificationStatusPagedResponse> fetchDomainVerificationStatusSettings()

Returns the object with the settings used for calls to fetchDomainVerificationStatus.

createStub

public SiteSearchEngineServiceStub createStub()
                                       throws IOException

Throws:

IOException

getServiceName

public String getServiceName()

Returns the default service name.

Overrides:

getServiceName in class com.google.api.gax.rpc.StubSettings<SiteSearchEngineServiceStubSettings>

defaultExecutorProviderBuilder

public static com.google.api.gax.core.InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

getDefaultEndpoint

@ObsoleteApi(value="Use getEndpoint() instead")
public static String getDefaultEndpoint()

Returns the default service endpoint.

getDefaultMtlsEndpoint

public static String getDefaultMtlsEndpoint()

Returns the default mTLS service endpoint.

getDefaultServiceScopes

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

defaultCredentialsProviderBuilder

public static com.google.api.gax.core.GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

defaultGrpcTransportProviderBuilder

public static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default gRPC ChannelProvider for this service.

defaultHttpJsonTransportProviderBuilder

@BetaApi
public static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default REST ChannelProvider for this service.

defaultTransportChannelProvider

public static com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider()

defaultGrpcApiClientHeaderProviderBuilder

public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultGrpcApiClientHeaderProviderBuilder()

defaultHttpJsonApiClientHeaderProviderBuilder

public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultHttpJsonApiClientHeaderProviderBuilder()

defaultApiClientHeaderProviderBuilder

public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

newBuilder

public static SiteSearchEngineServiceStubSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

newHttpJsonBuilder

public static SiteSearchEngineServiceStubSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

newBuilder

public static SiteSearchEngineServiceStubSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public SiteSearchEngineServiceStubSettings.Builder toBuilder()

Returns a builder containing all the values of this settings class.

Specified by:

toBuilder in class com.google.api.gax.rpc.StubSettings<SiteSearchEngineServiceStubSettings>