Class RecaptchaEnterpriseServiceClientImpl (2.1.0)

public sealed class RecaptchaEnterpriseServiceClientImpl : RecaptchaEnterpriseServiceClient

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.GetKeyAsync(GetKeyRequest, CancellationToken)

RecaptchaEnterpriseServiceClient.UpdateKeyAsync(UpdateKeyRequest, CancellationToken)

RecaptchaEnterpriseServiceClient.DeleteKeyAsync(DeleteKeyRequest, 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.ListRelatedAccountGroups(String, String, Nullable<Int32>, CallSettings)

RecaptchaEnterpriseServiceClient.ListRelatedAccountGroupsAsync(String, String, Nullable<Int32>, CallSettings)

RecaptchaEnterpriseServiceClient.ListRelatedAccountGroups(ProjectName, String, Nullable<Int32>, CallSettings)

RecaptchaEnterpriseServiceClient.ListRelatedAccountGroupsAsync(ProjectName, String, Nullable<Int32>, CallSettings)

RecaptchaEnterpriseServiceClient.ListRelatedAccountGroupMemberships(String, String, Nullable<Int32>, CallSettings)

RecaptchaEnterpriseServiceClient.ListRelatedAccountGroupMembershipsAsync(String, String, Nullable<Int32>, CallSettings)

RecaptchaEnterpriseServiceClient.ListRelatedAccountGroupMemberships(RelatedAccountGroupName, String, Nullable<Int32>, CallSettings)

RecaptchaEnterpriseServiceClient.ListRelatedAccountGroupMembershipsAsync(RelatedAccountGroupName, String, Nullable<Int32>, CallSettings)

RecaptchaEnterpriseServiceClient.SearchRelatedAccountGroupMemberships(String, ByteString, String, Nullable<Int32>, CallSettings)

RecaptchaEnterpriseServiceClient.SearchRelatedAccountGroupMembershipsAsync(String, ByteString, String, Nullable<Int32>, CallSettings)

RecaptchaEnterpriseServiceClient.SearchRelatedAccountGroupMemberships(RelatedAccountGroupName, ByteString, String, Nullable<Int32>, CallSettings)

RecaptchaEnterpriseServiceClient.SearchRelatedAccountGroupMembershipsAsync(RelatedAccountGroupName, ByteString, String, Nullable<Int32>, CallSettings)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

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(RecaptchaEnterpriseService.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`	`RecaptchaEnterpriseService.RecaptchaEnterpriseServiceClient` 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
`RecaptchaEnterpriseService.RecaptchaEnterpriseServiceClient`

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
`Task<AnnotateAssessmentResponse>`	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
`Task<Assessment>`	A Task containing the RPC response.

Overrides

RecaptchaEnterpriseServiceClient.CreateAssessmentAsync(CreateAssessmentRequest, 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
`Task<Key>`	A Task containing the RPC response.

Overrides

RecaptchaEnterpriseServiceClient.CreateKeyAsync(CreateKeyRequest, 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)

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
`Task<Key>`	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
`Task<Metrics>`	A Task containing the RPC response.

Overrides

RecaptchaEnterpriseServiceClient.GetMetricsAsync(GetMetricsRequest, 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
`PagedEnumerable<ListKeysResponse, Key>`	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
`PagedAsyncEnumerable<ListKeysResponse, Key>`	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 the 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
`PagedEnumerable<ListRelatedAccountGroupMembershipsResponse, RelatedAccountGroupMembership>`	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 the 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
`PagedAsyncEnumerable<ListRelatedAccountGroupMembershipsResponse, RelatedAccountGroupMembership>`	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
`PagedEnumerable<ListRelatedAccountGroupsResponse, RelatedAccountGroup>`	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
`PagedAsyncEnumerable<ListRelatedAccountGroupsResponse, RelatedAccountGroup>`	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 Site 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)

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
`Task<Key>`	A Task containing the RPC response.

Overrides

RecaptchaEnterpriseServiceClient.MigrateKeyAsync(MigrateKeyRequest, 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
`PagedEnumerable<SearchRelatedAccountGroupMembershipsResponse, RelatedAccountGroupMembership>`	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
`PagedAsyncEnumerable<SearchRelatedAccountGroupMembershipsResponse, RelatedAccountGroupMembership>`	A pageable asynchronous sequence of RelatedAccountGroupMembership resources.

Overrides

RecaptchaEnterpriseServiceClient.SearchRelatedAccountGroupMembershipsAsync(SearchRelatedAccountGroupMembershipsRequest, 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
`Task<Key>`	A Task containing the RPC response.

Overrides

RecaptchaEnterpriseServiceClient.UpdateKeyAsync(UpdateKeyRequest, CallSettings)