@Generated(value="by gapic-generator") @BetaApi public class RecaptchaEnterpriseServiceV1Beta1Client extends Object implements BackgroundResource
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:
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);
Modifier | Constructor and Description |
---|---|
protected |
RecaptchaEnterpriseServiceV1Beta1Client(RecaptchaEnterpriseServiceV1Beta1Settings settings)
Constructs an instance of RecaptchaEnterpriseServiceV1Beta1Client, using the given settings.
|
protected |
RecaptchaEnterpriseServiceV1Beta1Client(RecaptchaEnterpriseServiceV1Beta1Stub stub) |
Modifier and Type | Method and Description |
---|---|
com.google.recaptchaenterprise.v1beta1.AnnotateAssessmentResponse |
annotateAssessment(com.google.recaptchaenterprise.v1beta1.AnnotateAssessmentRequest request)
Annotates a previously created Assessment to provide additional information on whether the
event turned out to be authentic or fradulent.
|
com.google.recaptchaenterprise.v1beta1.AnnotateAssessmentResponse |
annotateAssessment(com.google.recaptchaenterprise.v1beta1.AssessmentName name,
com.google.recaptchaenterprise.v1beta1.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.recaptchaenterprise.v1beta1.AnnotateAssessmentResponse |
annotateAssessment(String name,
com.google.recaptchaenterprise.v1beta1.AnnotateAssessmentRequest.Annotation annotation)
Annotates a previously created Assessment to provide additional information on whether the
event turned out to be authentic or fradulent.
|
UnaryCallable<com.google.recaptchaenterprise.v1beta1.AnnotateAssessmentRequest,com.google.recaptchaenterprise.v1beta1.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.
|
com.google.recaptchaenterprise.v1beta1.Assessment |
createAssessment(com.google.recaptchaenterprise.v1beta1.CreateAssessmentRequest request)
Creates an Assessment of the likelihood an event is legitimate.
|
com.google.recaptchaenterprise.v1beta1.Assessment |
createAssessment(com.google.recaptchaenterprise.v1beta1.ProjectName parent,
com.google.recaptchaenterprise.v1beta1.Assessment assessment)
Creates an Assessment of the likelihood an event is legitimate.
|
com.google.recaptchaenterprise.v1beta1.Assessment |
createAssessment(String parent,
com.google.recaptchaenterprise.v1beta1.Assessment assessment)
Creates an Assessment of the likelihood an event is legitimate.
|
UnaryCallable<com.google.recaptchaenterprise.v1beta1.CreateAssessmentRequest,com.google.recaptchaenterprise.v1beta1.Assessment> |
createAssessmentCallable()
Creates an Assessment of the likelihood an event is legitimate.
|
RecaptchaEnterpriseServiceV1Beta1Settings |
getSettings() |
RecaptchaEnterpriseServiceV1Beta1Stub |
getStub() |
boolean |
isShutdown() |
boolean |
isTerminated() |
void |
shutdown() |
void |
shutdownNow() |
protected RecaptchaEnterpriseServiceV1Beta1Client(RecaptchaEnterpriseServiceV1Beta1Settings settings) throws IOException
IOException
@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future") protected RecaptchaEnterpriseServiceV1Beta1Client(RecaptchaEnterpriseServiceV1Beta1Stub stub)
public static final RecaptchaEnterpriseServiceV1Beta1Client create() throws IOException
IOException
public static final RecaptchaEnterpriseServiceV1Beta1Client create(RecaptchaEnterpriseServiceV1Beta1Settings settings) throws IOException
IOException
@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future") public static final RecaptchaEnterpriseServiceV1Beta1Client create(RecaptchaEnterpriseServiceV1Beta1Stub stub)
public final RecaptchaEnterpriseServiceV1Beta1Settings getSettings()
@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future") public RecaptchaEnterpriseServiceV1Beta1Stub getStub()
public final com.google.recaptchaenterprise.v1beta1.Assessment createAssessment(com.google.recaptchaenterprise.v1beta1.ProjectName parent, com.google.recaptchaenterprise.v1beta1.Assessment assessment)
Sample code:
try (RecaptchaEnterpriseServiceV1Beta1Client recaptchaEnterpriseServiceV1Beta1Client = RecaptchaEnterpriseServiceV1Beta1Client.create()) {
ProjectName parent = ProjectName.of("[PROJECT]");
Assessment assessment = Assessment.newBuilder().build();
Assessment response = recaptchaEnterpriseServiceV1Beta1Client.createAssessment(parent, assessment);
}
parent
- Required. The name of the project in which the assessment will be created, in the
format "projects/{project_number}".assessment
- The asessment details.ApiException
- if the remote call failspublic final com.google.recaptchaenterprise.v1beta1.Assessment createAssessment(String parent, com.google.recaptchaenterprise.v1beta1.Assessment assessment)
Sample code:
try (RecaptchaEnterpriseServiceV1Beta1Client recaptchaEnterpriseServiceV1Beta1Client = RecaptchaEnterpriseServiceV1Beta1Client.create()) {
ProjectName parent = ProjectName.of("[PROJECT]");
Assessment assessment = Assessment.newBuilder().build();
Assessment response = recaptchaEnterpriseServiceV1Beta1Client.createAssessment(parent.toString(), assessment);
}
parent
- Required. The name of the project in which the assessment will be created, in the
format "projects/{project_number}".assessment
- The asessment details.ApiException
- if the remote call failspublic final com.google.recaptchaenterprise.v1beta1.Assessment createAssessment(com.google.recaptchaenterprise.v1beta1.CreateAssessmentRequest request)
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);
}
request
- The request object containing all of the parameters for the API call.ApiException
- if the remote call failspublic final UnaryCallable<com.google.recaptchaenterprise.v1beta1.CreateAssessmentRequest,com.google.recaptchaenterprise.v1beta1.Assessment> createAssessmentCallable()
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();
}
public final com.google.recaptchaenterprise.v1beta1.AnnotateAssessmentResponse annotateAssessment(com.google.recaptchaenterprise.v1beta1.AssessmentName name, com.google.recaptchaenterprise.v1beta1.AnnotateAssessmentRequest.Annotation annotation)
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);
}
name
- Required. The resource name of the Assessment, in the format
"projects/{project_number}/assessments/{assessment_id}".annotation
- The annotation that will be assigned to the Event.ApiException
- if the remote call failspublic final com.google.recaptchaenterprise.v1beta1.AnnotateAssessmentResponse annotateAssessment(String name, com.google.recaptchaenterprise.v1beta1.AnnotateAssessmentRequest.Annotation annotation)
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);
}
name
- Required. The resource name of the Assessment, in the format
"projects/{project_number}/assessments/{assessment_id}".annotation
- The annotation that will be assigned to the Event.ApiException
- if the remote call failspublic final com.google.recaptchaenterprise.v1beta1.AnnotateAssessmentResponse annotateAssessment(com.google.recaptchaenterprise.v1beta1.AnnotateAssessmentRequest request)
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);
}
request
- The request object containing all of the parameters for the API call.ApiException
- if the remote call failspublic final UnaryCallable<com.google.recaptchaenterprise.v1beta1.AnnotateAssessmentRequest,com.google.recaptchaenterprise.v1beta1.AnnotateAssessmentResponse> annotateAssessmentCallable()
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();
}
public final void close()
close
in interface AutoCloseable
public void shutdown()
shutdown
in interface BackgroundResource
public boolean isShutdown()
isShutdown
in interface BackgroundResource
public boolean isTerminated()
isTerminated
in interface BackgroundResource
public void shutdownNow()
shutdownNow
in interface BackgroundResource
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException
awaitTermination
in interface BackgroundResource
InterruptedException
Copyright © 2019 Google LLC. All rights reserved.