com.google.cloud.recaptchaenterprise.v1

Class RecaptchaEnterpriseServiceSettings

java.lang.Object

com.google.api.gax.rpc.ClientSettings<RecaptchaEnterpriseServiceSettings>

com.google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseServiceSettings

@Generated(value="by gapic-generator-java")
public class RecaptchaEnterpriseServiceSettings
extends com.google.api.gax.rpc.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://github.com/googleapis/google-cloud-java/blob/main/docs/client_retries.md) for additional support in setting retries.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RecaptchaEnterpriseServiceSettings.Builder Builder for RecaptchaEnterpriseServiceSettings.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RecaptchaEnterpriseServiceSettings(RecaptchaEnterpriseServiceSettings.Builder settingsBuilder)

Method Summary

Modifier and Type	Method and Description
com.google.api.gax.rpc.UnaryCallSettings<AddIpOverrideRequest,AddIpOverrideResponse>	addIpOverrideSettings() Returns the object with the settings used for calls to addIpOverride.
com.google.api.gax.rpc.UnaryCallSettings<AnnotateAssessmentRequest,AnnotateAssessmentResponse>	annotateAssessmentSettings() Returns the object with the settings used for calls to annotateAssessment.
static RecaptchaEnterpriseServiceSettings	create(RecaptchaEnterpriseServiceStubSettings stub)
com.google.api.gax.rpc.UnaryCallSettings<CreateAssessmentRequest,Assessment>	createAssessmentSettings() Returns the object with the settings used for calls to createAssessment.
com.google.api.gax.rpc.UnaryCallSettings<CreateFirewallPolicyRequest,FirewallPolicy>	createFirewallPolicySettings() Returns the object with the settings used for calls to createFirewallPolicy.
com.google.api.gax.rpc.UnaryCallSettings<CreateKeyRequest,Key>	createKeySettings() Returns the object with the settings used for calls to createKey.
static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder	defaultApiClientHeaderProviderBuilder()
static com.google.api.gax.core.GoogleCredentialsProvider.Builder	defaultCredentialsProviderBuilder() Returns a builder for the default credentials for this service.
static com.google.api.gax.core.InstantiatingExecutorProvider.Builder	defaultExecutorProviderBuilder() Returns a builder for the default ExecutorProvider for this service.
static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder	defaultGrpcTransportProviderBuilder() Returns a builder for the default ChannelProvider for this service.
static com.google.api.gax.rpc.TransportChannelProvider	defaultTransportChannelProvider()
com.google.api.gax.rpc.UnaryCallSettings<DeleteFirewallPolicyRequest,com.google.protobuf.Empty>	deleteFirewallPolicySettings() Returns the object with the settings used for calls to deleteFirewallPolicy.
com.google.api.gax.rpc.UnaryCallSettings<DeleteKeyRequest,com.google.protobuf.Empty>	deleteKeySettings() Returns the object with the settings used for calls to deleteKey.
static String	getDefaultEndpoint() Returns the default service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
com.google.api.gax.rpc.UnaryCallSettings<GetFirewallPolicyRequest,FirewallPolicy>	getFirewallPolicySettings() Returns the object with the settings used for calls to getFirewallPolicy.
com.google.api.gax.rpc.UnaryCallSettings<GetKeyRequest,Key>	getKeySettings() Returns the object with the settings used for calls to getKey.
com.google.api.gax.rpc.UnaryCallSettings<GetMetricsRequest,Metrics>	getMetricsSettings() Returns the object with the settings used for calls to getMetrics.
com.google.api.gax.rpc.PagedCallSettings<ListFirewallPoliciesRequest,ListFirewallPoliciesResponse,RecaptchaEnterpriseServiceClient.ListFirewallPoliciesPagedResponse>	listFirewallPoliciesSettings() Returns the object with the settings used for calls to listFirewallPolicies.
com.google.api.gax.rpc.PagedCallSettings<ListIpOverridesRequest,ListIpOverridesResponse,RecaptchaEnterpriseServiceClient.ListIpOverridesPagedResponse>	listIpOverridesSettings() Returns the object with the settings used for calls to listIpOverrides.
com.google.api.gax.rpc.PagedCallSettings<ListKeysRequest,ListKeysResponse,RecaptchaEnterpriseServiceClient.ListKeysPagedResponse>	listKeysSettings() Returns the object with the settings used for calls to listKeys.
com.google.api.gax.rpc.PagedCallSettings<ListRelatedAccountGroupMembershipsRequest,ListRelatedAccountGroupMembershipsResponse,RecaptchaEnterpriseServiceClient.ListRelatedAccountGroupMembershipsPagedResponse>	listRelatedAccountGroupMembershipsSettings() Returns the object with the settings used for calls to listRelatedAccountGroupMemberships.
com.google.api.gax.rpc.PagedCallSettings<ListRelatedAccountGroupsRequest,ListRelatedAccountGroupsResponse,RecaptchaEnterpriseServiceClient.ListRelatedAccountGroupsPagedResponse>	listRelatedAccountGroupsSettings() Returns the object with the settings used for calls to listRelatedAccountGroups.
com.google.api.gax.rpc.UnaryCallSettings<MigrateKeyRequest,Key>	migrateKeySettings() Returns the object with the settings used for calls to migrateKey.
static RecaptchaEnterpriseServiceSettings.Builder	newBuilder() Returns a new builder for this class.
static RecaptchaEnterpriseServiceSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
com.google.api.gax.rpc.UnaryCallSettings<RemoveIpOverrideRequest,RemoveIpOverrideResponse>	removeIpOverrideSettings() Returns the object with the settings used for calls to removeIpOverride.
com.google.api.gax.rpc.UnaryCallSettings<ReorderFirewallPoliciesRequest,ReorderFirewallPoliciesResponse>	reorderFirewallPoliciesSettings() Returns the object with the settings used for calls to reorderFirewallPolicies.
com.google.api.gax.rpc.UnaryCallSettings<RetrieveLegacySecretKeyRequest,RetrieveLegacySecretKeyResponse>	retrieveLegacySecretKeySettings() Returns the object with the settings used for calls to retrieveLegacySecretKey.
com.google.api.gax.rpc.PagedCallSettings<SearchRelatedAccountGroupMembershipsRequest,SearchRelatedAccountGroupMembershipsResponse,RecaptchaEnterpriseServiceClient.SearchRelatedAccountGroupMembershipsPagedResponse>	searchRelatedAccountGroupMembershipsSettings() Returns the object with the settings used for calls to searchRelatedAccountGroupMemberships.
RecaptchaEnterpriseServiceSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
com.google.api.gax.rpc.UnaryCallSettings<UpdateFirewallPolicyRequest,FirewallPolicy>	updateFirewallPolicySettings() Returns the object with the settings used for calls to updateFirewallPolicy.
com.google.api.gax.rpc.UnaryCallSettings<UpdateKeyRequest,Key>	updateKeySettings() 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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RecaptchaEnterpriseServiceSettings

protected RecaptchaEnterpriseServiceSettings(RecaptchaEnterpriseServiceSettings.Builder settingsBuilder)
                                      throws IOException

Throws:

IOException

Method Detail

createAssessmentSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateAssessmentRequest,Assessment> createAssessmentSettings()

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

annotateAssessmentSettings

public com.google.api.gax.rpc.UnaryCallSettings<AnnotateAssessmentRequest,AnnotateAssessmentResponse> annotateAssessmentSettings()

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

createKeySettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateKeyRequest,Key> createKeySettings()

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

listKeysSettings

public com.google.api.gax.rpc.PagedCallSettings<ListKeysRequest,ListKeysResponse,RecaptchaEnterpriseServiceClient.ListKeysPagedResponse> listKeysSettings()

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

retrieveLegacySecretKeySettings

public com.google.api.gax.rpc.UnaryCallSettings<RetrieveLegacySecretKeyRequest,RetrieveLegacySecretKeyResponse> retrieveLegacySecretKeySettings()

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

getKeySettings

public com.google.api.gax.rpc.UnaryCallSettings<GetKeyRequest,Key> getKeySettings()

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

updateKeySettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateKeyRequest,Key> updateKeySettings()

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

deleteKeySettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteKeyRequest,com.google.protobuf.Empty> deleteKeySettings()

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

migrateKeySettings

public com.google.api.gax.rpc.UnaryCallSettings<MigrateKeyRequest,Key> migrateKeySettings()

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

addIpOverrideSettings

public com.google.api.gax.rpc.UnaryCallSettings<AddIpOverrideRequest,AddIpOverrideResponse> addIpOverrideSettings()

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

removeIpOverrideSettings

public com.google.api.gax.rpc.UnaryCallSettings<RemoveIpOverrideRequest,RemoveIpOverrideResponse> removeIpOverrideSettings()

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

listIpOverridesSettings

public com.google.api.gax.rpc.PagedCallSettings<ListIpOverridesRequest,ListIpOverridesResponse,RecaptchaEnterpriseServiceClient.ListIpOverridesPagedResponse> listIpOverridesSettings()

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

getMetricsSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetMetricsRequest,Metrics> getMetricsSettings()

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

createFirewallPolicySettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateFirewallPolicyRequest,FirewallPolicy> createFirewallPolicySettings()

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

listFirewallPoliciesSettings

public com.google.api.gax.rpc.PagedCallSettings<ListFirewallPoliciesRequest,ListFirewallPoliciesResponse,RecaptchaEnterpriseServiceClient.ListFirewallPoliciesPagedResponse> listFirewallPoliciesSettings()

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

getFirewallPolicySettings

public com.google.api.gax.rpc.UnaryCallSettings<GetFirewallPolicyRequest,FirewallPolicy> getFirewallPolicySettings()

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

updateFirewallPolicySettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateFirewallPolicyRequest,FirewallPolicy> updateFirewallPolicySettings()

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

deleteFirewallPolicySettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteFirewallPolicyRequest,com.google.protobuf.Empty> deleteFirewallPolicySettings()

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

reorderFirewallPoliciesSettings

public com.google.api.gax.rpc.UnaryCallSettings<ReorderFirewallPoliciesRequest,ReorderFirewallPoliciesResponse> reorderFirewallPoliciesSettings()

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

listRelatedAccountGroupsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListRelatedAccountGroupsRequest,ListRelatedAccountGroupsResponse,RecaptchaEnterpriseServiceClient.ListRelatedAccountGroupsPagedResponse> listRelatedAccountGroupsSettings()

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

listRelatedAccountGroupMembershipsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListRelatedAccountGroupMembershipsRequest,ListRelatedAccountGroupMembershipsResponse,RecaptchaEnterpriseServiceClient.ListRelatedAccountGroupMembershipsPagedResponse> listRelatedAccountGroupMembershipsSettings()

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

searchRelatedAccountGroupMembershipsSettings

public com.google.api.gax.rpc.PagedCallSettings<SearchRelatedAccountGroupMembershipsRequest,SearchRelatedAccountGroupMembershipsResponse,RecaptchaEnterpriseServiceClient.SearchRelatedAccountGroupMembershipsPagedResponse> searchRelatedAccountGroupMembershipsSettings()

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

create

public static final RecaptchaEnterpriseServiceSettings create(RecaptchaEnterpriseServiceStubSettings stub)
                                                       throws IOException

Throws:

IOException

defaultExecutorProviderBuilder

public static com.google.api.gax.core.InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

getDefaultEndpoint

public static String getDefaultEndpoint()

Returns the default service endpoint.

getDefaultServiceScopes

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

defaultCredentialsProviderBuilder

public static com.google.api.gax.core.GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

defaultGrpcTransportProviderBuilder

public static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

defaultTransportChannelProvider

public static com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider()

defaultApiClientHeaderProviderBuilder

public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

newBuilder

public static RecaptchaEnterpriseServiceSettings.Builder newBuilder()

Returns a new builder for this class.

newBuilder

public static RecaptchaEnterpriseServiceSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public RecaptchaEnterpriseServiceSettings.Builder toBuilder()

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

Specified by:

toBuilder in class com.google.api.gax.rpc.ClientSettings<RecaptchaEnterpriseServiceSettings>