Class RecaptchaEnterpriseServiceGrpc.RecaptchaEnterpriseServiceBlockingStub (3.42.0)

public static final class RecaptchaEnterpriseServiceGrpc.RecaptchaEnterpriseServiceBlockingStub extends AbstractBlockingStub<RecaptchaEnterpriseServiceGrpc.RecaptchaEnterpriseServiceBlockingStub>

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

Service to determine the likelihood an event is legitimate.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractBlockingStub > RecaptchaEnterpriseServiceGrpc.RecaptchaEnterpriseServiceBlockingStub

Methods

annotateAssessment(AnnotateAssessmentRequest request)

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.

Parameter
Name Description
request AnnotateAssessmentRequest
Returns
Type Description
AnnotateAssessmentResponse

build(Channel channel, CallOptions callOptions)

protected RecaptchaEnterpriseServiceGrpc.RecaptchaEnterpriseServiceBlockingStub build(Channel channel, CallOptions callOptions)
Parameters
Name Description
channel io.grpc.Channel
callOptions io.grpc.CallOptions
Returns
Type Description
RecaptchaEnterpriseServiceGrpc.RecaptchaEnterpriseServiceBlockingStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createAssessment(CreateAssessmentRequest request)

public Assessment createAssessment(CreateAssessmentRequest request)

Creates an Assessment of the likelihood an event is legitimate.

Parameter
Name Description
request CreateAssessmentRequest
Returns
Type Description
Assessment

createFirewallPolicy(CreateFirewallPolicyRequest request)

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.

Parameter
Name Description
request CreateFirewallPolicyRequest
Returns
Type Description
FirewallPolicy

createKey(CreateKeyRequest request)

public Key createKey(CreateKeyRequest request)

Creates a new reCAPTCHA Enterprise key.

Parameter
Name Description
request CreateKeyRequest
Returns
Type Description
Key

deleteFirewallPolicy(DeleteFirewallPolicyRequest request)

public Empty deleteFirewallPolicy(DeleteFirewallPolicyRequest request)

Deletes the specified firewall policy.

Parameter
Name Description
request DeleteFirewallPolicyRequest
Returns
Type Description
Empty

deleteKey(DeleteKeyRequest request)

public Empty deleteKey(DeleteKeyRequest request)

Deletes the specified key.

Parameter
Name Description
request DeleteKeyRequest
Returns
Type Description
Empty

getFirewallPolicy(GetFirewallPolicyRequest request)

public FirewallPolicy getFirewallPolicy(GetFirewallPolicyRequest request)

Returns the specified firewall policy.

Parameter
Name Description
request GetFirewallPolicyRequest
Returns
Type Description
FirewallPolicy

getKey(GetKeyRequest request)

public Key getKey(GetKeyRequest request)

Returns the specified key.

Parameter
Name Description
request GetKeyRequest
Returns
Type Description
Key

getMetrics(GetMetricsRequest request)

public Metrics getMetrics(GetMetricsRequest request)

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

Parameter
Name Description
request GetMetricsRequest
Returns
Type Description
Metrics

listFirewallPolicies(ListFirewallPoliciesRequest request)

public ListFirewallPoliciesResponse listFirewallPolicies(ListFirewallPoliciesRequest request)

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

Parameter
Name Description
request ListFirewallPoliciesRequest
Returns
Type Description
ListFirewallPoliciesResponse

listKeys(ListKeysRequest request)

public ListKeysResponse listKeys(ListKeysRequest request)

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

Parameter
Name Description
request ListKeysRequest
Returns
Type Description
ListKeysResponse

listRelatedAccountGroupMemberships(ListRelatedAccountGroupMembershipsRequest request)

public ListRelatedAccountGroupMembershipsResponse listRelatedAccountGroupMemberships(ListRelatedAccountGroupMembershipsRequest request)

Get memberships in a group of related accounts.

Parameter
Name Description
request ListRelatedAccountGroupMembershipsRequest
Returns
Type Description
ListRelatedAccountGroupMembershipsResponse

listRelatedAccountGroups(ListRelatedAccountGroupsRequest request)

public ListRelatedAccountGroupsResponse listRelatedAccountGroups(ListRelatedAccountGroupsRequest request)

List groups of related accounts.

Parameter
Name Description
request ListRelatedAccountGroupsRequest
Returns
Type Description
ListRelatedAccountGroupsResponse

migrateKey(MigrateKeyRequest request)

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.

Parameter
Name Description
request MigrateKeyRequest
Returns
Type Description
Key

reorderFirewallPolicies(ReorderFirewallPoliciesRequest request)

public ReorderFirewallPoliciesResponse reorderFirewallPolicies(ReorderFirewallPoliciesRequest request)

Reorders all firewall policies.

Parameter
Name Description
request ReorderFirewallPoliciesRequest
Returns
Type Description
ReorderFirewallPoliciesResponse

retrieveLegacySecretKey(RetrieveLegacySecretKeyRequest request)

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.

Parameter
Name Description
request RetrieveLegacySecretKeyRequest
Returns
Type Description
RetrieveLegacySecretKeyResponse

searchRelatedAccountGroupMemberships(SearchRelatedAccountGroupMembershipsRequest request)

public SearchRelatedAccountGroupMembershipsResponse searchRelatedAccountGroupMemberships(SearchRelatedAccountGroupMembershipsRequest request)

Search group memberships related to a given account.

Parameter
Name Description
request SearchRelatedAccountGroupMembershipsRequest
Returns
Type Description
SearchRelatedAccountGroupMembershipsResponse

updateFirewallPolicy(UpdateFirewallPolicyRequest request)

public FirewallPolicy updateFirewallPolicy(UpdateFirewallPolicyRequest request)

Updates the specified firewall policy.

Parameter
Name Description
request UpdateFirewallPolicyRequest
Returns
Type Description
FirewallPolicy

updateKey(UpdateKeyRequest request)

public Key updateKey(UpdateKeyRequest request)

Updates the specified key.

Parameter
Name Description
request UpdateKeyRequest
Returns
Type Description
Key