Class protos.google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService (2.4.0)

Represents a RecaptchaEnterpriseService

Inheritance

$protobuf.rpc.Service > protos.google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService

Package

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

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

Constructs a new RecaptchaEnterpriseService 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.v1.IAnnotateAssessmentRequest, callback: google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.AnnotateAssessmentCallback): void;

Calls AnnotateAssessment.

Parameters

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

annotateAssessment(request)

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

Calls AnnotateAssessment.

Parameter

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

Returns

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

create(rpcImpl, requestDelimited, responseDelimited)

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

Creates new RecaptchaEnterpriseService 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
RecaptchaEnterpriseService	RPC service. Useful where requests and/or responses are streamed.

createAssessment(request, callback)

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

Calls CreateAssessment.

Parameters

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

createAssessment(request)

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

Calls CreateAssessment.

Parameter

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

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

Calls CreateKey.

Parameters

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

createKey(request)

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

Calls CreateKey.

Parameter

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

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

Calls DeleteKey.

Parameters

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

deleteKey(request)

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

Calls DeleteKey.

Parameter

Name	Description
request	`IDeleteKeyRequest` DeleteKeyRequest message or plain object

Returns

Type	Description
Promise<google.protobuf.Empty>	Promise

getKey(request, callback)

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

Calls GetKey.

Parameters

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

getKey(request)

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

Calls GetKey.

Parameter

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

public getMetrics(request: google.cloud.recaptchaenterprise.v1.IGetMetricsRequest, callback: google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.GetMetricsCallback): void;

Calls GetMetrics.

Parameters

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

getMetrics(request)

public getMetrics(request: google.cloud.recaptchaenterprise.v1.IGetMetricsRequest): Promise<google.cloud.recaptchaenterprise.v1.Metrics>;

Calls GetMetrics.

Parameter

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

Returns

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

listKeys(request, callback)

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

Calls ListKeys.

Parameters

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

listKeys(request)

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

Calls ListKeys.

Parameter

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

public listRelatedAccountGroupMemberships(request: google.cloud.recaptchaenterprise.v1.IListRelatedAccountGroupMembershipsRequest, callback: google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.ListRelatedAccountGroupMembershipsCallback): void;

Calls ListRelatedAccountGroupMemberships.

Parameters

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

listRelatedAccountGroupMemberships(request)

public listRelatedAccountGroupMemberships(request: google.cloud.recaptchaenterprise.v1.IListRelatedAccountGroupMembershipsRequest): Promise<google.cloud.recaptchaenterprise.v1.ListRelatedAccountGroupMembershipsResponse>;

Calls ListRelatedAccountGroupMemberships.

Parameter

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

public listRelatedAccountGroups(request: google.cloud.recaptchaenterprise.v1.IListRelatedAccountGroupsRequest, callback: google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.ListRelatedAccountGroupsCallback): void;

Calls ListRelatedAccountGroups.

Parameters

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

listRelatedAccountGroups(request)

public listRelatedAccountGroups(request: google.cloud.recaptchaenterprise.v1.IListRelatedAccountGroupsRequest): Promise<google.cloud.recaptchaenterprise.v1.ListRelatedAccountGroupsResponse>;

Calls ListRelatedAccountGroups.

Parameter

Name	Description
request	`IListRelatedAccountGroupsRequest` ListRelatedAccountGroupsRequest message or plain object

Returns

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

migrateKey(request, callback)

public migrateKey(request: google.cloud.recaptchaenterprise.v1.IMigrateKeyRequest, callback: google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.MigrateKeyCallback): void;

Calls MigrateKey.

Parameters

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

migrateKey(request)

public migrateKey(request: google.cloud.recaptchaenterprise.v1.IMigrateKeyRequest): Promise<google.cloud.recaptchaenterprise.v1.Key>;

Calls MigrateKey.

Parameter

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

Returns

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

searchRelatedAccountGroupMemberships(request, callback)

public searchRelatedAccountGroupMemberships(request: google.cloud.recaptchaenterprise.v1.ISearchRelatedAccountGroupMembershipsRequest, callback: google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseService.SearchRelatedAccountGroupMembershipsCallback): void;

Calls SearchRelatedAccountGroupMemberships.

Parameters

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

searchRelatedAccountGroupMemberships(request)

public searchRelatedAccountGroupMemberships(request: google.cloud.recaptchaenterprise.v1.ISearchRelatedAccountGroupMembershipsRequest): Promise<google.cloud.recaptchaenterprise.v1.SearchRelatedAccountGroupMembershipsResponse>;

Calls SearchRelatedAccountGroupMemberships.

Parameter

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

Returns

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

updateKey(request, callback)

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

Calls UpdateKey.

Parameters

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

updateKey(request)

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

Calls UpdateKey.

Parameter

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

Returns

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