com.google.cloud.recaptchaenterprise.v1beta1

Class RecaptchaEnterpriseServiceV1Beta1Client

java.lang.Object

com.google.cloud.recaptchaenterprise.v1beta1.RecaptchaEnterpriseServiceV1Beta1Client

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator")
 @BetaApi
public class RecaptchaEnterpriseServiceV1Beta1Client
extends Object
implements com.google.api.gax.core.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:

 
 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:

 
 RecaptchaEnterpriseServiceV1Beta1Settings recaptchaEnterpriseServiceV1Beta1Settings =
     RecaptchaEnterpriseServiceV1Beta1Settings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 RecaptchaEnterpriseServiceV1Beta1Client recaptchaEnterpriseServiceV1Beta1Client =
     RecaptchaEnterpriseServiceV1Beta1Client.create(recaptchaEnterpriseServiceV1Beta1Settings);
 
 

To customize the endpoint:

 
 RecaptchaEnterpriseServiceV1Beta1Settings recaptchaEnterpriseServiceV1Beta1Settings =
     RecaptchaEnterpriseServiceV1Beta1Settings.newBuilder().setEndpoint(myEndpoint).build();
 RecaptchaEnterpriseServiceV1Beta1Client recaptchaEnterpriseServiceV1Beta1Client =
     RecaptchaEnterpriseServiceV1Beta1Client.create(recaptchaEnterpriseServiceV1Beta1Settings);
 
 

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RecaptchaEnterpriseServiceV1Beta1Client(RecaptchaEnterpriseServiceV1Beta1Settings settings) Constructs an instance of RecaptchaEnterpriseServiceV1Beta1Client, using the given settings.
protected	RecaptchaEnterpriseServiceV1Beta1Client(RecaptchaEnterpriseServiceV1Beta1Stub stub)

Method Summary

Modifier and Type	Method and Description
AnnotateAssessmentResponse	annotateAssessment(AnnotateAssessmentRequest request) Annotates a previously created Assessment to provide additional information on whether the event turned out to be authentic or fradulent.
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.
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.
com.google.api.gax.rpc.UnaryCallable<AnnotateAssessmentRequest,AnnotateAssessmentResponse>	annotateAssessmentCallable() Annotates a previously created Assessment to provide additional information on whether the event turned out to be authentic or fradulent.
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static RecaptchaEnterpriseServiceV1Beta1Client	create() Constructs an instance of RecaptchaEnterpriseServiceV1Beta1Client with default settings.
static RecaptchaEnterpriseServiceV1Beta1Client	create(RecaptchaEnterpriseServiceV1Beta1Settings settings) Constructs an instance of RecaptchaEnterpriseServiceV1Beta1Client, using the given settings.
static RecaptchaEnterpriseServiceV1Beta1Client	create(RecaptchaEnterpriseServiceV1Beta1Stub stub) Constructs an instance of RecaptchaEnterpriseServiceV1Beta1Client, using the given stub for making calls.
Assessment	createAssessment(CreateAssessmentRequest request) Creates an Assessment of the likelihood an event is legitimate.
Assessment	createAssessment(ProjectName parent, Assessment assessment) Creates an Assessment of the likelihood an event is legitimate.
Assessment	createAssessment(String parent, Assessment assessment) Creates an Assessment of the likelihood an event is legitimate.
com.google.api.gax.rpc.UnaryCallable<CreateAssessmentRequest,Assessment>	createAssessmentCallable() Creates an Assessment of the likelihood an event is legitimate.
RecaptchaEnterpriseServiceV1Beta1Settings	getSettings()
RecaptchaEnterpriseServiceV1Beta1Stub	getStub()
boolean	isShutdown()
boolean	isTerminated()
void	shutdown()
void	shutdownNow()

Methods inherited from class java.lang.Object

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

Constructor Detail

RecaptchaEnterpriseServiceV1Beta1Client

protected RecaptchaEnterpriseServiceV1Beta1Client(RecaptchaEnterpriseServiceV1Beta1Settings settings)
                                           throws IOException

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.

Throws:

IOException

RecaptchaEnterpriseServiceV1Beta1Client

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected RecaptchaEnterpriseServiceV1Beta1Client(RecaptchaEnterpriseServiceV1Beta1Stub stub)

Method Detail

create

public static final RecaptchaEnterpriseServiceV1Beta1Client create()
                                                            throws IOException

Constructs an instance of RecaptchaEnterpriseServiceV1Beta1Client with default settings.

Throws:

IOException

create

public static final RecaptchaEnterpriseServiceV1Beta1Client create(RecaptchaEnterpriseServiceV1Beta1Settings settings)
                                                            throws IOException

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.

Throws:

IOException

create

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
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 to use RecaptchaEnterpriseServiceV1Beta1Settings}.

getSettings

public final RecaptchaEnterpriseServiceV1Beta1Settings getSettings()

getStub

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public RecaptchaEnterpriseServiceV1Beta1Stub getStub()

createAssessment

public final Assessment createAssessment(ProjectName parent,
                                         Assessment assessment)

Creates an Assessment of the likelihood an event is legitimate.

Sample code:

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

Parameters:

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

assessment - Required. The assessment details.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createAssessment

public final Assessment createAssessment(String parent,
                                         Assessment assessment)

Creates an Assessment of the likelihood an event is legitimate.

Sample code:

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

Parameters:

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

assessment - Required. The assessment details.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createAssessment

public final Assessment createAssessment(CreateAssessmentRequest request)

Creates an Assessment of the likelihood an event is legitimate.

Sample code:

 try (RecaptchaEnterpriseServiceV1Beta1Client recaptchaEnterpriseServiceV1Beta1Client = RecaptchaEnterpriseServiceV1Beta1Client.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   Assessment assessment = Assessment.newBuilder().build();
   CreateAssessmentRequest request = CreateAssessmentRequest.newBuilder()
     .setParent(parent.toString())
     .setAssessment(assessment)
     .build();
   Assessment response = recaptchaEnterpriseServiceV1Beta1Client.createAssessment(request);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createAssessmentCallable

public final com.google.api.gax.rpc.UnaryCallable<CreateAssessmentRequest,Assessment> createAssessmentCallable()

Creates an Assessment of the likelihood an event is legitimate.

Sample code:

 try (RecaptchaEnterpriseServiceV1Beta1Client recaptchaEnterpriseServiceV1Beta1Client = RecaptchaEnterpriseServiceV1Beta1Client.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   Assessment assessment = Assessment.newBuilder().build();
   CreateAssessmentRequest request = CreateAssessmentRequest.newBuilder()
     .setParent(parent.toString())
     .setAssessment(assessment)
     .build();
   ApiFuture<Assessment> future = recaptchaEnterpriseServiceV1Beta1Client.createAssessmentCallable().futureCall(request);
   // Do something
   Assessment response = future.get();
 }
 

annotateAssessment

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:

 try (RecaptchaEnterpriseServiceV1Beta1Client recaptchaEnterpriseServiceV1Beta1Client = RecaptchaEnterpriseServiceV1Beta1Client.create()) {
   AssessmentName name = AssessmentName.of("[PROJECT]", "[ASSESSMENT]");
   AnnotateAssessmentRequest.Annotation annotation = AnnotateAssessmentRequest.Annotation.ANNOTATION_UNSPECIFIED;
   AnnotateAssessmentResponse response = recaptchaEnterpriseServiceV1Beta1Client.annotateAssessment(name, annotation);
 }
 

Parameters:

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

annotation - Required. The annotation that will be assigned to the Event.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

annotateAssessment

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:

 try (RecaptchaEnterpriseServiceV1Beta1Client recaptchaEnterpriseServiceV1Beta1Client = RecaptchaEnterpriseServiceV1Beta1Client.create()) {
   AssessmentName name = AssessmentName.of("[PROJECT]", "[ASSESSMENT]");
   AnnotateAssessmentRequest.Annotation annotation = AnnotateAssessmentRequest.Annotation.ANNOTATION_UNSPECIFIED;
   AnnotateAssessmentResponse response = recaptchaEnterpriseServiceV1Beta1Client.annotateAssessment(name.toString(), annotation);
 }
 

Parameters:

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

annotation - Required. The annotation that will be assigned to the Event.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

annotateAssessment

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:

 try (RecaptchaEnterpriseServiceV1Beta1Client recaptchaEnterpriseServiceV1Beta1Client = RecaptchaEnterpriseServiceV1Beta1Client.create()) {
   AssessmentName name = AssessmentName.of("[PROJECT]", "[ASSESSMENT]");
   AnnotateAssessmentRequest.Annotation annotation = AnnotateAssessmentRequest.Annotation.ANNOTATION_UNSPECIFIED;
   AnnotateAssessmentRequest request = AnnotateAssessmentRequest.newBuilder()
     .setName(name.toString())
     .setAnnotation(annotation)
     .build();
   AnnotateAssessmentResponse response = recaptchaEnterpriseServiceV1Beta1Client.annotateAssessment(request);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

annotateAssessmentCallable

public final com.google.api.gax.rpc.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:

 try (RecaptchaEnterpriseServiceV1Beta1Client recaptchaEnterpriseServiceV1Beta1Client = RecaptchaEnterpriseServiceV1Beta1Client.create()) {
   AssessmentName name = AssessmentName.of("[PROJECT]", "[ASSESSMENT]");
   AnnotateAssessmentRequest.Annotation annotation = AnnotateAssessmentRequest.Annotation.ANNOTATION_UNSPECIFIED;
   AnnotateAssessmentRequest request = AnnotateAssessmentRequest.newBuilder()
     .setName(name.toString())
     .setAnnotation(annotation)
     .build();
   ApiFuture<AnnotateAssessmentResponse> future = recaptchaEnterpriseServiceV1Beta1Client.annotateAssessmentCallable().futureCall(request);
   // Do something
   AnnotateAssessmentResponse response = future.get();
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:

awaitTermination in interface com.google.api.gax.core.BackgroundResource

Throws:

InterruptedException