Class RecaptchaEnterpriseServiceStubSettings (3.18.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
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

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

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

Returns a new builder for this class.

Returns
TypeDescription
RecaptchaEnterpriseServiceStubSettings.Builder

newBuilder(ClientContext clientContext)

public static RecaptchaEnterpriseServiceStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
RecaptchaEnterpriseServiceStubSettings.Builder

Constructors

RecaptchaEnterpriseServiceStubSettings(RecaptchaEnterpriseServiceStubSettings.Builder settingsBuilder)

protected RecaptchaEnterpriseServiceStubSettings(RecaptchaEnterpriseServiceStubSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderRecaptchaEnterpriseServiceStubSettings.Builder

Methods

annotateAssessmentSettings()

public UnaryCallSettings<AnnotateAssessmentRequest,AnnotateAssessmentResponse> annotateAssessmentSettings()

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

Returns
TypeDescription
UnaryCallSettings<AnnotateAssessmentRequest,AnnotateAssessmentResponse>

createAssessmentSettings()

public UnaryCallSettings<CreateAssessmentRequest,Assessment> createAssessmentSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateAssessmentRequest,Assessment>

createKeySettings()

public UnaryCallSettings<CreateKeyRequest,Key> createKeySettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateKeyRequest,Key>

createStub()

public RecaptchaEnterpriseServiceStub createStub()
Returns
TypeDescription
RecaptchaEnterpriseServiceStub
Exceptions
TypeDescription
IOException

deleteKeySettings()

public UnaryCallSettings<DeleteKeyRequest,Empty> deleteKeySettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteKeyRequest,Empty>

getKeySettings()

public UnaryCallSettings<GetKeyRequest,Key> getKeySettings()

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

Returns
TypeDescription
UnaryCallSettings<GetKeyRequest,Key>

getMetricsSettings()

public UnaryCallSettings<GetMetricsRequest,Metrics> getMetricsSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetMetricsRequest,Metrics>

listKeysSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListKeysRequest,ListKeysResponse,ListKeysPagedResponse>

listRelatedAccountGroupMembershipsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListRelatedAccountGroupMembershipsRequest,ListRelatedAccountGroupMembershipsResponse,ListRelatedAccountGroupMembershipsPagedResponse>

listRelatedAccountGroupsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListRelatedAccountGroupsRequest,ListRelatedAccountGroupsResponse,ListRelatedAccountGroupsPagedResponse>

migrateKeySettings()

public UnaryCallSettings<MigrateKeyRequest,Key> migrateKeySettings()

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

Returns
TypeDescription
UnaryCallSettings<MigrateKeyRequest,Key>

retrieveLegacySecretKeySettings()

public UnaryCallSettings<RetrieveLegacySecretKeyRequest,RetrieveLegacySecretKeyResponse> retrieveLegacySecretKeySettings()

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

Returns
TypeDescription
UnaryCallSettings<RetrieveLegacySecretKeyRequest,RetrieveLegacySecretKeyResponse>

searchRelatedAccountGroupMembershipsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<SearchRelatedAccountGroupMembershipsRequest,SearchRelatedAccountGroupMembershipsResponse,SearchRelatedAccountGroupMembershipsPagedResponse>

toBuilder()

public RecaptchaEnterpriseServiceStubSettings.Builder toBuilder()

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

Returns
TypeDescription
RecaptchaEnterpriseServiceStubSettings.Builder
Overrides

updateKeySettings()

public UnaryCallSettings<UpdateKeyRequest,Key> updateKeySettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateKeyRequest,Key>