Google Cloud reCAPTCHA Enterprise v1 API - Class RecaptchaEnterpriseServiceClientImpl (2.10.0)

Version 2.10.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

public sealed class RecaptchaEnterpriseServiceClientImpl : RecaptchaEnterpriseServiceClient

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

RecaptchaEnterpriseService client wrapper implementation, for convenient use.

Inheritance

object > RecaptchaEnterpriseServiceClient > RecaptchaEnterpriseServiceClientImpl

Inherited Members

RecaptchaEnterpriseServiceClient.DefaultEndpoint

RecaptchaEnterpriseServiceClient.DefaultScopes

RecaptchaEnterpriseServiceClient.ServiceMetadata

RecaptchaEnterpriseServiceClient.CreateAsync(CancellationToken)

RecaptchaEnterpriseServiceClient.Create()

RecaptchaEnterpriseServiceClient.ShutdownDefaultChannelsAsync()

RecaptchaEnterpriseServiceClient.CreateAssessmentAsync(CreateAssessmentRequest, CancellationToken)

RecaptchaEnterpriseServiceClient.CreateAssessment(string, Assessment, CallSettings)

RecaptchaEnterpriseServiceClient.CreateAssessmentAsync(string, Assessment, CallSettings)

RecaptchaEnterpriseServiceClient.CreateAssessmentAsync(string, Assessment, CancellationToken)

RecaptchaEnterpriseServiceClient.CreateAssessment(ProjectName, Assessment, CallSettings)

RecaptchaEnterpriseServiceClient.CreateAssessmentAsync(ProjectName, Assessment, CallSettings)

RecaptchaEnterpriseServiceClient.CreateAssessmentAsync(ProjectName, Assessment, CancellationToken)

RecaptchaEnterpriseServiceClient.AnnotateAssessmentAsync(AnnotateAssessmentRequest, CancellationToken)

RecaptchaEnterpriseServiceClient.AnnotateAssessment(string, AnnotateAssessmentRequest.Types.Annotation, CallSettings)

RecaptchaEnterpriseServiceClient.AnnotateAssessmentAsync(string, AnnotateAssessmentRequest.Types.Annotation, CallSettings)

RecaptchaEnterpriseServiceClient.AnnotateAssessmentAsync(string, AnnotateAssessmentRequest.Types.Annotation, CancellationToken)

RecaptchaEnterpriseServiceClient.AnnotateAssessment(AssessmentName, AnnotateAssessmentRequest.Types.Annotation, CallSettings)

RecaptchaEnterpriseServiceClient.AnnotateAssessmentAsync(AssessmentName, AnnotateAssessmentRequest.Types.Annotation, CallSettings)

RecaptchaEnterpriseServiceClient.AnnotateAssessmentAsync(AssessmentName, AnnotateAssessmentRequest.Types.Annotation, CancellationToken)

RecaptchaEnterpriseServiceClient.CreateKeyAsync(CreateKeyRequest, CancellationToken)

RecaptchaEnterpriseServiceClient.CreateKey(string, Key, CallSettings)

RecaptchaEnterpriseServiceClient.CreateKeyAsync(string, Key, CallSettings)

RecaptchaEnterpriseServiceClient.CreateKeyAsync(string, Key, CancellationToken)

RecaptchaEnterpriseServiceClient.CreateKey(ProjectName, Key, CallSettings)

RecaptchaEnterpriseServiceClient.CreateKeyAsync(ProjectName, Key, CallSettings)

RecaptchaEnterpriseServiceClient.CreateKeyAsync(ProjectName, Key, CancellationToken)

RecaptchaEnterpriseServiceClient.ListKeys(string, string, int?, CallSettings)

RecaptchaEnterpriseServiceClient.ListKeysAsync(string, string, int?, CallSettings)

RecaptchaEnterpriseServiceClient.ListKeys(ProjectName, string, int?, CallSettings)

RecaptchaEnterpriseServiceClient.ListKeysAsync(ProjectName, string, int?, CallSettings)

RecaptchaEnterpriseServiceClient.RetrieveLegacySecretKeyAsync(RetrieveLegacySecretKeyRequest, CancellationToken)

RecaptchaEnterpriseServiceClient.RetrieveLegacySecretKey(string, CallSettings)

RecaptchaEnterpriseServiceClient.RetrieveLegacySecretKeyAsync(string, CallSettings)

RecaptchaEnterpriseServiceClient.RetrieveLegacySecretKeyAsync(string, CancellationToken)

RecaptchaEnterpriseServiceClient.RetrieveLegacySecretKey(KeyName, CallSettings)

RecaptchaEnterpriseServiceClient.RetrieveLegacySecretKeyAsync(KeyName, CallSettings)

RecaptchaEnterpriseServiceClient.RetrieveLegacySecretKeyAsync(KeyName, CancellationToken)

RecaptchaEnterpriseServiceClient.GetKeyAsync(GetKeyRequest, CancellationToken)

RecaptchaEnterpriseServiceClient.GetKey(string, CallSettings)

RecaptchaEnterpriseServiceClient.GetKeyAsync(string, CallSettings)

RecaptchaEnterpriseServiceClient.GetKeyAsync(string, CancellationToken)

RecaptchaEnterpriseServiceClient.GetKey(KeyName, CallSettings)

RecaptchaEnterpriseServiceClient.GetKeyAsync(KeyName, CallSettings)

RecaptchaEnterpriseServiceClient.GetKeyAsync(KeyName, CancellationToken)

RecaptchaEnterpriseServiceClient.UpdateKeyAsync(UpdateKeyRequest, CancellationToken)

RecaptchaEnterpriseServiceClient.UpdateKey(Key, FieldMask, CallSettings)

RecaptchaEnterpriseServiceClient.UpdateKeyAsync(Key, FieldMask, CallSettings)

RecaptchaEnterpriseServiceClient.UpdateKeyAsync(Key, FieldMask, CancellationToken)

RecaptchaEnterpriseServiceClient.DeleteKeyAsync(DeleteKeyRequest, CancellationToken)

RecaptchaEnterpriseServiceClient.DeleteKey(string, CallSettings)

RecaptchaEnterpriseServiceClient.DeleteKeyAsync(string, CallSettings)

RecaptchaEnterpriseServiceClient.DeleteKeyAsync(string, CancellationToken)

RecaptchaEnterpriseServiceClient.DeleteKey(KeyName, CallSettings)

RecaptchaEnterpriseServiceClient.DeleteKeyAsync(KeyName, CallSettings)

RecaptchaEnterpriseServiceClient.DeleteKeyAsync(KeyName, CancellationToken)

RecaptchaEnterpriseServiceClient.MigrateKeyAsync(MigrateKeyRequest, CancellationToken)

RecaptchaEnterpriseServiceClient.GetMetricsAsync(GetMetricsRequest, CancellationToken)

RecaptchaEnterpriseServiceClient.GetMetrics(string, CallSettings)

RecaptchaEnterpriseServiceClient.GetMetricsAsync(string, CallSettings)

RecaptchaEnterpriseServiceClient.GetMetricsAsync(string, CancellationToken)

RecaptchaEnterpriseServiceClient.GetMetrics(MetricsName, CallSettings)

RecaptchaEnterpriseServiceClient.GetMetricsAsync(MetricsName, CallSettings)

RecaptchaEnterpriseServiceClient.GetMetricsAsync(MetricsName, CancellationToken)

RecaptchaEnterpriseServiceClient.CreateFirewallPolicyAsync(CreateFirewallPolicyRequest, CancellationToken)

RecaptchaEnterpriseServiceClient.CreateFirewallPolicy(string, FirewallPolicy, CallSettings)

RecaptchaEnterpriseServiceClient.CreateFirewallPolicyAsync(string, FirewallPolicy, CallSettings)

RecaptchaEnterpriseServiceClient.CreateFirewallPolicyAsync(string, FirewallPolicy, CancellationToken)

RecaptchaEnterpriseServiceClient.CreateFirewallPolicy(ProjectName, FirewallPolicy, CallSettings)

RecaptchaEnterpriseServiceClient.CreateFirewallPolicyAsync(ProjectName, FirewallPolicy, CallSettings)

RecaptchaEnterpriseServiceClient.CreateFirewallPolicyAsync(ProjectName, FirewallPolicy, CancellationToken)

RecaptchaEnterpriseServiceClient.ListFirewallPolicies(string, string, int?, CallSettings)

RecaptchaEnterpriseServiceClient.ListFirewallPoliciesAsync(string, string, int?, CallSettings)

RecaptchaEnterpriseServiceClient.ListFirewallPolicies(ProjectName, string, int?, CallSettings)

RecaptchaEnterpriseServiceClient.ListFirewallPoliciesAsync(ProjectName, string, int?, CallSettings)

RecaptchaEnterpriseServiceClient.GetFirewallPolicyAsync(GetFirewallPolicyRequest, CancellationToken)

RecaptchaEnterpriseServiceClient.GetFirewallPolicy(string, CallSettings)

RecaptchaEnterpriseServiceClient.GetFirewallPolicyAsync(string, CallSettings)

RecaptchaEnterpriseServiceClient.GetFirewallPolicyAsync(string, CancellationToken)

RecaptchaEnterpriseServiceClient.GetFirewallPolicy(FirewallPolicyName, CallSettings)

RecaptchaEnterpriseServiceClient.GetFirewallPolicyAsync(FirewallPolicyName, CallSettings)

RecaptchaEnterpriseServiceClient.GetFirewallPolicyAsync(FirewallPolicyName, CancellationToken)

RecaptchaEnterpriseServiceClient.UpdateFirewallPolicyAsync(UpdateFirewallPolicyRequest, CancellationToken)

RecaptchaEnterpriseServiceClient.UpdateFirewallPolicy(FirewallPolicy, FieldMask, CallSettings)

RecaptchaEnterpriseServiceClient.UpdateFirewallPolicyAsync(FirewallPolicy, FieldMask, CallSettings)

RecaptchaEnterpriseServiceClient.UpdateFirewallPolicyAsync(FirewallPolicy, FieldMask, CancellationToken)

RecaptchaEnterpriseServiceClient.DeleteFirewallPolicyAsync(DeleteFirewallPolicyRequest, CancellationToken)

RecaptchaEnterpriseServiceClient.DeleteFirewallPolicy(string, CallSettings)

RecaptchaEnterpriseServiceClient.DeleteFirewallPolicyAsync(string, CallSettings)

RecaptchaEnterpriseServiceClient.DeleteFirewallPolicyAsync(string, CancellationToken)

RecaptchaEnterpriseServiceClient.DeleteFirewallPolicy(FirewallPolicyName, CallSettings)

RecaptchaEnterpriseServiceClient.DeleteFirewallPolicyAsync(FirewallPolicyName, CallSettings)

RecaptchaEnterpriseServiceClient.DeleteFirewallPolicyAsync(FirewallPolicyName, CancellationToken)

RecaptchaEnterpriseServiceClient.ReorderFirewallPoliciesAsync(ReorderFirewallPoliciesRequest, CancellationToken)

RecaptchaEnterpriseServiceClient.ReorderFirewallPolicies(string, IEnumerable<string>, CallSettings)

RecaptchaEnterpriseServiceClient.ReorderFirewallPoliciesAsync(string, IEnumerable<string>, CallSettings)

RecaptchaEnterpriseServiceClient.ReorderFirewallPoliciesAsync(string, IEnumerable<string>, CancellationToken)

RecaptchaEnterpriseServiceClient.ReorderFirewallPolicies(ProjectName, IEnumerable<FirewallPolicyName>, CallSettings)

RecaptchaEnterpriseServiceClient.ReorderFirewallPoliciesAsync(ProjectName, IEnumerable<FirewallPolicyName>, CallSettings)

RecaptchaEnterpriseServiceClient.ReorderFirewallPoliciesAsync(ProjectName, IEnumerable<FirewallPolicyName>, CancellationToken)

RecaptchaEnterpriseServiceClient.ListRelatedAccountGroups(string, string, int?, CallSettings)

RecaptchaEnterpriseServiceClient.ListRelatedAccountGroupsAsync(string, string, int?, CallSettings)

RecaptchaEnterpriseServiceClient.ListRelatedAccountGroups(ProjectName, string, int?, CallSettings)

RecaptchaEnterpriseServiceClient.ListRelatedAccountGroupsAsync(ProjectName, string, int?, CallSettings)

RecaptchaEnterpriseServiceClient.ListRelatedAccountGroupMemberships(string, string, int?, CallSettings)

RecaptchaEnterpriseServiceClient.ListRelatedAccountGroupMembershipsAsync(string, string, int?, CallSettings)

RecaptchaEnterpriseServiceClient.ListRelatedAccountGroupMemberships(RelatedAccountGroupName, string, int?, CallSettings)

RecaptchaEnterpriseServiceClient.ListRelatedAccountGroupMembershipsAsync(RelatedAccountGroupName, string, int?, CallSettings)

RecaptchaEnterpriseServiceClient.SearchRelatedAccountGroupMemberships(string, ByteString, string, int?, CallSettings)

RecaptchaEnterpriseServiceClient.SearchRelatedAccountGroupMembershipsAsync(string, ByteString, string, int?, CallSettings)

RecaptchaEnterpriseServiceClient.SearchRelatedAccountGroupMemberships(RelatedAccountGroupName, ByteString, string, int?, CallSettings)

RecaptchaEnterpriseServiceClient.SearchRelatedAccountGroupMembershipsAsync(RelatedAccountGroupName, ByteString, string, int?, CallSettings)

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.RecaptchaEnterprise.V1

Assembly

Google.Cloud.RecaptchaEnterprise.V1.dll

Remarks

Service to determine the likelihood an event is legitimate.

Constructors

RecaptchaEnterpriseServiceClientImpl(RecaptchaEnterpriseServiceClient, RecaptchaEnterpriseServiceSettings, ILogger)

public RecaptchaEnterpriseServiceClientImpl(RecaptchaEnterpriseService.RecaptchaEnterpriseServiceClient grpcClient, RecaptchaEnterpriseServiceSettings settings, ILogger logger)

Constructs a client wrapper for the RecaptchaEnterpriseService service, with the specified gRPC client and settings.

Parameters
Name	Description
grpcClient	RecaptchaEnterpriseServiceRecaptchaEnterpriseServiceClient The underlying gRPC client.
settings	RecaptchaEnterpriseServiceSettings The base RecaptchaEnterpriseServiceSettings used within this client.
logger	ILogger Optional ILogger to use within this client.

Properties

GrpcClient

public override RecaptchaEnterpriseService.RecaptchaEnterpriseServiceClient GrpcClient { get; }

The underlying gRPC RecaptchaEnterpriseService client

Property Value
Type	Description
RecaptchaEnterpriseServiceRecaptchaEnterpriseServiceClient

Overrides

RecaptchaEnterpriseServiceClient.GrpcClient

Methods

AnnotateAssessment(AnnotateAssessmentRequest, CallSettings)

public override AnnotateAssessmentResponse AnnotateAssessment(AnnotateAssessmentRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
AnnotateAssessmentResponse	The RPC response.

Overrides

RecaptchaEnterpriseServiceClient.AnnotateAssessment(AnnotateAssessmentRequest, CallSettings)

AnnotateAssessmentAsync(AnnotateAssessmentRequest, CallSettings)

public override Task<AnnotateAssessmentResponse> AnnotateAssessmentAsync(AnnotateAssessmentRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskAnnotateAssessmentResponse	A Task containing the RPC response.

Overrides

RecaptchaEnterpriseServiceClient.AnnotateAssessmentAsync(AnnotateAssessmentRequest, CallSettings)

CreateAssessment(CreateAssessmentRequest, CallSettings)

public override Assessment CreateAssessment(CreateAssessmentRequest request, CallSettings callSettings = null)

Creates an Assessment of the likelihood an event is legitimate.

Parameters
Name	Description
request	CreateAssessmentRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Assessment	The RPC response.

Overrides

RecaptchaEnterpriseServiceClient.CreateAssessment(CreateAssessmentRequest, CallSettings)

CreateAssessmentAsync(CreateAssessmentRequest, CallSettings)

public override Task<Assessment> CreateAssessmentAsync(CreateAssessmentRequest request, CallSettings callSettings = null)

Creates an Assessment of the likelihood an event is legitimate.

Parameters
Name	Description
request	CreateAssessmentRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskAssessment	A Task containing the RPC response.

Overrides

RecaptchaEnterpriseServiceClient.CreateAssessmentAsync(CreateAssessmentRequest, CallSettings)

CreateFirewallPolicy(CreateFirewallPolicyRequest, CallSettings)

public override FirewallPolicy CreateFirewallPolicy(CreateFirewallPolicyRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
FirewallPolicy	The RPC response.

Overrides

RecaptchaEnterpriseServiceClient.CreateFirewallPolicy(CreateFirewallPolicyRequest, CallSettings)

CreateFirewallPolicyAsync(CreateFirewallPolicyRequest, CallSettings)

public override Task<FirewallPolicy> CreateFirewallPolicyAsync(CreateFirewallPolicyRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskFirewallPolicy	A Task containing the RPC response.

Overrides

RecaptchaEnterpriseServiceClient.CreateFirewallPolicyAsync(CreateFirewallPolicyRequest, CallSettings)

CreateKey(CreateKeyRequest, CallSettings)

public override Key CreateKey(CreateKeyRequest request, CallSettings callSettings = null)

Creates a new reCAPTCHA Enterprise key.

Parameters
Name	Description
request	CreateKeyRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Key	The RPC response.

Overrides

RecaptchaEnterpriseServiceClient.CreateKey(CreateKeyRequest, CallSettings)

CreateKeyAsync(CreateKeyRequest, CallSettings)

public override Task<Key> CreateKeyAsync(CreateKeyRequest request, CallSettings callSettings = null)

Creates a new reCAPTCHA Enterprise key.

Parameters
Name	Description
request	CreateKeyRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskKey	A Task containing the RPC response.

Overrides

RecaptchaEnterpriseServiceClient.CreateKeyAsync(CreateKeyRequest, CallSettings)

DeleteFirewallPolicy(DeleteFirewallPolicyRequest, CallSettings)

public override void DeleteFirewallPolicy(DeleteFirewallPolicyRequest request, CallSettings callSettings = null)

Deletes the specified firewall policy.

Parameters
Name	Description
request	DeleteFirewallPolicyRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Overrides

RecaptchaEnterpriseServiceClient.DeleteFirewallPolicy(DeleteFirewallPolicyRequest, CallSettings)

DeleteFirewallPolicyAsync(DeleteFirewallPolicyRequest, CallSettings)

public override Task DeleteFirewallPolicyAsync(DeleteFirewallPolicyRequest request, CallSettings callSettings = null)

Deletes the specified firewall policy.

Parameters
Name	Description
request	DeleteFirewallPolicyRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task	A Task containing the RPC response.

Overrides

RecaptchaEnterpriseServiceClient.DeleteFirewallPolicyAsync(DeleteFirewallPolicyRequest, CallSettings)

DeleteKey(DeleteKeyRequest, CallSettings)

public override void DeleteKey(DeleteKeyRequest request, CallSettings callSettings = null)

Deletes the specified key.

Parameters
Name	Description
request	DeleteKeyRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Overrides

RecaptchaEnterpriseServiceClient.DeleteKey(DeleteKeyRequest, CallSettings)

DeleteKeyAsync(DeleteKeyRequest, CallSettings)

public override Task DeleteKeyAsync(DeleteKeyRequest request, CallSettings callSettings = null)

Deletes the specified key.

Parameters
Name	Description
request	DeleteKeyRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task	A Task containing the RPC response.

Overrides

RecaptchaEnterpriseServiceClient.DeleteKeyAsync(DeleteKeyRequest, CallSettings)

GetFirewallPolicy(GetFirewallPolicyRequest, CallSettings)

public override FirewallPolicy GetFirewallPolicy(GetFirewallPolicyRequest request, CallSettings callSettings = null)

Returns the specified firewall policy.

Parameters
Name	Description
request	GetFirewallPolicyRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
FirewallPolicy	The RPC response.

Overrides

RecaptchaEnterpriseServiceClient.GetFirewallPolicy(GetFirewallPolicyRequest, CallSettings)

GetFirewallPolicyAsync(GetFirewallPolicyRequest, CallSettings)

public override Task<FirewallPolicy> GetFirewallPolicyAsync(GetFirewallPolicyRequest request, CallSettings callSettings = null)

Returns the specified firewall policy.

Parameters
Name	Description
request	GetFirewallPolicyRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskFirewallPolicy	A Task containing the RPC response.

Overrides

RecaptchaEnterpriseServiceClient.GetFirewallPolicyAsync(GetFirewallPolicyRequest, CallSettings)

GetKey(GetKeyRequest, CallSettings)

public override Key GetKey(GetKeyRequest request, CallSettings callSettings = null)

Returns the specified key.

Parameters
Name	Description
request	GetKeyRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Key	The RPC response.

Overrides

RecaptchaEnterpriseServiceClient.GetKey(GetKeyRequest, CallSettings)

GetKeyAsync(GetKeyRequest, CallSettings)

public override Task<Key> GetKeyAsync(GetKeyRequest request, CallSettings callSettings = null)

Returns the specified key.

Parameters
Name	Description
request	GetKeyRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskKey	A Task containing the RPC response.

Overrides

RecaptchaEnterpriseServiceClient.GetKeyAsync(GetKeyRequest, CallSettings)

GetMetrics(GetMetricsRequest, CallSettings)

public override Metrics GetMetrics(GetMetricsRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	GetMetricsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Metrics	The RPC response.

Overrides

RecaptchaEnterpriseServiceClient.GetMetrics(GetMetricsRequest, CallSettings)

GetMetricsAsync(GetMetricsRequest, CallSettings)

public override Task<Metrics> GetMetricsAsync(GetMetricsRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	GetMetricsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskMetrics	A Task containing the RPC response.

Overrides

RecaptchaEnterpriseServiceClient.GetMetricsAsync(GetMetricsRequest, CallSettings)

ListFirewallPolicies(ListFirewallPoliciesRequest, CallSettings)

public override PagedEnumerable<ListFirewallPoliciesResponse, FirewallPolicy> ListFirewallPolicies(ListFirewallPoliciesRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	ListFirewallPoliciesRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerableListFirewallPoliciesResponseFirewallPolicy	A pageable sequence of FirewallPolicy resources.

Overrides

RecaptchaEnterpriseServiceClient.ListFirewallPolicies(ListFirewallPoliciesRequest, CallSettings)

ListFirewallPoliciesAsync(ListFirewallPoliciesRequest, CallSettings)

public override PagedAsyncEnumerable<ListFirewallPoliciesResponse, FirewallPolicy> ListFirewallPoliciesAsync(ListFirewallPoliciesRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	ListFirewallPoliciesRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerableListFirewallPoliciesResponseFirewallPolicy	A pageable asynchronous sequence of FirewallPolicy resources.

Overrides

RecaptchaEnterpriseServiceClient.ListFirewallPoliciesAsync(ListFirewallPoliciesRequest, CallSettings)

ListKeys(ListKeysRequest, CallSettings)

public override PagedEnumerable<ListKeysResponse, Key> ListKeys(ListKeysRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	ListKeysRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerableListKeysResponseKey	A pageable sequence of Key resources.

Overrides

RecaptchaEnterpriseServiceClient.ListKeys(ListKeysRequest, CallSettings)

ListKeysAsync(ListKeysRequest, CallSettings)

public override PagedAsyncEnumerable<ListKeysResponse, Key> ListKeysAsync(ListKeysRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	ListKeysRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerableListKeysResponseKey	A pageable asynchronous sequence of Key resources.

Overrides

RecaptchaEnterpriseServiceClient.ListKeysAsync(ListKeysRequest, CallSettings)

ListRelatedAccountGroupMemberships(ListRelatedAccountGroupMembershipsRequest, CallSettings)

public override PagedEnumerable<ListRelatedAccountGroupMembershipsResponse, RelatedAccountGroupMembership> ListRelatedAccountGroupMemberships(ListRelatedAccountGroupMembershipsRequest request, CallSettings callSettings = null)

Get memberships in a group of related accounts.

Parameters
Name	Description
request	ListRelatedAccountGroupMembershipsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerableListRelatedAccountGroupMembershipsResponseRelatedAccountGroupMembership	A pageable sequence of RelatedAccountGroupMembership resources.

Overrides

RecaptchaEnterpriseServiceClient.ListRelatedAccountGroupMemberships(ListRelatedAccountGroupMembershipsRequest, CallSettings)

ListRelatedAccountGroupMembershipsAsync(ListRelatedAccountGroupMembershipsRequest, CallSettings)

public override PagedAsyncEnumerable<ListRelatedAccountGroupMembershipsResponse, RelatedAccountGroupMembership> ListRelatedAccountGroupMembershipsAsync(ListRelatedAccountGroupMembershipsRequest request, CallSettings callSettings = null)

Get memberships in a group of related accounts.

Parameters
Name	Description
request	ListRelatedAccountGroupMembershipsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerableListRelatedAccountGroupMembershipsResponseRelatedAccountGroupMembership	A pageable asynchronous sequence of RelatedAccountGroupMembership resources.

Overrides

RecaptchaEnterpriseServiceClient.ListRelatedAccountGroupMembershipsAsync(ListRelatedAccountGroupMembershipsRequest, CallSettings)

ListRelatedAccountGroups(ListRelatedAccountGroupsRequest, CallSettings)

public override PagedEnumerable<ListRelatedAccountGroupsResponse, RelatedAccountGroup> ListRelatedAccountGroups(ListRelatedAccountGroupsRequest request, CallSettings callSettings = null)

List groups of related accounts.

Parameters
Name	Description
request	ListRelatedAccountGroupsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerableListRelatedAccountGroupsResponseRelatedAccountGroup	A pageable sequence of RelatedAccountGroup resources.

Overrides

RecaptchaEnterpriseServiceClient.ListRelatedAccountGroups(ListRelatedAccountGroupsRequest, CallSettings)

ListRelatedAccountGroupsAsync(ListRelatedAccountGroupsRequest, CallSettings)

public override PagedAsyncEnumerable<ListRelatedAccountGroupsResponse, RelatedAccountGroup> ListRelatedAccountGroupsAsync(ListRelatedAccountGroupsRequest request, CallSettings callSettings = null)

List groups of related accounts.

Parameters
Name	Description
request	ListRelatedAccountGroupsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerableListRelatedAccountGroupsResponseRelatedAccountGroup	A pageable asynchronous sequence of RelatedAccountGroup resources.

Overrides

RecaptchaEnterpriseServiceClient.ListRelatedAccountGroupsAsync(ListRelatedAccountGroupsRequest, CallSettings)

MigrateKey(MigrateKeyRequest, CallSettings)

public override Key MigrateKey(MigrateKeyRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Key	The RPC response.

Overrides

RecaptchaEnterpriseServiceClient.MigrateKey(MigrateKeyRequest, CallSettings)

MigrateKeyAsync(MigrateKeyRequest, CallSettings)

public override Task<Key> MigrateKeyAsync(MigrateKeyRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskKey	A Task containing the RPC response.

Overrides

RecaptchaEnterpriseServiceClient.MigrateKeyAsync(MigrateKeyRequest, CallSettings)

ReorderFirewallPolicies(ReorderFirewallPoliciesRequest, CallSettings)

public override ReorderFirewallPoliciesResponse ReorderFirewallPolicies(ReorderFirewallPoliciesRequest request, CallSettings callSettings = null)

Reorders all firewall policies.

Parameters
Name	Description
request	ReorderFirewallPoliciesRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
ReorderFirewallPoliciesResponse	The RPC response.

Overrides

RecaptchaEnterpriseServiceClient.ReorderFirewallPolicies(ReorderFirewallPoliciesRequest, CallSettings)

ReorderFirewallPoliciesAsync(ReorderFirewallPoliciesRequest, CallSettings)

public override Task<ReorderFirewallPoliciesResponse> ReorderFirewallPoliciesAsync(ReorderFirewallPoliciesRequest request, CallSettings callSettings = null)

Reorders all firewall policies.

Parameters
Name	Description
request	ReorderFirewallPoliciesRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskReorderFirewallPoliciesResponse	A Task containing the RPC response.

Overrides

RecaptchaEnterpriseServiceClient.ReorderFirewallPoliciesAsync(ReorderFirewallPoliciesRequest, CallSettings)

RetrieveLegacySecretKey(RetrieveLegacySecretKeyRequest, CallSettings)

public override RetrieveLegacySecretKeyResponse RetrieveLegacySecretKey(RetrieveLegacySecretKeyRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
RetrieveLegacySecretKeyResponse	The RPC response.

Overrides

RecaptchaEnterpriseServiceClient.RetrieveLegacySecretKey(RetrieveLegacySecretKeyRequest, CallSettings)

RetrieveLegacySecretKeyAsync(RetrieveLegacySecretKeyRequest, CallSettings)

public override Task<RetrieveLegacySecretKeyResponse> RetrieveLegacySecretKeyAsync(RetrieveLegacySecretKeyRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskRetrieveLegacySecretKeyResponse	A Task containing the RPC response.

Overrides

RecaptchaEnterpriseServiceClient.RetrieveLegacySecretKeyAsync(RetrieveLegacySecretKeyRequest, CallSettings)

SearchRelatedAccountGroupMemberships(SearchRelatedAccountGroupMembershipsRequest, CallSettings)

public override PagedEnumerable<SearchRelatedAccountGroupMembershipsResponse, RelatedAccountGroupMembership> SearchRelatedAccountGroupMemberships(SearchRelatedAccountGroupMembershipsRequest request, CallSettings callSettings = null)

Search group memberships related to a given account.

Parameters
Name	Description
request	SearchRelatedAccountGroupMembershipsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerableSearchRelatedAccountGroupMembershipsResponseRelatedAccountGroupMembership	A pageable sequence of RelatedAccountGroupMembership resources.

Overrides

RecaptchaEnterpriseServiceClient.SearchRelatedAccountGroupMemberships(SearchRelatedAccountGroupMembershipsRequest, CallSettings)

SearchRelatedAccountGroupMembershipsAsync(SearchRelatedAccountGroupMembershipsRequest, CallSettings)

public override PagedAsyncEnumerable<SearchRelatedAccountGroupMembershipsResponse, RelatedAccountGroupMembership> SearchRelatedAccountGroupMembershipsAsync(SearchRelatedAccountGroupMembershipsRequest request, CallSettings callSettings = null)

Search group memberships related to a given account.

Parameters
Name	Description
request	SearchRelatedAccountGroupMembershipsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerableSearchRelatedAccountGroupMembershipsResponseRelatedAccountGroupMembership	A pageable asynchronous sequence of RelatedAccountGroupMembership resources.

Overrides

RecaptchaEnterpriseServiceClient.SearchRelatedAccountGroupMembershipsAsync(SearchRelatedAccountGroupMembershipsRequest, CallSettings)

UpdateFirewallPolicy(UpdateFirewallPolicyRequest, CallSettings)

public override FirewallPolicy UpdateFirewallPolicy(UpdateFirewallPolicyRequest request, CallSettings callSettings = null)

Updates the specified firewall policy.

Parameters
Name	Description
request	UpdateFirewallPolicyRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
FirewallPolicy	The RPC response.

Overrides

RecaptchaEnterpriseServiceClient.UpdateFirewallPolicy(UpdateFirewallPolicyRequest, CallSettings)

UpdateFirewallPolicyAsync(UpdateFirewallPolicyRequest, CallSettings)

public override Task<FirewallPolicy> UpdateFirewallPolicyAsync(UpdateFirewallPolicyRequest request, CallSettings callSettings = null)

Updates the specified firewall policy.

Parameters
Name	Description
request	UpdateFirewallPolicyRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskFirewallPolicy	A Task containing the RPC response.

Overrides

RecaptchaEnterpriseServiceClient.UpdateFirewallPolicyAsync(UpdateFirewallPolicyRequest, CallSettings)

UpdateKey(UpdateKeyRequest, CallSettings)

public override Key UpdateKey(UpdateKeyRequest request, CallSettings callSettings = null)

Updates the specified key.

Parameters
Name	Description
request	UpdateKeyRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Key	The RPC response.

Overrides

RecaptchaEnterpriseServiceClient.UpdateKey(UpdateKeyRequest, CallSettings)

UpdateKeyAsync(UpdateKeyRequest, CallSettings)

public override Task<Key> UpdateKeyAsync(UpdateKeyRequest request, CallSettings callSettings = null)

Updates the specified key.

Parameters
Name	Description
request	UpdateKeyRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskKey	A Task containing the RPC response.

Overrides

RecaptchaEnterpriseServiceClient.UpdateKeyAsync(UpdateKeyRequest, CallSettings)