RecaptchaEnterpriseService

Constructor

new RecaptchaEnterpriseService(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new RecaptchaEnterpriseService service.

Parameters:

Name	Type	Attributes	Default	Description
`rpcImpl`	$protobuf.RPCImpl			RPC implementation
`requestDelimited`	boolean	<optional>	false	Whether requests are length-delimited
`responseDelimited`	boolean	<optional>	false	Whether responses are length-delimited

Extends

$protobuf.rpc.Service

Methods

annotateAssessment(request, callback) → {undefined}

Calls AnnotateAssessment.

Parameters:

Name	Type	Description
`request`	google.cloud.recaptchaenterprise.v1.IAnnotateAssessmentRequest	AnnotateAssessmentRequest message or plain object
`callback`	google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.AnnotateAssessmentCallback	Node-style callback called with the error, if any, and AnnotateAssessmentResponse

Returns:

Type	Description
undefined

annotateAssessment(request) → {Promise.<google.cloud.recaptchaenterprise.v1.AnnotateAssessmentResponse>}

Calls AnnotateAssessment.

Parameters:

Name	Type	Description
`request`	google.cloud.recaptchaenterprise.v1.IAnnotateAssessmentRequest	AnnotateAssessmentRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.recaptchaenterprise.v1.AnnotateAssessmentResponse>	Promise

createAssessment(request, callback) → {undefined}

Calls CreateAssessment.

Parameters:

Name	Type	Description
`request`	google.cloud.recaptchaenterprise.v1.ICreateAssessmentRequest	CreateAssessmentRequest message or plain object
`callback`	google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.CreateAssessmentCallback	Node-style callback called with the error, if any, and Assessment

Returns:

Type	Description
undefined

createAssessment(request) → {Promise.<google.cloud.recaptchaenterprise.v1.Assessment>}

Calls CreateAssessment.

Parameters:

Name	Type	Description
`request`	google.cloud.recaptchaenterprise.v1.ICreateAssessmentRequest	CreateAssessmentRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.recaptchaenterprise.v1.Assessment>	Promise

createFirewallPolicy(request, callback) → {undefined}

Calls CreateFirewallPolicy.

Parameters:

Name	Type	Description
`request`	google.cloud.recaptchaenterprise.v1.ICreateFirewallPolicyRequest	CreateFirewallPolicyRequest message or plain object
`callback`	google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.CreateFirewallPolicyCallback	Node-style callback called with the error, if any, and FirewallPolicy

Returns:

Type	Description
undefined

createFirewallPolicy(request) → {Promise.<google.cloud.recaptchaenterprise.v1.FirewallPolicy>}

Calls CreateFirewallPolicy.

Parameters:

Name	Type	Description
`request`	google.cloud.recaptchaenterprise.v1.ICreateFirewallPolicyRequest	CreateFirewallPolicyRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.recaptchaenterprise.v1.FirewallPolicy>	Promise

createKey(request, callback) → {undefined}

Calls CreateKey.

Parameters:

Name	Type	Description
`request`	google.cloud.recaptchaenterprise.v1.ICreateKeyRequest	CreateKeyRequest message or plain object
`callback`	google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.CreateKeyCallback	Node-style callback called with the error, if any, and Key

Returns:

Type	Description
undefined

createKey(request) → {Promise.<google.cloud.recaptchaenterprise.v1.Key>}

Calls CreateKey.

Parameters:

Name	Type	Description
`request`	google.cloud.recaptchaenterprise.v1.ICreateKeyRequest	CreateKeyRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.recaptchaenterprise.v1.Key>	Promise

deleteFirewallPolicy(request, callback) → {undefined}

Calls DeleteFirewallPolicy.

Parameters:

Name	Type	Description
`request`	google.cloud.recaptchaenterprise.v1.IDeleteFirewallPolicyRequest	DeleteFirewallPolicyRequest message or plain object
`callback`	google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.DeleteFirewallPolicyCallback	Node-style callback called with the error, if any, and Empty

Returns:

Type	Description
undefined

deleteFirewallPolicy(request) → {Promise.<google.protobuf.Empty>}

Calls DeleteFirewallPolicy.

Parameters:

Name	Type	Description
`request`	google.cloud.recaptchaenterprise.v1.IDeleteFirewallPolicyRequest	DeleteFirewallPolicyRequest message or plain object

Returns:

Type	Description
Promise.<google.protobuf.Empty>	Promise

deleteKey(request, callback) → {undefined}

Calls DeleteKey.

Parameters:

Name	Type	Description
`request`	google.cloud.recaptchaenterprise.v1.IDeleteKeyRequest	DeleteKeyRequest message or plain object
`callback`	google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.DeleteKeyCallback	Node-style callback called with the error, if any, and Empty

Returns:

Type	Description
undefined

deleteKey(request) → {Promise.<google.protobuf.Empty>}

Calls DeleteKey.

Parameters:

Name	Type	Description
`request`	google.cloud.recaptchaenterprise.v1.IDeleteKeyRequest	DeleteKeyRequest message or plain object

Returns:

Type	Description
Promise.<google.protobuf.Empty>	Promise

getFirewallPolicy(request, callback) → {undefined}

Calls GetFirewallPolicy.

Parameters:

Name	Type	Description
`request`	google.cloud.recaptchaenterprise.v1.IGetFirewallPolicyRequest	GetFirewallPolicyRequest message or plain object
`callback`	google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.GetFirewallPolicyCallback	Node-style callback called with the error, if any, and FirewallPolicy

Returns:

Type	Description
undefined

getFirewallPolicy(request) → {Promise.<google.cloud.recaptchaenterprise.v1.FirewallPolicy>}

Calls GetFirewallPolicy.

Parameters:

Name	Type	Description
`request`	google.cloud.recaptchaenterprise.v1.IGetFirewallPolicyRequest	GetFirewallPolicyRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.recaptchaenterprise.v1.FirewallPolicy>	Promise

getKey(request, callback) → {undefined}

Calls GetKey.

Parameters:

Name	Type	Description
`request`	google.cloud.recaptchaenterprise.v1.IGetKeyRequest	GetKeyRequest message or plain object
`callback`	google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.GetKeyCallback	Node-style callback called with the error, if any, and Key

Returns:

Type	Description
undefined

getKey(request) → {Promise.<google.cloud.recaptchaenterprise.v1.Key>}

Calls GetKey.

Parameters:

Name	Type	Description
`request`	google.cloud.recaptchaenterprise.v1.IGetKeyRequest	GetKeyRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.recaptchaenterprise.v1.Key>	Promise

getMetrics(request, callback) → {undefined}

Calls GetMetrics.

Parameters:

Name	Type	Description
`request`	google.cloud.recaptchaenterprise.v1.IGetMetricsRequest	GetMetricsRequest message or plain object
`callback`	google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.GetMetricsCallback	Node-style callback called with the error, if any, and Metrics

Returns:

Type	Description
undefined

getMetrics(request) → {Promise.<google.cloud.recaptchaenterprise.v1.Metrics>}

Calls GetMetrics.

Parameters:

Name	Type	Description
`request`	google.cloud.recaptchaenterprise.v1.IGetMetricsRequest	GetMetricsRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.recaptchaenterprise.v1.Metrics>	Promise

listFirewallPolicies(request, callback) → {undefined}

Calls ListFirewallPolicies.

Parameters:

Name	Type	Description
`request`	google.cloud.recaptchaenterprise.v1.IListFirewallPoliciesRequest	ListFirewallPoliciesRequest message or plain object
`callback`	google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.ListFirewallPoliciesCallback	Node-style callback called with the error, if any, and ListFirewallPoliciesResponse

Returns:

Type	Description
undefined

listFirewallPolicies(request) → {Promise.<google.cloud.recaptchaenterprise.v1.ListFirewallPoliciesResponse>}

Calls ListFirewallPolicies.

Parameters:

Name	Type	Description
`request`	google.cloud.recaptchaenterprise.v1.IListFirewallPoliciesRequest	ListFirewallPoliciesRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.recaptchaenterprise.v1.ListFirewallPoliciesResponse>	Promise

listKeys(request, callback) → {undefined}

Calls ListKeys.

Parameters:

Name	Type	Description
`request`	google.cloud.recaptchaenterprise.v1.IListKeysRequest	ListKeysRequest message or plain object
`callback`	google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.ListKeysCallback	Node-style callback called with the error, if any, and ListKeysResponse

Returns:

Type	Description
undefined

listKeys(request) → {Promise.<google.cloud.recaptchaenterprise.v1.ListKeysResponse>}

Calls ListKeys.

Parameters:

Name	Type	Description
`request`	google.cloud.recaptchaenterprise.v1.IListKeysRequest	ListKeysRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.recaptchaenterprise.v1.ListKeysResponse>	Promise

listRelatedAccountGroupMemberships(request, callback) → {undefined}

Calls ListRelatedAccountGroupMemberships.

Parameters:

Name	Type	Description
`request`	google.cloud.recaptchaenterprise.v1.IListRelatedAccountGroupMembershipsRequest	ListRelatedAccountGroupMembershipsRequest message or plain object
`callback`	google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.ListRelatedAccountGroupMembershipsCallback	Node-style callback called with the error, if any, and ListRelatedAccountGroupMembershipsResponse

Returns:

Type	Description
undefined

listRelatedAccountGroupMemberships(request) → {Promise.<google.cloud.recaptchaenterprise.v1.ListRelatedAccountGroupMembershipsResponse>}

Calls ListRelatedAccountGroupMemberships.

Parameters:

Name	Type	Description
`request`	google.cloud.recaptchaenterprise.v1.IListRelatedAccountGroupMembershipsRequest	ListRelatedAccountGroupMembershipsRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.recaptchaenterprise.v1.ListRelatedAccountGroupMembershipsResponse>	Promise

listRelatedAccountGroups(request, callback) → {undefined}

Calls ListRelatedAccountGroups.

Parameters:

Name	Type	Description
`request`	google.cloud.recaptchaenterprise.v1.IListRelatedAccountGroupsRequest	ListRelatedAccountGroupsRequest message or plain object
`callback`	google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.ListRelatedAccountGroupsCallback	Node-style callback called with the error, if any, and ListRelatedAccountGroupsResponse

Returns:

Type	Description
undefined

listRelatedAccountGroups(request) → {Promise.<google.cloud.recaptchaenterprise.v1.ListRelatedAccountGroupsResponse>}

Calls ListRelatedAccountGroups.

Parameters:

Name	Type	Description
`request`	google.cloud.recaptchaenterprise.v1.IListRelatedAccountGroupsRequest	ListRelatedAccountGroupsRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.recaptchaenterprise.v1.ListRelatedAccountGroupsResponse>	Promise

migrateKey(request, callback) → {undefined}

Calls MigrateKey.

Parameters:

Name	Type	Description
`request`	google.cloud.recaptchaenterprise.v1.IMigrateKeyRequest	MigrateKeyRequest message or plain object
`callback`	google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.MigrateKeyCallback	Node-style callback called with the error, if any, and Key

Returns:

Type	Description
undefined

migrateKey(request) → {Promise.<google.cloud.recaptchaenterprise.v1.Key>}

Calls MigrateKey.

Parameters:

Name	Type	Description
`request`	google.cloud.recaptchaenterprise.v1.IMigrateKeyRequest	MigrateKeyRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.recaptchaenterprise.v1.Key>	Promise

reorderFirewallPolicies(request, callback) → {undefined}

Calls ReorderFirewallPolicies.

Parameters:

Name	Type	Description
`request`	google.cloud.recaptchaenterprise.v1.IReorderFirewallPoliciesRequest	ReorderFirewallPoliciesRequest message or plain object
`callback`	google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.ReorderFirewallPoliciesCallback	Node-style callback called with the error, if any, and ReorderFirewallPoliciesResponse

Returns:

Type	Description
undefined

reorderFirewallPolicies(request) → {Promise.<google.cloud.recaptchaenterprise.v1.ReorderFirewallPoliciesResponse>}

Calls ReorderFirewallPolicies.

Parameters:

Name	Type	Description
`request`	google.cloud.recaptchaenterprise.v1.IReorderFirewallPoliciesRequest	ReorderFirewallPoliciesRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.recaptchaenterprise.v1.ReorderFirewallPoliciesResponse>	Promise

retrieveLegacySecretKey(request, callback) → {undefined}

Calls RetrieveLegacySecretKey.

Parameters:

Name	Type	Description
`request`	google.cloud.recaptchaenterprise.v1.IRetrieveLegacySecretKeyRequest	RetrieveLegacySecretKeyRequest message or plain object
`callback`	google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.RetrieveLegacySecretKeyCallback	Node-style callback called with the error, if any, and RetrieveLegacySecretKeyResponse

Returns:

Type	Description
undefined

retrieveLegacySecretKey(request) → {Promise.<google.cloud.recaptchaenterprise.v1.RetrieveLegacySecretKeyResponse>}

Calls RetrieveLegacySecretKey.

Parameters:

Name	Type	Description
`request`	google.cloud.recaptchaenterprise.v1.IRetrieveLegacySecretKeyRequest	RetrieveLegacySecretKeyRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.recaptchaenterprise.v1.RetrieveLegacySecretKeyResponse>	Promise

searchRelatedAccountGroupMemberships(request, callback) → {undefined}

Calls SearchRelatedAccountGroupMemberships.

Parameters:

Name	Type	Description
`request`	google.cloud.recaptchaenterprise.v1.ISearchRelatedAccountGroupMembershipsRequest	SearchRelatedAccountGroupMembershipsRequest message or plain object
`callback`	google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.SearchRelatedAccountGroupMembershipsCallback	Node-style callback called with the error, if any, and SearchRelatedAccountGroupMembershipsResponse

Returns:

Type	Description
undefined

searchRelatedAccountGroupMemberships(request) → {Promise.<google.cloud.recaptchaenterprise.v1.SearchRelatedAccountGroupMembershipsResponse>}

Calls SearchRelatedAccountGroupMemberships.

Parameters:

Name	Type	Description
`request`	google.cloud.recaptchaenterprise.v1.ISearchRelatedAccountGroupMembershipsRequest	SearchRelatedAccountGroupMembershipsRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.recaptchaenterprise.v1.SearchRelatedAccountGroupMembershipsResponse>	Promise

updateFirewallPolicy(request, callback) → {undefined}

Calls UpdateFirewallPolicy.

Parameters:

Name	Type	Description
`request`	google.cloud.recaptchaenterprise.v1.IUpdateFirewallPolicyRequest	UpdateFirewallPolicyRequest message or plain object
`callback`	google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.UpdateFirewallPolicyCallback	Node-style callback called with the error, if any, and FirewallPolicy

Returns:

Type	Description
undefined

updateFirewallPolicy(request) → {Promise.<google.cloud.recaptchaenterprise.v1.FirewallPolicy>}

Calls UpdateFirewallPolicy.

Parameters:

Name	Type	Description
`request`	google.cloud.recaptchaenterprise.v1.IUpdateFirewallPolicyRequest	UpdateFirewallPolicyRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.recaptchaenterprise.v1.FirewallPolicy>	Promise

updateKey(request, callback) → {undefined}

Calls UpdateKey.

Parameters:

Name	Type	Description
`request`	google.cloud.recaptchaenterprise.v1.IUpdateKeyRequest	UpdateKeyRequest message or plain object
`callback`	google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.UpdateKeyCallback	Node-style callback called with the error, if any, and Key

Returns:

Type	Description
undefined

updateKey(request) → {Promise.<google.cloud.recaptchaenterprise.v1.Key>}

Calls UpdateKey.

Parameters:

Name	Type	Description
`request`	google.cloud.recaptchaenterprise.v1.IUpdateKeyRequest	UpdateKeyRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.recaptchaenterprise.v1.Key>	Promise

(static) create(rpcImpl, requestDelimitedopt, responseDelimitedopt) → {RecaptchaEnterpriseService}

Creates new RecaptchaEnterpriseService service using the specified rpc implementation.

Parameters:

Name	Type	Attributes	Default	Description
`rpcImpl`	$protobuf.RPCImpl			RPC implementation
`requestDelimited`	boolean	<optional>	false	Whether requests are length-delimited
`responseDelimited`	boolean	<optional>	false	Whether responses are length-delimited

Returns:

Type	Description
RecaptchaEnterpriseService	RPC service. Useful where requests and/or responses are streamed.

Type Definitions

AnnotateAssessmentCallback(error, responseopt)

Callback as used by annotateAssessment.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.recaptchaenterprise.v1.AnnotateAssessmentResponse	<optional>	AnnotateAssessmentResponse

CreateAssessmentCallback(error, responseopt)

Callback as used by createAssessment.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.recaptchaenterprise.v1.Assessment	<optional>	Assessment

CreateFirewallPolicyCallback(error, responseopt)

Callback as used by createFirewallPolicy.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.recaptchaenterprise.v1.FirewallPolicy	<optional>	FirewallPolicy

CreateKeyCallback(error, responseopt)

Callback as used by createKey.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.recaptchaenterprise.v1.Key	<optional>	Key

DeleteFirewallPolicyCallback(error, responseopt)

Callback as used by deleteFirewallPolicy.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.protobuf.Empty	<optional>	Empty

DeleteKeyCallback(error, responseopt)

Callback as used by deleteKey.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.protobuf.Empty	<optional>	Empty

GetFirewallPolicyCallback(error, responseopt)

Callback as used by getFirewallPolicy.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.recaptchaenterprise.v1.FirewallPolicy	<optional>	FirewallPolicy

GetKeyCallback(error, responseopt)

Callback as used by getKey.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.recaptchaenterprise.v1.Key	<optional>	Key

GetMetricsCallback(error, responseopt)

Callback as used by getMetrics.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.recaptchaenterprise.v1.Metrics	<optional>	Metrics

ListFirewallPoliciesCallback(error, responseopt)

Callback as used by listFirewallPolicies.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.recaptchaenterprise.v1.ListFirewallPoliciesResponse	<optional>	ListFirewallPoliciesResponse

ListKeysCallback(error, responseopt)

Callback as used by listKeys.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.recaptchaenterprise.v1.ListKeysResponse	<optional>	ListKeysResponse

ListRelatedAccountGroupMembershipsCallback(error, responseopt)

Callback as used by listRelatedAccountGroupMemberships.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.recaptchaenterprise.v1.ListRelatedAccountGroupMembershipsResponse	<optional>	ListRelatedAccountGroupMembershipsResponse

ListRelatedAccountGroupsCallback(error, responseopt)

Callback as used by listRelatedAccountGroups.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.recaptchaenterprise.v1.ListRelatedAccountGroupsResponse	<optional>	ListRelatedAccountGroupsResponse

MigrateKeyCallback(error, responseopt)

Callback as used by migrateKey.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.recaptchaenterprise.v1.Key	<optional>	Key

ReorderFirewallPoliciesCallback(error, responseopt)

Callback as used by reorderFirewallPolicies.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.recaptchaenterprise.v1.ReorderFirewallPoliciesResponse	<optional>	ReorderFirewallPoliciesResponse

RetrieveLegacySecretKeyCallback(error, responseopt)

Callback as used by retrieveLegacySecretKey.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.recaptchaenterprise.v1.RetrieveLegacySecretKeyResponse	<optional>	RetrieveLegacySecretKeyResponse

SearchRelatedAccountGroupMembershipsCallback(error, responseopt)

Callback as used by searchRelatedAccountGroupMemberships.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.recaptchaenterprise.v1.SearchRelatedAccountGroupMembershipsResponse	<optional>	SearchRelatedAccountGroupMembershipsResponse

UpdateFirewallPolicyCallback(error, responseopt)

Callback as used by updateFirewallPolicy.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.recaptchaenterprise.v1.FirewallPolicy	<optional>	FirewallPolicy

UpdateKeyCallback(error, responseopt)

Callback as used by updateKey.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.recaptchaenterprise.v1.Key	<optional>	Key