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

Version 2.15.0

• 2.17.0 (latest)
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.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

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.RecaptchaEnterprise.V1

Assembly

Google.Cloud.RecaptchaEnterprise.V1.dll

Methods

AddIpOverride(AddIpOverrideRequest, ServerCallContext)

public virtual Task<AddIpOverrideResponse> AddIpOverride(AddIpOverrideRequest request, ServerCallContext context)

Adds an IP override to a key. The following restrictions hold:

• The maximum number of IP overrides per key is 100.
• For any conflict (such as IP already exists or IP part of an existing IP range), an error is returned.

Parameters
Name	Description
request	AddIpOverrideRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskAddIpOverrideResponse	The response to send back to the client (wrapped by a task).

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
Name	Description
request	AnnotateAssessmentRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
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
Name	Description
request	CreateAssessmentRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
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
Name	Description
request	CreateFirewallPolicyRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
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
Name	Description
request	CreateKeyRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
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
Name	Description
request	DeleteFirewallPolicyRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
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
Name	Description
request	DeleteKeyRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
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
Name	Description
request	GetFirewallPolicyRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
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
Name	Description
request	GetKeyRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
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
Name	Description
request	GetMetricsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
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
Name	Description
request	ListFirewallPoliciesRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
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
Name	Description
request	ListKeysRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
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
Name	Description
request	ListRelatedAccountGroupMembershipsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
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
Name	Description
request	ListRelatedAccountGroupsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
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
Name	Description
request	MigrateKeyRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskKey	The response to send back to the client (wrapped by a task).

ReorderFirewallPolicies(ReorderFirewallPoliciesRequest, ServerCallContext)

public virtual Task<ReorderFirewallPoliciesResponse> ReorderFirewallPolicies(ReorderFirewallPoliciesRequest request, ServerCallContext context)

Reorders all firewall policies.

Parameters
Name	Description
request	ReorderFirewallPoliciesRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskReorderFirewallPoliciesResponse	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
Name	Description
request	RetrieveLegacySecretKeyRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
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
Name	Description
request	SearchRelatedAccountGroupMembershipsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
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
Name	Description
request	UpdateFirewallPolicyRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
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
Name	Description
request	UpdateKeyRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskKey	The response to send back to the client (wrapped by a task).