Class DomainsSettings (1.41.0) 

public class DomainsSettings extends ClientSettings<DomainsSettings>

Settings class to configure an instance of DomainsClient.

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 total timeout of searchDomains to 30 seconds:


 // 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
 DomainsSettings.Builder domainsSettingsBuilder = DomainsSettings.newBuilder();
 domainsSettingsBuilder
     .searchDomainsSettings()
     .setRetrySettings(
         domainsSettingsBuilder
             .searchDomainsSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 DomainsSettings domainsSettings = domainsSettingsBuilder.build();

Inheritance

java.lang.Object > ClientSettings > DomainsSettings

Static Methods

create(DomainsStubSettings stub)

public static final DomainsSettings create(DomainsStubSettings stub)
Parameter
Name Description
stub DomainsStubSettings
Returns
Type Description
DomainsSettings
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()

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 DomainsSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type Description
DomainsSettings.Builder

newBuilder(ClientContext clientContext)

public static DomainsSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
DomainsSettings.Builder

newHttpJsonBuilder()

public static DomainsSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type Description
DomainsSettings.Builder

Constructors

DomainsSettings(DomainsSettings.Builder settingsBuilder)

protected DomainsSettings(DomainsSettings.Builder settingsBuilder)
Parameter
Name Description
settingsBuilder DomainsSettings.Builder

Methods

configureContactSettingsOperationSettings()

public OperationCallSettings<ConfigureContactSettingsRequest,Registration,OperationMetadata> configureContactSettingsOperationSettings()

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

Returns
Type Description
OperationCallSettings<ConfigureContactSettingsRequest,Registration,OperationMetadata>

configureContactSettingsSettings()

public UnaryCallSettings<ConfigureContactSettingsRequest,Operation> configureContactSettingsSettings()

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

Returns
Type Description
UnaryCallSettings<ConfigureContactSettingsRequest,Operation>

configureDnsSettingsOperationSettings()

public OperationCallSettings<ConfigureDnsSettingsRequest,Registration,OperationMetadata> configureDnsSettingsOperationSettings()

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

Returns
Type Description
OperationCallSettings<ConfigureDnsSettingsRequest,Registration,OperationMetadata>

configureDnsSettingsSettings()

public UnaryCallSettings<ConfigureDnsSettingsRequest,Operation> configureDnsSettingsSettings()

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

Returns
Type Description
UnaryCallSettings<ConfigureDnsSettingsRequest,Operation>

configureManagementSettingsOperationSettings()

public OperationCallSettings<ConfigureManagementSettingsRequest,Registration,OperationMetadata> configureManagementSettingsOperationSettings()

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

Returns
Type Description
OperationCallSettings<ConfigureManagementSettingsRequest,Registration,OperationMetadata>

configureManagementSettingsSettings()

public UnaryCallSettings<ConfigureManagementSettingsRequest,Operation> configureManagementSettingsSettings()

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

Returns
Type Description
UnaryCallSettings<ConfigureManagementSettingsRequest,Operation>

deleteRegistrationOperationSettings()

public OperationCallSettings<DeleteRegistrationRequest,Empty,OperationMetadata> deleteRegistrationOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeleteRegistrationRequest,Empty,OperationMetadata>

deleteRegistrationSettings()

public UnaryCallSettings<DeleteRegistrationRequest,Operation> deleteRegistrationSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteRegistrationRequest,Operation>

exportRegistrationOperationSettings()

public OperationCallSettings<ExportRegistrationRequest,Registration,OperationMetadata> exportRegistrationOperationSettings()

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

Returns
Type Description
OperationCallSettings<ExportRegistrationRequest,Registration,OperationMetadata>

exportRegistrationSettings()

public UnaryCallSettings<ExportRegistrationRequest,Operation> exportRegistrationSettings()

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

Returns
Type Description
UnaryCallSettings<ExportRegistrationRequest,Operation>

getRegistrationSettings()

public UnaryCallSettings<GetRegistrationRequest,Registration> getRegistrationSettings()

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

Returns
Type Description
UnaryCallSettings<GetRegistrationRequest,Registration>

listRegistrationsSettings()

public PagedCallSettings<ListRegistrationsRequest,ListRegistrationsResponse,DomainsClient.ListRegistrationsPagedResponse> listRegistrationsSettings()

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

Returns
Type Description
PagedCallSettings<ListRegistrationsRequest,ListRegistrationsResponse,ListRegistrationsPagedResponse>

registerDomainOperationSettings()

public OperationCallSettings<RegisterDomainRequest,Registration,OperationMetadata> registerDomainOperationSettings()

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

Returns
Type Description
OperationCallSettings<RegisterDomainRequest,Registration,OperationMetadata>

registerDomainSettings()

public UnaryCallSettings<RegisterDomainRequest,Operation> registerDomainSettings()

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

Returns
Type Description
UnaryCallSettings<RegisterDomainRequest,Operation>

resetAuthorizationCodeSettings()

public UnaryCallSettings<ResetAuthorizationCodeRequest,AuthorizationCode> resetAuthorizationCodeSettings()

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

Returns
Type Description
UnaryCallSettings<ResetAuthorizationCodeRequest,AuthorizationCode>

retrieveAuthorizationCodeSettings()

public UnaryCallSettings<RetrieveAuthorizationCodeRequest,AuthorizationCode> retrieveAuthorizationCodeSettings()

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

Returns
Type Description
UnaryCallSettings<RetrieveAuthorizationCodeRequest,AuthorizationCode>

retrieveRegisterParametersSettings()

public UnaryCallSettings<RetrieveRegisterParametersRequest,RetrieveRegisterParametersResponse> retrieveRegisterParametersSettings()

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

Returns
Type Description
UnaryCallSettings<RetrieveRegisterParametersRequest,RetrieveRegisterParametersResponse>

retrieveTransferParametersSettings()

public UnaryCallSettings<RetrieveTransferParametersRequest,RetrieveTransferParametersResponse> retrieveTransferParametersSettings()

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

Returns
Type Description
UnaryCallSettings<RetrieveTransferParametersRequest,RetrieveTransferParametersResponse>

searchDomainsSettings()

public UnaryCallSettings<SearchDomainsRequest,SearchDomainsResponse> searchDomainsSettings()

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

Returns
Type Description
UnaryCallSettings<SearchDomainsRequest,SearchDomainsResponse>

toBuilder()

public DomainsSettings.Builder toBuilder()

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

Returns
Type Description
DomainsSettings.Builder
Overrides

transferDomainOperationSettings()

public OperationCallSettings<TransferDomainRequest,Registration,OperationMetadata> transferDomainOperationSettings()

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

Returns
Type Description
OperationCallSettings<TransferDomainRequest,Registration,OperationMetadata>

transferDomainSettings()

public UnaryCallSettings<TransferDomainRequest,Operation> transferDomainSettings()

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

Returns
Type Description
UnaryCallSettings<TransferDomainRequest,Operation>

updateRegistrationOperationSettings()

public OperationCallSettings<UpdateRegistrationRequest,Registration,OperationMetadata> updateRegistrationOperationSettings()

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

Returns
Type Description
OperationCallSettings<UpdateRegistrationRequest,Registration,OperationMetadata>

updateRegistrationSettings()

public UnaryCallSettings<UpdateRegistrationRequest,Operation> updateRegistrationSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateRegistrationRequest,Operation>