Class DomainsStubSettings
java.lang.Object
com.google.api.gax.rpc.StubSettings<DomainsStubSettings>
com.google.cloud.domains.v1alpha2.stub.DomainsStubSettings
@BetaApi
@Generated("by gapic-generator-java")
public class DomainsStubSettings
extends StubSettings<DomainsStubSettings>
Settings class to configure an instance of
DomainsStub.
The default instance has everything set to sensible defaults:
- The default service address (domains.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 searchDomains:
// 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
DomainsStubSettings.Builder domainsSettingsBuilder = DomainsStubSettings.newBuilder();
domainsSettingsBuilder
.searchDomainsSettings()
.setRetrySettings(
domainsSettingsBuilder
.searchDomainsSettings()
.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());
DomainsStubSettings domainsSettings = domainsSettingsBuilder.build();
Please refer to the [Client Side Retry
Guide](https://docs.cloud.google.com/java/docs/client-retries) 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 registerDomain:
// 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
DomainsStubSettings.Builder domainsSettingsBuilder = DomainsStubSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
domainsSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for DomainsStubSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedDomainsStubSettings(DomainsStubSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionReturns the object with the settings used for calls to configureContactSettings.Returns the object with the settings used for calls to configureContactSettings.Returns the object with the settings used for calls to configureDnsSettings.Returns the object with the settings used for calls to configureDnsSettings.Returns the object with the settings used for calls to configureManagementSettings.Returns the object with the settings used for calls to configureManagementSettings.Returns a builder for the default credentials for this service.Returns a builder for the default ExecutorProvider for this service.Returns a builder for the default gRPC ChannelProvider for this service.Returns a builder for the default REST ChannelProvider for this service.static TransportChannelProviderOperationCallSettings<DeleteRegistrationRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteRegistration.Returns the object with the settings used for calls to deleteRegistration.Returns the object with the settings used for calls to exportRegistration.Returns the object with the settings used for calls to exportRegistration.static StringReturns the default service endpoint.static StringReturns the default mTLS service endpoint.Returns the default service scopes.protected LibraryMetadataReturns the object with the settings used for calls to getRegistration.Returns the default service name.PagedCallSettings<ListRegistrationsRequest,ListRegistrationsResponse, DomainsClient.ListRegistrationsPagedResponse> Returns the object with the settings used for calls to listRegistrations.static DomainsStubSettings.BuilderReturns a new gRPC builder for this class.static DomainsStubSettings.BuildernewBuilder(ClientContext clientContext) Returns a new builder for this class.static DomainsStubSettings.BuilderReturns a new REST builder for this class.Returns the object with the settings used for calls to registerDomain.Returns the object with the settings used for calls to registerDomain.Returns the object with the settings used for calls to resetAuthorizationCode.Returns the object with the settings used for calls to retrieveAuthorizationCode.Returns the object with the settings used for calls to retrieveRegisterParameters.Returns the object with the settings used for calls to retrieveTransferParameters.Returns the object with the settings used for calls to searchDomains.Returns a builder containing all the values of this settings class.Returns the object with the settings used for calls to transferDomain.Returns the object with the settings used for calls to transferDomain.Returns the object with the settings used for calls to updateRegistration.Returns the object with the settings used for calls to updateRegistration.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
-
Constructor Details
-
DomainsStubSettings
- Throws:
IOException
-
-
Method Details
-
searchDomainsSettings
Returns the object with the settings used for calls to searchDomains. -
retrieveRegisterParametersSettings
public UnaryCallSettings<RetrieveRegisterParametersRequest,RetrieveRegisterParametersResponse> retrieveRegisterParametersSettings()Returns the object with the settings used for calls to retrieveRegisterParameters. -
registerDomainSettings
Returns the object with the settings used for calls to registerDomain. -
registerDomainOperationSettings
public OperationCallSettings<RegisterDomainRequest,Registration, registerDomainOperationSettings()OperationMetadata> Returns the object with the settings used for calls to registerDomain. -
retrieveTransferParametersSettings
public UnaryCallSettings<RetrieveTransferParametersRequest,RetrieveTransferParametersResponse> retrieveTransferParametersSettings()Returns the object with the settings used for calls to retrieveTransferParameters. -
transferDomainSettings
Returns the object with the settings used for calls to transferDomain. -
transferDomainOperationSettings
public OperationCallSettings<TransferDomainRequest,Registration, transferDomainOperationSettings()OperationMetadata> Returns the object with the settings used for calls to transferDomain. -
listRegistrationsSettings
public PagedCallSettings<ListRegistrationsRequest,ListRegistrationsResponse, listRegistrationsSettings()DomainsClient.ListRegistrationsPagedResponse> Returns the object with the settings used for calls to listRegistrations. -
getRegistrationSettings
Returns the object with the settings used for calls to getRegistration. -
updateRegistrationSettings
Returns the object with the settings used for calls to updateRegistration. -
updateRegistrationOperationSettings
public OperationCallSettings<UpdateRegistrationRequest,Registration, updateRegistrationOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateRegistration. -
configureManagementSettingsSettings
public UnaryCallSettings<ConfigureManagementSettingsRequest,Operation> configureManagementSettingsSettings()Returns the object with the settings used for calls to configureManagementSettings. -
configureManagementSettingsOperationSettings
public OperationCallSettings<ConfigureManagementSettingsRequest,Registration, configureManagementSettingsOperationSettings()OperationMetadata> Returns the object with the settings used for calls to configureManagementSettings. -
configureDnsSettingsSettings
Returns the object with the settings used for calls to configureDnsSettings. -
configureDnsSettingsOperationSettings
public OperationCallSettings<ConfigureDnsSettingsRequest,Registration, configureDnsSettingsOperationSettings()OperationMetadata> Returns the object with the settings used for calls to configureDnsSettings. -
configureContactSettingsSettings
public UnaryCallSettings<ConfigureContactSettingsRequest,Operation> configureContactSettingsSettings()Returns the object with the settings used for calls to configureContactSettings. -
configureContactSettingsOperationSettings
public OperationCallSettings<ConfigureContactSettingsRequest,Registration, configureContactSettingsOperationSettings()OperationMetadata> Returns the object with the settings used for calls to configureContactSettings. -
exportRegistrationSettings
Returns the object with the settings used for calls to exportRegistration. -
exportRegistrationOperationSettings
public OperationCallSettings<ExportRegistrationRequest,Registration, exportRegistrationOperationSettings()OperationMetadata> Returns the object with the settings used for calls to exportRegistration. -
deleteRegistrationSettings
Returns the object with the settings used for calls to deleteRegistration. -
deleteRegistrationOperationSettings
public OperationCallSettings<DeleteRegistrationRequest,com.google.protobuf.Empty, deleteRegistrationOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteRegistration. -
retrieveAuthorizationCodeSettings
public UnaryCallSettings<RetrieveAuthorizationCodeRequest,AuthorizationCode> retrieveAuthorizationCodeSettings()Returns the object with the settings used for calls to retrieveAuthorizationCode. -
resetAuthorizationCodeSettings
public UnaryCallSettings<ResetAuthorizationCodeRequest,AuthorizationCode> resetAuthorizationCodeSettings()Returns the object with the settings used for calls to resetAuthorizationCode. -
createStub
- Throws:
IOException
-
getServiceName
Returns the default service name.- Overrides:
getServiceNamein classStubSettings<DomainsStubSettings>
-
defaultExecutorProviderBuilder
Returns a builder for the default ExecutorProvider for this service. -
getDefaultEndpoint
Returns the default service endpoint. -
getDefaultMtlsEndpoint
Returns the default mTLS service endpoint. -
getDefaultServiceScopes
Returns the default service scopes. -
defaultCredentialsProviderBuilder
Returns a builder for the default credentials for this service. -
defaultGrpcTransportProviderBuilder
Returns a builder for the default gRPC ChannelProvider for this service. -
defaultHttpJsonTransportProviderBuilder
@BetaApi public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()Returns a builder for the default REST ChannelProvider for this service. -
defaultTransportChannelProvider
-
defaultGrpcApiClientHeaderProviderBuilder
-
defaultHttpJsonApiClientHeaderProviderBuilder
-
defaultApiClientHeaderProviderBuilder
-
newBuilder
Returns a new gRPC builder for this class. -
newHttpJsonBuilder
Returns a new REST builder for this class. -
newBuilder
Returns a new builder for this class. -
toBuilder
Returns a builder containing all the values of this settings class.- Specified by:
toBuilderin classStubSettings<DomainsStubSettings>
-
getLibraryMetadata
- Overrides:
getLibraryMetadatain classStubSettings<DomainsStubSettings>
-