Class RecaptchaEnterpriseService.RecaptchaEnterpriseServiceClient (1.4.0)

public class RecaptchaEnterpriseServiceClient : ClientBase<RecaptchaEnterpriseService.RecaptchaEnterpriseServiceClient>

Client for RecaptchaEnterpriseService

Inheritance

Object > ClientBase > ClientBase<RecaptchaEnterpriseService.RecaptchaEnterpriseServiceClient> > RecaptchaEnterpriseService.RecaptchaEnterpriseServiceClient

Namespace

Google.Cloud.RecaptchaEnterprise.V1

Assembly

Google.Cloud.RecaptchaEnterprise.V1.dll

Constructors

RecaptchaEnterpriseServiceClient()

protected RecaptchaEnterpriseServiceClient()

Protected parameterless constructor to allow creation of test doubles.

RecaptchaEnterpriseServiceClient(CallInvoker)

public RecaptchaEnterpriseServiceClient(CallInvoker callInvoker)

Creates a new client for RecaptchaEnterpriseService that uses a custom CallInvoker.

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

RecaptchaEnterpriseServiceClient(Channel)

[Obsolete("This constructor overload is present for compatibility only, and will be removed in the next major version")]
public RecaptchaEnterpriseServiceClient(Channel channel)

Creates a new client using a channel.

Parameter
Name Description
channel Grpc.Core.Channel

The channel to use to make remote calls.

RecaptchaEnterpriseServiceClient(ChannelBase)

public RecaptchaEnterpriseServiceClient(ChannelBase channel)

Creates a new client for RecaptchaEnterpriseService

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

RecaptchaEnterpriseServiceClient(ClientBase.ClientBaseConfiguration)

protected RecaptchaEnterpriseServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBase.ClientBaseConfiguration

The client configuration.

Methods

AnnotateAssessment(AnnotateAssessmentRequest, CallOptions)

public virtual AnnotateAssessmentResponse AnnotateAssessment(AnnotateAssessmentRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AnnotateAssessmentResponse

The response received from the server.

AnnotateAssessment(AnnotateAssessmentRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AnnotateAssessmentResponse AnnotateAssessment(AnnotateAssessmentRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline Nullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AnnotateAssessmentResponse

The response received from the server.

AnnotateAssessmentAsync(AnnotateAssessmentRequest, CallOptions)

public virtual AsyncUnaryCall<AnnotateAssessmentResponse> AnnotateAssessmentAsync(AnnotateAssessmentRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCall<AnnotateAssessmentResponse>

The call object.

AnnotateAssessmentAsync(AnnotateAssessmentRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<AnnotateAssessmentResponse> AnnotateAssessmentAsync(AnnotateAssessmentRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline Nullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCall<AnnotateAssessmentResponse>

The call object.

CreateAssessment(CreateAssessmentRequest, CallOptions)

public virtual Assessment CreateAssessment(CreateAssessmentRequest request, CallOptions options)

Creates an Assessment of the likelihood an event is legitimate.

Parameters
Name Description
request CreateAssessmentRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Assessment

The response received from the server.

CreateAssessment(CreateAssessmentRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Assessment CreateAssessment(CreateAssessmentRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Creates an Assessment of the likelihood an event is legitimate.

Parameters
Name Description
request CreateAssessmentRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline Nullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Assessment

The response received from the server.

CreateAssessmentAsync(CreateAssessmentRequest, CallOptions)

public virtual AsyncUnaryCall<Assessment> CreateAssessmentAsync(CreateAssessmentRequest request, CallOptions options)

Creates an Assessment of the likelihood an event is legitimate.

Parameters
Name Description
request CreateAssessmentRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCall<Assessment>

The call object.

CreateAssessmentAsync(CreateAssessmentRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Assessment> CreateAssessmentAsync(CreateAssessmentRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Creates an Assessment of the likelihood an event is legitimate.

Parameters
Name Description
request CreateAssessmentRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline Nullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCall<Assessment>

The call object.

CreateKey(CreateKeyRequest, CallOptions)

public virtual Key CreateKey(CreateKeyRequest request, CallOptions options)

Creates a new reCAPTCHA Enterprise key.

Parameters
Name Description
request CreateKeyRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Key

The response received from the server.

CreateKey(CreateKeyRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Key CreateKey(CreateKeyRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Creates a new reCAPTCHA Enterprise key.

Parameters
Name Description
request CreateKeyRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline Nullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Key

The response received from the server.

CreateKeyAsync(CreateKeyRequest, CallOptions)

public virtual AsyncUnaryCall<Key> CreateKeyAsync(CreateKeyRequest request, CallOptions options)

Creates a new reCAPTCHA Enterprise key.

Parameters
Name Description
request CreateKeyRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCall<Key>

The call object.

CreateKeyAsync(CreateKeyRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Key> CreateKeyAsync(CreateKeyRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Creates a new reCAPTCHA Enterprise key.

Parameters
Name Description
request CreateKeyRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline Nullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCall<Key>

The call object.

DeleteKey(DeleteKeyRequest, CallOptions)

public virtual Empty DeleteKey(DeleteKeyRequest request, CallOptions options)

Deletes the specified key.

Parameters
Name Description
request DeleteKeyRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Empty

The response received from the server.

DeleteKey(DeleteKeyRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Empty DeleteKey(DeleteKeyRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Deletes the specified key.

Parameters
Name Description
request DeleteKeyRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline Nullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Empty

The response received from the server.

DeleteKeyAsync(DeleteKeyRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteKeyAsync(DeleteKeyRequest request, CallOptions options)

Deletes the specified key.

Parameters
Name Description
request DeleteKeyRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCall<Empty>

The call object.

DeleteKeyAsync(DeleteKeyRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Empty> DeleteKeyAsync(DeleteKeyRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Deletes the specified key.

Parameters
Name Description
request DeleteKeyRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline Nullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCall<Empty>

The call object.

GetKey(GetKeyRequest, CallOptions)

public virtual Key GetKey(GetKeyRequest request, CallOptions options)

Returns the specified key.

Parameters
Name Description
request GetKeyRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Key

The response received from the server.

GetKey(GetKeyRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Key GetKey(GetKeyRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Returns the specified key.

Parameters
Name Description
request GetKeyRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline Nullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Key

The response received from the server.

GetKeyAsync(GetKeyRequest, CallOptions)

public virtual AsyncUnaryCall<Key> GetKeyAsync(GetKeyRequest request, CallOptions options)

Returns the specified key.

Parameters
Name Description
request GetKeyRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCall<Key>

The call object.

GetKeyAsync(GetKeyRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Key> GetKeyAsync(GetKeyRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Returns the specified key.

Parameters
Name Description
request GetKeyRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline Nullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCall<Key>

The call object.

GetMetrics(GetMetricsRequest, CallOptions)

public virtual Metrics GetMetrics(GetMetricsRequest request, CallOptions options)

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

Parameters
Name Description
request GetMetricsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Metrics

The response received from the server.

GetMetrics(GetMetricsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Metrics GetMetrics(GetMetricsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
Name Description
request GetMetricsRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline Nullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Metrics

The response received from the server.

GetMetricsAsync(GetMetricsRequest, CallOptions)

public virtual AsyncUnaryCall<Metrics> GetMetricsAsync(GetMetricsRequest request, CallOptions options)

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

Parameters
Name Description
request GetMetricsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCall<Metrics>

The call object.

GetMetricsAsync(GetMetricsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Metrics> GetMetricsAsync(GetMetricsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
Name Description
request GetMetricsRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline Nullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCall<Metrics>

The call object.

ListKeys(ListKeysRequest, CallOptions)

public virtual ListKeysResponse ListKeys(ListKeysRequest request, CallOptions options)

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

Parameters
Name Description
request ListKeysRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ListKeysResponse

The response received from the server.

ListKeys(ListKeysRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListKeysResponse ListKeys(ListKeysRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
Name Description
request ListKeysRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline Nullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
ListKeysResponse

The response received from the server.

ListKeysAsync(ListKeysRequest, CallOptions)

public virtual AsyncUnaryCall<ListKeysResponse> ListKeysAsync(ListKeysRequest request, CallOptions options)

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

Parameters
Name Description
request ListKeysRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCall<ListKeysResponse>

The call object.

ListKeysAsync(ListKeysRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListKeysResponse> ListKeysAsync(ListKeysRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
Name Description
request ListKeysRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline Nullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCall<ListKeysResponse>

The call object.

MigrateKey(MigrateKeyRequest, CallOptions)

public virtual Key MigrateKey(MigrateKeyRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Key

The response received from the server.

MigrateKey(MigrateKeyRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Key MigrateKey(MigrateKeyRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline Nullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Key

The response received from the server.

MigrateKeyAsync(MigrateKeyRequest, CallOptions)

public virtual AsyncUnaryCall<Key> MigrateKeyAsync(MigrateKeyRequest request, CallOptions options)

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 to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCall<Key>

The call object.

MigrateKeyAsync(MigrateKeyRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Key> MigrateKeyAsync(MigrateKeyRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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 to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline Nullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCall<Key>

The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

protected override RecaptchaEnterpriseService.RecaptchaEnterpriseServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBase.ClientBaseConfiguration
Returns
Type Description
RecaptchaEnterpriseService.RecaptchaEnterpriseServiceClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.RecaptchaEnterprise.V1.RecaptchaEnterpriseService.RecaptchaEnterpriseServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

UpdateKey(UpdateKeyRequest, CallOptions)

public virtual Key UpdateKey(UpdateKeyRequest request, CallOptions options)

Updates the specified key.

Parameters
Name Description
request UpdateKeyRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Key

The response received from the server.

UpdateKey(UpdateKeyRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Key UpdateKey(UpdateKeyRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Updates the specified key.

Parameters
Name Description
request UpdateKeyRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline Nullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Key

The response received from the server.

UpdateKeyAsync(UpdateKeyRequest, CallOptions)

public virtual AsyncUnaryCall<Key> UpdateKeyAsync(UpdateKeyRequest request, CallOptions options)

Updates the specified key.

Parameters
Name Description
request UpdateKeyRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCall<Key>

The call object.

UpdateKeyAsync(UpdateKeyRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Key> UpdateKeyAsync(UpdateKeyRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Updates the specified key.

Parameters
Name Description
request UpdateKeyRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline Nullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCall<Key>

The call object.