Google Cloud reCAPTCHA Enterprise v1 API - Class RecaptchaEnterpriseService.RecaptchaEnterpriseServiceBase (2.5.0)

[BindServiceMethod(typeof(RecaptchaEnterpriseService), "BindService")]
public abstract class RecaptchaEnterpriseService.RecaptchaEnterpriseServiceBase

Reference documentation and code samples for the Google Cloud reCAPTCHA Enterprise v1 API class RecaptchaEnterpriseService.RecaptchaEnterpriseServiceBase.

Base class for server-side implementations of RecaptchaEnterpriseService

Inheritance

object > RecaptchaEnterpriseService.RecaptchaEnterpriseServiceBase

Namespace

Google.Cloud.RecaptchaEnterprise.V1

Assembly

Google.Cloud.RecaptchaEnterprise.V1.dll

Methods

AnnotateAssessment(AnnotateAssessmentRequest, ServerCallContext)

public virtual Task<AnnotateAssessmentResponse> AnnotateAssessment(AnnotateAssessmentRequest request, ServerCallContext context)

Annotates a previously created Assessment to provide additional information on whether the event turned out to be authentic or fraudulent.

Parameters
NameDescription
requestAnnotateAssessmentRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskAnnotateAssessmentResponse

The response to send back to the client (wrapped by a task).

CreateAssessment(CreateAssessmentRequest, ServerCallContext)

public virtual Task<Assessment> CreateAssessment(CreateAssessmentRequest request, ServerCallContext context)

Creates an Assessment of the likelihood an event is legitimate.

Parameters
NameDescription
requestCreateAssessmentRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskAssessment

The response to send back to the client (wrapped by a task).

CreateFirewallPolicy(CreateFirewallPolicyRequest, ServerCallContext)

public virtual Task<FirewallPolicy> CreateFirewallPolicy(CreateFirewallPolicyRequest request, ServerCallContext context)

Creates a new FirewallPolicy, specifying conditions at which reCAPTCHA Enterprise actions can be executed. A project may have a maximum of 1000 policies.

Parameters
NameDescription
requestCreateFirewallPolicyRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskFirewallPolicy

The response to send back to the client (wrapped by a task).

CreateKey(CreateKeyRequest, ServerCallContext)

public virtual Task<Key> CreateKey(CreateKeyRequest request, ServerCallContext context)

Creates a new reCAPTCHA Enterprise key.

Parameters
NameDescription
requestCreateKeyRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskKey

The response to send back to the client (wrapped by a task).

DeleteFirewallPolicy(DeleteFirewallPolicyRequest, ServerCallContext)

public virtual Task<Empty> DeleteFirewallPolicy(DeleteFirewallPolicyRequest request, ServerCallContext context)

Deletes the specified firewall policy.

Parameters
NameDescription
requestDeleteFirewallPolicyRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskEmpty

The response to send back to the client (wrapped by a task).

DeleteKey(DeleteKeyRequest, ServerCallContext)

public virtual Task<Empty> DeleteKey(DeleteKeyRequest request, ServerCallContext context)

Deletes the specified key.

Parameters
NameDescription
requestDeleteKeyRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskEmpty

The response to send back to the client (wrapped by a task).

GetFirewallPolicy(GetFirewallPolicyRequest, ServerCallContext)

public virtual Task<FirewallPolicy> GetFirewallPolicy(GetFirewallPolicyRequest request, ServerCallContext context)

Returns the specified firewall policy.

Parameters
NameDescription
requestGetFirewallPolicyRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskFirewallPolicy

The response to send back to the client (wrapped by a task).

GetKey(GetKeyRequest, ServerCallContext)

public virtual Task<Key> GetKey(GetKeyRequest request, ServerCallContext context)

Returns the specified key.

Parameters
NameDescription
requestGetKeyRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskKey

The response to send back to the client (wrapped by a task).

GetMetrics(GetMetricsRequest, ServerCallContext)

public virtual Task<Metrics> GetMetrics(GetMetricsRequest request, ServerCallContext context)

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

Parameters
NameDescription
requestGetMetricsRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskMetrics

The response to send back to the client (wrapped by a task).

ListFirewallPolicies(ListFirewallPoliciesRequest, ServerCallContext)

public virtual Task<ListFirewallPoliciesResponse> ListFirewallPolicies(ListFirewallPoliciesRequest request, ServerCallContext context)

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

Parameters
NameDescription
requestListFirewallPoliciesRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskListFirewallPoliciesResponse

The response to send back to the client (wrapped by a task).

ListKeys(ListKeysRequest, ServerCallContext)

public virtual Task<ListKeysResponse> ListKeys(ListKeysRequest request, ServerCallContext context)

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

Parameters
NameDescription
requestListKeysRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskListKeysResponse

The response to send back to the client (wrapped by a task).

ListRelatedAccountGroupMemberships(ListRelatedAccountGroupMembershipsRequest, ServerCallContext)

public virtual Task<ListRelatedAccountGroupMembershipsResponse> ListRelatedAccountGroupMemberships(ListRelatedAccountGroupMembershipsRequest request, ServerCallContext context)

Get memberships in a group of related accounts.

Parameters
NameDescription
requestListRelatedAccountGroupMembershipsRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskListRelatedAccountGroupMembershipsResponse

The response to send back to the client (wrapped by a task).

ListRelatedAccountGroups(ListRelatedAccountGroupsRequest, ServerCallContext)

public virtual Task<ListRelatedAccountGroupsResponse> ListRelatedAccountGroups(ListRelatedAccountGroupsRequest request, ServerCallContext context)

List groups of related accounts.

Parameters
NameDescription
requestListRelatedAccountGroupsRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskListRelatedAccountGroupsResponse

The response to send back to the client (wrapped by a task).

MigrateKey(MigrateKeyRequest, ServerCallContext)

public virtual Task<Key> MigrateKey(MigrateKeyRequest request, ServerCallContext context)

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.

Parameters
NameDescription
requestMigrateKeyRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskKey

The response to send back to the client (wrapped by a task).

RetrieveLegacySecretKey(RetrieveLegacySecretKeyRequest, ServerCallContext)

public virtual Task<RetrieveLegacySecretKeyResponse> RetrieveLegacySecretKey(RetrieveLegacySecretKeyRequest request, ServerCallContext context)

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.

Parameters
NameDescription
requestRetrieveLegacySecretKeyRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskRetrieveLegacySecretKeyResponse

The response to send back to the client (wrapped by a task).

SearchRelatedAccountGroupMemberships(SearchRelatedAccountGroupMembershipsRequest, ServerCallContext)

public virtual Task<SearchRelatedAccountGroupMembershipsResponse> SearchRelatedAccountGroupMemberships(SearchRelatedAccountGroupMembershipsRequest request, ServerCallContext context)

Search group memberships related to a given account.

Parameters
NameDescription
requestSearchRelatedAccountGroupMembershipsRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskSearchRelatedAccountGroupMembershipsResponse

The response to send back to the client (wrapped by a task).

UpdateFirewallPolicy(UpdateFirewallPolicyRequest, ServerCallContext)

public virtual Task<FirewallPolicy> UpdateFirewallPolicy(UpdateFirewallPolicyRequest request, ServerCallContext context)

Updates the specified firewall policy.

Parameters
NameDescription
requestUpdateFirewallPolicyRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskFirewallPolicy

The response to send back to the client (wrapped by a task).

UpdateKey(UpdateKeyRequest, ServerCallContext)

public virtual Task<Key> UpdateKey(UpdateKeyRequest request, ServerCallContext context)

Updates the specified key.

Parameters
NameDescription
requestUpdateKeyRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskKey

The response to send back to the client (wrapped by a task).