Class RecaptchaEnterpriseServiceStubSettings (3.45.0) 

public class RecaptchaEnterpriseServiceStubSettings extends StubSettings<RecaptchaEnterpriseServiceStubSettings>

Settings class to configure an instance of RecaptchaEnterpriseServiceStub.

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 total timeout of createAssessment 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
 RecaptchaEnterpriseServiceStubSettings.Builder recaptchaEnterpriseServiceSettingsBuilder =
     RecaptchaEnterpriseServiceStubSettings.newBuilder();
 recaptchaEnterpriseServiceSettingsBuilder
     .createAssessmentSettings()
     .setRetrySettings(
         recaptchaEnterpriseServiceSettingsBuilder
             .createAssessmentSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 RecaptchaEnterpriseServiceStubSettings recaptchaEnterpriseServiceSettings =
     recaptchaEnterpriseServiceSettingsBuilder.build();

Inheritance

java.lang.Object > StubSettings > RecaptchaEnterpriseServiceStubSettings

Static Methods

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

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS 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 RecaptchaEnterpriseServiceStubSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
Type Description
RecaptchaEnterpriseServiceStubSettings.Builder

newBuilder(ClientContext clientContext)

public static RecaptchaEnterpriseServiceStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
RecaptchaEnterpriseServiceStubSettings.Builder

Constructors

RecaptchaEnterpriseServiceStubSettings(RecaptchaEnterpriseServiceStubSettings.Builder settingsBuilder)

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

Methods

addIpOverrideSettings()

public UnaryCallSettings<AddIpOverrideRequest,AddIpOverrideResponse> addIpOverrideSettings()

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

Returns
Type Description
UnaryCallSettings<AddIpOverrideRequest,AddIpOverrideResponse>

annotateAssessmentSettings()

public UnaryCallSettings<AnnotateAssessmentRequest,AnnotateAssessmentResponse> annotateAssessmentSettings()

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

Returns
Type Description
UnaryCallSettings<AnnotateAssessmentRequest,AnnotateAssessmentResponse>

createAssessmentSettings()

public UnaryCallSettings<CreateAssessmentRequest,Assessment> createAssessmentSettings()

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

Returns
Type Description
UnaryCallSettings<CreateAssessmentRequest,Assessment>

createFirewallPolicySettings()

public UnaryCallSettings<CreateFirewallPolicyRequest,FirewallPolicy> createFirewallPolicySettings()

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

Returns
Type Description
UnaryCallSettings<CreateFirewallPolicyRequest,FirewallPolicy>

createKeySettings()

public UnaryCallSettings<CreateKeyRequest,Key> createKeySettings()

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

Returns
Type Description
UnaryCallSettings<CreateKeyRequest,Key>

createStub()

public RecaptchaEnterpriseServiceStub createStub()
Returns
Type Description
RecaptchaEnterpriseServiceStub
Exceptions
Type Description
IOException

deleteFirewallPolicySettings()

public UnaryCallSettings<DeleteFirewallPolicyRequest,Empty> deleteFirewallPolicySettings()

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

Returns
Type Description
UnaryCallSettings<DeleteFirewallPolicyRequest,Empty>

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.

Returns
Type Description
UnaryCallSettings<GetFirewallPolicyRequest,FirewallPolicy>

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>

getServiceName()

public String getServiceName()

Returns the default service name.

Returns
Type Description
String
Overrides

listFirewallPoliciesSettings()

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

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

Returns
Type Description
PagedCallSettings<ListFirewallPoliciesRequest,ListFirewallPoliciesResponse,ListFirewallPoliciesPagedResponse>

listKeysSettings()

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

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

Returns
Type Description
PagedCallSettings<ListKeysRequest,ListKeysResponse,ListKeysPagedResponse>

listRelatedAccountGroupMembershipsSettings()

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

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

Returns
Type Description
PagedCallSettings<ListRelatedAccountGroupMembershipsRequest,ListRelatedAccountGroupMembershipsResponse,ListRelatedAccountGroupMembershipsPagedResponse>

listRelatedAccountGroupsSettings()

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

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

Returns
Type Description
PagedCallSettings<ListRelatedAccountGroupsRequest,ListRelatedAccountGroupsResponse,ListRelatedAccountGroupsPagedResponse>

migrateKeySettings()

public UnaryCallSettings<MigrateKeyRequest,Key> migrateKeySettings()

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

Returns
Type Description
UnaryCallSettings<MigrateKeyRequest,Key>

reorderFirewallPoliciesSettings()

public UnaryCallSettings<ReorderFirewallPoliciesRequest,ReorderFirewallPoliciesResponse> reorderFirewallPoliciesSettings()

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

Returns
Type Description
UnaryCallSettings<ReorderFirewallPoliciesRequest,ReorderFirewallPoliciesResponse>

retrieveLegacySecretKeySettings()

public UnaryCallSettings<RetrieveLegacySecretKeyRequest,RetrieveLegacySecretKeyResponse> retrieveLegacySecretKeySettings()

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

Returns
Type Description
UnaryCallSettings<RetrieveLegacySecretKeyRequest,RetrieveLegacySecretKeyResponse>

searchRelatedAccountGroupMembershipsSettings()

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

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

Returns
Type Description
PagedCallSettings<SearchRelatedAccountGroupMembershipsRequest,SearchRelatedAccountGroupMembershipsResponse,SearchRelatedAccountGroupMembershipsPagedResponse>

toBuilder()

public RecaptchaEnterpriseServiceStubSettings.Builder toBuilder()

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

Returns
Type Description
RecaptchaEnterpriseServiceStubSettings.Builder
Overrides

updateFirewallPolicySettings()

public UnaryCallSettings<UpdateFirewallPolicyRequest,FirewallPolicy> updateFirewallPolicySettings()

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

Returns
Type Description
UnaryCallSettings<UpdateFirewallPolicyRequest,FirewallPolicy>

updateKeySettings()

public UnaryCallSettings<UpdateKeyRequest,Key> updateKeySettings()

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

Returns
Type Description
UnaryCallSettings<UpdateKeyRequest,Key>