Interface RecaptchaEnterpriseServiceGrpc.AsyncService (3.24.0)

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

createKey(CreateKeyRequest request, StreamObserver<Key> responseObserver)

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

Creates a new reCAPTCHA Enterprise key.

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

deleteKey(DeleteKeyRequest request, StreamObserver<Empty> responseObserver)

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

Deletes the specified key.

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

getKey(GetKeyRequest request, StreamObserver<Key> responseObserver)

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

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

updateKey(UpdateKeyRequest request, StreamObserver<Key> responseObserver)

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

Updates the specified key.

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