Class DomainsStubSettings (1.20.0)

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

Inheritance

java.lang.Object > StubSettings > DomainsStubSettings

Static Methods

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
TypeDescription
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
TypeDescription
Builder

defaultGrpcApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultGrpcApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

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

Returns
TypeDescription
Builder

defaultHttpJsonApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultHttpJsonApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

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

Returns
TypeDescription
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
TypeDescription
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
TypeDescription
String

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

newBuilder()

public static DomainsStubSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
TypeDescription
DomainsStubSettings.Builder

newBuilder(ClientContext clientContext)

public static DomainsStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
DomainsStubSettings.Builder

newHttpJsonBuilder()

public static DomainsStubSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
TypeDescription
DomainsStubSettings.Builder

Constructors

DomainsStubSettings(DomainsStubSettings.Builder settingsBuilder)

protected DomainsStubSettings(DomainsStubSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderDomainsStubSettings.Builder

Methods

configureContactSettingsOperationSettings()

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

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

configureContactSettingsSettings()

public UnaryCallSettings<ConfigureContactSettingsRequest,Operation> configureContactSettingsSettings()

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

configureDnsSettingsOperationSettings()

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

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

configureDnsSettingsSettings()

public UnaryCallSettings<ConfigureDnsSettingsRequest,Operation> configureDnsSettingsSettings()

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

configureManagementSettingsOperationSettings()

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

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

configureManagementSettingsSettings()

public UnaryCallSettings<ConfigureManagementSettingsRequest,Operation> configureManagementSettingsSettings()

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

createStub()

public DomainsStub createStub()
Returns
TypeDescription
DomainsStub
Exceptions
TypeDescription
IOException

deleteRegistrationOperationSettings()

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

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

deleteRegistrationSettings()

public UnaryCallSettings<DeleteRegistrationRequest,Operation> deleteRegistrationSettings()

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

exportRegistrationOperationSettings()

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

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

exportRegistrationSettings()

public UnaryCallSettings<ExportRegistrationRequest,Operation> exportRegistrationSettings()

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

getRegistrationSettings()

public UnaryCallSettings<GetRegistrationRequest,Registration> getRegistrationSettings()

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

listRegistrationsSettings()

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

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

registerDomainOperationSettings()

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

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

registerDomainSettings()

public UnaryCallSettings<RegisterDomainRequest,Operation> registerDomainSettings()

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

resetAuthorizationCodeSettings()

public UnaryCallSettings<ResetAuthorizationCodeRequest,AuthorizationCode> resetAuthorizationCodeSettings()

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

retrieveAuthorizationCodeSettings()

public UnaryCallSettings<RetrieveAuthorizationCodeRequest,AuthorizationCode> retrieveAuthorizationCodeSettings()

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

retrieveRegisterParametersSettings()

public UnaryCallSettings<RetrieveRegisterParametersRequest,RetrieveRegisterParametersResponse> retrieveRegisterParametersSettings()

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

retrieveTransferParametersSettings()

public UnaryCallSettings<RetrieveTransferParametersRequest,RetrieveTransferParametersResponse> retrieveTransferParametersSettings()

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

searchDomainsSettings()

public UnaryCallSettings<SearchDomainsRequest,SearchDomainsResponse> searchDomainsSettings()

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

toBuilder()

public DomainsStubSettings.Builder toBuilder()

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

Returns
TypeDescription
DomainsStubSettings.Builder
Overrides

transferDomainOperationSettings()

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

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

transferDomainSettings()

public UnaryCallSettings<TransferDomainRequest,Operation> transferDomainSettings()

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

updateRegistrationOperationSettings()

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

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

updateRegistrationSettings()

public UnaryCallSettings<UpdateRegistrationRequest,Operation> updateRegistrationSettings()

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