Class RecaptchaEnterpriseServiceGrpc.RecaptchaEnterpriseServiceBlockingStub (3.2.0)

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

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
NameDescription
requestAnnotateAssessmentRequest
Returns
TypeDescription
AnnotateAssessmentResponse

build(Channel channel, CallOptions callOptions)

protected RecaptchaEnterpriseServiceGrpc.RecaptchaEnterpriseServiceBlockingStub build(Channel channel, CallOptions callOptions)
Parameters
NameDescription
channelio.grpc.Channel
callOptionsio.grpc.CallOptions
Returns
TypeDescription
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
NameDescription
requestCreateAssessmentRequest
Returns
TypeDescription
Assessment

createKey(CreateKeyRequest request)

public Key createKey(CreateKeyRequest request)

Creates a new reCAPTCHA Enterprise key.

Parameter
NameDescription
requestCreateKeyRequest
Returns
TypeDescription
Key

deleteKey(DeleteKeyRequest request)

public Empty deleteKey(DeleteKeyRequest request)

Deletes the specified key.

Parameter
NameDescription
requestDeleteKeyRequest
Returns
TypeDescription
Empty

getKey(GetKeyRequest request)

public Key getKey(GetKeyRequest request)

Returns the specified key.

Parameter
NameDescription
requestGetKeyRequest
Returns
TypeDescription
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
NameDescription
requestGetMetricsRequest
Returns
TypeDescription
Metrics

listKeys(ListKeysRequest request)

public ListKeysResponse listKeys(ListKeysRequest request)

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

Parameter
NameDescription
requestListKeysRequest
Returns
TypeDescription
ListKeysResponse

listRelatedAccountGroupMemberships(ListRelatedAccountGroupMembershipsRequest request)

public ListRelatedAccountGroupMembershipsResponse listRelatedAccountGroupMemberships(ListRelatedAccountGroupMembershipsRequest request)

Get memberships in a group of related accounts.

Parameter
NameDescription
requestListRelatedAccountGroupMembershipsRequest
Returns
TypeDescription
ListRelatedAccountGroupMembershipsResponse

listRelatedAccountGroups(ListRelatedAccountGroupsRequest request)

public ListRelatedAccountGroupsResponse listRelatedAccountGroups(ListRelatedAccountGroupsRequest request)

List groups of related accounts.

Parameter
NameDescription
requestListRelatedAccountGroupsRequest
Returns
TypeDescription
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 Site Key, and your user must have the reCAPTCHA Enterprise Admin IAM role in the destination project.

Parameter
NameDescription
requestMigrateKeyRequest
Returns
TypeDescription
Key

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
NameDescription
requestRetrieveLegacySecretKeyRequest
Returns
TypeDescription
RetrieveLegacySecretKeyResponse

searchRelatedAccountGroupMemberships(SearchRelatedAccountGroupMembershipsRequest request)

public SearchRelatedAccountGroupMembershipsResponse searchRelatedAccountGroupMemberships(SearchRelatedAccountGroupMembershipsRequest request)

Search group memberships related to a given account.

Parameter
NameDescription
requestSearchRelatedAccountGroupMembershipsRequest
Returns
TypeDescription
SearchRelatedAccountGroupMembershipsResponse

updateKey(UpdateKeyRequest request)

public Key updateKey(UpdateKeyRequest request)

Updates the specified key.

Parameter
NameDescription
requestUpdateKeyRequest
Returns
TypeDescription
Key