Class RecaptchaEnterpriseServiceGrpc.RecaptchaEnterpriseServiceStub (3.27.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

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
NameDescription
requestAnnotateAssessmentRequest
responseObserverio.grpc.stub.StreamObserver<AnnotateAssessmentResponse>

build(Channel channel, CallOptions callOptions)

protected RecaptchaEnterpriseServiceGrpc.RecaptchaEnterpriseServiceStub build(Channel channel, CallOptions callOptions)
Parameters
NameDescription
channelio.grpc.Channel
callOptionsio.grpc.CallOptions
Returns
TypeDescription
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
NameDescription
requestCreateAssessmentRequest
responseObserverio.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
NameDescription
requestCreateFirewallPolicyRequest
responseObserverio.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
NameDescription
requestCreateKeyRequest
responseObserverio.grpc.stub.StreamObserver<Key>

deleteFirewallPolicy(DeleteFirewallPolicyRequest request, StreamObserver<Empty> responseObserver)

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

Deletes the specified firewall policy.

Parameters
NameDescription
requestDeleteFirewallPolicyRequest
responseObserverio.grpc.stub.StreamObserver<Empty>

deleteKey(DeleteKeyRequest request, StreamObserver<Empty> responseObserver)

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

Deletes the specified key.

Parameters
NameDescription
requestDeleteKeyRequest
responseObserverio.grpc.stub.StreamObserver<Empty>

getFirewallPolicy(GetFirewallPolicyRequest request, StreamObserver<FirewallPolicy> responseObserver)

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

Returns the specified firewall policy.

Parameters
NameDescription
requestGetFirewallPolicyRequest
responseObserverio.grpc.stub.StreamObserver<FirewallPolicy>

getKey(GetKeyRequest request, StreamObserver<Key> responseObserver)

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

Returns the specified key.

Parameters
NameDescription
requestGetKeyRequest
responseObserverio.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
NameDescription
requestGetMetricsRequest
responseObserverio.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
NameDescription
requestListFirewallPoliciesRequest
responseObserverio.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
NameDescription
requestListKeysRequest
responseObserverio.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
NameDescription
requestListRelatedAccountGroupMembershipsRequest
responseObserverio.grpc.stub.StreamObserver<ListRelatedAccountGroupMembershipsResponse>

listRelatedAccountGroups(ListRelatedAccountGroupsRequest request, StreamObserver<ListRelatedAccountGroupsResponse> responseObserver)

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

List groups of related accounts.

Parameters
NameDescription
requestListRelatedAccountGroupsRequest
responseObserverio.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
NameDescription
requestMigrateKeyRequest
responseObserverio.grpc.stub.StreamObserver<Key>

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
NameDescription
requestRetrieveLegacySecretKeyRequest
responseObserverio.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
NameDescription
requestSearchRelatedAccountGroupMembershipsRequest
responseObserverio.grpc.stub.StreamObserver<SearchRelatedAccountGroupMembershipsResponse>

updateFirewallPolicy(UpdateFirewallPolicyRequest request, StreamObserver<FirewallPolicy> responseObserver)

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

Updates the specified firewall policy.

Parameters
NameDescription
requestUpdateFirewallPolicyRequest
responseObserverio.grpc.stub.StreamObserver<FirewallPolicy>

updateKey(UpdateKeyRequest request, StreamObserver<Key> responseObserver)

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

Updates the specified key.

Parameters
NameDescription
requestUpdateKeyRequest
responseObserverio.grpc.stub.StreamObserver<Key>