Class RecaptchaEnterpriseServiceGrpc.RecaptchaEnterpriseServiceFutureStub (3.50.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

Inherited Members

io.grpc.stub.AbstractFutureStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)

io.grpc.stub.AbstractFutureStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.<T>withOption(io.grpc.CallOptions.Key<T>,T)

io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.getCallOptions()

io.grpc.stub.AbstractStub.getChannel()

io.grpc.stub.AbstractStub.withCallCredentials(io.grpc.CallCredentials)

io.grpc.stub.AbstractStub.withChannel(io.grpc.Channel)

io.grpc.stub.AbstractStub.withCompression(java.lang.String)

io.grpc.stub.AbstractStub.withDeadline(io.grpc.Deadline)

io.grpc.stub.AbstractStub.withDeadlineAfter(long,java.util.concurrent.TimeUnit)

io.grpc.stub.AbstractStub.withExecutor(java.util.concurrent.Executor)

io.grpc.stub.AbstractStub.withInterceptors(io.grpc.ClientInterceptor...)

io.grpc.stub.AbstractStub.withMaxInboundMessageSize(int)

io.grpc.stub.AbstractStub.withMaxOutboundMessageSize(int)

io.grpc.stub.AbstractStub.withOnReadyThreshold(int)

io.grpc.stub.AbstractStub.withWaitForReady()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Methods

addIpOverride(AddIpOverrideRequest request)

public ListenableFuture<AddIpOverrideResponse> addIpOverride(AddIpOverrideRequest request)

Adds an IP override to a key. The following restrictions hold:

The maximum number of IP overrides per key is 100.
For any conflict (such as IP already exists or IP part of an existing IP range), an error is returned.

Parameter
Name	Description
`request`	`AddIpOverrideRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<AddIpOverrideResponse>`

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
Name	Description
`request`	`AnnotateAssessmentRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<AnnotateAssessmentResponse>`

build(Channel channel, CallOptions callOptions)

protected RecaptchaEnterpriseServiceGrpc.RecaptchaEnterpriseServiceFutureStub build(Channel channel, CallOptions callOptions)

Parameters
Name	Description
`channel`	`io.grpc.Channel`
`callOptions`	`io.grpc.CallOptions`

Returns
Type	Description
`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
Name	Description
`request`	`CreateAssessmentRequest`

Returns
Type	Description
`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
Name	Description
`request`	`CreateFirewallPolicyRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<FirewallPolicy>`

createKey(CreateKeyRequest request)

public ListenableFuture<Key> createKey(CreateKeyRequest request)

Creates a new reCAPTCHA Enterprise key.

Parameter
Name	Description
`request`	`CreateKeyRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Key>`

deleteFirewallPolicy(DeleteFirewallPolicyRequest request)

public ListenableFuture<Empty> deleteFirewallPolicy(DeleteFirewallPolicyRequest request)

Deletes the specified firewall policy.

Parameter
Name	Description
`request`	`DeleteFirewallPolicyRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Empty>`

deleteKey(DeleteKeyRequest request)

public ListenableFuture<Empty> deleteKey(DeleteKeyRequest request)

Deletes the specified key.

Parameter
Name	Description
`request`	`DeleteKeyRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Empty>`

getFirewallPolicy(GetFirewallPolicyRequest request)

public ListenableFuture<FirewallPolicy> getFirewallPolicy(GetFirewallPolicyRequest request)

Returns the specified firewall policy.

Parameter
Name	Description
`request`	`GetFirewallPolicyRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<FirewallPolicy>`

getKey(GetKeyRequest request)

public ListenableFuture<Key> getKey(GetKeyRequest request)

Returns the specified key.

Parameter
Name	Description
`request`	`GetKeyRequest`

Returns
Type	Description
`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
Name	Description
`request`	`GetMetricsRequest`

Returns
Type	Description
`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
Name	Description
`request`	`ListFirewallPoliciesRequest`

Returns
Type	Description
`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
Name	Description
`request`	`ListKeysRequest`

Returns
Type	Description
`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
Name	Description
`request`	`ListRelatedAccountGroupMembershipsRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<ListRelatedAccountGroupMembershipsResponse>`

listRelatedAccountGroups(ListRelatedAccountGroupsRequest request)

public ListenableFuture<ListRelatedAccountGroupsResponse> listRelatedAccountGroups(ListRelatedAccountGroupsRequest request)

List groups of related accounts.

Parameter
Name	Description
`request`	`ListRelatedAccountGroupsRequest`

Returns
Type	Description
`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
Name	Description
`request`	`MigrateKeyRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Key>`

reorderFirewallPolicies(ReorderFirewallPoliciesRequest request)

public ListenableFuture<ReorderFirewallPoliciesResponse> reorderFirewallPolicies(ReorderFirewallPoliciesRequest request)

Reorders all firewall policies.

Parameter
Name	Description
`request`	`ReorderFirewallPoliciesRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<ReorderFirewallPoliciesResponse>`

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
Name	Description
`request`	`RetrieveLegacySecretKeyRequest`

Returns
Type	Description
`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
Name	Description
`request`	`SearchRelatedAccountGroupMembershipsRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<SearchRelatedAccountGroupMembershipsResponse>`

updateFirewallPolicy(UpdateFirewallPolicyRequest request)

public ListenableFuture<FirewallPolicy> updateFirewallPolicy(UpdateFirewallPolicyRequest request)

Updates the specified firewall policy.

Parameter
Name	Description
`request`	`UpdateFirewallPolicyRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<FirewallPolicy>`

updateKey(UpdateKeyRequest request)

public ListenableFuture<Key> updateKey(UpdateKeyRequest request)

Updates the specified key.

Parameter
Name	Description
`request`	`UpdateKeyRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Key>`