RecaptchaEnterpriseServiceClient

RecaptchaEnterpriseServiceClient

Service to determine the likelihood an event is legitimate.

Constructor

new RecaptchaEnterpriseServiceClient(optionsopt)

Construct an instance of RecaptchaEnterpriseServiceClient.

Parameters:
Name Type Attributes Description
options object <optional>

The configuration object. The options accepted by the constructor are described in detail in this document. The common options are:

Properties
Name Type Attributes Description
credentials object <optional>

Credentials object.

Properties
Name Type Attributes Description
client_email string <optional>
private_key string <optional>
email string <optional>

Account email address. Required when using a .pem or .p12 keyFilename.
keyFilename string <optional>

Full path to the a .json, .pem, or .p12 key downloaded from the Google Developers Console. If you provide a path to a JSON file, the projectId option below is not necessary. NOTE: .pem and .p12 require you to specify options.email as well.
port number <optional>

The port on which to connect to the remote host.
projectId string <optional>

The project ID from the Google Developer's Console, e.g. 'grape-spaceship-123'. We will also check the environment variable GCLOUD_PROJECT for your project ID. If your app is running in an environment which supports Application Default Credentials, your project ID will be detected automatically.
apiEndpoint string <optional>

The domain name of the API remote host.
clientConfig gax.ClientConfig <optional>

Client configuration override. Follows the structure of gapicConfig.
fallback boolean <optional>

Use HTTP fallback mode. In fallback mode, a special browser-compatible transport implementation is used instead of gRPC transport. In browser context (if the window object is defined) the fallback mode is enabled automatically; set options.fallback to false if you need to override this behavior.

Members

apiEndpoint

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

port

The port for this API service.

scopes

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

servicePath

The DNS address for this API service.

Methods

annotateAssessment(request, optionsopt) → {Promise}

Annotates a previously created Assessment to provide additional information on whether the event turned out to be authentic or fradulent.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Required. The resource name of the Assessment, in the format "projects/{project}/assessments/{assessment}".
annotation google.cloud.recaptchaenterprise.v1.AnnotateAssessmentRequest.Annotation

Required. The annotation that will be assigned to the Event.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
Example
const [response] = await client.annotateAssessment(request);

assessmentPath(project, assessment) → {string}

Return a fully-qualified assessment resource name string.

Parameters:
Name Type Description
project string
assessment string
Returns:
Type Description
string

Resource name string.

close() → {Promise}

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

A promise that resolves when the client is closed.

createAssessment(request, optionsopt) → {Promise}

Creates an Assessment of the likelihood an event is legitimate.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The name of the project in which the assessment will be created, in the format "projects/{project}".
assessment google.cloud.recaptchaenterprise.v1.Assessment

Required. The assessment details.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing Assessment. Please see the documentation for more details and examples.
Example
const [response] = await client.createAssessment(request);

createKey(request, optionsopt) → {Promise}

Creates a new reCAPTCHA Enterprise key.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The name of the project in which the key will be created, in the format "projects/{project}".
key google.cloud.recaptchaenterprise.v1.Key

Required. Information to create a reCAPTCHA Enterprise key.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing Key. Please see the documentation for more details and examples.
Example
const [response] = await client.createKey(request);

deleteKey(request, optionsopt) → {Promise}

Deletes the specified key.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Required. The name of the key to be deleted, in the format "projects/{project}/keys/{key}".
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing Empty. Please see the documentation for more details and examples.
Example
const [response] = await client.deleteKey(request);

getKey(request, optionsopt) → {Promise}

Returns the specified key.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Required. The name of the requested key, in the format "projects/{project}/keys/{key}".
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing Key. Please see the documentation for more details and examples.
Example
const [response] = await client.getKey(request);

getProjectId() → {Promise}

Return the project ID used by this class.

Returns:
Type Description
Promise

A promise that resolves to string containing the project ID.

initialize() → {Promise}

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

A promise that resolves to an authenticated service stub.

keyPath(project, key) → {string}

Return a fully-qualified key resource name string.

Parameters:
Name Type Description
project string
key string
Returns:
Type Description
string

Resource name string.

listKeys(request, optionsopt) → {Promise}

Returns the list of all keys that belong to a project.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

Required. The name of the project that contains the keys that will be listed, in the format "projects/{project}".
pageSize number <optional>

Optional. The maximum number of keys to return. Default is 10. Max limit is 1000.
pageToken string <optional>

Optional. The next_page_token value returned from a previous. ListKeysRequest, if any.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is Array of Key. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. 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 for more details and examples.

listKeysAsync(request, optionsopt) → {Object}

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 Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

Required. The name of the project that contains the keys that will be listed, in the format "projects/{project}".
pageSize number <optional>

Optional. The maximum number of keys to return. Default is 10. Max limit is 1000.
pageToken string <optional>

Optional. The next_page_token value returned from a previous. ListKeysRequest, if any.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Object

An iterable Object that allows async iteration. 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 for more details and examples.
Example
const iterable = client.listKeysAsync(request);
for await (const response of iterable) {
  // process response
}

listKeysStream(request, optionsopt) → {Stream}

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

Required. The name of the project that contains the keys that will be listed, in the format "projects/{project}".
pageSize number <optional>

Optional. The maximum number of keys to return. Default is 10. Max limit is 1000.
pageToken string <optional>

Optional. The next_page_token value returned from a previous. ListKeysRequest, if any.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
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 for more details and examples.

matchAssessmentFromAssessmentName(assessmentName) → {string}

Parse the assessment from Assessment resource.

Parameters:
Name Type Description
assessmentName string

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

A string representing the assessment.

matchKeyFromKeyName(keyName) → {string}

Parse the key from Key resource.

Parameters:
Name Type Description
keyName string

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

A string representing the key.

matchProjectFromAssessmentName(assessmentName) → {string}

Parse the project from Assessment resource.

Parameters:
Name Type Description
assessmentName string

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

A string representing the project.

matchProjectFromKeyName(keyName) → {string}

Parse the project from Key resource.

Parameters:
Name Type Description
keyName string

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

A string representing the project.

matchProjectFromProjectName(projectName) → {string}

Parse the project from Project resource.

Parameters:
Name Type Description
projectName string

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

A string representing the project.

projectPath(project) → {string}

Return a fully-qualified project resource name string.

Parameters:
Name Type Description
project string
Returns:
Type Description
string

Resource name string.

updateKey(request, optionsopt) → {Promise}

Updates the specified key.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
key google.cloud.recaptchaenterprise.v1.Key

Required. The key to update.
updateMask google.protobuf.FieldMask <optional>

Optional. The mask to control which field of the key get updated. If the mask is not present, all fields will be updated.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing Key. Please see the documentation for more details and examples.
Example
const [response] = await client.updateKey(request);