Class v1.WebRiskServiceClient (3.1.1)

Package

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Properties

apiEndpoint

static get apiEndpoint(): string;

auth

auth: gax.GoogleAuth;

descriptors

descriptors: Descriptors;

innerApiCalls

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

pathTemplates

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

port

static get port(): number;

scopes

static get scopes(): string[];

servicePath

static get servicePath(): string;

warn

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

webRiskServiceStub

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

Methods

close()

close(): Promise<void>;

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
    ]>;

  /**
   * 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 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;

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;

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
    ]>;

  /**
   * 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 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;

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;

getProjectId()

getProjectId(): Promise<string>;

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;

initialize()

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

matchProjectFromProjectName(projectName)

matchProjectFromProjectName(projectName: string): string | number;

projectPath(project)

projectPath(project: string): 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
    ]>;

  /**
   * 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.
   */
  /**
   *  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;

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;

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 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 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;

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;