RecaptchaEnterpriseService

google .cloud .recaptchaenterprise .v1. RecaptchaEnterpriseService

Represents a 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

(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.

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

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

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

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

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

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

Type Definitions

AnnotateAssessmentCallback(error, responseopt)

Callback as used by google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService#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 google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService#createAssessment.

Parameters:

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

CreateKeyCallback(error, responseopt)

Callback as used by google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService#createKey.

Parameters:

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

DeleteKeyCallback(error, responseopt)

Callback as used by google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService#deleteKey.

Parameters:

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

GetKeyCallback(error, responseopt)

Callback as used by google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService#getKey.

Parameters:

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

ListKeysCallback(error, responseopt)

Callback as used by google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService#listKeys.

Parameters:

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

UpdateKeyCallback(error, responseopt)

Callback as used by google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService#updateKey.

Parameters:

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