RecaptchaEnterpriseServiceV1Beta1

google.cloud.recaptchaenterprise.v1beta1. RecaptchaEnterpriseServiceV1Beta1

Represents a RecaptchaEnterpriseServiceV1Beta1

Constructor

new RecaptchaEnterpriseServiceV1Beta1(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new RecaptchaEnterpriseServiceV1Beta1 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.v1beta1.IAnnotateAssessmentRequest

AnnotateAssessmentRequest message or plain object

callback google.cloud.recaptchaenterprise.v1beta1.RecaptchaEnterpriseServiceV1Beta1.AnnotateAssessmentCallback

Node-style callback called with the error, if any, and AnnotateAssessmentResponse

Returns:
Type Description
undefined

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

Calls AnnotateAssessment.

Parameters:
Name Type Description
request google.cloud.recaptchaenterprise.v1beta1.IAnnotateAssessmentRequest

AnnotateAssessmentRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.recaptchaenterprise.v1beta1.AnnotateAssessmentResponse>

Promise

createAssessment(request, callback) → {undefined}

Calls CreateAssessment.

Parameters:
Name Type Description
request google.cloud.recaptchaenterprise.v1beta1.ICreateAssessmentRequest

CreateAssessmentRequest message or plain object

callback google.cloud.recaptchaenterprise.v1beta1.RecaptchaEnterpriseServiceV1Beta1.CreateAssessmentCallback

Node-style callback called with the error, if any, and Assessment

Returns:
Type Description
undefined

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

Calls CreateAssessment.

Parameters:
Name Type Description
request google.cloud.recaptchaenterprise.v1beta1.ICreateAssessmentRequest

CreateAssessmentRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.recaptchaenterprise.v1beta1.Assessment>

Promise

createKey(request, callback) → {undefined}

Calls CreateKey.

Parameters:
Name Type Description
request google.cloud.recaptchaenterprise.v1beta1.ICreateKeyRequest

CreateKeyRequest message or plain object

callback google.cloud.recaptchaenterprise.v1beta1.RecaptchaEnterpriseServiceV1Beta1.CreateKeyCallback

Node-style callback called with the error, if any, and Key

Returns:
Type Description
undefined

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

Calls CreateKey.

Parameters:
Name Type Description
request google.cloud.recaptchaenterprise.v1beta1.ICreateKeyRequest

CreateKeyRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.recaptchaenterprise.v1beta1.Key>

Promise

deleteKey(request, callback) → {undefined}

Calls DeleteKey.

Parameters:
Name Type Description
request google.cloud.recaptchaenterprise.v1beta1.IDeleteKeyRequest

DeleteKeyRequest message or plain object

callback google.cloud.recaptchaenterprise.v1beta1.RecaptchaEnterpriseServiceV1Beta1.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.v1beta1.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.v1beta1.IGetKeyRequest

GetKeyRequest message or plain object

callback google.cloud.recaptchaenterprise.v1beta1.RecaptchaEnterpriseServiceV1Beta1.GetKeyCallback

Node-style callback called with the error, if any, and Key

Returns:
Type Description
undefined

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

Calls GetKey.

Parameters:
Name Type Description
request google.cloud.recaptchaenterprise.v1beta1.IGetKeyRequest

GetKeyRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.recaptchaenterprise.v1beta1.Key>

Promise

listKeys(request, callback) → {undefined}

Calls ListKeys.

Parameters:
Name Type Description
request google.cloud.recaptchaenterprise.v1beta1.IListKeysRequest

ListKeysRequest message or plain object

callback google.cloud.recaptchaenterprise.v1beta1.RecaptchaEnterpriseServiceV1Beta1.ListKeysCallback

Node-style callback called with the error, if any, and ListKeysResponse

Returns:
Type Description
undefined

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

Calls ListKeys.

Parameters:
Name Type Description
request google.cloud.recaptchaenterprise.v1beta1.IListKeysRequest

ListKeysRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.recaptchaenterprise.v1beta1.ListKeysResponse>

Promise

updateKey(request, callback) → {undefined}

Calls UpdateKey.

Parameters:
Name Type Description
request google.cloud.recaptchaenterprise.v1beta1.IUpdateKeyRequest

UpdateKeyRequest message or plain object

callback google.cloud.recaptchaenterprise.v1beta1.RecaptchaEnterpriseServiceV1Beta1.UpdateKeyCallback

Node-style callback called with the error, if any, and Key

Returns:
Type Description
undefined

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

Calls UpdateKey.

Parameters:
Name Type Description
request google.cloud.recaptchaenterprise.v1beta1.IUpdateKeyRequest

UpdateKeyRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.recaptchaenterprise.v1beta1.Key>

Promise

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

Creates new RecaptchaEnterpriseServiceV1Beta1 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
RecaptchaEnterpriseServiceV1Beta1

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

Type Definitions

AnnotateAssessmentCallback(error, responseopt)

Callback as used by google.cloud.recaptchaenterprise.v1beta1.RecaptchaEnterpriseServiceV1Beta1#annotateAssessment.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.recaptchaenterprise.v1beta1.AnnotateAssessmentResponse <optional>

AnnotateAssessmentResponse

CreateAssessmentCallback(error, responseopt)

Callback as used by google.cloud.recaptchaenterprise.v1beta1.RecaptchaEnterpriseServiceV1Beta1#createAssessment.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.recaptchaenterprise.v1beta1.Assessment <optional>

Assessment

CreateKeyCallback(error, responseopt)

Callback as used by google.cloud.recaptchaenterprise.v1beta1.RecaptchaEnterpriseServiceV1Beta1#createKey.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.recaptchaenterprise.v1beta1.Key <optional>

Key

DeleteKeyCallback(error, responseopt)

Callback as used by google.cloud.recaptchaenterprise.v1beta1.RecaptchaEnterpriseServiceV1Beta1#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.v1beta1.RecaptchaEnterpriseServiceV1Beta1#getKey.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.recaptchaenterprise.v1beta1.Key <optional>

Key

ListKeysCallback(error, responseopt)

Callback as used by google.cloud.recaptchaenterprise.v1beta1.RecaptchaEnterpriseServiceV1Beta1#listKeys.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.recaptchaenterprise.v1beta1.ListKeysResponse <optional>

ListKeysResponse

UpdateKeyCallback(error, responseopt)

Callback as used by google.cloud.recaptchaenterprise.v1beta1.RecaptchaEnterpriseServiceV1Beta1#updateKey.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.recaptchaenterprise.v1beta1.Key <optional>

Key