Interface RecaptchaEnterpriseServiceGrpc.AsyncService (3.42.0)

Version 3.42.0

• 3.50.0 (latest)
• 3.49.0
• 3.48.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.0
• 3.39.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.27.0
• 3.26.0
• 3.25.0
• 3.24.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.12
• 2.6.1
• 2.5.0
• 2.4.10
• 2.3.1

public static interface RecaptchaEnterpriseServiceGrpc.AsyncService

Service to determine the likelihood an event is legitimate.

Methods

annotateAssessment(AnnotateAssessmentRequest request, StreamObserver<AnnotateAssessmentResponse> responseObserver)

public default 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>

createAssessment(CreateAssessmentRequest request, StreamObserver<Assessment> responseObserver)

public default 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 default 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 default 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 default 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 default 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 default 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 default 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 default 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 default 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 default 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 default 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 default 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 default 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 default 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 default 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 default 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 default 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 default void updateKey(UpdateKeyRequest request, StreamObserver<Key> responseObserver)

Updates the specified key.

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