Class SiteSearchEngineServiceSettings (0.51.0)

Version latest

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

Beta

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

public class SiteSearchEngineServiceSettings extends ClientSettings<SiteSearchEngineServiceSettings>

Settings class to configure an instance of SiteSearchEngineServiceClient.

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 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
 SiteSearchEngineServiceSettings.Builder siteSearchEngineServiceSettingsBuilder =
     SiteSearchEngineServiceSettings.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());
 SiteSearchEngineServiceSettings siteSearchEngineServiceSettings =
     siteSearchEngineServiceSettingsBuilder.build();
 

Please refer to the Client Side Retry Guide 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
 SiteSearchEngineServiceSettings.Builder siteSearchEngineServiceSettingsBuilder =
     SiteSearchEngineServiceSettings.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();
 

Inheritance

java.lang.Object > ClientSettings > SiteSearchEngineServiceSettings

Inherited Members

ClientSettings.<B>toBuilder()

ClientSettings.getApiKey()

ClientSettings.getBackgroundExecutorProvider()

ClientSettings.getClock()

ClientSettings.getCredentialsProvider()

ClientSettings.getEndpoint()

ClientSettings.getExecutorProvider()

ClientSettings.getGdchApiAudience()

ClientSettings.getHeaderProvider()

ClientSettings.getInternalHeaderProvider()

ClientSettings.getQuotaProjectId()

ClientSettings.getStubSettings()

ClientSettings.getTransportChannelProvider()

ClientSettings.getUniverseDomain()

ClientSettings.getWatchdogCheckInterval()

ClientSettings.getWatchdogCheckIntervalDuration()

ClientSettings.getWatchdogProvider()

ClientSettings.toString()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create(SiteSearchEngineServiceStubSettings stub)

public static final SiteSearchEngineServiceSettings create(SiteSearchEngineServiceStubSettings stub)

Parameter
Name	Description
stub	SiteSearchEngineServiceStubSettings

Returns
Type	Description
SiteSearchEngineServiceSettings

Exceptions
Type	Description
IOException

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

Returns
Type	Description
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
Type	Description
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
Type	Description
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

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

Returns
Type	Description
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Beta

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

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

Returns
Type	Description
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()

Returns
Type	Description
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
Type	Description
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
Type	Description
List<String>

newBuilder()

public static SiteSearchEngineServiceSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type	Description
SiteSearchEngineServiceSettings.Builder

newBuilder(ClientContext clientContext)

public static SiteSearchEngineServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name	Description
clientContext	ClientContext

Returns
Type	Description
SiteSearchEngineServiceSettings.Builder

newHttpJsonBuilder()

public static SiteSearchEngineServiceSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type	Description
SiteSearchEngineServiceSettings.Builder

Constructors

SiteSearchEngineServiceSettings(SiteSearchEngineServiceSettings.Builder settingsBuilder)

protected SiteSearchEngineServiceSettings(SiteSearchEngineServiceSettings.Builder settingsBuilder)

Parameter
Name	Description
settingsBuilder	SiteSearchEngineServiceSettings.Builder

Methods

batchCreateTargetSitesOperationSettings()

public OperationCallSettings<BatchCreateTargetSitesRequest,BatchCreateTargetSitesResponse,BatchCreateTargetSiteMetadata> batchCreateTargetSitesOperationSettings()

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

Returns
Type	Description
OperationCallSettings<BatchCreateTargetSitesRequest,BatchCreateTargetSitesResponse,BatchCreateTargetSiteMetadata>

batchCreateTargetSitesSettings()

public UnaryCallSettings<BatchCreateTargetSitesRequest,Operation> batchCreateTargetSitesSettings()

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

Returns
Type	Description
UnaryCallSettings<BatchCreateTargetSitesRequest,Operation>

batchVerifyTargetSitesOperationSettings()

public OperationCallSettings<BatchVerifyTargetSitesRequest,BatchVerifyTargetSitesResponse,BatchVerifyTargetSitesMetadata> batchVerifyTargetSitesOperationSettings()

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

Returns
Type	Description
OperationCallSettings<BatchVerifyTargetSitesRequest,BatchVerifyTargetSitesResponse,BatchVerifyTargetSitesMetadata>

batchVerifyTargetSitesSettings()

public UnaryCallSettings<BatchVerifyTargetSitesRequest,Operation> batchVerifyTargetSitesSettings()

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

Returns
Type	Description
UnaryCallSettings<BatchVerifyTargetSitesRequest,Operation>

createTargetSiteOperationSettings()

public OperationCallSettings<CreateTargetSiteRequest,TargetSite,CreateTargetSiteMetadata> createTargetSiteOperationSettings()

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

Returns
Type	Description
OperationCallSettings<CreateTargetSiteRequest,TargetSite,CreateTargetSiteMetadata>

createTargetSiteSettings()

public UnaryCallSettings<CreateTargetSiteRequest,Operation> createTargetSiteSettings()

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

Returns
Type	Description
UnaryCallSettings<CreateTargetSiteRequest,Operation>

deleteTargetSiteOperationSettings()

public OperationCallSettings<DeleteTargetSiteRequest,Empty,DeleteTargetSiteMetadata> deleteTargetSiteOperationSettings()

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

Returns
Type	Description
OperationCallSettings<DeleteTargetSiteRequest,Empty,DeleteTargetSiteMetadata>

deleteTargetSiteSettings()

public UnaryCallSettings<DeleteTargetSiteRequest,Operation> deleteTargetSiteSettings()

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

Returns
Type	Description
UnaryCallSettings<DeleteTargetSiteRequest,Operation>

disableAdvancedSiteSearchOperationSettings()

public OperationCallSettings<DisableAdvancedSiteSearchRequest,DisableAdvancedSiteSearchResponse,DisableAdvancedSiteSearchMetadata> disableAdvancedSiteSearchOperationSettings()

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

Returns
Type	Description
OperationCallSettings<DisableAdvancedSiteSearchRequest,DisableAdvancedSiteSearchResponse,DisableAdvancedSiteSearchMetadata>

disableAdvancedSiteSearchSettings()

public UnaryCallSettings<DisableAdvancedSiteSearchRequest,Operation> disableAdvancedSiteSearchSettings()

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

Returns
Type	Description
UnaryCallSettings<DisableAdvancedSiteSearchRequest,Operation>

enableAdvancedSiteSearchOperationSettings()

public OperationCallSettings<EnableAdvancedSiteSearchRequest,EnableAdvancedSiteSearchResponse,EnableAdvancedSiteSearchMetadata> enableAdvancedSiteSearchOperationSettings()

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

Returns
Type	Description
OperationCallSettings<EnableAdvancedSiteSearchRequest,EnableAdvancedSiteSearchResponse,EnableAdvancedSiteSearchMetadata>

enableAdvancedSiteSearchSettings()

public UnaryCallSettings<EnableAdvancedSiteSearchRequest,Operation> enableAdvancedSiteSearchSettings()

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

Returns
Type	Description
UnaryCallSettings<EnableAdvancedSiteSearchRequest,Operation>

fetchDomainVerificationStatusSettings()

public PagedCallSettings<FetchDomainVerificationStatusRequest,FetchDomainVerificationStatusResponse,SiteSearchEngineServiceClient.FetchDomainVerificationStatusPagedResponse> fetchDomainVerificationStatusSettings()

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

Returns
Type	Description
PagedCallSettings<FetchDomainVerificationStatusRequest,FetchDomainVerificationStatusResponse,FetchDomainVerificationStatusPagedResponse>

getSiteSearchEngineSettings()

public UnaryCallSettings<GetSiteSearchEngineRequest,SiteSearchEngine> getSiteSearchEngineSettings()

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

Returns
Type	Description
UnaryCallSettings<GetSiteSearchEngineRequest,SiteSearchEngine>

getTargetSiteSettings()

public UnaryCallSettings<GetTargetSiteRequest,TargetSite> getTargetSiteSettings()

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

Returns
Type	Description
UnaryCallSettings<GetTargetSiteRequest,TargetSite>

getUriPatternDocumentDataSettings()

public UnaryCallSettings<GetUriPatternDocumentDataRequest,GetUriPatternDocumentDataResponse> getUriPatternDocumentDataSettings()

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

Returns
Type	Description
UnaryCallSettings<GetUriPatternDocumentDataRequest,GetUriPatternDocumentDataResponse>

listTargetSitesSettings()

public PagedCallSettings<ListTargetSitesRequest,ListTargetSitesResponse,SiteSearchEngineServiceClient.ListTargetSitesPagedResponse> listTargetSitesSettings()

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

Returns
Type	Description
PagedCallSettings<ListTargetSitesRequest,ListTargetSitesResponse,ListTargetSitesPagedResponse>

recrawlUrisOperationSettings()

public OperationCallSettings<RecrawlUrisRequest,RecrawlUrisResponse,RecrawlUrisMetadata> recrawlUrisOperationSettings()

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

Returns
Type	Description
OperationCallSettings<RecrawlUrisRequest,RecrawlUrisResponse,RecrawlUrisMetadata>

recrawlUrisSettings()

public UnaryCallSettings<RecrawlUrisRequest,Operation> recrawlUrisSettings()

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

Returns
Type	Description
UnaryCallSettings<RecrawlUrisRequest,Operation>

setUriPatternDocumentDataOperationSettings()

public OperationCallSettings<SetUriPatternDocumentDataRequest,SetUriPatternDocumentDataResponse,SetUriPatternDocumentDataMetadata> setUriPatternDocumentDataOperationSettings()

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

Returns
Type	Description
OperationCallSettings<SetUriPatternDocumentDataRequest,SetUriPatternDocumentDataResponse,SetUriPatternDocumentDataMetadata>

setUriPatternDocumentDataSettings()

public UnaryCallSettings<SetUriPatternDocumentDataRequest,Operation> setUriPatternDocumentDataSettings()

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

Returns
Type	Description
UnaryCallSettings<SetUriPatternDocumentDataRequest,Operation>

toBuilder()

public SiteSearchEngineServiceSettings.Builder toBuilder()

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

Returns
Type	Description
SiteSearchEngineServiceSettings.Builder

Overrides

ClientSettings<SettingsT>.<B>toBuilder()

updateTargetSiteOperationSettings()

public OperationCallSettings<UpdateTargetSiteRequest,TargetSite,UpdateTargetSiteMetadata> updateTargetSiteOperationSettings()

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

Returns
Type	Description
OperationCallSettings<UpdateTargetSiteRequest,TargetSite,UpdateTargetSiteMetadata>

updateTargetSiteSettings()

public UnaryCallSettings<UpdateTargetSiteRequest,Operation> updateTargetSiteSettings()

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

Returns
Type	Description
UnaryCallSettings<UpdateTargetSiteRequest,Operation>