Package com.google.recaptchaenterprise.v1

Interface RecaptchaEnterpriseServiceGrpc.AsyncService

All Known Implementing Classes:
RecaptchaEnterpriseServiceGrpc.RecaptchaEnterpriseServiceImplBase
Enclosing class:
RecaptchaEnterpriseServiceGrpc
public static interface RecaptchaEnterpriseServiceGrpc.AsyncService
 Service to determine the likelihood an event is legitimate.

  • Method Details

    • createAssessment

      default void createAssessment(CreateAssessmentRequest request, io.grpc.stub.StreamObserver<Assessment> responseObserver)
       Creates an Assessment of the likelihood an event is legitimate.

    • annotateAssessment

      default void annotateAssessment(AnnotateAssessmentRequest request, io.grpc.stub.StreamObserver<AnnotateAssessmentResponse> responseObserver)
       Annotates a previously created Assessment to provide additional information
 on whether the event turned out to be authentic or fraudulent.

    • createKey

      default void createKey(CreateKeyRequest request, io.grpc.stub.StreamObserver<Key> responseObserver)
       Creates a new reCAPTCHA Enterprise key.

    • listKeys

      default void listKeys(ListKeysRequest request, io.grpc.stub.StreamObserver<ListKeysResponse> responseObserver)
       Returns the list of all keys that belong to a project.

    • retrieveLegacySecretKey

      default void retrieveLegacySecretKey(RetrieveLegacySecretKeyRequest request, io.grpc.stub.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.

    • getKey

      default void getKey(GetKeyRequest request, io.grpc.stub.StreamObserver<Key> responseObserver)
       Returns the specified key.

    • updateKey

      default void updateKey(UpdateKeyRequest request, io.grpc.stub.StreamObserver<Key> responseObserver)
       Updates the specified key.

    • deleteKey

      default void deleteKey(DeleteKeyRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)
       Deletes the specified key.

    • migrateKey

      default void migrateKey(MigrateKeyRequest request, io.grpc.stub.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.

    • addIpOverride

      default void addIpOverride(AddIpOverrideRequest request, io.grpc.stub.StreamObserver<AddIpOverrideResponse> responseObserver)
       Adds an IP override to a key. The following restrictions hold:
 * The maximum number of IP overrides per key is 1000.
 * For any conflict (such as IP already exists or IP part of an existing
   IP range), an error is returned.

    • removeIpOverride

      default void removeIpOverride(RemoveIpOverrideRequest request, io.grpc.stub.StreamObserver<RemoveIpOverrideResponse> responseObserver)
       Removes an IP override from a key. The following restrictions hold:
 * If the IP isn't found in an existing IP override, a `NOT_FOUND` error
 is returned.
 * If the IP is found in an existing IP override, but the
 override type does not match, a `NOT_FOUND` error is returned.

    • listIpOverrides

      default void listIpOverrides(ListIpOverridesRequest request, io.grpc.stub.StreamObserver<ListIpOverridesResponse> responseObserver)
       Lists all IP overrides for a key.

    • getMetrics

      default void getMetrics(GetMetricsRequest request, io.grpc.stub.StreamObserver<Metrics> responseObserver)
       Get some aggregated metrics for a Key. This data can be used to build
 dashboards.

    • createFirewallPolicy

      default void createFirewallPolicy(CreateFirewallPolicyRequest request, io.grpc.stub.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.

    • listFirewallPolicies

      default void listFirewallPolicies(ListFirewallPoliciesRequest request, io.grpc.stub.StreamObserver<ListFirewallPoliciesResponse> responseObserver)
       Returns the list of all firewall policies that belong to a project.

    • getFirewallPolicy

      default void getFirewallPolicy(GetFirewallPolicyRequest request, io.grpc.stub.StreamObserver<FirewallPolicy> responseObserver)
       Returns the specified firewall policy.

    • updateFirewallPolicy

      default void updateFirewallPolicy(UpdateFirewallPolicyRequest request, io.grpc.stub.StreamObserver<FirewallPolicy> responseObserver)
       Updates the specified firewall policy.

    • deleteFirewallPolicy

      default void deleteFirewallPolicy(DeleteFirewallPolicyRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)
       Deletes the specified firewall policy.

    • reorderFirewallPolicies

      default void reorderFirewallPolicies(ReorderFirewallPoliciesRequest request, io.grpc.stub.StreamObserver<ReorderFirewallPoliciesResponse> responseObserver)
       Reorders all firewall policies.

    • listRelatedAccountGroups

      default void listRelatedAccountGroups(ListRelatedAccountGroupsRequest request, io.grpc.stub.StreamObserver<ListRelatedAccountGroupsResponse> responseObserver)
       List groups of related accounts.

    • listRelatedAccountGroupMemberships

      default void listRelatedAccountGroupMemberships(ListRelatedAccountGroupMembershipsRequest request, io.grpc.stub.StreamObserver<ListRelatedAccountGroupMembershipsResponse> responseObserver)
       Get memberships in a group of related accounts.

    • searchRelatedAccountGroupMemberships

      default void searchRelatedAccountGroupMemberships(SearchRelatedAccountGroupMembershipsRequest request, io.grpc.stub.StreamObserver<SearchRelatedAccountGroupMembershipsResponse> responseObserver)
       Search group memberships related to a given account.