Package com.google.cloud.recaptchaenterprise.v1 (2.5.0)

The interfaces provided are listed below, along with usage samples.

RecaptchaEnterpriseServiceClient

Service Description: Service to determine the likelihood an event is legitimate.

Sample for RecaptchaEnterpriseServiceClient:


 try (RecaptchaEnterpriseServiceClient recaptchaEnterpriseServiceClient =
     RecaptchaEnterpriseServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   Assessment assessment = Assessment.newBuilder().build();
   Assessment response = recaptchaEnterpriseServiceClient.createAssessment(parent, assessment);
 }

Classes

RecaptchaEnterpriseServiceClient

Service Description: Service to determine the likelihood an event is legitimate.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 try (RecaptchaEnterpriseServiceClient recaptchaEnterpriseServiceClient =
     RecaptchaEnterpriseServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   Assessment assessment = Assessment.newBuilder().build();
   Assessment response = recaptchaEnterpriseServiceClient.createAssessment(parent, assessment);
 }

Note: close() needs to be called on the RecaptchaEnterpriseServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

  1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
  2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
  3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of RecaptchaEnterpriseServiceSettings to create(). For example:

To customize credentials:


 RecaptchaEnterpriseServiceSettings recaptchaEnterpriseServiceSettings =
     RecaptchaEnterpriseServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 RecaptchaEnterpriseServiceClient recaptchaEnterpriseServiceClient =
     RecaptchaEnterpriseServiceClient.create(recaptchaEnterpriseServiceSettings);

To customize the endpoint:


 RecaptchaEnterpriseServiceSettings recaptchaEnterpriseServiceSettings =
     RecaptchaEnterpriseServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 RecaptchaEnterpriseServiceClient recaptchaEnterpriseServiceClient =
     RecaptchaEnterpriseServiceClient.create(recaptchaEnterpriseServiceSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

RecaptchaEnterpriseServiceClient.ListKeysFixedSizeCollection

RecaptchaEnterpriseServiceClient.ListKeysPage

RecaptchaEnterpriseServiceClient.ListKeysPagedResponse

RecaptchaEnterpriseServiceClient.ListRelatedAccountGroupMembershipsFixedSizeCollection

RecaptchaEnterpriseServiceClient.ListRelatedAccountGroupMembershipsPage

RecaptchaEnterpriseServiceClient.ListRelatedAccountGroupMembershipsPagedResponse

RecaptchaEnterpriseServiceClient.ListRelatedAccountGroupsFixedSizeCollection

RecaptchaEnterpriseServiceClient.ListRelatedAccountGroupsPage

RecaptchaEnterpriseServiceClient.ListRelatedAccountGroupsPagedResponse

RecaptchaEnterpriseServiceClient.SearchRelatedAccountGroupMembershipsFixedSizeCollection

RecaptchaEnterpriseServiceClient.SearchRelatedAccountGroupMembershipsPage

RecaptchaEnterpriseServiceClient.SearchRelatedAccountGroupMembershipsPagedResponse

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 total timeout of createAssessment to 30 seconds:


 RecaptchaEnterpriseServiceSettings.Builder recaptchaEnterpriseServiceSettingsBuilder =
     RecaptchaEnterpriseServiceSettings.newBuilder();
 recaptchaEnterpriseServiceSettingsBuilder
     .createAssessmentSettings()
     .setRetrySettings(
         recaptchaEnterpriseServiceSettingsBuilder
             .createAssessmentSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 RecaptchaEnterpriseServiceSettings recaptchaEnterpriseServiceSettings =
     recaptchaEnterpriseServiceSettingsBuilder.build();

RecaptchaEnterpriseServiceSettings.Builder

Builder for RecaptchaEnterpriseServiceSettings.