RecaptchaEnterpriseServiceClient

Constructor

new RecaptchaEnterpriseServiceClient(optionsopt, gaxInstanceopt)

Construct an instance of RecaptchaEnterpriseServiceClient.

Parameters:

Name Type Attributes Description

options

object

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

Credentials object.

Properties

Name	Type	Attributes	Description
`client_email`	string	<optional>
`private_key`	string	<optional>

email

string

Account email address. Required when using a .pem or .p12 keyFilename.

keyFilename

string

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

The port on which to connect to the remote host.

projectId

string

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

The domain name of the API remote host.

clientConfig

gax.ClientConfig

Client configuration override. Follows the structure of gapicConfig.

fallback

boolean

Use HTTP/1.1 REST mode. For more information, please check the documentation.

gaxInstance

gax

loaded instance of google-gax. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new RecaptchaEnterpriseServiceClient({fallback: true}, gax);

Members

apiEndpoint

The DNS address for this API service.

apiEndpoint

The DNS address for this API service - same as servicePath.

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

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.

firewallPolicyPath(project, firewallpolicy) → {string}

Return a fully-qualified firewallPolicy resource name string.

Parameters:

Name	Type	Description
`project`	string
`firewallpolicy`	string

Returns:

Type	Description
string	Resource name string.

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.

listFirewallPoliciesAsync(request, optionsopt) → {Object}

Equivalent to listFirewallPolicies, 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 to list the policies for, in the format `projects/{project}`.
`pageSize`	number	<optional>	Optional. The maximum number of policies to return. Default is 10. Max limit is 1000.
`pageToken`	string	<optional>	Optional. The next_page_token value returned from a previous. ListFirewallPoliciesRequest, if any.

options

object

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 FirewallPolicy. 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

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the project to list the policies for, in the format
   *  `projects/{project}`.
   */
  // const parent = 'abc123'
  /**
   *  Optional. The maximum number of policies to return. Default is 10. Max
   *  limit is 1000.
   */
  // const pageSize = 1234
  /**
   *  Optional. The next_page_token value returned from a previous.
   *  ListFirewallPoliciesRequest, if any.
   */
  // const pageToken = 'abc123'

  // Imports the Recaptchaenterprise library
  const {RecaptchaEnterpriseServiceClient} = require('@google-cloud/recaptcha-enterprise').v1;

  // Instantiates a client
  const recaptchaenterpriseClient = new RecaptchaEnterpriseServiceClient();

  async function callListFirewallPolicies() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = recaptchaenterpriseClient.listFirewallPoliciesAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListFirewallPolicies();

listFirewallPoliciesStream(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 to list the policies for, in the format `projects/{project}`.
`pageSize`	number	<optional>	Optional. The maximum number of policies to return. Default is 10. Max limit is 1000.
`pageToken`	string	<optional>	Optional. The next_page_token value returned from a previous. ListFirewallPoliciesRequest, if any.

options

object

Call options. See CallOptions for more details.

Returns:

Type Description

Type	Description
Stream	An object stream which emits an object representing FirewallPolicy 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 `listFirewallPoliciesAsync()` method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

Stream

An object stream which emits an object representing FirewallPolicy 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 listFirewallPoliciesAsync() 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

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

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the project that contains the keys that will be
   *  listed, in the format `projects/{project}`.
   */
  // const parent = 'abc123'
  /**
   *  Optional. The maximum number of keys to return. Default is 10. Max limit is
   *  1000.
   */
  // const pageSize = 1234
  /**
   *  Optional. The next_page_token value returned from a previous.
   *  ListKeysRequest, if any.
   */
  // const pageToken = 'abc123'

  // Imports the Recaptchaenterprise library
  const {RecaptchaEnterpriseServiceClient} = require('@google-cloud/recaptcha-enterprise').v1;

  // Instantiates a client
  const recaptchaenterpriseClient = new RecaptchaEnterpriseServiceClient();

  async function callListKeys() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = recaptchaenterpriseClient.listKeysAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListKeys();

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

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.

listRelatedAccountGroupMembershipsAsync(request, optionsopt) → {Object}

Equivalent to listRelatedAccountGroupMemberships, 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 resource name for the related account group in the format projects/{project}/relatedaccountgroups/{relatedaccountgroup}.

pageSize

number

Optional. The maximum number of accounts to return. The service might return fewer than this value. If unspecified, at most 50 accounts are returned. The maximum value is 1000; values above 1000 are coerced to 1000.

pageToken

string

Optional. A page token, received from a previous ListRelatedAccountGroupMemberships call.

When paginating, all other parameters provided to ListRelatedAccountGroupMemberships must match the call that provided the page token.

options

object

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 RelatedAccountGroupMembership. 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

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name for the related account group in the format
   *  `projects/{project}/relatedaccountgroups/{relatedaccountgroup}`.
   */
  // const parent = 'abc123'
  /**
   *  Optional. The maximum number of accounts to return. The service might
   *  return fewer than this value. If unspecified, at most 50 accounts are
   *  returned. The maximum value is 1000; values above 1000 are coerced to 1000.
   */
  // const pageSize = 1234
  /**
   *  Optional. A page token, received from a previous
   *  `ListRelatedAccountGroupMemberships` call.
   *  When paginating, all other parameters provided to
   *  `ListRelatedAccountGroupMemberships` must match the call that provided the
   *  page token.
   */
  // const pageToken = 'abc123'

  // Imports the Recaptchaenterprise library
  const {RecaptchaEnterpriseServiceClient} = require('@google-cloud/recaptcha-enterprise').v1;

  // Instantiates a client
  const recaptchaenterpriseClient = new RecaptchaEnterpriseServiceClient();

  async function callListRelatedAccountGroupMemberships() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = recaptchaenterpriseClient.listRelatedAccountGroupMembershipsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListRelatedAccountGroupMemberships();

listRelatedAccountGroupMembershipsStream(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 resource name for the related account group in the format projects/{project}/relatedaccountgroups/{relatedaccountgroup}.

pageSize

number

pageToken

string

Optional. A page token, received from a previous ListRelatedAccountGroupMemberships call.

When paginating, all other parameters provided to ListRelatedAccountGroupMemberships must match the call that provided the page token.

options

object

Call options. See CallOptions for more details.

Returns:

Type Description

Type	Description
Stream	An object stream which emits an object representing RelatedAccountGroupMembership 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 `listRelatedAccountGroupMembershipsAsync()` method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

Stream

An object stream which emits an object representing RelatedAccountGroupMembership 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 listRelatedAccountGroupMembershipsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listRelatedAccountGroupsAsync(request, optionsopt) → {Object}

Equivalent to listRelatedAccountGroups, 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 to list related account groups from, in the format projects/{project}.

pageSize

number

Optional. The maximum number of groups to return. The service might return fewer than this value. If unspecified, at most 50 groups are returned. The maximum value is 1000; values above 1000 are coerced to 1000.

pageToken

string

Optional. A page token, received from a previous ListRelatedAccountGroups call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListRelatedAccountGroups must match the call that provided the page token.

options

object

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 RelatedAccountGroup. 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

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the project to list related account groups from, in
   *  the format `projects/{project}`.
   */
  // const parent = 'abc123'
  /**
   *  Optional. The maximum number of groups to return. The service might return
   *  fewer than this value. If unspecified, at most 50 groups are returned. The
   *  maximum value is 1000; values above 1000 are coerced to 1000.
   */
  // const pageSize = 1234
  /**
   *  Optional. A page token, received from a previous `ListRelatedAccountGroups`
   *  call. Provide this to retrieve the subsequent page.
   *  When paginating, all other parameters provided to
   *  `ListRelatedAccountGroups` must match the call that provided the page
   *  token.
   */
  // const pageToken = 'abc123'

  // Imports the Recaptchaenterprise library
  const {RecaptchaEnterpriseServiceClient} = require('@google-cloud/recaptcha-enterprise').v1;

  // Instantiates a client
  const recaptchaenterpriseClient = new RecaptchaEnterpriseServiceClient();

  async function callListRelatedAccountGroups() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = recaptchaenterpriseClient.listRelatedAccountGroupsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListRelatedAccountGroups();

listRelatedAccountGroupsStream(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 to list related account groups from, in the format projects/{project}.

pageSize

number

pageToken

string

Optional. A page token, received from a previous ListRelatedAccountGroups call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListRelatedAccountGroups must match the call that provided the page token.

options

object

Call options. See CallOptions for more details.

Returns:

Type Description

Type	Description
Stream	An object stream which emits an object representing RelatedAccountGroup 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 `listRelatedAccountGroupsAsync()` method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

Stream

An object stream which emits an object representing RelatedAccountGroup 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 listRelatedAccountGroupsAsync() 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.

matchFirewallpolicyFromFirewallPolicyName(firewallPolicyName) → {string}

Parse the firewallpolicy from FirewallPolicy resource.

Parameters:

Name	Type	Description
`firewallPolicyName`	string	A fully-qualified path representing FirewallPolicy resource.

Returns:

Type	Description
string	A string representing the firewallpolicy.

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.

matchKeyFromMetricsName(metricsName) → {string}

Parse the key from Metrics resource.

Parameters:

Name	Type	Description
`metricsName`	string	A fully-qualified path representing Metrics resource.

Returns:

Type	Description
string	A string representing the key.

matchMembershipFromRelatedAccountGroupMembershipName(relatedAccountGroupMembershipName) → {string}

Parse the membership from RelatedAccountGroupMembership resource.

Parameters:

Name	Type	Description
`relatedAccountGroupMembershipName`	string	A fully-qualified path representing RelatedAccountGroupMembership resource.

Returns:

Type	Description
string	A string representing the membership.

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.

matchProjectFromFirewallPolicyName(firewallPolicyName) → {string}

Parse the project from FirewallPolicy resource.

Parameters:

Name	Type	Description
`firewallPolicyName`	string	A fully-qualified path representing FirewallPolicy 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.

matchProjectFromMetricsName(metricsName) → {string}

Parse the project from Metrics resource.

Parameters:

Name	Type	Description
`metricsName`	string	A fully-qualified path representing Metrics 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.

matchProjectFromRelatedAccountGroupMembershipName(relatedAccountGroupMembershipName) → {string}

Parse the project from RelatedAccountGroupMembership resource.

Parameters:

Name	Type	Description
`relatedAccountGroupMembershipName`	string	A fully-qualified path representing RelatedAccountGroupMembership resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromRelatedAccountGroupName(relatedAccountGroupName) → {string}

Parse the project from RelatedAccountGroup resource.

Parameters:

Name	Type	Description
`relatedAccountGroupName`	string	A fully-qualified path representing RelatedAccountGroup resource.

Returns:

Type	Description
string	A string representing the project.

matchRelatedaccountgroupFromRelatedAccountGroupMembershipName(relatedAccountGroupMembershipName) → {string}

Parse the relatedaccountgroup from RelatedAccountGroupMembership resource.

Parameters:

Name	Type	Description
`relatedAccountGroupMembershipName`	string	A fully-qualified path representing RelatedAccountGroupMembership resource.

Returns:

Type	Description
string	A string representing the relatedaccountgroup.

matchRelatedaccountgroupFromRelatedAccountGroupName(relatedAccountGroupName) → {string}

Parse the relatedaccountgroup from RelatedAccountGroup resource.

Parameters:

Name	Type	Description
`relatedAccountGroupName`	string	A fully-qualified path representing RelatedAccountGroup resource.

Returns:

Type	Description
string	A string representing the relatedaccountgroup.

metricsPath(project, key) → {string}

Return a fully-qualified metrics resource name string.

Parameters:

Name	Type	Description
`project`	string
`key`	string

Returns:

Type	Description
string	Resource name string.

projectPath(project) → {string}

Return a fully-qualified project resource name string.

Parameters:

Name	Type	Description
`project`	string

Returns:

Type	Description
string	Resource name string.

relatedAccountGroupMembershipPath(project, relatedaccountgroup, membership) → {string}

Return a fully-qualified relatedAccountGroupMembership resource name string.

Parameters:

Name	Type	Description
`project`	string
`relatedaccountgroup`	string
`membership`	string

Returns:

Type	Description
string	Resource name string.

relatedAccountGroupPath(project, relatedaccountgroup) → {string}

Return a fully-qualified relatedAccountGroup resource name string.

Parameters:

Name	Type	Description
`project`	string
`relatedaccountgroup`	string

Returns:

Type	Description
string	Resource name string.

searchRelatedAccountGroupMembershipsAsync(request, optionsopt) → {Object}

Equivalent to searchRelatedAccountGroupMemberships, 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
`project`	string		Required. The name of the project to search related account group memberships from. Specify the project name in the following format: `projects/{project}`.
`accountId`	string	<optional>	Optional. The unique stable account identifier used to search connections. The identifier should correspond to an `account_id` provided in a previous `CreateAssessment` or `AnnotateAssessment` call. Either hashed_account_id or account_id must be set, but not both.
`hashedAccountId`	Buffer	<optional>	Optional. Deprecated: use `account_id` instead. The unique stable hashed account identifier used to search connections. The identifier should correspond to a `hashed_account_id` provided in a previous `CreateAssessment` or `AnnotateAssessment` call. Either hashed_account_id or account_id must be set, but not both.
`pageSize`	number	<optional>	Optional. The maximum number of groups to return. The service might return fewer than this value. If unspecified, at most 50 groups are returned. The maximum value is 1000; values above 1000 are coerced to 1000.
`pageToken`	string	<optional>	Optional. A page token, received from a previous `SearchRelatedAccountGroupMemberships` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchRelatedAccountGroupMemberships` must match the call that provided the page token.

options

object

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 RelatedAccountGroupMembership. 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

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the project to search related account group
   *  memberships from. Specify the project name in the following format:
   *  `projects/{project}`.
   */
  // const project = 'my-project'
  /**
   *  Optional. The unique stable account identifier used to search connections.
   *  The identifier should correspond to an `account_id` provided in a previous
   *  `CreateAssessment` or `AnnotateAssessment` call. Either hashed_account_id
   *  or account_id must be set, but not both.
   */
  // const accountId = 'abc123'
  /**
   *  Optional. The maximum number of groups to return. The service might return
   *  fewer than this value. If unspecified, at most 50 groups are returned. The
   *  maximum value is 1000; values above 1000 are coerced to 1000.
   */
  // const pageSize = 1234
  /**
   *  Optional. A page token, received from a previous
   *  `SearchRelatedAccountGroupMemberships` call. Provide this to retrieve the
   *  subsequent page.
   *  When paginating, all other parameters provided to
   *  `SearchRelatedAccountGroupMemberships` must match the call that provided
   *  the page token.
   */
  // const pageToken = 'abc123'

  // Imports the Recaptchaenterprise library
  const {RecaptchaEnterpriseServiceClient} = require('@google-cloud/recaptcha-enterprise').v1;

  // Instantiates a client
  const recaptchaenterpriseClient = new RecaptchaEnterpriseServiceClient();

  async function callSearchRelatedAccountGroupMemberships() {
    // Construct request
    const request = {
      project,
    };

    // Run request
    const iterable = recaptchaenterpriseClient.searchRelatedAccountGroupMembershipsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callSearchRelatedAccountGroupMemberships();

searchRelatedAccountGroupMembershipsStream(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
`project`	string		Required. The name of the project to search related account group memberships from. Specify the project name in the following format: `projects/{project}`.
`accountId`	string	<optional>	Optional. The unique stable account identifier used to search connections. The identifier should correspond to an `account_id` provided in a previous `CreateAssessment` or `AnnotateAssessment` call. Either hashed_account_id or account_id must be set, but not both.
`hashedAccountId`	Buffer	<optional>	Optional. Deprecated: use `account_id` instead. The unique stable hashed account identifier used to search connections. The identifier should correspond to a `hashed_account_id` provided in a previous `CreateAssessment` or `AnnotateAssessment` call. Either hashed_account_id or account_id must be set, but not both.
`pageSize`	number	<optional>	Optional. The maximum number of groups to return. The service might return fewer than this value. If unspecified, at most 50 groups are returned. The maximum value is 1000; values above 1000 are coerced to 1000.
`pageToken`	string	<optional>	Optional. A page token, received from a previous `SearchRelatedAccountGroupMemberships` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchRelatedAccountGroupMemberships` must match the call that provided the page token.

options

object

Call options. See CallOptions for more details.

Returns:

Type Description

Stream

An object stream which emits an object representing RelatedAccountGroupMembership 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 searchRelatedAccountGroupMembershipsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.