Class RecaptchaEnterpriseServiceV1Beta1Client (3.3.0) 

public class RecaptchaEnterpriseServiceV1Beta1Client implements BackgroundResource

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:


 // 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
 try (RecaptchaEnterpriseServiceV1Beta1Client recaptchaEnterpriseServiceV1Beta1Client =
     RecaptchaEnterpriseServiceV1Beta1Client.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   Assessment assessment = Assessment.newBuilder().build();
   Assessment response =
       recaptchaEnterpriseServiceV1Beta1Client.createAssessment(parent, assessment);
 }

Note: close() needs to be called on the RecaptchaEnterpriseServiceV1Beta1Client 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 RecaptchaEnterpriseServiceV1Beta1Settings to create(). For example:

To customize credentials:


 // 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
 RecaptchaEnterpriseServiceV1Beta1Settings recaptchaEnterpriseServiceV1Beta1Settings =
     RecaptchaEnterpriseServiceV1Beta1Settings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 RecaptchaEnterpriseServiceV1Beta1Client recaptchaEnterpriseServiceV1Beta1Client =
     RecaptchaEnterpriseServiceV1Beta1Client.create(recaptchaEnterpriseServiceV1Beta1Settings);

To customize the endpoint:


 // 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
 RecaptchaEnterpriseServiceV1Beta1Settings recaptchaEnterpriseServiceV1Beta1Settings =
     RecaptchaEnterpriseServiceV1Beta1Settings.newBuilder().setEndpoint(myEndpoint).build();
 RecaptchaEnterpriseServiceV1Beta1Client recaptchaEnterpriseServiceV1Beta1Client =
     RecaptchaEnterpriseServiceV1Beta1Client.create(recaptchaEnterpriseServiceV1Beta1Settings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // 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
 RecaptchaEnterpriseServiceV1Beta1Settings recaptchaEnterpriseServiceV1Beta1Settings =
     RecaptchaEnterpriseServiceV1Beta1Settings.newHttpJsonBuilder().build();
 RecaptchaEnterpriseServiceV1Beta1Client recaptchaEnterpriseServiceV1Beta1Client =
     RecaptchaEnterpriseServiceV1Beta1Client.create(recaptchaEnterpriseServiceV1Beta1Settings);

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

Inheritance

java.lang.Object > RecaptchaEnterpriseServiceV1Beta1Client

Implements

BackgroundResource

Static Methods

create()

public static final RecaptchaEnterpriseServiceV1Beta1Client create()

Constructs an instance of RecaptchaEnterpriseServiceV1Beta1Client with default settings.

Returns
TypeDescription
RecaptchaEnterpriseServiceV1Beta1Client
Exceptions
TypeDescription
IOException

create(RecaptchaEnterpriseServiceV1Beta1Settings settings)

public static final RecaptchaEnterpriseServiceV1Beta1Client create(RecaptchaEnterpriseServiceV1Beta1Settings settings)

Constructs an instance of RecaptchaEnterpriseServiceV1Beta1Client, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter
NameDescription
settingsRecaptchaEnterpriseServiceV1Beta1Settings
Returns
TypeDescription
RecaptchaEnterpriseServiceV1Beta1Client
Exceptions
TypeDescription
IOException

create(RecaptchaEnterpriseServiceV1Beta1Stub stub)

public static final RecaptchaEnterpriseServiceV1Beta1Client create(RecaptchaEnterpriseServiceV1Beta1Stub stub)

Constructs an instance of RecaptchaEnterpriseServiceV1Beta1Client, using the given stub for making calls. This is for advanced usage - prefer using create(RecaptchaEnterpriseServiceV1Beta1Settings).

Parameter
NameDescription
stubRecaptchaEnterpriseServiceV1Beta1Stub
Returns
TypeDescription
RecaptchaEnterpriseServiceV1Beta1Client

Constructors

RecaptchaEnterpriseServiceV1Beta1Client(RecaptchaEnterpriseServiceV1Beta1Settings settings)

protected RecaptchaEnterpriseServiceV1Beta1Client(RecaptchaEnterpriseServiceV1Beta1Settings settings)

Constructs an instance of RecaptchaEnterpriseServiceV1Beta1Client, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Parameter
NameDescription
settingsRecaptchaEnterpriseServiceV1Beta1Settings

RecaptchaEnterpriseServiceV1Beta1Client(RecaptchaEnterpriseServiceV1Beta1Stub stub)

protected RecaptchaEnterpriseServiceV1Beta1Client(RecaptchaEnterpriseServiceV1Beta1Stub stub)
Parameter
NameDescription
stubRecaptchaEnterpriseServiceV1Beta1Stub

Methods

annotateAssessment(AnnotateAssessmentRequest request)

public final AnnotateAssessmentResponse annotateAssessment(AnnotateAssessmentRequest request)

Annotates a previously created Assessment to provide additional information on whether the event turned out to be authentic or fradulent.

Sample code:


 // 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
 try (RecaptchaEnterpriseServiceV1Beta1Client recaptchaEnterpriseServiceV1Beta1Client =
     RecaptchaEnterpriseServiceV1Beta1Client.create()) {
   AnnotateAssessmentRequest request =
       AnnotateAssessmentRequest.newBuilder()
           .setName(AssessmentName.of("[PROJECT]", "[ASSESSMENT]").toString())
           .addAllReasons(new ArrayList<AnnotateAssessmentRequest.Reason>())
           .setHashedAccountId(ByteString.EMPTY)
           .build();
   AnnotateAssessmentResponse response =
       recaptchaEnterpriseServiceV1Beta1Client.annotateAssessment(request);
 }
Parameter
NameDescription
requestAnnotateAssessmentRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
AnnotateAssessmentResponse

annotateAssessment(AssessmentName name, AnnotateAssessmentRequest.Annotation annotation)

public final AnnotateAssessmentResponse annotateAssessment(AssessmentName name, AnnotateAssessmentRequest.Annotation annotation)

Annotates a previously created Assessment to provide additional information on whether the event turned out to be authentic or fradulent.

Sample code:


 // 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
 try (RecaptchaEnterpriseServiceV1Beta1Client recaptchaEnterpriseServiceV1Beta1Client =
     RecaptchaEnterpriseServiceV1Beta1Client.create()) {
   AssessmentName name = AssessmentName.of("[PROJECT]", "[ASSESSMENT]");
   AnnotateAssessmentRequest.Annotation annotation =
       AnnotateAssessmentRequest.Annotation.forNumber(0);
   AnnotateAssessmentResponse response =
       recaptchaEnterpriseServiceV1Beta1Client.annotateAssessment(name, annotation);
 }
Parameters
NameDescription
nameAssessmentName

Required. The resource name of the Assessment, in the format "projects/{project_number}/assessments/{assessment_id}".

annotationAnnotateAssessmentRequest.Annotation

Optional. The annotation that will be assigned to the Event. This field can be left empty to provide reasons that apply to an event without concluding whether the event is legitimate or fraudulent.

Returns
TypeDescription
AnnotateAssessmentResponse

annotateAssessment(String name, AnnotateAssessmentRequest.Annotation annotation)

public final AnnotateAssessmentResponse annotateAssessment(String name, AnnotateAssessmentRequest.Annotation annotation)

Annotates a previously created Assessment to provide additional information on whether the event turned out to be authentic or fradulent.

Sample code:


 // 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
 try (RecaptchaEnterpriseServiceV1Beta1Client recaptchaEnterpriseServiceV1Beta1Client =
     RecaptchaEnterpriseServiceV1Beta1Client.create()) {
   String name = AssessmentName.of("[PROJECT]", "[ASSESSMENT]").toString();
   AnnotateAssessmentRequest.Annotation annotation =
       AnnotateAssessmentRequest.Annotation.forNumber(0);
   AnnotateAssessmentResponse response =
       recaptchaEnterpriseServiceV1Beta1Client.annotateAssessment(name, annotation);
 }
Parameters
NameDescription
nameString

Required. The resource name of the Assessment, in the format "projects/{project_number}/assessments/{assessment_id}".

annotationAnnotateAssessmentRequest.Annotation

Optional. The annotation that will be assigned to the Event. This field can be left empty to provide reasons that apply to an event without concluding whether the event is legitimate or fraudulent.

Returns
TypeDescription
AnnotateAssessmentResponse

annotateAssessmentCallable()

public final UnaryCallable<AnnotateAssessmentRequest,AnnotateAssessmentResponse> annotateAssessmentCallable()

Annotates a previously created Assessment to provide additional information on whether the event turned out to be authentic or fradulent.

Sample code:


 // 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
 try (RecaptchaEnterpriseServiceV1Beta1Client recaptchaEnterpriseServiceV1Beta1Client =
     RecaptchaEnterpriseServiceV1Beta1Client.create()) {
   AnnotateAssessmentRequest request =
       AnnotateAssessmentRequest.newBuilder()
           .setName(AssessmentName.of("[PROJECT]", "[ASSESSMENT]").toString())
           .addAllReasons(new ArrayList<AnnotateAssessmentRequest.Reason>())
           .setHashedAccountId(ByteString.EMPTY)
           .build();
   ApiFuture<AnnotateAssessmentResponse> future =
       recaptchaEnterpriseServiceV1Beta1Client.annotateAssessmentCallable().futureCall(request);
   // Do something.
   AnnotateAssessmentResponse response = future.get();
 }
Returns
TypeDescription
UnaryCallable<AnnotateAssessmentRequest,AnnotateAssessmentResponse>

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
NameDescription
durationlong
unitTimeUnit
Returns
TypeDescription
boolean
Exceptions
TypeDescription
InterruptedException

close()

public final void close()

createAssessment(CreateAssessmentRequest request)

public final Assessment createAssessment(CreateAssessmentRequest request)

Creates an Assessment of the likelihood an event is legitimate.

Sample code:


 // 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
 try (RecaptchaEnterpriseServiceV1Beta1Client recaptchaEnterpriseServiceV1Beta1Client =
     RecaptchaEnterpriseServiceV1Beta1Client.create()) {
   CreateAssessmentRequest request =
       CreateAssessmentRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setAssessment(Assessment.newBuilder().build())
           .build();
   Assessment response = recaptchaEnterpriseServiceV1Beta1Client.createAssessment(request);
 }
Parameter
NameDescription
requestCreateAssessmentRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
Assessment

createAssessment(ProjectName parent, Assessment assessment)

public final Assessment createAssessment(ProjectName parent, Assessment assessment)

Creates an Assessment of the likelihood an event is legitimate.

Sample code:


 // 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
 try (RecaptchaEnterpriseServiceV1Beta1Client recaptchaEnterpriseServiceV1Beta1Client =
     RecaptchaEnterpriseServiceV1Beta1Client.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   Assessment assessment = Assessment.newBuilder().build();
   Assessment response =
       recaptchaEnterpriseServiceV1Beta1Client.createAssessment(parent, assessment);
 }
Parameters
NameDescription
parentProjectName

Required. The name of the project in which the assessment will be created, in the format "projects/{project_number}".

assessmentAssessment

Required. The assessment details.

Returns
TypeDescription
Assessment

createAssessment(String parent, Assessment assessment)

public final Assessment createAssessment(String parent, Assessment assessment)

Creates an Assessment of the likelihood an event is legitimate.

Sample code:


 // 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
 try (RecaptchaEnterpriseServiceV1Beta1Client recaptchaEnterpriseServiceV1Beta1Client =
     RecaptchaEnterpriseServiceV1Beta1Client.create()) {
   String parent = ProjectName.of("[PROJECT]").toString();
   Assessment assessment = Assessment.newBuilder().build();
   Assessment response =
       recaptchaEnterpriseServiceV1Beta1Client.createAssessment(parent, assessment);
 }
Parameters
NameDescription
parentString

Required. The name of the project in which the assessment will be created, in the format "projects/{project_number}".

assessmentAssessment

Required. The assessment details.

Returns
TypeDescription
Assessment

createAssessmentCallable()

public final UnaryCallable<CreateAssessmentRequest,Assessment> createAssessmentCallable()

Creates an Assessment of the likelihood an event is legitimate.

Sample code:


 // 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
 try (RecaptchaEnterpriseServiceV1Beta1Client recaptchaEnterpriseServiceV1Beta1Client =
     RecaptchaEnterpriseServiceV1Beta1Client.create()) {
   CreateAssessmentRequest request =
       CreateAssessmentRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setAssessment(Assessment.newBuilder().build())
           .build();
   ApiFuture<Assessment> future =
       recaptchaEnterpriseServiceV1Beta1Client.createAssessmentCallable().futureCall(request);
   // Do something.
   Assessment response = future.get();
 }
Returns
TypeDescription
UnaryCallable<CreateAssessmentRequest,Assessment>

getSettings()

public final RecaptchaEnterpriseServiceV1Beta1Settings getSettings()
Returns
TypeDescription
RecaptchaEnterpriseServiceV1Beta1Settings

getStub()

public RecaptchaEnterpriseServiceV1Beta1Stub getStub()
Returns
TypeDescription
RecaptchaEnterpriseServiceV1Beta1Stub

isShutdown()

public boolean isShutdown()
Returns
TypeDescription
boolean

isTerminated()

public boolean isTerminated()
Returns
TypeDescription
boolean

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()