Class protos.google.cloud.recaptchaenterprise.v1beta1.RecaptchaEnterpriseServiceV1Beta1 (2.5.0)

Represents a RecaptchaEnterpriseServiceV1Beta1

Inheritance

$protobuf.rpc.Service > protos.google.cloud.recaptchaenterprise.v1beta1.RecaptchaEnterpriseServiceV1Beta1

Package

@google-cloud/recaptcha-enterprise

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new RecaptchaEnterpriseServiceV1Beta1 service.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited

Methods

annotateAssessment(request, callback)

public annotateAssessment(request: google.cloud.recaptchaenterprise.v1beta1.IAnnotateAssessmentRequest, callback: google.cloud.recaptchaenterprise.v1beta1.RecaptchaEnterpriseServiceV1Beta1.AnnotateAssessmentCallback): void;

Calls AnnotateAssessment.

Parameters
Name Description
request 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
void

annotateAssessment(request)

public annotateAssessment(request: google.cloud.recaptchaenterprise.v1beta1.IAnnotateAssessmentRequest): Promise<google.cloud.recaptchaenterprise.v1beta1.AnnotateAssessmentResponse>;

Calls AnnotateAssessment.

Parameter
Name Description
request IAnnotateAssessmentRequest

AnnotateAssessmentRequest message or plain object
Returns
Type Description
Promise<google.cloud.recaptchaenterprise.v1beta1.AnnotateAssessmentResponse>

Promise

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): RecaptchaEnterpriseServiceV1Beta1;

Creates new RecaptchaEnterpriseServiceV1Beta1 service using the specified rpc implementation.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited
Returns
Type Description
RecaptchaEnterpriseServiceV1Beta1

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

createAssessment(request, callback)

public createAssessment(request: google.cloud.recaptchaenterprise.v1beta1.ICreateAssessmentRequest, callback: google.cloud.recaptchaenterprise.v1beta1.RecaptchaEnterpriseServiceV1Beta1.CreateAssessmentCallback): void;

Calls CreateAssessment.

Parameters
Name Description
request 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
void

createAssessment(request)

public createAssessment(request: google.cloud.recaptchaenterprise.v1beta1.ICreateAssessmentRequest): Promise<google.cloud.recaptchaenterprise.v1beta1.Assessment>;

Calls CreateAssessment.

Parameter
Name Description
request ICreateAssessmentRequest

CreateAssessmentRequest message or plain object
Returns
Type Description
Promise<google.cloud.recaptchaenterprise.v1beta1.Assessment>

Promise

createKey(request, callback)

public createKey(request: google.cloud.recaptchaenterprise.v1beta1.ICreateKeyRequest, callback: google.cloud.recaptchaenterprise.v1beta1.RecaptchaEnterpriseServiceV1Beta1.CreateKeyCallback): void;

Calls CreateKey.

Parameters
Name 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
void

createKey(request)

public createKey(request: google.cloud.recaptchaenterprise.v1beta1.ICreateKeyRequest): Promise<google.cloud.recaptchaenterprise.v1beta1.Key>;

Calls CreateKey.

Parameter
Name 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)

public deleteKey(request: google.cloud.recaptchaenterprise.v1beta1.IDeleteKeyRequest, callback: google.cloud.recaptchaenterprise.v1beta1.RecaptchaEnterpriseServiceV1Beta1.DeleteKeyCallback): void;

Calls DeleteKey.

Parameters
Name 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
void

deleteKey(request)

public deleteKey(request: google.cloud.recaptchaenterprise.v1beta1.IDeleteKeyRequest): Promise<google.protobuf.Empty>;

Calls DeleteKey.

Parameter
Name Description
request google.cloud.recaptchaenterprise.v1beta1.IDeleteKeyRequest

DeleteKeyRequest message or plain object
Returns
Type Description
Promise<google.protobuf.Empty>

Promise

getKey(request, callback)

public getKey(request: google.cloud.recaptchaenterprise.v1beta1.IGetKeyRequest, callback: google.cloud.recaptchaenterprise.v1beta1.RecaptchaEnterpriseServiceV1Beta1.GetKeyCallback): void;

Calls GetKey.

Parameters
Name Description
request 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
void

getKey(request)

public getKey(request: google.cloud.recaptchaenterprise.v1beta1.IGetKeyRequest): Promise<google.cloud.recaptchaenterprise.v1beta1.Key>;

Calls GetKey.

Parameter
Name Description
request IGetKeyRequest

GetKeyRequest message or plain object
Returns
Type Description
Promise<google.cloud.recaptchaenterprise.v1beta1.Key>

Promise

listKeys(request, callback)

public listKeys(request: google.cloud.recaptchaenterprise.v1beta1.IListKeysRequest, callback: google.cloud.recaptchaenterprise.v1beta1.RecaptchaEnterpriseServiceV1Beta1.ListKeysCallback): void;

Calls ListKeys.

Parameters
Name 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
void

listKeys(request)

public listKeys(request: google.cloud.recaptchaenterprise.v1beta1.IListKeysRequest): Promise<google.cloud.recaptchaenterprise.v1beta1.ListKeysResponse>;

Calls ListKeys.

Parameter
Name 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)

public updateKey(request: google.cloud.recaptchaenterprise.v1beta1.IUpdateKeyRequest, callback: google.cloud.recaptchaenterprise.v1beta1.RecaptchaEnterpriseServiceV1Beta1.UpdateKeyCallback): void;

Calls UpdateKey.

Parameters
Name Description
request 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
void

updateKey(request)

public updateKey(request: google.cloud.recaptchaenterprise.v1beta1.IUpdateKeyRequest): Promise<google.cloud.recaptchaenterprise.v1beta1.Key>;

Calls UpdateKey.

Parameter
Name Description
request IUpdateKeyRequest

UpdateKeyRequest message or plain object
Returns
Type Description
Promise<google.cloud.recaptchaenterprise.v1beta1.Key>

Promise