Class RecaptchaEnterpriseServiceSettings
java.lang.Object
com.google.api.gax.rpc.ClientSettings<RecaptchaEnterpriseServiceSettings>
com.google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseServiceSettings
@Generated("by gapic-generator-java")
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](https://cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.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](https://docs.cloud.google.com/java/docs/client-retries) for additional support in setting
retries.-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for RecaptchaEnterpriseServiceSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected -
Method Summary
Modifier and TypeMethodDescriptionReturns the object with the settings used for calls to addIpOverride.Returns the object with the settings used for calls to annotateAssessment.static final RecaptchaEnterpriseServiceSettingsReturns the object with the settings used for calls to createAssessment.Returns the object with the settings used for calls to createFirewallPolicy.Returns the object with the settings used for calls to createKey.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 ChannelProvider for this service.static TransportChannelProviderUnaryCallSettings<DeleteFirewallPolicyRequest,com.google.protobuf.Empty> Returns the object with the settings used for calls to deleteFirewallPolicy.UnaryCallSettings<DeleteKeyRequest,com.google.protobuf.Empty> Returns the object with the settings used for calls to deleteKey.static StringReturns the default service endpoint.Returns the default service scopes.Returns the object with the settings used for calls to getFirewallPolicy.Returns the object with the settings used for calls to getKey.Returns the object with the settings used for calls to getMetrics.PagedCallSettings<ListFirewallPoliciesRequest,ListFirewallPoliciesResponse, RecaptchaEnterpriseServiceClient.ListFirewallPoliciesPagedResponse> Returns the object with the settings used for calls to listFirewallPolicies.PagedCallSettings<ListIpOverridesRequest,ListIpOverridesResponse, RecaptchaEnterpriseServiceClient.ListIpOverridesPagedResponse> Returns the object with the settings used for calls to listIpOverrides.PagedCallSettings<ListKeysRequest,ListKeysResponse, RecaptchaEnterpriseServiceClient.ListKeysPagedResponse> Returns the object with the settings used for calls to listKeys.PagedCallSettings<ListRelatedAccountGroupMembershipsRequest,ListRelatedAccountGroupMembershipsResponse, RecaptchaEnterpriseServiceClient.ListRelatedAccountGroupMembershipsPagedResponse> Returns the object with the settings used for calls to listRelatedAccountGroupMemberships.PagedCallSettings<ListRelatedAccountGroupsRequest,ListRelatedAccountGroupsResponse, RecaptchaEnterpriseServiceClient.ListRelatedAccountGroupsPagedResponse> Returns the object with the settings used for calls to listRelatedAccountGroups.Returns the object with the settings used for calls to migrateKey.Returns a new builder for this class.newBuilder(ClientContext clientContext) Returns a new builder for this class.Returns the object with the settings used for calls to removeIpOverride.Returns the object with the settings used for calls to reorderFirewallPolicies.Returns the object with the settings used for calls to retrieveLegacySecretKey.PagedCallSettings<SearchRelatedAccountGroupMembershipsRequest,SearchRelatedAccountGroupMembershipsResponse, RecaptchaEnterpriseServiceClient.SearchRelatedAccountGroupMembershipsPagedResponse> Returns the object with the settings used for calls to searchRelatedAccountGroupMemberships.Returns a builder containing all the values of this settings class.Returns the object with the settings used for calls to updateFirewallPolicy.Returns the object with the settings used for calls to updateKey.Methods inherited from class com.google.api.gax.rpc.ClientSettings
getApiKey, getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getUniverseDomain, getWatchdogCheckInterval, getWatchdogCheckIntervalDuration, getWatchdogProvider, toString
-
Constructor Details
-
RecaptchaEnterpriseServiceSettings
protected RecaptchaEnterpriseServiceSettings(RecaptchaEnterpriseServiceSettings.Builder settingsBuilder) throws IOException - Throws:
IOException
-
-
Method Details
-
createAssessmentSettings
Returns the object with the settings used for calls to createAssessment. -
annotateAssessmentSettings
public UnaryCallSettings<AnnotateAssessmentRequest,AnnotateAssessmentResponse> annotateAssessmentSettings()Returns the object with the settings used for calls to annotateAssessment. -
createKeySettings
Returns the object with the settings used for calls to createKey. -
listKeysSettings
public PagedCallSettings<ListKeysRequest,ListKeysResponse, listKeysSettings()RecaptchaEnterpriseServiceClient.ListKeysPagedResponse> Returns the object with the settings used for calls to listKeys. -
retrieveLegacySecretKeySettings
public UnaryCallSettings<RetrieveLegacySecretKeyRequest,RetrieveLegacySecretKeyResponse> retrieveLegacySecretKeySettings()Returns the object with the settings used for calls to retrieveLegacySecretKey. -
getKeySettings
Returns the object with the settings used for calls to getKey. -
updateKeySettings
Returns the object with the settings used for calls to updateKey. -
deleteKeySettings
Returns the object with the settings used for calls to deleteKey. -
migrateKeySettings
Returns the object with the settings used for calls to migrateKey. -
addIpOverrideSettings
Returns the object with the settings used for calls to addIpOverride. -
removeIpOverrideSettings
public UnaryCallSettings<RemoveIpOverrideRequest,RemoveIpOverrideResponse> removeIpOverrideSettings()Returns the object with the settings used for calls to removeIpOverride. -
listIpOverridesSettings
public PagedCallSettings<ListIpOverridesRequest,ListIpOverridesResponse, listIpOverridesSettings()RecaptchaEnterpriseServiceClient.ListIpOverridesPagedResponse> Returns the object with the settings used for calls to listIpOverrides. -
getMetricsSettings
Returns the object with the settings used for calls to getMetrics. -
createFirewallPolicySettings
Returns the object with the settings used for calls to createFirewallPolicy. -
listFirewallPoliciesSettings
public PagedCallSettings<ListFirewallPoliciesRequest,ListFirewallPoliciesResponse, listFirewallPoliciesSettings()RecaptchaEnterpriseServiceClient.ListFirewallPoliciesPagedResponse> Returns the object with the settings used for calls to listFirewallPolicies. -
getFirewallPolicySettings
Returns the object with the settings used for calls to getFirewallPolicy. -
updateFirewallPolicySettings
Returns the object with the settings used for calls to updateFirewallPolicy. -
deleteFirewallPolicySettings
public UnaryCallSettings<DeleteFirewallPolicyRequest,com.google.protobuf.Empty> deleteFirewallPolicySettings()Returns the object with the settings used for calls to deleteFirewallPolicy. -
reorderFirewallPoliciesSettings
public UnaryCallSettings<ReorderFirewallPoliciesRequest,ReorderFirewallPoliciesResponse> reorderFirewallPoliciesSettings()Returns the object with the settings used for calls to reorderFirewallPolicies. -
listRelatedAccountGroupsSettings
public PagedCallSettings<ListRelatedAccountGroupsRequest,ListRelatedAccountGroupsResponse, listRelatedAccountGroupsSettings()RecaptchaEnterpriseServiceClient.ListRelatedAccountGroupsPagedResponse> Returns the object with the settings used for calls to listRelatedAccountGroups. -
listRelatedAccountGroupMembershipsSettings
public PagedCallSettings<ListRelatedAccountGroupMembershipsRequest,ListRelatedAccountGroupMembershipsResponse, listRelatedAccountGroupMembershipsSettings()RecaptchaEnterpriseServiceClient.ListRelatedAccountGroupMembershipsPagedResponse> Returns the object with the settings used for calls to listRelatedAccountGroupMemberships. -
searchRelatedAccountGroupMembershipsSettings
public PagedCallSettings<SearchRelatedAccountGroupMembershipsRequest,SearchRelatedAccountGroupMembershipsResponse, searchRelatedAccountGroupMembershipsSettings()RecaptchaEnterpriseServiceClient.SearchRelatedAccountGroupMembershipsPagedResponse> Returns the object with the settings used for calls to searchRelatedAccountGroupMemberships. -
create
public static final RecaptchaEnterpriseServiceSettings create(RecaptchaEnterpriseServiceStubSettings stub) throws IOException - Throws:
IOException
-
defaultExecutorProviderBuilder
Returns a builder for the default ExecutorProvider for this service. -
getDefaultEndpoint
Returns the default 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 ChannelProvider for this service. -
defaultTransportChannelProvider
-
defaultApiClientHeaderProviderBuilder
-
newBuilder
Returns a new 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 classClientSettings<RecaptchaEnterpriseServiceSettings>
-