Google Cloud reCAPTCHA Enterprise v1 API - Class RecaptchaEnterpriseService.RecaptchaEnterpriseServiceClient (2.16.0) 

public class RecaptchaEnterpriseService.RecaptchaEnterpriseServiceClient : ClientBase<RecaptchaEnterpriseService.RecaptchaEnterpriseServiceClient>

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

Client for RecaptchaEnterpriseService

Inheritance

object > ClientBase > ClientBaseRecaptchaEnterpriseServiceRecaptchaEnterpriseServiceClient > 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(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(ClientBaseConfiguration)

protected RecaptchaEnterpriseServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

AddIpOverride(AddIpOverrideRequest, CallOptions)

public virtual AddIpOverrideResponse AddIpOverride(AddIpOverrideRequest request, CallOptions options)

Adds an IP override to a key. The following restrictions hold:

  • The maximum number of IP overrides per key is 100.
  • For any conflict (such as IP already exists or IP part of an existing IP range), an error is returned.
Parameters
Name Description
request AddIpOverrideRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AddIpOverrideResponse

The response received from the server.

AddIpOverride(AddIpOverrideRequest, Metadata, DateTime?, CancellationToken)

public virtual AddIpOverrideResponse AddIpOverride(AddIpOverrideRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Adds an IP override to a key. The following restrictions hold:

  • The maximum number of IP overrides per key is 100.
  • For any conflict (such as IP already exists or IP part of an existing IP range), an error is returned.
Parameters
Name Description
request AddIpOverrideRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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
AddIpOverrideResponse

The response received from the server.

AddIpOverrideAsync(AddIpOverrideRequest, CallOptions)

public virtual AsyncUnaryCall<AddIpOverrideResponse> AddIpOverrideAsync(AddIpOverrideRequest request, CallOptions options)

Adds an IP override to a key. The following restrictions hold:

  • The maximum number of IP overrides per key is 100.
  • For any conflict (such as IP already exists or IP part of an existing IP range), an error is returned.
Parameters
Name Description
request AddIpOverrideRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallAddIpOverrideResponse

The call object.

AddIpOverrideAsync(AddIpOverrideRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<AddIpOverrideResponse> AddIpOverrideAsync(AddIpOverrideRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Adds an IP override to a key. The following restrictions hold:

  • The maximum number of IP overrides per key is 100.
  • For any conflict (such as IP already exists or IP part of an existing IP range), an error is returned.
Parameters
Name Description
request AddIpOverrideRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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
AsyncUnaryCallAddIpOverrideResponse

The call object.

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, DateTime?, CancellationToken)

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

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 System.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
AsyncUnaryCallAnnotateAssessmentResponse

The call object.

AnnotateAssessmentAsync(AnnotateAssessmentRequest, Metadata, DateTime?, CancellationToken)

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

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 System.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
AsyncUnaryCallAnnotateAssessmentResponse

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, DateTime?, CancellationToken)

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

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 System.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
AsyncUnaryCallAssessment

The call object.

CreateAssessmentAsync(CreateAssessmentRequest, Metadata, DateTime?, CancellationToken)

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

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 System.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
AsyncUnaryCallAssessment

The call object.

CreateFirewallPolicy(CreateFirewallPolicyRequest, CallOptions)

public virtual FirewallPolicy CreateFirewallPolicy(CreateFirewallPolicyRequest request, CallOptions options)

Creates a new FirewallPolicy, specifying conditions at which reCAPTCHA Enterprise actions can be executed. A project may have a maximum of 1000 policies.

Parameters
Name Description
request CreateFirewallPolicyRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
FirewallPolicy

The response received from the server.

CreateFirewallPolicy(CreateFirewallPolicyRequest, Metadata, DateTime?, CancellationToken)

public virtual FirewallPolicy CreateFirewallPolicy(CreateFirewallPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a new FirewallPolicy, specifying conditions at which reCAPTCHA Enterprise actions can be executed. A project may have a maximum of 1000 policies.

Parameters
Name Description
request CreateFirewallPolicyRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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
FirewallPolicy

The response received from the server.

CreateFirewallPolicyAsync(CreateFirewallPolicyRequest, CallOptions)

public virtual AsyncUnaryCall<FirewallPolicy> CreateFirewallPolicyAsync(CreateFirewallPolicyRequest request, CallOptions options)

Creates a new FirewallPolicy, specifying conditions at which reCAPTCHA Enterprise actions can be executed. A project may have a maximum of 1000 policies.

Parameters
Name Description
request CreateFirewallPolicyRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallFirewallPolicy

The call object.

CreateFirewallPolicyAsync(CreateFirewallPolicyRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<FirewallPolicy> CreateFirewallPolicyAsync(CreateFirewallPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a new FirewallPolicy, specifying conditions at which reCAPTCHA Enterprise actions can be executed. A project may have a maximum of 1000 policies.

Parameters
Name Description
request CreateFirewallPolicyRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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
AsyncUnaryCallFirewallPolicy

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, DateTime?, CancellationToken)

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

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 System.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
AsyncUnaryCallKey

The call object.

CreateKeyAsync(CreateKeyRequest, Metadata, DateTime?, CancellationToken)

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

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 System.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
AsyncUnaryCallKey

The call object.

DeleteFirewallPolicy(DeleteFirewallPolicyRequest, CallOptions)

public virtual Empty DeleteFirewallPolicy(DeleteFirewallPolicyRequest request, CallOptions options)

Deletes the specified firewall policy.

Parameters
Name Description
request DeleteFirewallPolicyRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Empty

The response received from the server.

DeleteFirewallPolicy(DeleteFirewallPolicyRequest, Metadata, DateTime?, CancellationToken)

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

Deletes the specified firewall policy.

Parameters
Name Description
request DeleteFirewallPolicyRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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.

DeleteFirewallPolicyAsync(DeleteFirewallPolicyRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteFirewallPolicyAsync(DeleteFirewallPolicyRequest request, CallOptions options)

Deletes the specified firewall policy.

Parameters
Name Description
request DeleteFirewallPolicyRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallEmpty

The call object.

DeleteFirewallPolicyAsync(DeleteFirewallPolicyRequest, Metadata, DateTime?, CancellationToken)

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

Deletes the specified firewall policy.

Parameters
Name Description
request DeleteFirewallPolicyRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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
AsyncUnaryCallEmpty

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, DateTime?, CancellationToken)

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

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 System.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
AsyncUnaryCallEmpty

The call object.

DeleteKeyAsync(DeleteKeyRequest, Metadata, DateTime?, CancellationToken)

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

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 System.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
AsyncUnaryCallEmpty

The call object.

GetFirewallPolicy(GetFirewallPolicyRequest, CallOptions)

public virtual FirewallPolicy GetFirewallPolicy(GetFirewallPolicyRequest request, CallOptions options)

Returns the specified firewall policy.

Parameters
Name Description
request GetFirewallPolicyRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
FirewallPolicy

The response received from the server.

GetFirewallPolicy(GetFirewallPolicyRequest, Metadata, DateTime?, CancellationToken)

public virtual FirewallPolicy GetFirewallPolicy(GetFirewallPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns the specified firewall policy.

Parameters
Name Description
request GetFirewallPolicyRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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
FirewallPolicy

The response received from the server.

GetFirewallPolicyAsync(GetFirewallPolicyRequest, CallOptions)

public virtual AsyncUnaryCall<FirewallPolicy> GetFirewallPolicyAsync(GetFirewallPolicyRequest request, CallOptions options)

Returns the specified firewall policy.

Parameters
Name Description
request GetFirewallPolicyRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallFirewallPolicy

The call object.

GetFirewallPolicyAsync(GetFirewallPolicyRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<FirewallPolicy> GetFirewallPolicyAsync(GetFirewallPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns the specified firewall policy.

Parameters
Name Description
request GetFirewallPolicyRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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
AsyncUnaryCallFirewallPolicy

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, DateTime?, CancellationToken)

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

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 System.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
AsyncUnaryCallKey

The call object.

GetKeyAsync(GetKeyRequest, Metadata, DateTime?, CancellationToken)

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

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 System.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
AsyncUnaryCallKey

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, DateTime?, CancellationToken)

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

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 System.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
AsyncUnaryCallMetrics

The call object.

GetMetricsAsync(GetMetricsRequest, Metadata, DateTime?, CancellationToken)

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

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 System.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
AsyncUnaryCallMetrics

The call object.

ListFirewallPolicies(ListFirewallPoliciesRequest, CallOptions)

public virtual ListFirewallPoliciesResponse ListFirewallPolicies(ListFirewallPoliciesRequest request, CallOptions options)

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

Parameters
Name Description
request ListFirewallPoliciesRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
ListFirewallPoliciesResponse

The response received from the server.

ListFirewallPolicies(ListFirewallPoliciesRequest, Metadata, DateTime?, CancellationToken)

public virtual ListFirewallPoliciesResponse ListFirewallPolicies(ListFirewallPoliciesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request ListFirewallPoliciesRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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
ListFirewallPoliciesResponse

The response received from the server.

ListFirewallPoliciesAsync(ListFirewallPoliciesRequest, CallOptions)

public virtual AsyncUnaryCall<ListFirewallPoliciesResponse> ListFirewallPoliciesAsync(ListFirewallPoliciesRequest request, CallOptions options)

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

Parameters
Name Description
request ListFirewallPoliciesRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallListFirewallPoliciesResponse

The call object.

ListFirewallPoliciesAsync(ListFirewallPoliciesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListFirewallPoliciesResponse> ListFirewallPoliciesAsync(ListFirewallPoliciesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request ListFirewallPoliciesRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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
AsyncUnaryCallListFirewallPoliciesResponse

The call object.

ListIpOverrides(ListIpOverridesRequest, CallOptions)

public virtual ListIpOverridesResponse ListIpOverrides(ListIpOverridesRequest request, CallOptions options)

Lists all IP overrides for a key.

Parameters
Name Description
request ListIpOverridesRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
ListIpOverridesResponse

The response received from the server.

ListIpOverrides(ListIpOverridesRequest, Metadata, DateTime?, CancellationToken)

public virtual ListIpOverridesResponse ListIpOverrides(ListIpOverridesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists all IP overrides for a key.

Parameters
Name Description
request ListIpOverridesRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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
ListIpOverridesResponse

The response received from the server.

ListIpOverridesAsync(ListIpOverridesRequest, CallOptions)

public virtual AsyncUnaryCall<ListIpOverridesResponse> ListIpOverridesAsync(ListIpOverridesRequest request, CallOptions options)

Lists all IP overrides for a key.

Parameters
Name Description
request ListIpOverridesRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallListIpOverridesResponse

The call object.

ListIpOverridesAsync(ListIpOverridesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListIpOverridesResponse> ListIpOverridesAsync(ListIpOverridesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists all IP overrides for a key.

Parameters
Name Description
request ListIpOverridesRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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
AsyncUnaryCallListIpOverridesResponse

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, DateTime?, CancellationToken)

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

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 System.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
AsyncUnaryCallListKeysResponse

The call object.

ListKeysAsync(ListKeysRequest, Metadata, DateTime?, CancellationToken)

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

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 System.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
AsyncUnaryCallListKeysResponse

The call object.

ListRelatedAccountGroupMemberships(ListRelatedAccountGroupMembershipsRequest, CallOptions)

public virtual ListRelatedAccountGroupMembershipsResponse ListRelatedAccountGroupMemberships(ListRelatedAccountGroupMembershipsRequest request, CallOptions options)

Get memberships in a group of related accounts.

Parameters
Name Description
request ListRelatedAccountGroupMembershipsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
ListRelatedAccountGroupMembershipsResponse

The response received from the server.

ListRelatedAccountGroupMemberships(ListRelatedAccountGroupMembershipsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListRelatedAccountGroupMembershipsResponse ListRelatedAccountGroupMemberships(ListRelatedAccountGroupMembershipsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Get memberships in a group of related accounts.

Parameters
Name Description
request ListRelatedAccountGroupMembershipsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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
ListRelatedAccountGroupMembershipsResponse

The response received from the server.

ListRelatedAccountGroupMembershipsAsync(ListRelatedAccountGroupMembershipsRequest, CallOptions)

public virtual AsyncUnaryCall<ListRelatedAccountGroupMembershipsResponse> ListRelatedAccountGroupMembershipsAsync(ListRelatedAccountGroupMembershipsRequest request, CallOptions options)

Get memberships in a group of related accounts.

Parameters
Name Description
request ListRelatedAccountGroupMembershipsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallListRelatedAccountGroupMembershipsResponse

The call object.

ListRelatedAccountGroupMembershipsAsync(ListRelatedAccountGroupMembershipsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListRelatedAccountGroupMembershipsResponse> ListRelatedAccountGroupMembershipsAsync(ListRelatedAccountGroupMembershipsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Get memberships in a group of related accounts.

Parameters
Name Description
request ListRelatedAccountGroupMembershipsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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
AsyncUnaryCallListRelatedAccountGroupMembershipsResponse

The call object.

ListRelatedAccountGroups(ListRelatedAccountGroupsRequest, CallOptions)

public virtual ListRelatedAccountGroupsResponse ListRelatedAccountGroups(ListRelatedAccountGroupsRequest request, CallOptions options)

List groups of related accounts.

Parameters
Name Description
request ListRelatedAccountGroupsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
ListRelatedAccountGroupsResponse

The response received from the server.

ListRelatedAccountGroups(ListRelatedAccountGroupsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListRelatedAccountGroupsResponse ListRelatedAccountGroups(ListRelatedAccountGroupsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

List groups of related accounts.

Parameters
Name Description
request ListRelatedAccountGroupsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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
ListRelatedAccountGroupsResponse

The response received from the server.

ListRelatedAccountGroupsAsync(ListRelatedAccountGroupsRequest, CallOptions)

public virtual AsyncUnaryCall<ListRelatedAccountGroupsResponse> ListRelatedAccountGroupsAsync(ListRelatedAccountGroupsRequest request, CallOptions options)

List groups of related accounts.

Parameters
Name Description
request ListRelatedAccountGroupsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallListRelatedAccountGroupsResponse

The call object.

ListRelatedAccountGroupsAsync(ListRelatedAccountGroupsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListRelatedAccountGroupsResponse> ListRelatedAccountGroupsAsync(ListRelatedAccountGroupsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

List groups of related accounts.

Parameters
Name Description
request ListRelatedAccountGroupsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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
AsyncUnaryCallListRelatedAccountGroupsResponse

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 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, DateTime?, CancellationToken)

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

Migrates an existing key from reCAPTCHA to reCAPTCHA Enterprise. Once a key is migrated, it can be used from either product. SiteVerify requests are billed as CreateAssessment calls. You must be authenticated as one of the current owners of the reCAPTCHA Key, and your user must have the reCAPTCHA Enterprise Admin IAM role in the destination project.

Parameters
Name Description
request MigrateKeyRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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 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
AsyncUnaryCallKey

The call object.

MigrateKeyAsync(MigrateKeyRequest, Metadata, DateTime?, CancellationToken)

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

Migrates an existing key from reCAPTCHA to reCAPTCHA Enterprise. Once a key is migrated, it can be used from either product. SiteVerify requests are billed as CreateAssessment calls. You must be authenticated as one of the current owners of the reCAPTCHA Key, and your user must have the reCAPTCHA Enterprise Admin IAM role in the destination project.

Parameters
Name Description
request MigrateKeyRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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
AsyncUnaryCallKey

The call object.

NewInstance(ClientBaseConfiguration)

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

Creates a new instance of client from given ClientBaseConfiguration.

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

RemoveIpOverride(RemoveIpOverrideRequest, CallOptions)

public virtual RemoveIpOverrideResponse RemoveIpOverride(RemoveIpOverrideRequest request, CallOptions options)

Removes an IP override from a key. The following restrictions hold:

  • If the IP isn't found in an existing IP override, a NOT_FOUND error is returned.
  • If the IP is found in an existing IP override, but the override type does not match, a NOT_FOUND error is returned.
Parameters
Name Description
request RemoveIpOverrideRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
RemoveIpOverrideResponse

The response received from the server.

RemoveIpOverride(RemoveIpOverrideRequest, Metadata, DateTime?, CancellationToken)

public virtual RemoveIpOverrideResponse RemoveIpOverride(RemoveIpOverrideRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Removes an IP override from a key. The following restrictions hold:

  • If the IP isn't found in an existing IP override, a NOT_FOUND error is returned.
  • If the IP is found in an existing IP override, but the override type does not match, a NOT_FOUND error is returned.
Parameters
Name Description
request RemoveIpOverrideRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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
RemoveIpOverrideResponse

The response received from the server.

RemoveIpOverrideAsync(RemoveIpOverrideRequest, CallOptions)

public virtual AsyncUnaryCall<RemoveIpOverrideResponse> RemoveIpOverrideAsync(RemoveIpOverrideRequest request, CallOptions options)

Removes an IP override from a key. The following restrictions hold:

  • If the IP isn't found in an existing IP override, a NOT_FOUND error is returned.
  • If the IP is found in an existing IP override, but the override type does not match, a NOT_FOUND error is returned.
Parameters
Name Description
request RemoveIpOverrideRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallRemoveIpOverrideResponse

The call object.

RemoveIpOverrideAsync(RemoveIpOverrideRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<RemoveIpOverrideResponse> RemoveIpOverrideAsync(RemoveIpOverrideRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Removes an IP override from a key. The following restrictions hold:

  • If the IP isn't found in an existing IP override, a NOT_FOUND error is returned.
  • If the IP is found in an existing IP override, but the override type does not match, a NOT_FOUND error is returned.
Parameters
Name Description
request RemoveIpOverrideRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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
AsyncUnaryCallRemoveIpOverrideResponse

The call object.

ReorderFirewallPolicies(ReorderFirewallPoliciesRequest, CallOptions)

public virtual ReorderFirewallPoliciesResponse ReorderFirewallPolicies(ReorderFirewallPoliciesRequest request, CallOptions options)

Reorders all firewall policies.

Parameters
Name Description
request ReorderFirewallPoliciesRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
ReorderFirewallPoliciesResponse

The response received from the server.

ReorderFirewallPolicies(ReorderFirewallPoliciesRequest, Metadata, DateTime?, CancellationToken)

public virtual ReorderFirewallPoliciesResponse ReorderFirewallPolicies(ReorderFirewallPoliciesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Reorders all firewall policies.

Parameters
Name Description
request ReorderFirewallPoliciesRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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
ReorderFirewallPoliciesResponse

The response received from the server.

ReorderFirewallPoliciesAsync(ReorderFirewallPoliciesRequest, CallOptions)

public virtual AsyncUnaryCall<ReorderFirewallPoliciesResponse> ReorderFirewallPoliciesAsync(ReorderFirewallPoliciesRequest request, CallOptions options)

Reorders all firewall policies.

Parameters
Name Description
request ReorderFirewallPoliciesRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallReorderFirewallPoliciesResponse

The call object.

ReorderFirewallPoliciesAsync(ReorderFirewallPoliciesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ReorderFirewallPoliciesResponse> ReorderFirewallPoliciesAsync(ReorderFirewallPoliciesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Reorders all firewall policies.

Parameters
Name Description
request ReorderFirewallPoliciesRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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
AsyncUnaryCallReorderFirewallPoliciesResponse

The call object.

RetrieveLegacySecretKey(RetrieveLegacySecretKeyRequest, CallOptions)

public virtual RetrieveLegacySecretKeyResponse RetrieveLegacySecretKey(RetrieveLegacySecretKeyRequest request, CallOptions options)

Returns the secret key related to the specified public key. You must use the legacy secret key only in a 3rd party integration with legacy reCAPTCHA.

Parameters
Name Description
request RetrieveLegacySecretKeyRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
RetrieveLegacySecretKeyResponse

The response received from the server.

RetrieveLegacySecretKey(RetrieveLegacySecretKeyRequest, Metadata, DateTime?, CancellationToken)

public virtual RetrieveLegacySecretKeyResponse RetrieveLegacySecretKey(RetrieveLegacySecretKeyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns the secret key related to the specified public key. You must use the legacy secret key only in a 3rd party integration with legacy reCAPTCHA.

Parameters
Name Description
request RetrieveLegacySecretKeyRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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
RetrieveLegacySecretKeyResponse

The response received from the server.

RetrieveLegacySecretKeyAsync(RetrieveLegacySecretKeyRequest, CallOptions)

public virtual AsyncUnaryCall<RetrieveLegacySecretKeyResponse> RetrieveLegacySecretKeyAsync(RetrieveLegacySecretKeyRequest request, CallOptions options)

Returns the secret key related to the specified public key. You must use the legacy secret key only in a 3rd party integration with legacy reCAPTCHA.

Parameters
Name Description
request RetrieveLegacySecretKeyRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallRetrieveLegacySecretKeyResponse

The call object.

RetrieveLegacySecretKeyAsync(RetrieveLegacySecretKeyRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<RetrieveLegacySecretKeyResponse> RetrieveLegacySecretKeyAsync(RetrieveLegacySecretKeyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns the secret key related to the specified public key. You must use the legacy secret key only in a 3rd party integration with legacy reCAPTCHA.

Parameters
Name Description
request RetrieveLegacySecretKeyRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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
AsyncUnaryCallRetrieveLegacySecretKeyResponse

The call object.

SearchRelatedAccountGroupMemberships(SearchRelatedAccountGroupMembershipsRequest, CallOptions)

public virtual SearchRelatedAccountGroupMembershipsResponse SearchRelatedAccountGroupMemberships(SearchRelatedAccountGroupMembershipsRequest request, CallOptions options)

Search group memberships related to a given account.

Parameters
Name Description
request SearchRelatedAccountGroupMembershipsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
SearchRelatedAccountGroupMembershipsResponse

The response received from the server.

SearchRelatedAccountGroupMemberships(SearchRelatedAccountGroupMembershipsRequest, Metadata, DateTime?, CancellationToken)

public virtual SearchRelatedAccountGroupMembershipsResponse SearchRelatedAccountGroupMemberships(SearchRelatedAccountGroupMembershipsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Search group memberships related to a given account.

Parameters
Name Description
request SearchRelatedAccountGroupMembershipsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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
SearchRelatedAccountGroupMembershipsResponse

The response received from the server.

SearchRelatedAccountGroupMembershipsAsync(SearchRelatedAccountGroupMembershipsRequest, CallOptions)

public virtual AsyncUnaryCall<SearchRelatedAccountGroupMembershipsResponse> SearchRelatedAccountGroupMembershipsAsync(SearchRelatedAccountGroupMembershipsRequest request, CallOptions options)

Search group memberships related to a given account.

Parameters
Name Description
request SearchRelatedAccountGroupMembershipsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallSearchRelatedAccountGroupMembershipsResponse

The call object.

SearchRelatedAccountGroupMembershipsAsync(SearchRelatedAccountGroupMembershipsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<SearchRelatedAccountGroupMembershipsResponse> SearchRelatedAccountGroupMembershipsAsync(SearchRelatedAccountGroupMembershipsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Search group memberships related to a given account.

Parameters
Name Description
request SearchRelatedAccountGroupMembershipsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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
AsyncUnaryCallSearchRelatedAccountGroupMembershipsResponse

The call object.

UpdateFirewallPolicy(UpdateFirewallPolicyRequest, CallOptions)

public virtual FirewallPolicy UpdateFirewallPolicy(UpdateFirewallPolicyRequest request, CallOptions options)

Updates the specified firewall policy.

Parameters
Name Description
request UpdateFirewallPolicyRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
FirewallPolicy

The response received from the server.

UpdateFirewallPolicy(UpdateFirewallPolicyRequest, Metadata, DateTime?, CancellationToken)

public virtual FirewallPolicy UpdateFirewallPolicy(UpdateFirewallPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates the specified firewall policy.

Parameters
Name Description
request UpdateFirewallPolicyRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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
FirewallPolicy

The response received from the server.

UpdateFirewallPolicyAsync(UpdateFirewallPolicyRequest, CallOptions)

public virtual AsyncUnaryCall<FirewallPolicy> UpdateFirewallPolicyAsync(UpdateFirewallPolicyRequest request, CallOptions options)

Updates the specified firewall policy.

Parameters
Name Description
request UpdateFirewallPolicyRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallFirewallPolicy

The call object.

UpdateFirewallPolicyAsync(UpdateFirewallPolicyRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<FirewallPolicy> UpdateFirewallPolicyAsync(UpdateFirewallPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates the specified firewall policy.

Parameters
Name Description
request UpdateFirewallPolicyRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline System.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
AsyncUnaryCallFirewallPolicy

The call object.

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, DateTime?, CancellationToken)

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

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 System.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
AsyncUnaryCallKey

The call object.

UpdateKeyAsync(UpdateKeyRequest, Metadata, DateTime?, CancellationToken)

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

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 System.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
AsyncUnaryCallKey

The call object.