Class RecaptchaEnterpriseServiceGrpc.RecaptchaEnterpriseServiceFutureStub (3.29.0)

public static final class RecaptchaEnterpriseServiceGrpc.RecaptchaEnterpriseServiceFutureStub extends AbstractFutureStub<RecaptchaEnterpriseServiceGrpc.RecaptchaEnterpriseServiceFutureStub>

A stub to allow clients to do ListenableFuture-style rpc calls to service RecaptchaEnterpriseService.

Service to determine the likelihood an event is legitimate.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractFutureStub > RecaptchaEnterpriseServiceGrpc.RecaptchaEnterpriseServiceFutureStub

Methods

annotateAssessment(AnnotateAssessmentRequest request)

public ListenableFuture<AnnotateAssessmentResponse> annotateAssessment(AnnotateAssessmentRequest request)

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

Parameter
NameDescription
requestAnnotateAssessmentRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<AnnotateAssessmentResponse>

build(Channel channel, CallOptions callOptions)

protected RecaptchaEnterpriseServiceGrpc.RecaptchaEnterpriseServiceFutureStub build(Channel channel, CallOptions callOptions)
Parameters
NameDescription
channelio.grpc.Channel
callOptionsio.grpc.CallOptions
Returns
TypeDescription
RecaptchaEnterpriseServiceGrpc.RecaptchaEnterpriseServiceFutureStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createAssessment(CreateAssessmentRequest request)

public ListenableFuture<Assessment> createAssessment(CreateAssessmentRequest request)

Creates an Assessment of the likelihood an event is legitimate.

Parameter
NameDescription
requestCreateAssessmentRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Assessment>

createFirewallPolicy(CreateFirewallPolicyRequest request)

public ListenableFuture<FirewallPolicy> createFirewallPolicy(CreateFirewallPolicyRequest request)

Creates a new FirewallPolicy, specifying conditions at which reCAPTCHA Enterprise actions can be executed. A project may have a maximum of 1000 policies.

Parameter
NameDescription
requestCreateFirewallPolicyRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<FirewallPolicy>

createKey(CreateKeyRequest request)

public ListenableFuture<Key> createKey(CreateKeyRequest request)

Creates a new reCAPTCHA Enterprise key.

Parameter
NameDescription
requestCreateKeyRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Key>

deleteFirewallPolicy(DeleteFirewallPolicyRequest request)

public ListenableFuture<Empty> deleteFirewallPolicy(DeleteFirewallPolicyRequest request)

Deletes the specified firewall policy.

Parameter
NameDescription
requestDeleteFirewallPolicyRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteKey(DeleteKeyRequest request)

public ListenableFuture<Empty> deleteKey(DeleteKeyRequest request)

Deletes the specified key.

Parameter
NameDescription
requestDeleteKeyRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Empty>

getFirewallPolicy(GetFirewallPolicyRequest request)

public ListenableFuture<FirewallPolicy> getFirewallPolicy(GetFirewallPolicyRequest request)

Returns the specified firewall policy.

Parameter
NameDescription
requestGetFirewallPolicyRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<FirewallPolicy>

getKey(GetKeyRequest request)

public ListenableFuture<Key> getKey(GetKeyRequest request)

Returns the specified key.

Parameter
NameDescription
requestGetKeyRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Key>

getMetrics(GetMetricsRequest request)

public ListenableFuture<Metrics> getMetrics(GetMetricsRequest request)

Get some aggregated metrics for a Key. This data can be used to build dashboards.

Parameter
NameDescription
requestGetMetricsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Metrics>

listFirewallPolicies(ListFirewallPoliciesRequest request)

public ListenableFuture<ListFirewallPoliciesResponse> listFirewallPolicies(ListFirewallPoliciesRequest request)

Returns the list of all firewall policies that belong to a project.

Parameter
NameDescription
requestListFirewallPoliciesRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListFirewallPoliciesResponse>

listKeys(ListKeysRequest request)

public ListenableFuture<ListKeysResponse> listKeys(ListKeysRequest request)

Returns the list of all keys that belong to a project.

Parameter
NameDescription
requestListKeysRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListKeysResponse>

listRelatedAccountGroupMemberships(ListRelatedAccountGroupMembershipsRequest request)

public ListenableFuture<ListRelatedAccountGroupMembershipsResponse> listRelatedAccountGroupMemberships(ListRelatedAccountGroupMembershipsRequest request)

Get memberships in a group of related accounts.

Parameter
NameDescription
requestListRelatedAccountGroupMembershipsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListRelatedAccountGroupMembershipsResponse>

listRelatedAccountGroups(ListRelatedAccountGroupsRequest request)

public ListenableFuture<ListRelatedAccountGroupsResponse> listRelatedAccountGroups(ListRelatedAccountGroupsRequest request)

List groups of related accounts.

Parameter
NameDescription
requestListRelatedAccountGroupsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListRelatedAccountGroupsResponse>

migrateKey(MigrateKeyRequest request)

public ListenableFuture<Key> migrateKey(MigrateKeyRequest request)

Migrates an existing key from reCAPTCHA to reCAPTCHA Enterprise. Once a key is migrated, it can be used from either product. SiteVerify requests are billed as CreateAssessment calls. You must be authenticated as one of the current owners of the reCAPTCHA Key, and your user must have the reCAPTCHA Enterprise Admin IAM role in the destination project.

Parameter
NameDescription
requestMigrateKeyRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Key>

retrieveLegacySecretKey(RetrieveLegacySecretKeyRequest request)

public ListenableFuture<RetrieveLegacySecretKeyResponse> retrieveLegacySecretKey(RetrieveLegacySecretKeyRequest request)

Returns the secret key related to the specified public key. You must use the legacy secret key only in a 3rd party integration with legacy reCAPTCHA.

Parameter
NameDescription
requestRetrieveLegacySecretKeyRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<RetrieveLegacySecretKeyResponse>

searchRelatedAccountGroupMemberships(SearchRelatedAccountGroupMembershipsRequest request)

public ListenableFuture<SearchRelatedAccountGroupMembershipsResponse> searchRelatedAccountGroupMemberships(SearchRelatedAccountGroupMembershipsRequest request)

Search group memberships related to a given account.

Parameter
NameDescription
requestSearchRelatedAccountGroupMembershipsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<SearchRelatedAccountGroupMembershipsResponse>

updateFirewallPolicy(UpdateFirewallPolicyRequest request)

public ListenableFuture<FirewallPolicy> updateFirewallPolicy(UpdateFirewallPolicyRequest request)

Updates the specified firewall policy.

Parameter
NameDescription
requestUpdateFirewallPolicyRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<FirewallPolicy>

updateKey(UpdateKeyRequest request)

public ListenableFuture<Key> updateKey(UpdateKeyRequest request)

Updates the specified key.

Parameter
NameDescription
requestUpdateKeyRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Key>