Class v1beta.WebSecurityScannerClient

Cloud Web Security Scanner Service identifies security vulnerabilities in web applications hosted on Google Cloud Platform. It crawls your application, and attempts to exercise as many user inputs and event handlers as possible. v1beta

Package

@google-cloud/web-security-scanner

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of WebSecurityScannerClient.

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;

webSecurityScannerStub

webSecurityScannerStub?: 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.

createScanConfig(request, options)

createScanConfig(request?: protos.google.cloud.websecurityscanner.v1beta.ICreateScanConfigRequest, options?: CallOptions): Promise<[
        protos.google.cloud.websecurityscanner.v1beta.IScanConfig,
        (protos.google.cloud.websecurityscanner.v1beta.ICreateScanConfigRequest | undefined),
        {} | undefined
    ]>;

Creates a new ScanConfig.

Parameters
NameDescription
request protos.google.cloud.websecurityscanner.v1beta.ICreateScanConfigRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.websecurityscanner.v1beta.IScanConfig, (protos.google.cloud.websecurityscanner.v1beta.ICreateScanConfigRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [ScanConfig]. 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 parent resource name where the scan is created, which should be a
   *  project resource name in the format 'projects/{projectId}'.
   */
  // const parent = 'abc123'
  /**
   *  Required. The ScanConfig to be created.
   */
  // const scanConfig = {}

  // Imports the Websecurityscanner library
  const {WebSecurityScannerClient} =
    require('@google-cloud/web-security-scanner').v1beta;

  // Instantiates a client
  const websecurityscannerClient = new WebSecurityScannerClient();

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

    // Run request
    const response = await websecurityscannerClient.createScanConfig(request);
    console.log(response);
  }

  callCreateScanConfig();

createScanConfig(request, options, callback)

createScanConfig(request: protos.google.cloud.websecurityscanner.v1beta.ICreateScanConfigRequest, options: CallOptions, callback: Callback<protos.google.cloud.websecurityscanner.v1beta.IScanConfig, protos.google.cloud.websecurityscanner.v1beta.ICreateScanConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.websecurityscanner.v1beta.ICreateScanConfigRequest
options CallOptions
callback Callback<protos.google.cloud.websecurityscanner.v1beta.IScanConfig, protos.google.cloud.websecurityscanner.v1beta.ICreateScanConfigRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createScanConfig(request, callback)

createScanConfig(request: protos.google.cloud.websecurityscanner.v1beta.ICreateScanConfigRequest, callback: Callback<protos.google.cloud.websecurityscanner.v1beta.IScanConfig, protos.google.cloud.websecurityscanner.v1beta.ICreateScanConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.websecurityscanner.v1beta.ICreateScanConfigRequest
callback Callback<protos.google.cloud.websecurityscanner.v1beta.IScanConfig, protos.google.cloud.websecurityscanner.v1beta.ICreateScanConfigRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteScanConfig(request, options)

deleteScanConfig(request?: protos.google.cloud.websecurityscanner.v1beta.IDeleteScanConfigRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        (protos.google.cloud.websecurityscanner.v1beta.IDeleteScanConfigRequest | undefined),
        {} | undefined
    ]>;

Deletes an existing ScanConfig and its child resources.

Parameters
NameDescription
request protos.google.cloud.websecurityscanner.v1beta.IDeleteScanConfigRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.protobuf.IEmpty, (protos.google.cloud.websecurityscanner.v1beta.IDeleteScanConfigRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Empty]. 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 resource name of the ScanConfig to be deleted. The name follows the
   *  format of 'projects/{projectId}/scanConfigs/{scanConfigId}'.
   */
  // const name = 'abc123'

  // Imports the Websecurityscanner library
  const {WebSecurityScannerClient} =
    require('@google-cloud/web-security-scanner').v1beta;

  // Instantiates a client
  const websecurityscannerClient = new WebSecurityScannerClient();

  async function callDeleteScanConfig() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await websecurityscannerClient.deleteScanConfig(request);
    console.log(response);
  }

  callDeleteScanConfig();

deleteScanConfig(request, options, callback)

deleteScanConfig(request: protos.google.cloud.websecurityscanner.v1beta.IDeleteScanConfigRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.websecurityscanner.v1beta.IDeleteScanConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.websecurityscanner.v1beta.IDeleteScanConfigRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.websecurityscanner.v1beta.IDeleteScanConfigRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteScanConfig(request, callback)

deleteScanConfig(request: protos.google.cloud.websecurityscanner.v1beta.IDeleteScanConfigRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.websecurityscanner.v1beta.IDeleteScanConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.websecurityscanner.v1beta.IDeleteScanConfigRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.websecurityscanner.v1beta.IDeleteScanConfigRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

findingPath(project, scanConfig, scanRun, finding)

findingPath(project: string, scanConfig: string, scanRun: string, finding: string): string;

Return a fully-qualified finding resource name string.

Parameters
NameDescription
project string
scanConfig string
scanRun string
finding string
Returns
TypeDescription
string

{string} Resource name string.

getFinding(request, options)

getFinding(request?: protos.google.cloud.websecurityscanner.v1beta.IGetFindingRequest, options?: CallOptions): Promise<[
        protos.google.cloud.websecurityscanner.v1beta.IFinding,
        (protos.google.cloud.websecurityscanner.v1beta.IGetFindingRequest | undefined),
        {} | undefined
    ]>;

Gets a Finding.

Parameters
NameDescription
request protos.google.cloud.websecurityscanner.v1beta.IGetFindingRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.websecurityscanner.v1beta.IFinding, (protos.google.cloud.websecurityscanner.v1beta.IGetFindingRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Finding]. 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 resource name of the Finding to be returned. The name follows the
   *  format of
   *  'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}/findings/{findingId}'.
   */
  // const name = 'abc123'

  // Imports the Websecurityscanner library
  const {WebSecurityScannerClient} =
    require('@google-cloud/web-security-scanner').v1beta;

  // Instantiates a client
  const websecurityscannerClient = new WebSecurityScannerClient();

  async function callGetFinding() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await websecurityscannerClient.getFinding(request);
    console.log(response);
  }

  callGetFinding();

getFinding(request, options, callback)

getFinding(request: protos.google.cloud.websecurityscanner.v1beta.IGetFindingRequest, options: CallOptions, callback: Callback<protos.google.cloud.websecurityscanner.v1beta.IFinding, protos.google.cloud.websecurityscanner.v1beta.IGetFindingRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.websecurityscanner.v1beta.IGetFindingRequest
options CallOptions
callback Callback<protos.google.cloud.websecurityscanner.v1beta.IFinding, protos.google.cloud.websecurityscanner.v1beta.IGetFindingRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getFinding(request, callback)

getFinding(request: protos.google.cloud.websecurityscanner.v1beta.IGetFindingRequest, callback: Callback<protos.google.cloud.websecurityscanner.v1beta.IFinding, protos.google.cloud.websecurityscanner.v1beta.IGetFindingRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.websecurityscanner.v1beta.IGetFindingRequest
callback Callback<protos.google.cloud.websecurityscanner.v1beta.IFinding, protos.google.cloud.websecurityscanner.v1beta.IGetFindingRequest | 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

getScanConfig(request, options)

getScanConfig(request?: protos.google.cloud.websecurityscanner.v1beta.IGetScanConfigRequest, options?: CallOptions): Promise<[
        protos.google.cloud.websecurityscanner.v1beta.IScanConfig,
        (protos.google.cloud.websecurityscanner.v1beta.IGetScanConfigRequest | undefined),
        {} | undefined
    ]>;

Gets a ScanConfig.

Parameters
NameDescription
request protos.google.cloud.websecurityscanner.v1beta.IGetScanConfigRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.websecurityscanner.v1beta.IScanConfig, (protos.google.cloud.websecurityscanner.v1beta.IGetScanConfigRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [ScanConfig]. 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 resource name of the ScanConfig to be returned. The name follows the
   *  format of 'projects/{projectId}/scanConfigs/{scanConfigId}'.
   */
  // const name = 'abc123'

  // Imports the Websecurityscanner library
  const {WebSecurityScannerClient} =
    require('@google-cloud/web-security-scanner').v1beta;

  // Instantiates a client
  const websecurityscannerClient = new WebSecurityScannerClient();

  async function callGetScanConfig() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await websecurityscannerClient.getScanConfig(request);
    console.log(response);
  }

  callGetScanConfig();

getScanConfig(request, options, callback)

getScanConfig(request: protos.google.cloud.websecurityscanner.v1beta.IGetScanConfigRequest, options: CallOptions, callback: Callback<protos.google.cloud.websecurityscanner.v1beta.IScanConfig, protos.google.cloud.websecurityscanner.v1beta.IGetScanConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.websecurityscanner.v1beta.IGetScanConfigRequest
options CallOptions
callback Callback<protos.google.cloud.websecurityscanner.v1beta.IScanConfig, protos.google.cloud.websecurityscanner.v1beta.IGetScanConfigRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getScanConfig(request, callback)

getScanConfig(request: protos.google.cloud.websecurityscanner.v1beta.IGetScanConfigRequest, callback: Callback<protos.google.cloud.websecurityscanner.v1beta.IScanConfig, protos.google.cloud.websecurityscanner.v1beta.IGetScanConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.websecurityscanner.v1beta.IGetScanConfigRequest
callback Callback<protos.google.cloud.websecurityscanner.v1beta.IScanConfig, protos.google.cloud.websecurityscanner.v1beta.IGetScanConfigRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getScanRun(request, options)

getScanRun(request?: protos.google.cloud.websecurityscanner.v1beta.IGetScanRunRequest, options?: CallOptions): Promise<[
        protos.google.cloud.websecurityscanner.v1beta.IScanRun,
        (protos.google.cloud.websecurityscanner.v1beta.IGetScanRunRequest | undefined),
        {} | undefined
    ]>;

Gets a ScanRun.

Parameters
NameDescription
request protos.google.cloud.websecurityscanner.v1beta.IGetScanRunRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.websecurityscanner.v1beta.IScanRun, (protos.google.cloud.websecurityscanner.v1beta.IGetScanRunRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [ScanRun]. 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 resource name of the ScanRun to be returned. The name follows the
   *  format of
   *  'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
   */
  // const name = 'abc123'

  // Imports the Websecurityscanner library
  const {WebSecurityScannerClient} =
    require('@google-cloud/web-security-scanner').v1beta;

  // Instantiates a client
  const websecurityscannerClient = new WebSecurityScannerClient();

  async function callGetScanRun() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await websecurityscannerClient.getScanRun(request);
    console.log(response);
  }

  callGetScanRun();

getScanRun(request, options, callback)

getScanRun(request: protos.google.cloud.websecurityscanner.v1beta.IGetScanRunRequest, options: CallOptions, callback: Callback<protos.google.cloud.websecurityscanner.v1beta.IScanRun, protos.google.cloud.websecurityscanner.v1beta.IGetScanRunRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.websecurityscanner.v1beta.IGetScanRunRequest
options CallOptions
callback Callback<protos.google.cloud.websecurityscanner.v1beta.IScanRun, protos.google.cloud.websecurityscanner.v1beta.IGetScanRunRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getScanRun(request, callback)

getScanRun(request: protos.google.cloud.websecurityscanner.v1beta.IGetScanRunRequest, callback: Callback<protos.google.cloud.websecurityscanner.v1beta.IScanRun, protos.google.cloud.websecurityscanner.v1beta.IGetScanRunRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.websecurityscanner.v1beta.IGetScanRunRequest
callback Callback<protos.google.cloud.websecurityscanner.v1beta.IScanRun, protos.google.cloud.websecurityscanner.v1beta.IGetScanRunRequest | null | undefined, {} | null | 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.

listCrawledUrls(request, options)

listCrawledUrls(request?: protos.google.cloud.websecurityscanner.v1beta.IListCrawledUrlsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.websecurityscanner.v1beta.ICrawledUrl[],
        protos.google.cloud.websecurityscanner.v1beta.IListCrawledUrlsRequest | null,
        protos.google.cloud.websecurityscanner.v1beta.IListCrawledUrlsResponse
    ]>;

List CrawledUrls under a given ScanRun.

Parameters
NameDescription
request protos.google.cloud.websecurityscanner.v1beta.IListCrawledUrlsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.websecurityscanner.v1beta.ICrawledUrl[], protos.google.cloud.websecurityscanner.v1beta.IListCrawledUrlsRequest | null, protos.google.cloud.websecurityscanner.v1beta.IListCrawledUrlsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of [CrawledUrl]. 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 listCrawledUrlsAsync() 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.

listCrawledUrls(request, options, callback)

listCrawledUrls(request: protos.google.cloud.websecurityscanner.v1beta.IListCrawledUrlsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.websecurityscanner.v1beta.IListCrawledUrlsRequest, protos.google.cloud.websecurityscanner.v1beta.IListCrawledUrlsResponse | null | undefined, protos.google.cloud.websecurityscanner.v1beta.ICrawledUrl>): void;
Parameters
NameDescription
request protos.google.cloud.websecurityscanner.v1beta.IListCrawledUrlsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.websecurityscanner.v1beta.IListCrawledUrlsRequest, protos.google.cloud.websecurityscanner.v1beta.IListCrawledUrlsResponse | null | undefined, protos.google.cloud.websecurityscanner.v1beta.ICrawledUrl>
Returns
TypeDescription
void

listCrawledUrls(request, callback)

listCrawledUrls(request: protos.google.cloud.websecurityscanner.v1beta.IListCrawledUrlsRequest, callback: PaginationCallback<protos.google.cloud.websecurityscanner.v1beta.IListCrawledUrlsRequest, protos.google.cloud.websecurityscanner.v1beta.IListCrawledUrlsResponse | null | undefined, protos.google.cloud.websecurityscanner.v1beta.ICrawledUrl>): void;
Parameters
NameDescription
request protos.google.cloud.websecurityscanner.v1beta.IListCrawledUrlsRequest
callback PaginationCallback<protos.google.cloud.websecurityscanner.v1beta.IListCrawledUrlsRequest, protos.google.cloud.websecurityscanner.v1beta.IListCrawledUrlsResponse | null | undefined, protos.google.cloud.websecurityscanner.v1beta.ICrawledUrl>
Returns
TypeDescription
void

listCrawledUrlsAsync(request, options)

listCrawledUrlsAsync(request?: protos.google.cloud.websecurityscanner.v1beta.IListCrawledUrlsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.websecurityscanner.v1beta.ICrawledUrl>;

Equivalent to listCrawledUrls, but returns an iterable object.

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

Parameters
NameDescription
request protos.google.cloud.websecurityscanner.v1beta.IListCrawledUrlsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.websecurityscanner.v1beta.ICrawledUrl>

{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 [CrawledUrl]. 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.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent resource name, which should be a scan run resource name in the
   *  format
   *  'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
   */
  // const parent = 'abc123'
  /**
   *  A token identifying a page of results to be returned. This should be a
   *  `next_page_token` value returned from a previous List request.
   *  If unspecified, the first page of results is returned.
   */
  // const pageToken = 'abc123'
  /**
   *  The maximum number of CrawledUrls to return, can be limited by server.
   *  If not specified or not positive, the implementation will select a
   *  reasonable value.
   */
  // const pageSize = 1234

  // Imports the Websecurityscanner library
  const {WebSecurityScannerClient} =
    require('@google-cloud/web-security-scanner').v1beta;

  // Instantiates a client
  const websecurityscannerClient = new WebSecurityScannerClient();

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

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

  callListCrawledUrls();

listCrawledUrlsStream(request, options)

listCrawledUrlsStream(request?: protos.google.cloud.websecurityscanner.v1beta.IListCrawledUrlsRequest, options?: CallOptions): Transform;

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

Parameters
NameDescription
request protos.google.cloud.websecurityscanner.v1beta.IListCrawledUrlsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing [CrawledUrl] 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 listCrawledUrlsAsync() 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.

listFindings(request, options)

listFindings(request?: protos.google.cloud.websecurityscanner.v1beta.IListFindingsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.websecurityscanner.v1beta.IFinding[],
        protos.google.cloud.websecurityscanner.v1beta.IListFindingsRequest | null,
        protos.google.cloud.websecurityscanner.v1beta.IListFindingsResponse
    ]>;

List Findings under a given ScanRun.

Parameters
NameDescription
request protos.google.cloud.websecurityscanner.v1beta.IListFindingsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.websecurityscanner.v1beta.IFinding[], protos.google.cloud.websecurityscanner.v1beta.IListFindingsRequest | null, protos.google.cloud.websecurityscanner.v1beta.IListFindingsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of [Finding]. 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 listFindingsAsync() 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.

listFindings(request, options, callback)

listFindings(request: protos.google.cloud.websecurityscanner.v1beta.IListFindingsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.websecurityscanner.v1beta.IListFindingsRequest, protos.google.cloud.websecurityscanner.v1beta.IListFindingsResponse | null | undefined, protos.google.cloud.websecurityscanner.v1beta.IFinding>): void;
Parameters
NameDescription
request protos.google.cloud.websecurityscanner.v1beta.IListFindingsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.websecurityscanner.v1beta.IListFindingsRequest, protos.google.cloud.websecurityscanner.v1beta.IListFindingsResponse | null | undefined, protos.google.cloud.websecurityscanner.v1beta.IFinding>
Returns
TypeDescription
void

listFindings(request, callback)

listFindings(request: protos.google.cloud.websecurityscanner.v1beta.IListFindingsRequest, callback: PaginationCallback<protos.google.cloud.websecurityscanner.v1beta.IListFindingsRequest, protos.google.cloud.websecurityscanner.v1beta.IListFindingsResponse | null | undefined, protos.google.cloud.websecurityscanner.v1beta.IFinding>): void;
Parameters
NameDescription
request protos.google.cloud.websecurityscanner.v1beta.IListFindingsRequest
callback PaginationCallback<protos.google.cloud.websecurityscanner.v1beta.IListFindingsRequest, protos.google.cloud.websecurityscanner.v1beta.IListFindingsResponse | null | undefined, protos.google.cloud.websecurityscanner.v1beta.IFinding>
Returns
TypeDescription
void

listFindingsAsync(request, options)

listFindingsAsync(request?: protos.google.cloud.websecurityscanner.v1beta.IListFindingsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.websecurityscanner.v1beta.IFinding>;

Equivalent to listFindings, but returns an iterable object.

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

Parameters
NameDescription
request protos.google.cloud.websecurityscanner.v1beta.IListFindingsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.websecurityscanner.v1beta.IFinding>

{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 [Finding]. 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.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent resource name, which should be a scan run resource name in the
   *  format
   *  'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
   */
  // const parent = 'abc123'
  /**
   *  Required. The filter expression. The expression must be in the format: 

listFindingsStream(request, options)

listFindingsStream(request?: protos.google.cloud.websecurityscanner.v1beta.IListFindingsRequest, options?: CallOptions): Transform;

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

Parameters
NameDescription
request protos.google.cloud.websecurityscanner.v1beta.IListFindingsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing [Finding] 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 listFindingsAsync() 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.

listFindingTypeStats(request, options)

listFindingTypeStats(request?: protos.google.cloud.websecurityscanner.v1beta.IListFindingTypeStatsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.websecurityscanner.v1beta.IListFindingTypeStatsResponse,
        (protos.google.cloud.websecurityscanner.v1beta.IListFindingTypeStatsRequest | undefined),
        {} | undefined
    ]>;

List all FindingTypeStats under a given ScanRun.

Parameters
NameDescription
request protos.google.cloud.websecurityscanner.v1beta.IListFindingTypeStatsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.websecurityscanner.v1beta.IListFindingTypeStatsResponse, (protos.google.cloud.websecurityscanner.v1beta.IListFindingTypeStatsRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [ListFindingTypeStatsResponse]. 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 parent resource name, which should be a scan run resource name in the
   *  format
   *  'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
   */
  // const parent = 'abc123'

  // Imports the Websecurityscanner library
  const {WebSecurityScannerClient} =
    require('@google-cloud/web-security-scanner').v1beta;

  // Instantiates a client
  const websecurityscannerClient = new WebSecurityScannerClient();

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

    // Run request
    const response = await websecurityscannerClient.listFindingTypeStats(
      request
    );
    console.log(response);
  }

  callListFindingTypeStats();

listFindingTypeStats(request, options, callback)

listFindingTypeStats(request: protos.google.cloud.websecurityscanner.v1beta.IListFindingTypeStatsRequest, options: CallOptions, callback: Callback<protos.google.cloud.websecurityscanner.v1beta.IListFindingTypeStatsResponse, protos.google.cloud.websecurityscanner.v1beta.IListFindingTypeStatsRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.websecurityscanner.v1beta.IListFindingTypeStatsRequest
options CallOptions
callback Callback<protos.google.cloud.websecurityscanner.v1beta.IListFindingTypeStatsResponse, protos.google.cloud.websecurityscanner.v1beta.IListFindingTypeStatsRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

listFindingTypeStats(request, callback)

listFindingTypeStats(request: protos.google.cloud.websecurityscanner.v1beta.IListFindingTypeStatsRequest, callback: Callback<protos.google.cloud.websecurityscanner.v1beta.IListFindingTypeStatsResponse, protos.google.cloud.websecurityscanner.v1beta.IListFindingTypeStatsRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.websecurityscanner.v1beta.IListFindingTypeStatsRequest
callback Callback<protos.google.cloud.websecurityscanner.v1beta.IListFindingTypeStatsResponse, protos.google.cloud.websecurityscanner.v1beta.IListFindingTypeStatsRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

listScanConfigs(request, options)

listScanConfigs(request?: protos.google.cloud.websecurityscanner.v1beta.IListScanConfigsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.websecurityscanner.v1beta.IScanConfig[],
        protos.google.cloud.websecurityscanner.v1beta.IListScanConfigsRequest | null,
        protos.google.cloud.websecurityscanner.v1beta.IListScanConfigsResponse
    ]>;

Lists ScanConfigs under a given project.

Parameters
NameDescription
request protos.google.cloud.websecurityscanner.v1beta.IListScanConfigsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.websecurityscanner.v1beta.IScanConfig[], protos.google.cloud.websecurityscanner.v1beta.IListScanConfigsRequest | null, protos.google.cloud.websecurityscanner.v1beta.IListScanConfigsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of [ScanConfig]. 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 listScanConfigsAsync() 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.

listScanConfigs(request, options, callback)

listScanConfigs(request: protos.google.cloud.websecurityscanner.v1beta.IListScanConfigsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.websecurityscanner.v1beta.IListScanConfigsRequest, protos.google.cloud.websecurityscanner.v1beta.IListScanConfigsResponse | null | undefined, protos.google.cloud.websecurityscanner.v1beta.IScanConfig>): void;
Parameters
NameDescription
request protos.google.cloud.websecurityscanner.v1beta.IListScanConfigsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.websecurityscanner.v1beta.IListScanConfigsRequest, protos.google.cloud.websecurityscanner.v1beta.IListScanConfigsResponse | null | undefined, protos.google.cloud.websecurityscanner.v1beta.IScanConfig>
Returns
TypeDescription
void

listScanConfigs(request, callback)

listScanConfigs(request: protos.google.cloud.websecurityscanner.v1beta.IListScanConfigsRequest, callback: PaginationCallback<protos.google.cloud.websecurityscanner.v1beta.IListScanConfigsRequest, protos.google.cloud.websecurityscanner.v1beta.IListScanConfigsResponse | null | undefined, protos.google.cloud.websecurityscanner.v1beta.IScanConfig>): void;
Parameters
NameDescription
request protos.google.cloud.websecurityscanner.v1beta.IListScanConfigsRequest
callback PaginationCallback<protos.google.cloud.websecurityscanner.v1beta.IListScanConfigsRequest, protos.google.cloud.websecurityscanner.v1beta.IListScanConfigsResponse | null | undefined, protos.google.cloud.websecurityscanner.v1beta.IScanConfig>
Returns
TypeDescription
void

listScanConfigsAsync(request, options)

listScanConfigsAsync(request?: protos.google.cloud.websecurityscanner.v1beta.IListScanConfigsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.websecurityscanner.v1beta.IScanConfig>;

Equivalent to listScanConfigs, but returns an iterable object.

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

Parameters
NameDescription
request protos.google.cloud.websecurityscanner.v1beta.IListScanConfigsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.websecurityscanner.v1beta.IScanConfig>

{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 [ScanConfig]. 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.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent resource name, which should be a project resource name in the
   *  format 'projects/{projectId}'.
   */
  // const parent = 'abc123'
  /**
   *  A token identifying a page of results to be returned. This should be a
   *  `next_page_token` value returned from a previous List request.
   *  If unspecified, the first page of results is returned.
   */
  // const pageToken = 'abc123'
  /**
   *  The maximum number of ScanConfigs to return, can be limited by server.
   *  If not specified or not positive, the implementation will select a
   *  reasonable value.
   */
  // const pageSize = 1234

  // Imports the Websecurityscanner library
  const {WebSecurityScannerClient} =
    require('@google-cloud/web-security-scanner').v1beta;

  // Instantiates a client
  const websecurityscannerClient = new WebSecurityScannerClient();

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

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

  callListScanConfigs();

listScanConfigsStream(request, options)

listScanConfigsStream(request?: protos.google.cloud.websecurityscanner.v1beta.IListScanConfigsRequest, options?: CallOptions): Transform;

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

Parameters
NameDescription
request protos.google.cloud.websecurityscanner.v1beta.IListScanConfigsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing [ScanConfig] 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 listScanConfigsAsync() 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.

listScanRuns(request, options)

listScanRuns(request?: protos.google.cloud.websecurityscanner.v1beta.IListScanRunsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.websecurityscanner.v1beta.IScanRun[],
        protos.google.cloud.websecurityscanner.v1beta.IListScanRunsRequest | null,
        protos.google.cloud.websecurityscanner.v1beta.IListScanRunsResponse
    ]>;

Lists ScanRuns under a given ScanConfig, in descending order of ScanRun stop time.

Parameters
NameDescription
request protos.google.cloud.websecurityscanner.v1beta.IListScanRunsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.websecurityscanner.v1beta.IScanRun[], protos.google.cloud.websecurityscanner.v1beta.IListScanRunsRequest | null, protos.google.cloud.websecurityscanner.v1beta.IListScanRunsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of [ScanRun]. 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 listScanRunsAsync() 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.

listScanRuns(request, options, callback)

listScanRuns(request: protos.google.cloud.websecurityscanner.v1beta.IListScanRunsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.websecurityscanner.v1beta.IListScanRunsRequest, protos.google.cloud.websecurityscanner.v1beta.IListScanRunsResponse | null | undefined, protos.google.cloud.websecurityscanner.v1beta.IScanRun>): void;
Parameters
NameDescription
request protos.google.cloud.websecurityscanner.v1beta.IListScanRunsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.websecurityscanner.v1beta.IListScanRunsRequest, protos.google.cloud.websecurityscanner.v1beta.IListScanRunsResponse | null | undefined, protos.google.cloud.websecurityscanner.v1beta.IScanRun>
Returns
TypeDescription
void

listScanRuns(request, callback)

listScanRuns(request: protos.google.cloud.websecurityscanner.v1beta.IListScanRunsRequest, callback: PaginationCallback<protos.google.cloud.websecurityscanner.v1beta.IListScanRunsRequest, protos.google.cloud.websecurityscanner.v1beta.IListScanRunsResponse | null | undefined, protos.google.cloud.websecurityscanner.v1beta.IScanRun>): void;
Parameters
NameDescription
request protos.google.cloud.websecurityscanner.v1beta.IListScanRunsRequest
callback PaginationCallback<protos.google.cloud.websecurityscanner.v1beta.IListScanRunsRequest, protos.google.cloud.websecurityscanner.v1beta.IListScanRunsResponse | null | undefined, protos.google.cloud.websecurityscanner.v1beta.IScanRun>
Returns
TypeDescription
void

listScanRunsAsync(request, options)

listScanRunsAsync(request?: protos.google.cloud.websecurityscanner.v1beta.IListScanRunsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.websecurityscanner.v1beta.IScanRun>;

Equivalent to listScanRuns, but returns an iterable object.

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

Parameters
NameDescription
request protos.google.cloud.websecurityscanner.v1beta.IListScanRunsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.websecurityscanner.v1beta.IScanRun>

{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 [ScanRun]. 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.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent resource name, which should be a scan resource name in the
   *  format 'projects/{projectId}/scanConfigs/{scanConfigId}'.
   */
  // const parent = 'abc123'
  /**
   *  A token identifying a page of results to be returned. This should be a
   *  `next_page_token` value returned from a previous List request.
   *  If unspecified, the first page of results is returned.
   */
  // const pageToken = 'abc123'
  /**
   *  The maximum number of ScanRuns to return, can be limited by server.
   *  If not specified or not positive, the implementation will select a
   *  reasonable value.
   */
  // const pageSize = 1234

  // Imports the Websecurityscanner library
  const {WebSecurityScannerClient} =
    require('@google-cloud/web-security-scanner').v1beta;

  // Instantiates a client
  const websecurityscannerClient = new WebSecurityScannerClient();

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

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

  callListScanRuns();

listScanRunsStream(request, options)

listScanRunsStream(request?: protos.google.cloud.websecurityscanner.v1beta.IListScanRunsRequest, options?: CallOptions): Transform;

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

Parameters
NameDescription
request protos.google.cloud.websecurityscanner.v1beta.IListScanRunsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing [ScanRun] 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 listScanRunsAsync() 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.

matchFindingFromFindingName(findingName)

matchFindingFromFindingName(findingName: string): string | number;

Parse the finding from Finding resource.

Parameter
NameDescription
findingName string

A fully-qualified path representing Finding resource.

Returns
TypeDescription
string | number

{string} A string representing the finding.

matchProjectFromFindingName(findingName)

matchProjectFromFindingName(findingName: string): string | number;

Parse the project from Finding resource.

Parameter
NameDescription
findingName string

A fully-qualified path representing Finding resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

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.

matchProjectFromScanConfigName(scanConfigName)

matchProjectFromScanConfigName(scanConfigName: string): string | number;

Parse the project from ScanConfig resource.

Parameter
NameDescription
scanConfigName string

A fully-qualified path representing ScanConfig resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromScanRunName(scanRunName)

matchProjectFromScanRunName(scanRunName: string): string | number;

Parse the project from ScanRun resource.

Parameter
NameDescription
scanRunName string

A fully-qualified path representing ScanRun resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchScanConfigFromFindingName(findingName)

matchScanConfigFromFindingName(findingName: string): string | number;

Parse the scan_config from Finding resource.

Parameter
NameDescription
findingName string

A fully-qualified path representing Finding resource.

Returns
TypeDescription
string | number

{string} A string representing the scan_config.

matchScanConfigFromScanConfigName(scanConfigName)

matchScanConfigFromScanConfigName(scanConfigName: string): string | number;

Parse the scan_config from ScanConfig resource.

Parameter
NameDescription
scanConfigName string

A fully-qualified path representing ScanConfig resource.

Returns
TypeDescription
string | number

{string} A string representing the scan_config.

matchScanConfigFromScanRunName(scanRunName)

matchScanConfigFromScanRunName(scanRunName: string): string | number;

Parse the scan_config from ScanRun resource.

Parameter
NameDescription
scanRunName string

A fully-qualified path representing ScanRun resource.

Returns
TypeDescription
string | number

{string} A string representing the scan_config.

matchScanRunFromFindingName(findingName)

matchScanRunFromFindingName(findingName: string): string | number;

Parse the scan_run from Finding resource.

Parameter
NameDescription
findingName string

A fully-qualified path representing Finding resource.

Returns
TypeDescription
string | number

{string} A string representing the scan_run.

matchScanRunFromScanRunName(scanRunName)

matchScanRunFromScanRunName(scanRunName: string): string | number;

Parse the scan_run from ScanRun resource.

Parameter
NameDescription
scanRunName string

A fully-qualified path representing ScanRun resource.

Returns
TypeDescription
string | number

{string} A string representing the scan_run.

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.

scanConfigPath(project, scanConfig)

scanConfigPath(project: string, scanConfig: string): string;

Return a fully-qualified scanConfig resource name string.

Parameters
NameDescription
project string
scanConfig string
Returns
TypeDescription
string

{string} Resource name string.

scanRunPath(project, scanConfig, scanRun)

scanRunPath(project: string, scanConfig: string, scanRun: string): string;

Return a fully-qualified scanRun resource name string.

Parameters
NameDescription
project string
scanConfig string
scanRun string
Returns
TypeDescription
string

{string} Resource name string.

startScanRun(request, options)

startScanRun(request?: protos.google.cloud.websecurityscanner.v1beta.IStartScanRunRequest, options?: CallOptions): Promise<[
        protos.google.cloud.websecurityscanner.v1beta.IScanRun,
        (protos.google.cloud.websecurityscanner.v1beta.IStartScanRunRequest | undefined),
        {} | undefined
    ]>;

Start a ScanRun according to the given ScanConfig.

Parameters
NameDescription
request protos.google.cloud.websecurityscanner.v1beta.IStartScanRunRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.websecurityscanner.v1beta.IScanRun, (protos.google.cloud.websecurityscanner.v1beta.IStartScanRunRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [ScanRun]. 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 resource name of the ScanConfig to be used. The name follows the
   *  format of 'projects/{projectId}/scanConfigs/{scanConfigId}'.
   */
  // const name = 'abc123'

  // Imports the Websecurityscanner library
  const {WebSecurityScannerClient} =
    require('@google-cloud/web-security-scanner').v1beta;

  // Instantiates a client
  const websecurityscannerClient = new WebSecurityScannerClient();

  async function callStartScanRun() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await websecurityscannerClient.startScanRun(request);
    console.log(response);
  }

  callStartScanRun();

startScanRun(request, options, callback)

startScanRun(request: protos.google.cloud.websecurityscanner.v1beta.IStartScanRunRequest, options: CallOptions, callback: Callback<protos.google.cloud.websecurityscanner.v1beta.IScanRun, protos.google.cloud.websecurityscanner.v1beta.IStartScanRunRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.websecurityscanner.v1beta.IStartScanRunRequest
options CallOptions
callback Callback<protos.google.cloud.websecurityscanner.v1beta.IScanRun, protos.google.cloud.websecurityscanner.v1beta.IStartScanRunRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

startScanRun(request, callback)

startScanRun(request: protos.google.cloud.websecurityscanner.v1beta.IStartScanRunRequest, callback: Callback<protos.google.cloud.websecurityscanner.v1beta.IScanRun, protos.google.cloud.websecurityscanner.v1beta.IStartScanRunRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.websecurityscanner.v1beta.IStartScanRunRequest
callback Callback<protos.google.cloud.websecurityscanner.v1beta.IScanRun, protos.google.cloud.websecurityscanner.v1beta.IStartScanRunRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

stopScanRun(request, options)

stopScanRun(request?: protos.google.cloud.websecurityscanner.v1beta.IStopScanRunRequest, options?: CallOptions): Promise<[
        protos.google.cloud.websecurityscanner.v1beta.IScanRun,
        (protos.google.cloud.websecurityscanner.v1beta.IStopScanRunRequest | undefined),
        {} | undefined
    ]>;

Stops a ScanRun. The stopped ScanRun is returned.

Parameters
NameDescription
request protos.google.cloud.websecurityscanner.v1beta.IStopScanRunRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.websecurityscanner.v1beta.IScanRun, (protos.google.cloud.websecurityscanner.v1beta.IStopScanRunRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [ScanRun]. 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 resource name of the ScanRun to be stopped. The name follows the
   *  format of
   *  'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
   */
  // const name = 'abc123'

  // Imports the Websecurityscanner library
  const {WebSecurityScannerClient} =
    require('@google-cloud/web-security-scanner').v1beta;

  // Instantiates a client
  const websecurityscannerClient = new WebSecurityScannerClient();

  async function callStopScanRun() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await websecurityscannerClient.stopScanRun(request);
    console.log(response);
  }

  callStopScanRun();

stopScanRun(request, options, callback)

stopScanRun(request: protos.google.cloud.websecurityscanner.v1beta.IStopScanRunRequest, options: CallOptions, callback: Callback<protos.google.cloud.websecurityscanner.v1beta.IScanRun, protos.google.cloud.websecurityscanner.v1beta.IStopScanRunRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.websecurityscanner.v1beta.IStopScanRunRequest
options CallOptions
callback Callback<protos.google.cloud.websecurityscanner.v1beta.IScanRun, protos.google.cloud.websecurityscanner.v1beta.IStopScanRunRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

stopScanRun(request, callback)

stopScanRun(request: protos.google.cloud.websecurityscanner.v1beta.IStopScanRunRequest, callback: Callback<protos.google.cloud.websecurityscanner.v1beta.IScanRun, protos.google.cloud.websecurityscanner.v1beta.IStopScanRunRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.websecurityscanner.v1beta.IStopScanRunRequest
callback Callback<protos.google.cloud.websecurityscanner.v1beta.IScanRun, protos.google.cloud.websecurityscanner.v1beta.IStopScanRunRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateScanConfig(request, options)

updateScanConfig(request?: protos.google.cloud.websecurityscanner.v1beta.IUpdateScanConfigRequest, options?: CallOptions): Promise<[
        protos.google.cloud.websecurityscanner.v1beta.IScanConfig,
        (protos.google.cloud.websecurityscanner.v1beta.IUpdateScanConfigRequest | undefined),
        {} | undefined
    ]>;

Updates a ScanConfig. This method support partial update of a ScanConfig.

Parameters
NameDescription
request protos.google.cloud.websecurityscanner.v1beta.IUpdateScanConfigRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.websecurityscanner.v1beta.IScanConfig, (protos.google.cloud.websecurityscanner.v1beta.IUpdateScanConfigRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [ScanConfig]. 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 ScanConfig to be updated. The name field must be set to identify the
   *  resource to be updated. The values of fields not covered by the mask
   *  will be ignored.
   */
  // const scanConfig = {}
  /**
   *  Required. The update mask applies to the resource. For the `FieldMask` definition,
   *  see
   *  https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
   */
  // const updateMask = {}

  // Imports the Websecurityscanner library
  const {WebSecurityScannerClient} =
    require('@google-cloud/web-security-scanner').v1beta;

  // Instantiates a client
  const websecurityscannerClient = new WebSecurityScannerClient();

  async function callUpdateScanConfig() {
    // Construct request
    const request = {
      scanConfig,
      updateMask,
    };

    // Run request
    const response = await websecurityscannerClient.updateScanConfig(request);
    console.log(response);
  }

  callUpdateScanConfig();

updateScanConfig(request, options, callback)

updateScanConfig(request: protos.google.cloud.websecurityscanner.v1beta.IUpdateScanConfigRequest, options: CallOptions, callback: Callback<protos.google.cloud.websecurityscanner.v1beta.IScanConfig, protos.google.cloud.websecurityscanner.v1beta.IUpdateScanConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.websecurityscanner.v1beta.IUpdateScanConfigRequest
options CallOptions
callback Callback<protos.google.cloud.websecurityscanner.v1beta.IScanConfig, protos.google.cloud.websecurityscanner.v1beta.IUpdateScanConfigRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateScanConfig(request, callback)

updateScanConfig(request: protos.google.cloud.websecurityscanner.v1beta.IUpdateScanConfigRequest, callback: Callback<protos.google.cloud.websecurityscanner.v1beta.IScanConfig, protos.google.cloud.websecurityscanner.v1beta.IUpdateScanConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.websecurityscanner.v1beta.IUpdateScanConfigRequest
callback Callback<protos.google.cloud.websecurityscanner.v1beta.IScanConfig, protos.google.cloud.websecurityscanner.v1beta.IUpdateScanConfigRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void