public sealed class RecaptchaEnterpriseServiceClientImpl : RecaptchaEnterpriseServiceClientReference documentation and code samples for the Google Cloud reCAPTCHA Enterprise v1 API class RecaptchaEnterpriseServiceClientImpl.
RecaptchaEnterpriseService client wrapper implementation, for convenient use.
Namespace
Google.Cloud.RecaptchaEnterprise.V1Assembly
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 | RecaptchaEnterpriseServiceRecaptchaEnterpriseServiceClientThe underlying gRPC client. |
settings | RecaptchaEnterpriseServiceSettingsThe base RecaptchaEnterpriseServiceSettings used within this client. |
logger | ILoggerOptional ILogger to use within this client. |
Properties
GrpcClient
public override RecaptchaEnterpriseService.RecaptchaEnterpriseServiceClient GrpcClient { get; }The underlying gRPC RecaptchaEnterpriseService client
| Property Value | |
|---|---|
| Type | Description |
RecaptchaEnterpriseServiceRecaptchaEnterpriseServiceClient | |
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 | AnnotateAssessmentRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
AnnotateAssessmentResponse | The RPC response. |
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 | AnnotateAssessmentRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskAnnotateAssessmentResponse | A Task containing the RPC response. |
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 | CreateAssessmentRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Assessment | The RPC response. |
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 | CreateAssessmentRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskAssessment | A Task containing the RPC response. |
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 | CreateFirewallPolicyRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
FirewallPolicy | The RPC response. |
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 | CreateFirewallPolicyRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskFirewallPolicy | A Task containing the RPC response. |
CreateKey(CreateKeyRequest, CallSettings)
public override Key CreateKey(CreateKeyRequest request, CallSettings callSettings = null)Creates a new reCAPTCHA Enterprise key.
| Parameters | |
|---|---|
| Name | Description |
request | CreateKeyRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Key | The RPC response. |
CreateKeyAsync(CreateKeyRequest, CallSettings)
public override Task<Key> CreateKeyAsync(CreateKeyRequest request, CallSettings callSettings = null)Creates a new reCAPTCHA Enterprise key.
| Parameters | |
|---|---|
| Name | Description |
request | CreateKeyRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskKey | A Task containing the RPC response. |
DeleteFirewallPolicy(DeleteFirewallPolicyRequest, CallSettings)
public override void DeleteFirewallPolicy(DeleteFirewallPolicyRequest request, CallSettings callSettings = null)Deletes the specified firewall policy.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteFirewallPolicyRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
DeleteFirewallPolicyAsync(DeleteFirewallPolicyRequest, CallSettings)
public override Task DeleteFirewallPolicyAsync(DeleteFirewallPolicyRequest request, CallSettings callSettings = null)Deletes the specified firewall policy.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteFirewallPolicyRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task | A Task containing the RPC response. |
DeleteKey(DeleteKeyRequest, CallSettings)
public override void DeleteKey(DeleteKeyRequest request, CallSettings callSettings = null)Deletes the specified key.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteKeyRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
DeleteKeyAsync(DeleteKeyRequest, CallSettings)
public override Task DeleteKeyAsync(DeleteKeyRequest request, CallSettings callSettings = null)Deletes the specified key.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteKeyRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task | A Task containing the RPC response. |
GetFirewallPolicy(GetFirewallPolicyRequest, CallSettings)
public override FirewallPolicy GetFirewallPolicy(GetFirewallPolicyRequest request, CallSettings callSettings = null)Returns the specified firewall policy.
| Parameters | |
|---|---|
| Name | Description |
request | GetFirewallPolicyRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
FirewallPolicy | The RPC response. |
GetFirewallPolicyAsync(GetFirewallPolicyRequest, CallSettings)
public override Task<FirewallPolicy> GetFirewallPolicyAsync(GetFirewallPolicyRequest request, CallSettings callSettings = null)Returns the specified firewall policy.
| Parameters | |
|---|---|
| Name | Description |
request | GetFirewallPolicyRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskFirewallPolicy | A Task containing the RPC response. |
GetKey(GetKeyRequest, CallSettings)
public override Key GetKey(GetKeyRequest request, CallSettings callSettings = null)Returns the specified key.
| Parameters | |
|---|---|
| Name | Description |
request | GetKeyRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Key | The RPC response. |
GetKeyAsync(GetKeyRequest, CallSettings)
public override Task<Key> GetKeyAsync(GetKeyRequest request, CallSettings callSettings = null)Returns the specified key.
| Parameters | |
|---|---|
| Name | Description |
request | GetKeyRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskKey | A Task containing the RPC response. |
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 | GetMetricsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Metrics | The RPC response. |
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 | GetMetricsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskMetrics | A Task containing the RPC response. |
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 | ListFirewallPoliciesRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListFirewallPoliciesResponseFirewallPolicy | A pageable sequence of FirewallPolicy resources. |
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 | ListFirewallPoliciesRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListFirewallPoliciesResponseFirewallPolicy | A pageable asynchronous sequence of FirewallPolicy resources. |
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 | ListKeysRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListKeysResponseKey | A pageable sequence of Key resources. |
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 | ListKeysRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListKeysResponseKey | A pageable asynchronous sequence of Key resources. |
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 | ListRelatedAccountGroupMembershipsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListRelatedAccountGroupMembershipsResponseRelatedAccountGroupMembership | A pageable sequence of RelatedAccountGroupMembership resources. |
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 | ListRelatedAccountGroupMembershipsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListRelatedAccountGroupMembershipsResponseRelatedAccountGroupMembership | A pageable asynchronous sequence of RelatedAccountGroupMembership resources. |
ListRelatedAccountGroups(ListRelatedAccountGroupsRequest, CallSettings)
public override PagedEnumerable<ListRelatedAccountGroupsResponse, RelatedAccountGroup> ListRelatedAccountGroups(ListRelatedAccountGroupsRequest request, CallSettings callSettings = null)List groups of related accounts.
| Parameters | |
|---|---|
| Name | Description |
request | ListRelatedAccountGroupsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListRelatedAccountGroupsResponseRelatedAccountGroup | A pageable sequence of RelatedAccountGroup resources. |
ListRelatedAccountGroupsAsync(ListRelatedAccountGroupsRequest, CallSettings)
public override PagedAsyncEnumerable<ListRelatedAccountGroupsResponse, RelatedAccountGroup> ListRelatedAccountGroupsAsync(ListRelatedAccountGroupsRequest request, CallSettings callSettings = null)List groups of related accounts.
| Parameters | |
|---|---|
| Name | Description |
request | ListRelatedAccountGroupsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListRelatedAccountGroupsResponseRelatedAccountGroup | A pageable asynchronous sequence of RelatedAccountGroup resources. |
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 | MigrateKeyRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Key | The RPC response. |
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 | MigrateKeyRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskKey | A Task containing the RPC response. |
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 | RetrieveLegacySecretKeyRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
RetrieveLegacySecretKeyResponse | The RPC response. |
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 | RetrieveLegacySecretKeyRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskRetrieveLegacySecretKeyResponse | A Task containing the RPC response. |
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 | SearchRelatedAccountGroupMembershipsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableSearchRelatedAccountGroupMembershipsResponseRelatedAccountGroupMembership | A pageable sequence of RelatedAccountGroupMembership resources. |
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 | SearchRelatedAccountGroupMembershipsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableSearchRelatedAccountGroupMembershipsResponseRelatedAccountGroupMembership | A pageable asynchronous sequence of RelatedAccountGroupMembership resources. |
UpdateFirewallPolicy(UpdateFirewallPolicyRequest, CallSettings)
public override FirewallPolicy UpdateFirewallPolicy(UpdateFirewallPolicyRequest request, CallSettings callSettings = null)Updates the specified firewall policy.
| Parameters | |
|---|---|
| Name | Description |
request | UpdateFirewallPolicyRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
FirewallPolicy | The RPC response. |
UpdateFirewallPolicyAsync(UpdateFirewallPolicyRequest, CallSettings)
public override Task<FirewallPolicy> UpdateFirewallPolicyAsync(UpdateFirewallPolicyRequest request, CallSettings callSettings = null)Updates the specified firewall policy.
| Parameters | |
|---|---|
| Name | Description |
request | UpdateFirewallPolicyRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskFirewallPolicy | A Task containing the RPC response. |
UpdateKey(UpdateKeyRequest, CallSettings)
public override Key UpdateKey(UpdateKeyRequest request, CallSettings callSettings = null)Updates the specified key.
| Parameters | |
|---|---|
| Name | Description |
request | UpdateKeyRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Key | The RPC response. |
UpdateKeyAsync(UpdateKeyRequest, CallSettings)
public override Task<Key> UpdateKeyAsync(UpdateKeyRequest request, CallSettings callSettings = null)Updates the specified key.
| Parameters | |
|---|---|
| Name | Description |
request | UpdateKeyRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskKey | A Task containing the RPC response. |