Class v1.RecaptchaEnterpriseServiceClient (2.1.7)

Service to determine the likelihood an event is legitimate. v1

Package

@google-cloud/recaptcha-enterprise!

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of RecaptchaEnterpriseServiceClient.

Parameter
Name Description
opts ClientOptions

Properties

apiEndpoint

static get apiEndpoint(): string;

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

Property Value
Type Description
string

auth

auth: gax.GoogleAuth;
Property Value
Type Description
gax.GoogleAuth

descriptors

descriptors: Descriptors;
Property Value
Type Description
Descriptors

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };
Property Value
Type Description
{ [name: string]: Function; }

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };
Property Value
Type Description
{ [name: string]: gax.PathTemplate; }

port

static get port(): number;

The port for this API service.

Property Value
Type Description
number

recaptchaEnterpriseServiceStub

recaptchaEnterpriseServiceStub?: Promise<{
        [name: string]: Function;
    }>;
Property Value
Type Description
Promise<{ [name: string]: Function; }>

scopes

static get scopes(): string[];

The scopes needed to make gRPC calls for every method defined in this service.

Property Value
Type Description
string[]

servicePath

static get servicePath(): string;

The DNS address for this API service.

Property Value
Type Description
string

warn

warn: (code: string, message: string, warnType?: string) => void;
Property Value
Type Description
(code: string, message: string, warnType?: string) => void

Methods

annotateAssessment(request, options)

annotateAssessment(request?: protos.google.cloud.recaptchaenterprise.v1.IAnnotateAssessmentRequest, options?: CallOptions): Promise<[protos.google.cloud.recaptchaenterprise.v1.IAnnotateAssessmentResponse, (protos.google.cloud.recaptchaenterprise.v1.IAnnotateAssessmentRequest | undefined), {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.recaptchaenterprise.v1.IAnnotateAssessmentRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.recaptchaenterprise.v1.IAnnotateAssessmentResponse, (protos.google.cloud.recaptchaenterprise.v1.IAnnotateAssessmentRequest | undefined), {} | undefined]>

annotateAssessment(request, options, callback)

annotateAssessment(request: protos.google.cloud.recaptchaenterprise.v1.IAnnotateAssessmentRequest, options: CallOptions, callback: Callback<protos.google.cloud.recaptchaenterprise.v1.IAnnotateAssessmentResponse, protos.google.cloud.recaptchaenterprise.v1.IAnnotateAssessmentRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.recaptchaenterprise.v1.IAnnotateAssessmentRequest
options CallOptions
callback Callback<protos.google.cloud.recaptchaenterprise.v1.IAnnotateAssessmentResponse, protos.google.cloud.recaptchaenterprise.v1.IAnnotateAssessmentRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

annotateAssessment(request, callback)

annotateAssessment(request: protos.google.cloud.recaptchaenterprise.v1.IAnnotateAssessmentRequest, callback: Callback<protos.google.cloud.recaptchaenterprise.v1.IAnnotateAssessmentResponse, protos.google.cloud.recaptchaenterprise.v1.IAnnotateAssessmentRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.recaptchaenterprise.v1.IAnnotateAssessmentRequest
callback Callback<protos.google.cloud.recaptchaenterprise.v1.IAnnotateAssessmentResponse, protos.google.cloud.recaptchaenterprise.v1.IAnnotateAssessmentRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

assessmentPath(project, assessment)

assessmentPath(project: string, assessment: string): string;

Return a fully-qualified assessment resource name string.

Parameters
Name Description
project string
assessment string
Returns
Type Description
string

{string} Resource name string.

close()

close(): Promise<void>;

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns
Type Description
Promise<void>

{Promise} A promise that resolves when the client is closed.

createAssessment(request, options)

createAssessment(request?: protos.google.cloud.recaptchaenterprise.v1.ICreateAssessmentRequest, options?: CallOptions): Promise<[protos.google.cloud.recaptchaenterprise.v1.IAssessment, (protos.google.cloud.recaptchaenterprise.v1.ICreateAssessmentRequest | undefined), {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.recaptchaenterprise.v1.ICreateAssessmentRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.recaptchaenterprise.v1.IAssessment, (protos.google.cloud.recaptchaenterprise.v1.ICreateAssessmentRequest | undefined), {} | undefined]>

createAssessment(request, options, callback)

createAssessment(request: protos.google.cloud.recaptchaenterprise.v1.ICreateAssessmentRequest, options: CallOptions, callback: Callback<protos.google.cloud.recaptchaenterprise.v1.IAssessment, protos.google.cloud.recaptchaenterprise.v1.ICreateAssessmentRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.recaptchaenterprise.v1.ICreateAssessmentRequest
options CallOptions
callback Callback<protos.google.cloud.recaptchaenterprise.v1.IAssessment, protos.google.cloud.recaptchaenterprise.v1.ICreateAssessmentRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

createAssessment(request, callback)

createAssessment(request: protos.google.cloud.recaptchaenterprise.v1.ICreateAssessmentRequest, callback: Callback<protos.google.cloud.recaptchaenterprise.v1.IAssessment, protos.google.cloud.recaptchaenterprise.v1.ICreateAssessmentRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.recaptchaenterprise.v1.ICreateAssessmentRequest
callback Callback<protos.google.cloud.recaptchaenterprise.v1.IAssessment, protos.google.cloud.recaptchaenterprise.v1.ICreateAssessmentRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

createKey(request, options)

createKey(request?: protos.google.cloud.recaptchaenterprise.v1.ICreateKeyRequest, options?: CallOptions): Promise<[protos.google.cloud.recaptchaenterprise.v1.IKey, protos.google.cloud.recaptchaenterprise.v1.ICreateKeyRequest | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.recaptchaenterprise.v1.ICreateKeyRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.recaptchaenterprise.v1.IKey, protos.google.cloud.recaptchaenterprise.v1.ICreateKeyRequest | undefined, {} | undefined]>

createKey(request, options, callback)

createKey(request: protos.google.cloud.recaptchaenterprise.v1.ICreateKeyRequest, options: CallOptions, callback: Callback<protos.google.cloud.recaptchaenterprise.v1.IKey, protos.google.cloud.recaptchaenterprise.v1.ICreateKeyRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.recaptchaenterprise.v1.ICreateKeyRequest
options CallOptions
callback Callback<protos.google.cloud.recaptchaenterprise.v1.IKey, protos.google.cloud.recaptchaenterprise.v1.ICreateKeyRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

createKey(request, callback)

createKey(request: protos.google.cloud.recaptchaenterprise.v1.ICreateKeyRequest, callback: Callback<protos.google.cloud.recaptchaenterprise.v1.IKey, protos.google.cloud.recaptchaenterprise.v1.ICreateKeyRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.recaptchaenterprise.v1.ICreateKeyRequest
callback Callback<protos.google.cloud.recaptchaenterprise.v1.IKey, protos.google.cloud.recaptchaenterprise.v1.ICreateKeyRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteKey(request, options)

deleteKey(request?: protos.google.cloud.recaptchaenterprise.v1.IDeleteKeyRequest, options?: CallOptions): Promise<[protos.google.protobuf.IEmpty, protos.google.cloud.recaptchaenterprise.v1.IDeleteKeyRequest | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.recaptchaenterprise.v1.IDeleteKeyRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.protobuf.IEmpty, protos.google.cloud.recaptchaenterprise.v1.IDeleteKeyRequest | undefined, {} | undefined]>

deleteKey(request, options, callback)

deleteKey(request: protos.google.cloud.recaptchaenterprise.v1.IDeleteKeyRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.recaptchaenterprise.v1.IDeleteKeyRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.recaptchaenterprise.v1.IDeleteKeyRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.recaptchaenterprise.v1.IDeleteKeyRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteKey(request, callback)

deleteKey(request: protos.google.cloud.recaptchaenterprise.v1.IDeleteKeyRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.recaptchaenterprise.v1.IDeleteKeyRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.recaptchaenterprise.v1.IDeleteKeyRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.recaptchaenterprise.v1.IDeleteKeyRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getKey(request, options)

getKey(request?: protos.google.cloud.recaptchaenterprise.v1.IGetKeyRequest, options?: CallOptions): Promise<[protos.google.cloud.recaptchaenterprise.v1.IKey, protos.google.cloud.recaptchaenterprise.v1.IGetKeyRequest | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.recaptchaenterprise.v1.IGetKeyRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.recaptchaenterprise.v1.IKey, protos.google.cloud.recaptchaenterprise.v1.IGetKeyRequest | undefined, {} | undefined]>

getKey(request, options, callback)

getKey(request: protos.google.cloud.recaptchaenterprise.v1.IGetKeyRequest, options: CallOptions, callback: Callback<protos.google.cloud.recaptchaenterprise.v1.IKey, protos.google.cloud.recaptchaenterprise.v1.IGetKeyRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.recaptchaenterprise.v1.IGetKeyRequest
options CallOptions
callback Callback<protos.google.cloud.recaptchaenterprise.v1.IKey, protos.google.cloud.recaptchaenterprise.v1.IGetKeyRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getKey(request, callback)

getKey(request: protos.google.cloud.recaptchaenterprise.v1.IGetKeyRequest, callback: Callback<protos.google.cloud.recaptchaenterprise.v1.IKey, protos.google.cloud.recaptchaenterprise.v1.IGetKeyRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.recaptchaenterprise.v1.IGetKeyRequest
callback Callback<protos.google.cloud.recaptchaenterprise.v1.IKey, protos.google.cloud.recaptchaenterprise.v1.IGetKeyRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getProjectId()

getProjectId(): Promise<string>;
Returns
Type Description
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
Name Description
callback Callback<string, undefined, undefined>
Returns
Type Description
void

initialize()

initialize(): Promise<{
        [name: string]: Function;
    }>;

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

Returns
Type Description
Promise<{ [name: string]: Function; }>

{Promise} A promise that resolves to an authenticated service stub.

keyPath(project, key)

keyPath(project: string, key: string): string;

Return a fully-qualified key resource name string.

Parameters
Name Description
project string
key string
Returns
Type Description
string

{string} Resource name string.

listKeys(request, options)

listKeys(request?: protos.google.cloud.recaptchaenterprise.v1.IListKeysRequest, options?: CallOptions): Promise<[protos.google.cloud.recaptchaenterprise.v1.IKey[], protos.google.cloud.recaptchaenterprise.v1.IListKeysRequest | null, protos.google.cloud.recaptchaenterprise.v1.IListKeysResponse]>;
Parameters
Name Description
request protos.google.cloud.recaptchaenterprise.v1.IListKeysRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.recaptchaenterprise.v1.IKey[], protos.google.cloud.recaptchaenterprise.v1.IListKeysRequest | null, protos.google.cloud.recaptchaenterprise.v1.IListKeysResponse]>

listKeys(request, options, callback)

listKeys(request: protos.google.cloud.recaptchaenterprise.v1.IListKeysRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.recaptchaenterprise.v1.IListKeysRequest, protos.google.cloud.recaptchaenterprise.v1.IListKeysResponse | null | undefined, protos.google.cloud.recaptchaenterprise.v1.IKey>): void;
Parameters
Name Description
request protos.google.cloud.recaptchaenterprise.v1.IListKeysRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.recaptchaenterprise.v1.IListKeysRequest, protos.google.cloud.recaptchaenterprise.v1.IListKeysResponse | null | undefined, protos.google.cloud.recaptchaenterprise.v1.IKey>
Returns
Type Description
void

listKeys(request, callback)

listKeys(request: protos.google.cloud.recaptchaenterprise.v1.IListKeysRequest, callback: PaginationCallback<protos.google.cloud.recaptchaenterprise.v1.IListKeysRequest, protos.google.cloud.recaptchaenterprise.v1.IListKeysResponse | null | undefined, protos.google.cloud.recaptchaenterprise.v1.IKey>): void;
Parameters
Name Description
request protos.google.cloud.recaptchaenterprise.v1.IListKeysRequest
callback PaginationCallback<protos.google.cloud.recaptchaenterprise.v1.IListKeysRequest, protos.google.cloud.recaptchaenterprise.v1.IListKeysResponse | null | undefined, protos.google.cloud.recaptchaenterprise.v1.IKey>
Returns
Type Description
void

listKeysAsync(request, options)

listKeysAsync(request?: protos.google.cloud.recaptchaenterprise.v1.IListKeysRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.recaptchaenterprise.v1.IKey>;

Equivalent to listKeys, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name Description
request protos.google.cloud.recaptchaenterprise.v1.IListKeysRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
AsyncIterable<protos.google.cloud.recaptchaenterprise.v1.IKey>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Key]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listKeysStream(request, options)

listKeysStream(request?: protos.google.cloud.recaptchaenterprise.v1.IListKeysRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name Description
request protos.google.cloud.recaptchaenterprise.v1.IListKeysRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Transform

{Stream} An object stream which emits an object representing [Key] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listKeysAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

matchAssessmentFromAssessmentName(assessmentName)

matchAssessmentFromAssessmentName(assessmentName: string): string | number;

Parse the assessment from Assessment resource.

Parameter
Name Description
assessmentName string

A fully-qualified path representing Assessment resource.
Returns
Type Description
string | number

{string} A string representing the assessment.

matchKeyFromKeyName(keyName)

matchKeyFromKeyName(keyName: string): string | number;

Parse the key from Key resource.

Parameter
Name Description
keyName string

A fully-qualified path representing Key resource.
Returns
Type Description
string | number

{string} A string representing the key.

matchProjectFromAssessmentName(assessmentName)

matchProjectFromAssessmentName(assessmentName: string): string | number;

Parse the project from Assessment resource.

Parameter
Name Description
assessmentName string

A fully-qualified path representing Assessment resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromKeyName(keyName)

matchProjectFromKeyName(keyName: string): string | number;

Parse the project from Key resource.

Parameter
Name Description
keyName string

A fully-qualified path representing Key resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectName(projectName)

matchProjectFromProjectName(projectName: string): string | number;

Parse the project from Project resource.

Parameter
Name Description
projectName string

A fully-qualified path representing Project resource.
Returns
Type Description
string | number

{string} A string representing the project.

projectPath(project)

projectPath(project: string): string;

Return a fully-qualified project resource name string.

Parameter
Name Description
project string
Returns
Type Description
string

{string} Resource name string.

updateKey(request, options)

updateKey(request?: protos.google.cloud.recaptchaenterprise.v1.IUpdateKeyRequest, options?: CallOptions): Promise<[protos.google.cloud.recaptchaenterprise.v1.IKey, protos.google.cloud.recaptchaenterprise.v1.IUpdateKeyRequest | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.recaptchaenterprise.v1.IUpdateKeyRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.recaptchaenterprise.v1.IKey, protos.google.cloud.recaptchaenterprise.v1.IUpdateKeyRequest | undefined, {} | undefined]>

updateKey(request, options, callback)

updateKey(request: protos.google.cloud.recaptchaenterprise.v1.IUpdateKeyRequest, options: CallOptions, callback: Callback<protos.google.cloud.recaptchaenterprise.v1.IKey, protos.google.cloud.recaptchaenterprise.v1.IUpdateKeyRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.recaptchaenterprise.v1.IUpdateKeyRequest
options CallOptions
callback Callback<protos.google.cloud.recaptchaenterprise.v1.IKey, protos.google.cloud.recaptchaenterprise.v1.IUpdateKeyRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateKey(request, callback)

updateKey(request: protos.google.cloud.recaptchaenterprise.v1.IUpdateKeyRequest, callback: Callback<protos.google.cloud.recaptchaenterprise.v1.IKey, protos.google.cloud.recaptchaenterprise.v1.IUpdateKeyRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.recaptchaenterprise.v1.IUpdateKeyRequest
callback Callback<protos.google.cloud.recaptchaenterprise.v1.IKey, protos.google.cloud.recaptchaenterprise.v1.IUpdateKeyRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void