Google Cloud reCAPTCHA Enterprise v1 API - Class RecaptchaEnterpriseServiceClientImpl (2.5.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

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
NameDescription
grpcClientRecaptchaEnterpriseServiceRecaptchaEnterpriseServiceClient

The underlying gRPC client.

settingsRecaptchaEnterpriseServiceSettings

The base RecaptchaEnterpriseServiceSettings used within this client.

loggerILogger

Optional ILogger to use within this client.

Properties

GrpcClient

public override RecaptchaEnterpriseService.RecaptchaEnterpriseServiceClient GrpcClient { get; }

The underlying gRPC RecaptchaEnterpriseService client

Property Value
TypeDescription
RecaptchaEnterpriseServiceRecaptchaEnterpriseServiceClient
Overrides

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
NameDescription
requestAnnotateAssessmentRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
AnnotateAssessmentResponse

The RPC response.

Overrides

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
NameDescription
requestAnnotateAssessmentRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskAnnotateAssessmentResponse

A Task containing the RPC response.

Overrides

CreateAssessment(CreateAssessmentRequest, CallSettings)

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

Creates an Assessment of the likelihood an event is legitimate.

Parameters
NameDescription
requestCreateAssessmentRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Assessment

The RPC response.

Overrides

CreateAssessmentAsync(CreateAssessmentRequest, CallSettings)

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

Creates an Assessment of the likelihood an event is legitimate.

Parameters
NameDescription
requestCreateAssessmentRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskAssessment

A Task containing the RPC response.

Overrides

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
NameDescription
requestCreateFirewallPolicyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
FirewallPolicy

The RPC response.

Overrides

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
NameDescription
requestCreateFirewallPolicyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskFirewallPolicy

A Task containing the RPC response.

Overrides

CreateKey(CreateKeyRequest, CallSettings)

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

Creates a new reCAPTCHA Enterprise key.

Parameters
NameDescription
requestCreateKeyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Key

The RPC response.

Overrides

CreateKeyAsync(CreateKeyRequest, CallSettings)

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

Creates a new reCAPTCHA Enterprise key.

Parameters
NameDescription
requestCreateKeyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskKey

A Task containing the RPC response.

Overrides

DeleteFirewallPolicy(DeleteFirewallPolicyRequest, CallSettings)

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

Deletes the specified firewall policy.

Parameters
NameDescription
requestDeleteFirewallPolicyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Overrides

DeleteFirewallPolicyAsync(DeleteFirewallPolicyRequest, CallSettings)

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

Deletes the specified firewall policy.

Parameters
NameDescription
requestDeleteFirewallPolicyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Overrides

DeleteKey(DeleteKeyRequest, CallSettings)

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

Deletes the specified key.

Parameters
NameDescription
requestDeleteKeyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Overrides

DeleteKeyAsync(DeleteKeyRequest, CallSettings)

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

Deletes the specified key.

Parameters
NameDescription
requestDeleteKeyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Overrides

GetFirewallPolicy(GetFirewallPolicyRequest, CallSettings)

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

Returns the specified firewall policy.

Parameters
NameDescription
requestGetFirewallPolicyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
FirewallPolicy

The RPC response.

Overrides

GetFirewallPolicyAsync(GetFirewallPolicyRequest, CallSettings)

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

Returns the specified firewall policy.

Parameters
NameDescription
requestGetFirewallPolicyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskFirewallPolicy

A Task containing the RPC response.

Overrides

GetKey(GetKeyRequest, CallSettings)

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

Returns the specified key.

Parameters
NameDescription
requestGetKeyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Key

The RPC response.

Overrides

GetKeyAsync(GetKeyRequest, CallSettings)

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

Returns the specified key.

Parameters
NameDescription
requestGetKeyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskKey

A Task containing the RPC response.

Overrides

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
NameDescription
requestGetMetricsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Metrics

The RPC response.

Overrides

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
NameDescription
requestGetMetricsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskMetrics

A Task containing the RPC response.

Overrides

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
NameDescription
requestListFirewallPoliciesRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListFirewallPoliciesResponseFirewallPolicy

A pageable sequence of FirewallPolicy resources.

Overrides

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
NameDescription
requestListFirewallPoliciesRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListFirewallPoliciesResponseFirewallPolicy

A pageable asynchronous sequence of FirewallPolicy resources.

Overrides

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
NameDescription
requestListKeysRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListKeysResponseKey

A pageable sequence of Key resources.

Overrides

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
NameDescription
requestListKeysRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListKeysResponseKey

A pageable asynchronous sequence of Key resources.

Overrides

ListRelatedAccountGroupMemberships(ListRelatedAccountGroupMembershipsRequest, CallSettings)

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

Get memberships in a group of related accounts.

Parameters
NameDescription
requestListRelatedAccountGroupMembershipsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListRelatedAccountGroupMembershipsResponseRelatedAccountGroupMembership

A pageable sequence of RelatedAccountGroupMembership resources.

Overrides

ListRelatedAccountGroupMembershipsAsync(ListRelatedAccountGroupMembershipsRequest, CallSettings)

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

Get memberships in a group of related accounts.

Parameters
NameDescription
requestListRelatedAccountGroupMembershipsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListRelatedAccountGroupMembershipsResponseRelatedAccountGroupMembership

A pageable asynchronous sequence of RelatedAccountGroupMembership resources.

Overrides

ListRelatedAccountGroups(ListRelatedAccountGroupsRequest, CallSettings)

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

List groups of related accounts.

Parameters
NameDescription
requestListRelatedAccountGroupsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListRelatedAccountGroupsResponseRelatedAccountGroup

A pageable sequence of RelatedAccountGroup resources.

Overrides

ListRelatedAccountGroupsAsync(ListRelatedAccountGroupsRequest, CallSettings)

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

List groups of related accounts.

Parameters
NameDescription
requestListRelatedAccountGroupsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListRelatedAccountGroupsResponseRelatedAccountGroup

A pageable asynchronous sequence of RelatedAccountGroup resources.

Overrides

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
NameDescription
requestMigrateKeyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Key

The RPC response.

Overrides

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
NameDescription
requestMigrateKeyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskKey

A Task containing the RPC response.

Overrides

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
NameDescription
requestRetrieveLegacySecretKeyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
RetrieveLegacySecretKeyResponse

The RPC response.

Overrides

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
NameDescription
requestRetrieveLegacySecretKeyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskRetrieveLegacySecretKeyResponse

A Task containing the RPC response.

Overrides

SearchRelatedAccountGroupMemberships(SearchRelatedAccountGroupMembershipsRequest, CallSettings)

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

Search group memberships related to a given account.

Parameters
NameDescription
requestSearchRelatedAccountGroupMembershipsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableSearchRelatedAccountGroupMembershipsResponseRelatedAccountGroupMembership

A pageable sequence of RelatedAccountGroupMembership resources.

Overrides

SearchRelatedAccountGroupMembershipsAsync(SearchRelatedAccountGroupMembershipsRequest, CallSettings)

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

Search group memberships related to a given account.

Parameters
NameDescription
requestSearchRelatedAccountGroupMembershipsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableSearchRelatedAccountGroupMembershipsResponseRelatedAccountGroupMembership

A pageable asynchronous sequence of RelatedAccountGroupMembership resources.

Overrides

UpdateFirewallPolicy(UpdateFirewallPolicyRequest, CallSettings)

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

Updates the specified firewall policy.

Parameters
NameDescription
requestUpdateFirewallPolicyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
FirewallPolicy

The RPC response.

Overrides

UpdateFirewallPolicyAsync(UpdateFirewallPolicyRequest, CallSettings)

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

Updates the specified firewall policy.

Parameters
NameDescription
requestUpdateFirewallPolicyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskFirewallPolicy

A Task containing the RPC response.

Overrides

UpdateKey(UpdateKeyRequest, CallSettings)

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

Updates the specified key.

Parameters
NameDescription
requestUpdateKeyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Key

The RPC response.

Overrides

UpdateKeyAsync(UpdateKeyRequest, CallSettings)

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

Updates the specified key.

Parameters
NameDescription
requestUpdateKeyRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskKey

A Task containing the RPC response.

Overrides