Class RecaptchaEnterpriseServiceSettings (3.52.0)

public class RecaptchaEnterpriseServiceSettings extends ClientSettings<RecaptchaEnterpriseServiceSettings>

Settings class to configure an instance of RecaptchaEnterpriseServiceClient.

The default instance has everything set to sensible defaults:

  • The default service address (recaptchaenterprise.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 createAssessment:


 // 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
 RecaptchaEnterpriseServiceSettings.Builder recaptchaEnterpriseServiceSettingsBuilder =
     RecaptchaEnterpriseServiceSettings.newBuilder();
 recaptchaEnterpriseServiceSettingsBuilder
     .createAssessmentSettings()
     .setRetrySettings(
         recaptchaEnterpriseServiceSettingsBuilder
             .createAssessmentSettings()
             .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());
 RecaptchaEnterpriseServiceSettings recaptchaEnterpriseServiceSettings =
     recaptchaEnterpriseServiceSettingsBuilder.build();
 

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

Inheritance

java.lang.Object > ClientSettings > RecaptchaEnterpriseServiceSettings

Static Methods

create(RecaptchaEnterpriseServiceStubSettings stub)

public static final RecaptchaEnterpriseServiceSettings create(RecaptchaEnterpriseServiceStubSettings stub)
Parameter
Name Description
stub RecaptchaEnterpriseServiceStubSettings
Returns
Type Description
RecaptchaEnterpriseServiceSettings
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 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 RecaptchaEnterpriseServiceSettings.Builder newBuilder()

Returns a new builder for this class.

newBuilder(ClientContext clientContext)

public static RecaptchaEnterpriseServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext

Constructors

RecaptchaEnterpriseServiceSettings(RecaptchaEnterpriseServiceSettings.Builder settingsBuilder)

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

Methods

addIpOverrideSettings()

public UnaryCallSettings<AddIpOverrideRequest,AddIpOverrideResponse> addIpOverrideSettings()

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

annotateAssessmentSettings()

public UnaryCallSettings<AnnotateAssessmentRequest,AnnotateAssessmentResponse> annotateAssessmentSettings()

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

createAssessmentSettings()

public UnaryCallSettings<CreateAssessmentRequest,Assessment> createAssessmentSettings()

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

createFirewallPolicySettings()

public UnaryCallSettings<CreateFirewallPolicyRequest,FirewallPolicy> createFirewallPolicySettings()

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

createKeySettings()

public UnaryCallSettings<CreateKeyRequest,Key> createKeySettings()

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

Returns
Type Description
UnaryCallSettings<CreateKeyRequest,Key>

deleteFirewallPolicySettings()

public UnaryCallSettings<DeleteFirewallPolicyRequest,Empty> deleteFirewallPolicySettings()

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

deleteKeySettings()

public UnaryCallSettings<DeleteKeyRequest,Empty> deleteKeySettings()

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

Returns
Type Description
UnaryCallSettings<DeleteKeyRequest,Empty>

getFirewallPolicySettings()

public UnaryCallSettings<GetFirewallPolicyRequest,FirewallPolicy> getFirewallPolicySettings()

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

getKeySettings()

public UnaryCallSettings<GetKeyRequest,Key> getKeySettings()

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

Returns
Type Description
UnaryCallSettings<GetKeyRequest,Key>

getMetricsSettings()

public UnaryCallSettings<GetMetricsRequest,Metrics> getMetricsSettings()

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

Returns
Type Description
UnaryCallSettings<GetMetricsRequest,Metrics>

listFirewallPoliciesSettings()

public PagedCallSettings<ListFirewallPoliciesRequest,ListFirewallPoliciesResponse,RecaptchaEnterpriseServiceClient.ListFirewallPoliciesPagedResponse> listFirewallPoliciesSettings()

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

listIpOverridesSettings()

public PagedCallSettings<ListIpOverridesRequest,ListIpOverridesResponse,RecaptchaEnterpriseServiceClient.ListIpOverridesPagedResponse> listIpOverridesSettings()

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

listKeysSettings()

public PagedCallSettings<ListKeysRequest,ListKeysResponse,RecaptchaEnterpriseServiceClient.ListKeysPagedResponse> listKeysSettings()

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

listRelatedAccountGroupMembershipsSettings()

public PagedCallSettings<ListRelatedAccountGroupMembershipsRequest,ListRelatedAccountGroupMembershipsResponse,RecaptchaEnterpriseServiceClient.ListRelatedAccountGroupMembershipsPagedResponse> listRelatedAccountGroupMembershipsSettings()

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

listRelatedAccountGroupsSettings()

public PagedCallSettings<ListRelatedAccountGroupsRequest,ListRelatedAccountGroupsResponse,RecaptchaEnterpriseServiceClient.ListRelatedAccountGroupsPagedResponse> listRelatedAccountGroupsSettings()

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

migrateKeySettings()

public UnaryCallSettings<MigrateKeyRequest,Key> migrateKeySettings()

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

Returns
Type Description
UnaryCallSettings<MigrateKeyRequest,Key>

removeIpOverrideSettings()

public UnaryCallSettings<RemoveIpOverrideRequest,RemoveIpOverrideResponse> removeIpOverrideSettings()

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

reorderFirewallPoliciesSettings()

public UnaryCallSettings<ReorderFirewallPoliciesRequest,ReorderFirewallPoliciesResponse> reorderFirewallPoliciesSettings()

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

retrieveLegacySecretKeySettings()

public UnaryCallSettings<RetrieveLegacySecretKeyRequest,RetrieveLegacySecretKeyResponse> retrieveLegacySecretKeySettings()

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

searchRelatedAccountGroupMembershipsSettings()

public PagedCallSettings<SearchRelatedAccountGroupMembershipsRequest,SearchRelatedAccountGroupMembershipsResponse,RecaptchaEnterpriseServiceClient.SearchRelatedAccountGroupMembershipsPagedResponse> searchRelatedAccountGroupMembershipsSettings()

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

toBuilder()

public RecaptchaEnterpriseServiceSettings.Builder toBuilder()

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

Overrides

updateFirewallPolicySettings()

public UnaryCallSettings<UpdateFirewallPolicyRequest,FirewallPolicy> updateFirewallPolicySettings()

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

updateKeySettings()

public UnaryCallSettings<UpdateKeyRequest,Key> updateKeySettings()

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

Returns
Type Description
UnaryCallSettings<UpdateKeyRequest,Key>