Class RecaptchaEnterpriseServiceGrpc.RecaptchaEnterpriseServiceStub (3.50.0) 

public static final class RecaptchaEnterpriseServiceGrpc.RecaptchaEnterpriseServiceStub extends AbstractAsyncStub<RecaptchaEnterpriseServiceGrpc.RecaptchaEnterpriseServiceStub>

A stub to allow clients to do asynchronous 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.AbstractAsyncStub > RecaptchaEnterpriseServiceGrpc.RecaptchaEnterpriseServiceStub

Methods

addIpOverride(AddIpOverrideRequest request, StreamObserver<AddIpOverrideResponse> responseObserver)

public void addIpOverride(AddIpOverrideRequest request, StreamObserver<AddIpOverrideResponse> responseObserver)

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.
Parameters
Name Description
request AddIpOverrideRequest
responseObserver io.grpc.stub.StreamObserver<AddIpOverrideResponse>

annotateAssessment(AnnotateAssessmentRequest request, StreamObserver<AnnotateAssessmentResponse> responseObserver)

public void annotateAssessment(AnnotateAssessmentRequest request, StreamObserver<AnnotateAssessmentResponse> responseObserver)

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

Parameters
Name Description
request AnnotateAssessmentRequest
responseObserver io.grpc.stub.StreamObserver<AnnotateAssessmentResponse>

build(Channel channel, CallOptions callOptions)

protected RecaptchaEnterpriseServiceGrpc.RecaptchaEnterpriseServiceStub build(Channel channel, CallOptions callOptions)
Parameters
Name Description
channel io.grpc.Channel
callOptions io.grpc.CallOptions
Returns
Type Description
RecaptchaEnterpriseServiceGrpc.RecaptchaEnterpriseServiceStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createAssessment(CreateAssessmentRequest request, StreamObserver<Assessment> responseObserver)

public void createAssessment(CreateAssessmentRequest request, StreamObserver<Assessment> responseObserver)

Creates an Assessment of the likelihood an event is legitimate.

Parameters
Name Description
request CreateAssessmentRequest
responseObserver io.grpc.stub.StreamObserver<Assessment>

createFirewallPolicy(CreateFirewallPolicyRequest request, StreamObserver<FirewallPolicy> responseObserver)

public void createFirewallPolicy(CreateFirewallPolicyRequest request, StreamObserver<FirewallPolicy> responseObserver)

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

Parameters
Name Description
request CreateFirewallPolicyRequest
responseObserver io.grpc.stub.StreamObserver<FirewallPolicy>

createKey(CreateKeyRequest request, StreamObserver<Key> responseObserver)

public void createKey(CreateKeyRequest request, StreamObserver<Key> responseObserver)

Creates a new reCAPTCHA Enterprise key.

Parameters
Name Description
request CreateKeyRequest
responseObserver io.grpc.stub.StreamObserver<Key>

deleteFirewallPolicy(DeleteFirewallPolicyRequest request, StreamObserver<Empty> responseObserver)

public void deleteFirewallPolicy(DeleteFirewallPolicyRequest request, StreamObserver<Empty> responseObserver)

Deletes the specified firewall policy.

Parameters
Name Description
request DeleteFirewallPolicyRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

deleteKey(DeleteKeyRequest request, StreamObserver<Empty> responseObserver)

public void deleteKey(DeleteKeyRequest request, StreamObserver<Empty> responseObserver)

Deletes the specified key.

Parameters
Name Description
request DeleteKeyRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

getFirewallPolicy(GetFirewallPolicyRequest request, StreamObserver<FirewallPolicy> responseObserver)

public void getFirewallPolicy(GetFirewallPolicyRequest request, StreamObserver<FirewallPolicy> responseObserver)

Returns the specified firewall policy.

Parameters
Name Description
request GetFirewallPolicyRequest
responseObserver io.grpc.stub.StreamObserver<FirewallPolicy>

getKey(GetKeyRequest request, StreamObserver<Key> responseObserver)

public void getKey(GetKeyRequest request, StreamObserver<Key> responseObserver)

Returns the specified key.

Parameters
Name Description
request GetKeyRequest
responseObserver io.grpc.stub.StreamObserver<Key>

getMetrics(GetMetricsRequest request, StreamObserver<Metrics> responseObserver)

public void getMetrics(GetMetricsRequest request, StreamObserver<Metrics> responseObserver)

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

Parameters
Name Description
request GetMetricsRequest
responseObserver io.grpc.stub.StreamObserver<Metrics>

listFirewallPolicies(ListFirewallPoliciesRequest request, StreamObserver<ListFirewallPoliciesResponse> responseObserver)

public void listFirewallPolicies(ListFirewallPoliciesRequest request, StreamObserver<ListFirewallPoliciesResponse> responseObserver)

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

Parameters
Name Description
request ListFirewallPoliciesRequest
responseObserver io.grpc.stub.StreamObserver<ListFirewallPoliciesResponse>

listKeys(ListKeysRequest request, StreamObserver<ListKeysResponse> responseObserver)

public void listKeys(ListKeysRequest request, StreamObserver<ListKeysResponse> responseObserver)

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

Parameters
Name Description
request ListKeysRequest
responseObserver io.grpc.stub.StreamObserver<ListKeysResponse>

listRelatedAccountGroupMemberships(ListRelatedAccountGroupMembershipsRequest request, StreamObserver<ListRelatedAccountGroupMembershipsResponse> responseObserver)

public void listRelatedAccountGroupMemberships(ListRelatedAccountGroupMembershipsRequest request, StreamObserver<ListRelatedAccountGroupMembershipsResponse> responseObserver)

Get memberships in a group of related accounts.

Parameters
Name Description
request ListRelatedAccountGroupMembershipsRequest
responseObserver io.grpc.stub.StreamObserver<ListRelatedAccountGroupMembershipsResponse>

listRelatedAccountGroups(ListRelatedAccountGroupsRequest request, StreamObserver<ListRelatedAccountGroupsResponse> responseObserver)

public void listRelatedAccountGroups(ListRelatedAccountGroupsRequest request, StreamObserver<ListRelatedAccountGroupsResponse> responseObserver)

List groups of related accounts.

Parameters
Name Description
request ListRelatedAccountGroupsRequest
responseObserver io.grpc.stub.StreamObserver<ListRelatedAccountGroupsResponse>

migrateKey(MigrateKeyRequest request, StreamObserver<Key> responseObserver)

public void migrateKey(MigrateKeyRequest request, StreamObserver<Key> responseObserver)

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.

Parameters
Name Description
request MigrateKeyRequest
responseObserver io.grpc.stub.StreamObserver<Key>

reorderFirewallPolicies(ReorderFirewallPoliciesRequest request, StreamObserver<ReorderFirewallPoliciesResponse> responseObserver)

public void reorderFirewallPolicies(ReorderFirewallPoliciesRequest request, StreamObserver<ReorderFirewallPoliciesResponse> responseObserver)

Reorders all firewall policies.

Parameters
Name Description
request ReorderFirewallPoliciesRequest
responseObserver io.grpc.stub.StreamObserver<ReorderFirewallPoliciesResponse>

retrieveLegacySecretKey(RetrieveLegacySecretKeyRequest request, StreamObserver<RetrieveLegacySecretKeyResponse> responseObserver)

public void retrieveLegacySecretKey(RetrieveLegacySecretKeyRequest request, StreamObserver<RetrieveLegacySecretKeyResponse> responseObserver)

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.

Parameters
Name Description
request RetrieveLegacySecretKeyRequest
responseObserver io.grpc.stub.StreamObserver<RetrieveLegacySecretKeyResponse>

searchRelatedAccountGroupMemberships(SearchRelatedAccountGroupMembershipsRequest request, StreamObserver<SearchRelatedAccountGroupMembershipsResponse> responseObserver)

public void searchRelatedAccountGroupMemberships(SearchRelatedAccountGroupMembershipsRequest request, StreamObserver<SearchRelatedAccountGroupMembershipsResponse> responseObserver)

Search group memberships related to a given account.

Parameters
Name Description
request SearchRelatedAccountGroupMembershipsRequest
responseObserver io.grpc.stub.StreamObserver<SearchRelatedAccountGroupMembershipsResponse>

updateFirewallPolicy(UpdateFirewallPolicyRequest request, StreamObserver<FirewallPolicy> responseObserver)

public void updateFirewallPolicy(UpdateFirewallPolicyRequest request, StreamObserver<FirewallPolicy> responseObserver)

Updates the specified firewall policy.

Parameters
Name Description
request UpdateFirewallPolicyRequest
responseObserver io.grpc.stub.StreamObserver<FirewallPolicy>

updateKey(UpdateKeyRequest request, StreamObserver<Key> responseObserver)

public void updateKey(UpdateKeyRequest request, StreamObserver<Key> responseObserver)

Updates the specified key.

Parameters
Name Description
request UpdateKeyRequest
responseObserver io.grpc.stub.StreamObserver<Key>