Class SiteServiceStubSettings (0.39.0)

public class SiteServiceStubSettings extends StubSettings<SiteServiceStubSettings>

Settings class to configure an instance of SiteServiceStub.

The default instance has everything set to sensible defaults:

The default service address (admanager.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 getSite:


 // 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
 SiteServiceStubSettings.Builder siteServiceSettingsBuilder =
     SiteServiceStubSettings.newBuilder();
 siteServiceSettingsBuilder
     .getSiteSettings()
     .setRetrySettings(
         siteServiceSettingsBuilder
             .getSiteSettings()
             .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());
 SiteServiceStubSettings siteServiceSettings = siteServiceSettingsBuilder.build();

Please refer to the Client Side Retry Guide for additional support in setting retries.

Inheritance

java.lang.Object > StubSettings > SiteServiceStubSettings

Inherited Members

StubSettings.getApiKey()

StubSettings.getBackgroundExecutorProvider()

StubSettings.getClock()

StubSettings.getCredentialsProvider()

StubSettings.getEndpoint()

StubSettings.getExecutorProvider()

StubSettings.getGdchApiAudience()

StubSettings.getHeaderProvider()

StubSettings.getInternalHeaderProvider()

StubSettings.getMtlsEndpoint()

StubSettings.getQuotaProjectId()

StubSettings.getServiceName()

StubSettings.getStreamWatchdogCheckInterval()

StubSettings.getStreamWatchdogCheckIntervalDuration()

StubSettings.getStreamWatchdogProvider()

StubSettings.getTracerFactory()

StubSettings.getTransportChannelProvider()

StubSettings.getUniverseDomain()

StubSettings.toBuilder()

StubSettings.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

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`

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default 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`

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS 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 SiteServiceStubSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
Type	Description
`SiteServiceStubSettings.Builder`

newBuilder(ClientContext clientContext)

public static SiteServiceStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name	Description
`clientContext`	`ClientContext`

Returns
Type	Description
`SiteServiceStubSettings.Builder`

Constructors

SiteServiceStubSettings(SiteServiceStubSettings.Builder settingsBuilder)

protected SiteServiceStubSettings(SiteServiceStubSettings.Builder settingsBuilder)

Parameter
Name	Description
`settingsBuilder`	`SiteServiceStubSettings.Builder`

Methods

batchCreateSitesSettings()

public UnaryCallSettings<BatchCreateSitesRequest,BatchCreateSitesResponse> batchCreateSitesSettings()

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

Returns
Type	Description
`UnaryCallSettings<BatchCreateSitesRequest,BatchCreateSitesResponse>`

batchDeactivateSitesSettings()

public UnaryCallSettings<BatchDeactivateSitesRequest,BatchDeactivateSitesResponse> batchDeactivateSitesSettings()

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

Returns
Type	Description
`UnaryCallSettings<BatchDeactivateSitesRequest,BatchDeactivateSitesResponse>`

batchSubmitSitesForApprovalSettings()

public UnaryCallSettings<BatchSubmitSitesForApprovalRequest,BatchSubmitSitesForApprovalResponse> batchSubmitSitesForApprovalSettings()

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

Returns
Type	Description
`UnaryCallSettings<BatchSubmitSitesForApprovalRequest,BatchSubmitSitesForApprovalResponse>`

batchUpdateSitesSettings()

public UnaryCallSettings<BatchUpdateSitesRequest,BatchUpdateSitesResponse> batchUpdateSitesSettings()

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

Returns
Type	Description
`UnaryCallSettings<BatchUpdateSitesRequest,BatchUpdateSitesResponse>`

createSiteSettings()

public UnaryCallSettings<CreateSiteRequest,Site> createSiteSettings()

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

Returns
Type	Description
`UnaryCallSettings<CreateSiteRequest,Site>`

createStub()

public SiteServiceStub createStub()

Returns
Type	Description
`SiteServiceStub`

Exceptions
Type	Description
`IOException`

getServiceName()

public String getServiceName()

Returns the default service name.

Returns
Type	Description
`String`

Overrides

StubSettings<SettingsT>.getServiceName()

getSiteSettings()

public UnaryCallSettings<GetSiteRequest,Site> getSiteSettings()

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

Returns
Type	Description
`UnaryCallSettings<GetSiteRequest,Site>`

listSitesSettings()

public PagedCallSettings<ListSitesRequest,ListSitesResponse,SiteServiceClient.ListSitesPagedResponse> listSitesSettings()

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

Returns
Type	Description
`PagedCallSettings<ListSitesRequest,ListSitesResponse,ListSitesPagedResponse>`

toBuilder()

public SiteServiceStubSettings.Builder toBuilder()

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

Returns
Type	Description
`SiteServiceStubSettings.Builder`