Class v1.WebRiskServiceClient

Web Risk API defines an interface to detect malicious URLs on your website and in client applications. v1

Package

@google-cloud/web-risk

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of WebRiskServiceClient.

Parameter
NameDescription
opts ClientOptions

Properties

apiEndpoint

static get apiEndpoint(): string;

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

auth

auth: gax.GoogleAuth;

descriptors

descriptors: Descriptors;

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };

port

static get port(): number;

The port for this API service.

scopes

static get scopes(): string[];

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

servicePath

static get servicePath(): string;

The DNS address for this API service.

warn

warn: (code: string, message: string, warnType?: string) => void;

webRiskServiceStub

webRiskServiceStub?: Promise<{
        [name: string]: Function;
    }>;

Methods

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
TypeDescription
Promise<void>

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

computeThreatListDiff(request, options)

computeThreatListDiff(request?: protos.google.cloud.webrisk.v1.IComputeThreatListDiffRequest, options?: CallOptions): Promise<[protos.google.cloud.webrisk.v1.IComputeThreatListDiffResponse, protos.google.cloud.webrisk.v1.IComputeThreatListDiffRequest | undefined, {} | undefined]>;

Gets the most recent threat list diffs. These diffs should be applied to a local database of hashes to keep it up-to-date. If the local database is empty or excessively out-of-date, a complete snapshot of the database will be returned. This Method only updates a single ThreatList at a time. To update multiple ThreatList databases, this method needs to be called once for each list.

Parameters
NameDescription
request protos.google.cloud.webrisk.v1.IComputeThreatListDiffRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.webrisk.v1.IComputeThreatListDiffResponse, protos.google.cloud.webrisk.v1.IComputeThreatListDiffRequest | undefined, {} | undefined]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [ComputeThreatListDiffResponse]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The threat list to update. Only a single ThreatType should be specified.
   */
  // const threatType = {}
  /**
   *  The current version token of the client for the requested list (the
   *  client version that was received from the last successful diff).
   *  If the client does not have a version token (this is the first time calling
   *  ComputeThreatListDiff), this may be left empty and a full database
   *  snapshot will be returned.
   */
  // const versionToken = 'Buffer.from('string')'
  /**
   *  Required. The constraints associated with this request.
   */
  // const constraints = {}

  // Imports the Webrisk library
  const {WebRiskServiceClient} = require('@google-cloud/web-risk').v1;

  // Instantiates a client
  const webriskClient = new WebRiskServiceClient();

  async function callComputeThreatListDiff() {
    // Construct request
    const request = {
      threatType,
      constraints,
    };

    // Run request
    const response = await webriskClient.computeThreatListDiff(request);
    console.log(response);
  }

  callComputeThreatListDiff();

computeThreatListDiff(request, options, callback)

computeThreatListDiff(request: protos.google.cloud.webrisk.v1.IComputeThreatListDiffRequest, options: CallOptions, callback: Callback<protos.google.cloud.webrisk.v1.IComputeThreatListDiffResponse, protos.google.cloud.webrisk.v1.IComputeThreatListDiffRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.webrisk.v1.IComputeThreatListDiffRequest
options CallOptions
callback Callback<protos.google.cloud.webrisk.v1.IComputeThreatListDiffResponse, protos.google.cloud.webrisk.v1.IComputeThreatListDiffRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

computeThreatListDiff(request, callback)

computeThreatListDiff(request: protos.google.cloud.webrisk.v1.IComputeThreatListDiffRequest, callback: Callback<protos.google.cloud.webrisk.v1.IComputeThreatListDiffResponse, protos.google.cloud.webrisk.v1.IComputeThreatListDiffRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.webrisk.v1.IComputeThreatListDiffRequest
callback Callback<protos.google.cloud.webrisk.v1.IComputeThreatListDiffResponse, protos.google.cloud.webrisk.v1.IComputeThreatListDiffRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createSubmission(request, options)

createSubmission(request?: protos.google.cloud.webrisk.v1.ICreateSubmissionRequest, options?: CallOptions): Promise<[protos.google.cloud.webrisk.v1.ISubmission, protos.google.cloud.webrisk.v1.ICreateSubmissionRequest | undefined, {} | undefined]>;

Creates a Submission of a URI suspected of containing phishing content to be reviewed. If the result verifies the existence of malicious phishing content, the site will be added to the [Google's Social Engineering lists](https://support.google.com/webmasters/answer/6350487/) in order to protect users that could get exposed to this threat in the future. Only projects with CREATE_SUBMISSION_USERS visibility can use this method.

Parameters
NameDescription
request protos.google.cloud.webrisk.v1.ICreateSubmissionRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.webrisk.v1.ISubmission, protos.google.cloud.webrisk.v1.ICreateSubmissionRequest | undefined, {} | undefined]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Submission]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the project that is making the submission. This string is in
   *  the format "projects/{project_number}".
   */
  // const parent = 'abc123'
  /**
   *  Required. The submission that contains the content of the phishing report.
   */
  // const submission = {}

  // Imports the Webrisk library
  const {WebRiskServiceClient} = require('@google-cloud/web-risk').v1;

  // Instantiates a client
  const webriskClient = new WebRiskServiceClient();

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

    // Run request
    const response = await webriskClient.createSubmission(request);
    console.log(response);
  }

  callCreateSubmission();

createSubmission(request, options, callback)

createSubmission(request: protos.google.cloud.webrisk.v1.ICreateSubmissionRequest, options: CallOptions, callback: Callback<protos.google.cloud.webrisk.v1.ISubmission, protos.google.cloud.webrisk.v1.ICreateSubmissionRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.webrisk.v1.ICreateSubmissionRequest
options CallOptions
callback Callback<protos.google.cloud.webrisk.v1.ISubmission, protos.google.cloud.webrisk.v1.ICreateSubmissionRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createSubmission(request, callback)

createSubmission(request: protos.google.cloud.webrisk.v1.ICreateSubmissionRequest, callback: Callback<protos.google.cloud.webrisk.v1.ISubmission, protos.google.cloud.webrisk.v1.ICreateSubmissionRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.webrisk.v1.ICreateSubmissionRequest
callback Callback<protos.google.cloud.webrisk.v1.ISubmission, protos.google.cloud.webrisk.v1.ICreateSubmissionRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getProjectId()

getProjectId(): Promise<string>;
Returns
TypeDescription
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
NameDescription
callback Callback<string, undefined, undefined>
Returns
TypeDescription
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
TypeDescription
Promise<{ [name: string]: Function; }>

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

matchProjectFromProjectName(projectName)

matchProjectFromProjectName(projectName: string): string | number;

Parse the project from Project resource.

Parameter
NameDescription
projectName string

A fully-qualified path representing Project resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

projectPath(project)

projectPath(project: string): string;

Return a fully-qualified project resource name string.

Parameter
NameDescription
project string
Returns
TypeDescription
string

{string} Resource name string.

searchHashes(request, options)

searchHashes(request?: protos.google.cloud.webrisk.v1.ISearchHashesRequest, options?: CallOptions): Promise<[protos.google.cloud.webrisk.v1.ISearchHashesResponse, protos.google.cloud.webrisk.v1.ISearchHashesRequest | undefined, {} | undefined]>;

Gets the full hashes that match the requested hash prefix. This is used after a hash prefix is looked up in a threatList and there is a match. The client side threatList only holds partial hashes so the client must query this method to determine if there is a full hash match of a threat.

Parameters
NameDescription
request protos.google.cloud.webrisk.v1.ISearchHashesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.webrisk.v1.ISearchHashesResponse, protos.google.cloud.webrisk.v1.ISearchHashesRequest | undefined, {} | undefined]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [SearchHashesResponse]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  A hash prefix, consisting of the most significant 4-32 bytes of a SHA256
   *  hash. For JSON requests, this field is base64-encoded.
   */
  // const hashPrefix = 'Buffer.from('string')'
  /**
   *  Required. The ThreatLists to search in. Multiple ThreatLists may be specified.
   */
  // const threatTypes = 1234

  // Imports the Webrisk library
  const {WebRiskServiceClient} = require('@google-cloud/web-risk').v1;

  // Instantiates a client
  const webriskClient = new WebRiskServiceClient();

  async function callSearchHashes() {
    // Construct request
    const request = {
      threatTypes,
    };

    // Run request
    const response = await webriskClient.searchHashes(request);
    console.log(response);
  }

  callSearchHashes();

searchHashes(request, options, callback)

searchHashes(request: protos.google.cloud.webrisk.v1.ISearchHashesRequest, options: CallOptions, callback: Callback<protos.google.cloud.webrisk.v1.ISearchHashesResponse, protos.google.cloud.webrisk.v1.ISearchHashesRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.webrisk.v1.ISearchHashesRequest
options CallOptions
callback Callback<protos.google.cloud.webrisk.v1.ISearchHashesResponse, protos.google.cloud.webrisk.v1.ISearchHashesRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

searchHashes(request, callback)

searchHashes(request: protos.google.cloud.webrisk.v1.ISearchHashesRequest, callback: Callback<protos.google.cloud.webrisk.v1.ISearchHashesResponse, protos.google.cloud.webrisk.v1.ISearchHashesRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.webrisk.v1.ISearchHashesRequest
callback Callback<protos.google.cloud.webrisk.v1.ISearchHashesResponse, protos.google.cloud.webrisk.v1.ISearchHashesRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

searchUris(request, options)

searchUris(request?: protos.google.cloud.webrisk.v1.ISearchUrisRequest, options?: CallOptions): Promise<[protos.google.cloud.webrisk.v1.ISearchUrisResponse, protos.google.cloud.webrisk.v1.ISearchUrisRequest | undefined, {} | undefined]>;

This method is used to check whether a URI is on a given threatList. Multiple threatLists may be searched in a single query. The response will list all requested threatLists the URI was found to match. If the URI is not found on any of the requested ThreatList an empty response will be returned.

Parameters
NameDescription
request protos.google.cloud.webrisk.v1.ISearchUrisRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.webrisk.v1.ISearchUrisResponse, protos.google.cloud.webrisk.v1.ISearchUrisRequest | undefined, {} | undefined]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [SearchUrisResponse]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The URI to be checked for matches.
   */
  // const uri = 'abc123'
  /**
   *  Required. The ThreatLists to search in. Multiple ThreatLists may be specified.
   */
  // const threatTypes = 1234

  // Imports the Webrisk library
  const {WebRiskServiceClient} = require('@google-cloud/web-risk').v1;

  // Instantiates a client
  const webriskClient = new WebRiskServiceClient();

  async function callSearchUris() {
    // Construct request
    const request = {
      uri,
      threatTypes,
    };

    // Run request
    const response = await webriskClient.searchUris(request);
    console.log(response);
  }

  callSearchUris();

searchUris(request, options, callback)

searchUris(request: protos.google.cloud.webrisk.v1.ISearchUrisRequest, options: CallOptions, callback: Callback<protos.google.cloud.webrisk.v1.ISearchUrisResponse, protos.google.cloud.webrisk.v1.ISearchUrisRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.webrisk.v1.ISearchUrisRequest
options CallOptions
callback Callback<protos.google.cloud.webrisk.v1.ISearchUrisResponse, protos.google.cloud.webrisk.v1.ISearchUrisRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

searchUris(request, callback)

searchUris(request: protos.google.cloud.webrisk.v1.ISearchUrisRequest, callback: Callback<protos.google.cloud.webrisk.v1.ISearchUrisResponse, protos.google.cloud.webrisk.v1.ISearchUrisRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.webrisk.v1.ISearchUrisRequest
callback Callback<protos.google.cloud.webrisk.v1.ISearchUrisResponse, protos.google.cloud.webrisk.v1.ISearchUrisRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void