Package com.google.recaptchaenterprise.v1

Class RecaptchaEnterpriseServiceGrpc.RecaptchaEnterpriseServiceBlockingStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractBlockingStub<RecaptchaEnterpriseServiceGrpc.RecaptchaEnterpriseServiceBlockingStub>

com.google.recaptchaenterprise.v1.RecaptchaEnterpriseServiceGrpc.RecaptchaEnterpriseServiceBlockingStub

Enclosing class:

RecaptchaEnterpriseServiceGrpc

public static final class RecaptchaEnterpriseServiceGrpc.RecaptchaEnterpriseServiceBlockingStub
extends io.grpc.stub.AbstractBlockingStub<RecaptchaEnterpriseServiceGrpc.RecaptchaEnterpriseServiceBlockingStub>

A stub to allow clients to do limited synchronous rpc calls to service RecaptchaEnterpriseService.

 Service to determine the likelihood an event is legitimate.
 

Nested Class Summary

Nested classes/interfaces inherited from class io.grpc.stub.AbstractStub

io.grpc.stub.AbstractStub.StubFactory<T extends io.grpc.stub.AbstractStub<T>>

Method Summary

Modifier and Type	Method	Description
AddIpOverrideResponse	addIpOverride(AddIpOverrideRequest request)	Adds an IP override to a key.
AnnotateAssessmentResponse	annotateAssessment(AnnotateAssessmentRequest request)	Annotates a previously created Assessment to provide additional information on whether the event turned out to be authentic or fraudulent.
protected RecaptchaEnterpriseServiceGrpc.RecaptchaEnterpriseServiceBlockingStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
Assessment	createAssessment(CreateAssessmentRequest request)	Creates an Assessment of the likelihood an event is legitimate.
FirewallPolicy	createFirewallPolicy(CreateFirewallPolicyRequest request)	Creates a new FirewallPolicy, specifying conditions at which reCAPTCHA Enterprise actions can be executed.
Key	createKey(CreateKeyRequest request)	Creates a new reCAPTCHA Enterprise key.
com.google.protobuf.Empty	deleteFirewallPolicy(DeleteFirewallPolicyRequest request)	Deletes the specified firewall policy.
com.google.protobuf.Empty	deleteKey(DeleteKeyRequest request)	Deletes the specified key.
FirewallPolicy	getFirewallPolicy(GetFirewallPolicyRequest request)	Returns the specified firewall policy.
Key	getKey(GetKeyRequest request)	Returns the specified key.
Metrics	getMetrics(GetMetricsRequest request)	Get some aggregated metrics for a Key.
ListFirewallPoliciesResponse	listFirewallPolicies(ListFirewallPoliciesRequest request)	Returns the list of all firewall policies that belong to a project.
ListIpOverridesResponse	listIpOverrides(ListIpOverridesRequest request)	Lists all IP overrides for a key.
ListKeysResponse	listKeys(ListKeysRequest request)	Returns the list of all keys that belong to a project.
ListRelatedAccountGroupMembershipsResponse	listRelatedAccountGroupMemberships(ListRelatedAccountGroupMembershipsRequest request)	Get memberships in a group of related accounts.
ListRelatedAccountGroupsResponse	listRelatedAccountGroups(ListRelatedAccountGroupsRequest request)	List groups of related accounts.
Key	migrateKey(MigrateKeyRequest request)	Migrates an existing key from reCAPTCHA to reCAPTCHA Enterprise.
RemoveIpOverrideResponse	removeIpOverride(RemoveIpOverrideRequest request)	Removes an IP override from a key.
ReorderFirewallPoliciesResponse	reorderFirewallPolicies(ReorderFirewallPoliciesRequest request)	Reorders all firewall policies.
RetrieveLegacySecretKeyResponse	retrieveLegacySecretKey(RetrieveLegacySecretKeyRequest request)	Returns the secret key related to the specified public key.
SearchRelatedAccountGroupMembershipsResponse	searchRelatedAccountGroupMemberships(SearchRelatedAccountGroupMembershipsRequest request)	Search group memberships related to a given account.
FirewallPolicy	updateFirewallPolicy(UpdateFirewallPolicyRequest request)	Updates the specified firewall policy.
Key	updateKey(UpdateKeyRequest request)	Updates the specified key.

Methods inherited from class io.grpc.stub.AbstractBlockingStub

newStub, newStub

Methods inherited from class io.grpc.stub.AbstractStub

getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOnReadyThreshold, withOption, withWaitForReady

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

build

protected RecaptchaEnterpriseServiceGrpc.RecaptchaEnterpriseServiceBlockingStub build(io.grpc.Channel channel,
 io.grpc.CallOptions callOptions)

Specified by:

build in class io.grpc.stub.AbstractStub<RecaptchaEnterpriseServiceGrpc.RecaptchaEnterpriseServiceBlockingStub>

createAssessment

public Assessment createAssessment(CreateAssessmentRequest request)

 Creates an Assessment of the likelihood an event is legitimate.
 

annotateAssessment

public 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 Key createKey(CreateKeyRequest request)

 Creates a new reCAPTCHA Enterprise key.
 

listKeys

public ListKeysResponse listKeys(ListKeysRequest request)

 Returns the list of all keys that belong to a project.
 

retrieveLegacySecretKey

public 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 Key getKey(GetKeyRequest request)

 Returns the specified key.
 

updateKey

public Key updateKey(UpdateKeyRequest request)

 Updates the specified key.
 

deleteKey

public com.google.protobuf.Empty deleteKey(DeleteKeyRequest request)

 Deletes the specified key.
 

migrateKey

public 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 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 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 ListIpOverridesResponse listIpOverrides(ListIpOverridesRequest request)

 Lists all IP overrides for a key.
 

getMetrics

public Metrics getMetrics(GetMetricsRequest request)

 Get some aggregated metrics for a Key. This data can be used to build
 dashboards.
 

createFirewallPolicy

public 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 ListFirewallPoliciesResponse listFirewallPolicies(ListFirewallPoliciesRequest request)

 Returns the list of all firewall policies that belong to a project.
 

getFirewallPolicy

public FirewallPolicy getFirewallPolicy(GetFirewallPolicyRequest request)

 Returns the specified firewall policy.
 

updateFirewallPolicy

public FirewallPolicy updateFirewallPolicy(UpdateFirewallPolicyRequest request)

 Updates the specified firewall policy.
 

deleteFirewallPolicy

public com.google.protobuf.Empty deleteFirewallPolicy(DeleteFirewallPolicyRequest request)

 Deletes the specified firewall policy.
 

reorderFirewallPolicies

public ReorderFirewallPoliciesResponse reorderFirewallPolicies(ReorderFirewallPoliciesRequest request)

 Reorders all firewall policies.
 

listRelatedAccountGroups

public ListRelatedAccountGroupsResponse listRelatedAccountGroups(ListRelatedAccountGroupsRequest request)

 List groups of related accounts.
 

listRelatedAccountGroupMemberships

public ListRelatedAccountGroupMembershipsResponse listRelatedAccountGroupMemberships(ListRelatedAccountGroupMembershipsRequest request)

 Get memberships in a group of related accounts.
 

searchRelatedAccountGroupMemberships

public SearchRelatedAccountGroupMembershipsResponse searchRelatedAccountGroupMemberships(SearchRelatedAccountGroupMembershipsRequest request)

 Search group memberships related to a given account.