Package com.google.recaptchaenterprise.v1

Class RecaptchaEnterpriseServiceGrpc.RecaptchaEnterpriseServiceFutureStub

java.lang.Object
io.grpc.stub.AbstractStub<S>
io.grpc.stub.AbstractFutureStub<RecaptchaEnterpriseServiceGrpc.RecaptchaEnterpriseServiceFutureStub>
com.google.recaptchaenterprise.v1.RecaptchaEnterpriseServiceGrpc.RecaptchaEnterpriseServiceFutureStub
Enclosing class:
RecaptchaEnterpriseServiceGrpc
public static final class RecaptchaEnterpriseServiceGrpc.RecaptchaEnterpriseServiceFutureStub extends io.grpc.stub.AbstractFutureStub<RecaptchaEnterpriseServiceGrpc.RecaptchaEnterpriseServiceFutureStub>
A stub to allow clients to do ListenableFuture-style rpc calls to service RecaptchaEnterpriseService. 
 Service to determine the likelihood an event is legitimate.

  • Method Details

    • build

      protected RecaptchaEnterpriseServiceGrpc.RecaptchaEnterpriseServiceFutureStub build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
      Specified by:
      build in class io.grpc.stub.AbstractStub<RecaptchaEnterpriseServiceGrpc.RecaptchaEnterpriseServiceFutureStub>

    • createAssessment

      public com.google.common.util.concurrent.ListenableFuture<Assessment> createAssessment(CreateAssessmentRequest request)
       Creates an Assessment of the likelihood an event is legitimate.

    • annotateAssessment

      public com.google.common.util.concurrent.ListenableFuture<AnnotateAssessmentResponse> annotateAssessment(AnnotateAssessmentRequest request)
       Annotates a previously created Assessment to provide additional information
 on whether the event turned out to be authentic or fraudulent.

    • createKey

      public com.google.common.util.concurrent.ListenableFuture<Key> createKey(CreateKeyRequest request)
       Creates a new reCAPTCHA Enterprise key.

    • listKeys

      public com.google.common.util.concurrent.ListenableFuture<ListKeysResponse> listKeys(ListKeysRequest request)
       Returns the list of all keys that belong to a project.

    • retrieveLegacySecretKey

      public com.google.common.util.concurrent.ListenableFuture<RetrieveLegacySecretKeyResponse> retrieveLegacySecretKey(RetrieveLegacySecretKeyRequest request)
       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

      public com.google.common.util.concurrent.ListenableFuture<Key> getKey(GetKeyRequest request)
       Returns the specified key.

    • updateKey

      public com.google.common.util.concurrent.ListenableFuture<Key> updateKey(UpdateKeyRequest request)
       Updates the specified key.

    • deleteKey

      public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> deleteKey(DeleteKeyRequest request)
       Deletes the specified key.

    • migrateKey

      public com.google.common.util.concurrent.ListenableFuture<Key> migrateKey(MigrateKeyRequest request)
       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

      public com.google.common.util.concurrent.ListenableFuture<AddIpOverrideResponse> addIpOverride(AddIpOverrideRequest request)
       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

      public com.google.common.util.concurrent.ListenableFuture<RemoveIpOverrideResponse> removeIpOverride(RemoveIpOverrideRequest request)
       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

      public com.google.common.util.concurrent.ListenableFuture<ListIpOverridesResponse> listIpOverrides(ListIpOverridesRequest request)
       Lists all IP overrides for a key.

    • getMetrics

      public com.google.common.util.concurrent.ListenableFuture<Metrics> getMetrics(GetMetricsRequest request)
       Get some aggregated metrics for a Key. This data can be used to build
 dashboards.

    • createFirewallPolicy

      public com.google.common.util.concurrent.ListenableFuture<FirewallPolicy> createFirewallPolicy(CreateFirewallPolicyRequest request)
       Creates a new FirewallPolicy, specifying conditions at which reCAPTCHA
 Enterprise actions can be executed.
 A project may have a maximum of 1000 policies.

    • listFirewallPolicies

      public com.google.common.util.concurrent.ListenableFuture<ListFirewallPoliciesResponse> listFirewallPolicies(ListFirewallPoliciesRequest request)
       Returns the list of all firewall policies that belong to a project.

    • getFirewallPolicy

      public com.google.common.util.concurrent.ListenableFuture<FirewallPolicy> getFirewallPolicy(GetFirewallPolicyRequest request)
       Returns the specified firewall policy.

    • updateFirewallPolicy

      public com.google.common.util.concurrent.ListenableFuture<FirewallPolicy> updateFirewallPolicy(UpdateFirewallPolicyRequest request)
       Updates the specified firewall policy.

    • deleteFirewallPolicy

      public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> deleteFirewallPolicy(DeleteFirewallPolicyRequest request)
       Deletes the specified firewall policy.

    • reorderFirewallPolicies

      public com.google.common.util.concurrent.ListenableFuture<ReorderFirewallPoliciesResponse> reorderFirewallPolicies(ReorderFirewallPoliciesRequest request)
       Reorders all firewall policies.

    • listRelatedAccountGroups

      public com.google.common.util.concurrent.ListenableFuture<ListRelatedAccountGroupsResponse> listRelatedAccountGroups(ListRelatedAccountGroupsRequest request)
       List groups of related accounts.

    • listRelatedAccountGroupMemberships

      public com.google.common.util.concurrent.ListenableFuture<ListRelatedAccountGroupMembershipsResponse> listRelatedAccountGroupMemberships(ListRelatedAccountGroupMembershipsRequest request)
       Get memberships in a group of related accounts.

    • searchRelatedAccountGroupMemberships

      public com.google.common.util.concurrent.ListenableFuture<SearchRelatedAccountGroupMembershipsResponse> searchRelatedAccountGroupMemberships(SearchRelatedAccountGroupMembershipsRequest request)
       Search group memberships related to a given account.