/** * Copyright 2019 Google LLC * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ import { GaxiosPromise } from 'gaxios'; import { Compute, JWT, OAuth2Client, UserRefreshClient } from 'google-auth-library'; import { BodyResponseCallback, GlobalOptions, GoogleConfigurable, MethodOptions } from 'googleapis-common'; export declare namespace websecurityscanner_v1alpha { interface Options extends GlobalOptions { version: 'v1alpha'; } interface StandardParameters { /** * V1 error format. */ '$.xgafv'?: string; /** * OAuth access token. */ access_token?: string; /** * Data format for response. */ alt?: string; /** * JSONP */ callback?: string; /** * Selector specifying which fields to include in a partial response. */ fields?: string; /** * API key. Your API key identifies your project and provides you with API * access, quota, and reports. Required unless you provide an OAuth 2.0 * token. */ key?: string; /** * OAuth 2.0 token for the current user. */ oauth_token?: string; /** * Returns response with indentations and line breaks. */ prettyPrint?: boolean; /** * Available to use for quota purposes for server-side applications. Can be * any arbitrary string assigned to a user, but should not exceed 40 * characters. */ quotaUser?: string; /** * Legacy upload protocol for media (e.g. "media", "multipart"). */ uploadType?: string; /** * Upload protocol for media (e.g. "raw", "multipart"). */ upload_protocol?: string; } /** * Web Security Scanner API * * Scans your Compute and App Engine apps for common web vulnerabilities. * * @example * const {google} = require('googleapis'); * const websecurityscanner = google.websecurityscanner('v1alpha'); * * @namespace websecurityscanner * @type {Function} * @version v1alpha * @variation v1alpha * @param {object=} options Options for Websecurityscanner */ class Websecurityscanner { projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable); } /** * Scan authentication configuration. */ interface Schema$Authentication { /** * Authentication using a custom account. */ customAccount?: Schema$CustomAccount; /** * Authentication using a Google account. */ googleAccount?: Schema$GoogleAccount; } /** * A CrawledUrl resource represents a URL that was crawled during a ScanRun. * Web Security Scanner Service crawls the web applications, following all * links within the scope of sites, to find the URLs to test against. */ interface Schema$CrawledUrl { /** * Output only. The body of the request that was used to visit the URL. */ body?: string; /** * Output only. The http method of the request that was used to visit the * URL, in uppercase. */ httpMethod?: string; /** * Output only. The URL that was crawled. */ url?: string; } /** * Describes authentication configuration that uses a custom account. */ interface Schema$CustomAccount { /** * Required. The login form URL of the website. */ loginUrl?: string; /** * Input only. Required. The password of the custom account. The credential * is stored encrypted and not returned in any response nor included in * audit logs. */ password?: string; /** * Required. The user name of the custom account. */ username?: string; } /** * A generic empty message that you can re-use to avoid defining duplicated * empty messages in your APIs. A typical example is to use it as the request * or the response type of an API method. For instance: service Foo { rpc * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON * representation for `Empty` is empty JSON object `{}`. */ interface Schema$Empty { } /** * A Finding resource represents a vulnerability instance identified during a * ScanRun. */ interface Schema$Finding { /** * Output only. The body of the request that triggered the vulnerability. */ body?: string; /** * Output only. The description of the vulnerability. */ description?: string; /** * Output only. The URL where the browser lands when the vulnerability is * detected. */ finalUrl?: string; /** * Output only. The type of the Finding. */ findingType?: string; /** * Output only. If the vulnerability was originated from nested IFrame, the * immediate parent IFrame is reported. */ frameUrl?: string; /** * Output only. The URL produced by the server-side fuzzer and used in the * request that triggered the vulnerability. */ fuzzedUrl?: string; /** * Output only. The http method of the request that triggered the * vulnerability, in uppercase. */ httpMethod?: string; /** * Output only. The resource name of the Finding. The name follows the * format of * 'projects/{projectId}/scanConfigs/{scanConfigId}/scanruns/{scanRunId}/findings/{findingId}'. * The finding IDs are generated by the system. */ name?: string; /** * Output only. An addon containing information about outdated libraries. */ outdatedLibrary?: Schema$OutdatedLibrary; /** * Output only. The URL containing human-readable payload that user can * leverage to reproduce the vulnerability. */ reproductionUrl?: string; /** * Output only. The tracking ID uniquely identifies a vulnerability instance * across multiple ScanRuns. */ trackingId?: string; /** * Output only. An addon containing detailed information regarding any * resource causing the vulnerability such as JavaScript sources, image, * audio files, etc. */ violatingResource?: Schema$ViolatingResource; /** * Output only. An addon containing information about vulnerable or missing * HTTP headers. */ vulnerableHeaders?: Schema$VulnerableHeaders; /** * Output only. An addon containing information about request parameters * which were found to be vulnerable. */ vulnerableParameters?: Schema$VulnerableParameters; /** * Output only. An addon containing information reported for an XSS, if any. */ xss?: Schema$Xss; } /** * A FindingTypeStats resource represents stats regarding a specific * FindingType of Findings under a given ScanRun. */ interface Schema$FindingTypeStats { /** * Output only. The count of findings belonging to this finding type. */ findingCount?: number; /** * Output only. The finding type associated with the stats. */ findingType?: string; } /** * Describes authentication configuration that uses a Google account. */ interface Schema$GoogleAccount { /** * Input only. Required. The password of the Google account. The credential * is stored encrypted and not returned in any response nor included in * audit logs. */ password?: string; /** * Required. The user name of the Google account. */ username?: string; } /** * Describes a HTTP Header. */ interface Schema$Header { /** * Header name. */ name?: string; /** * Header value. */ value?: string; } /** * Response for the `ListCrawledUrls` method. */ interface Schema$ListCrawledUrlsResponse { /** * The list of CrawledUrls returned. */ crawledUrls?: Schema$CrawledUrl[]; /** * Token to retrieve the next page of results, or empty if there are no more * results in the list. */ nextPageToken?: string; } /** * Response for the `ListFindings` method. */ interface Schema$ListFindingsResponse { /** * The list of Findings returned. */ findings?: Schema$Finding[]; /** * Token to retrieve the next page of results, or empty if there are no more * results in the list. */ nextPageToken?: string; } /** * Response for the `ListFindingTypeStats` method. */ interface Schema$ListFindingTypeStatsResponse { /** * The list of FindingTypeStats returned. */ findingTypeStats?: Schema$FindingTypeStats[]; } /** * Response for the `ListScanConfigs` method. */ interface Schema$ListScanConfigsResponse { /** * Token to retrieve the next page of results, or empty if there are no more * results in the list. */ nextPageToken?: string; /** * The list of ScanConfigs returned. */ scanConfigs?: Schema$ScanConfig[]; } /** * Response for the `ListScanRuns` method. */ interface Schema$ListScanRunsResponse { /** * Token to retrieve the next page of results, or empty if there are no more * results in the list. */ nextPageToken?: string; /** * The list of ScanRuns returned. */ scanRuns?: Schema$ScanRun[]; } /** * Information reported for an outdated library. */ interface Schema$OutdatedLibrary { /** * URLs to learn more information about the vulnerabilities in the library. */ learnMoreUrls?: string[]; /** * The name of the outdated library. */ libraryName?: string; /** * The version number. */ version?: string; } /** * A ScanConfig resource contains the configurations to launch a scan. next * id: 12 */ interface Schema$ScanConfig { /** * The authentication configuration. If specified, service will use the * authentication configuration during scanning. */ authentication?: Schema$Authentication; /** * The blacklist URL patterns as described in * https://cloud.google.com/security-scanner/docs/excluded-urls */ blacklistPatterns?: string[]; /** * Required. The user provided display name of the ScanConfig. */ displayName?: string; /** * Latest ScanRun if available. */ latestRun?: Schema$ScanRun; /** * The maximum QPS during scanning. A valid value ranges from 5 to 20 * inclusively. If the field is unspecified or its value is set 0, server * will default to 15. Other values outside of [5, 20] range will be * rejected with INVALID_ARGUMENT error. */ maxQps?: number; /** * The resource name of the ScanConfig. The name follows the format of * 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig * IDs are generated by the system. */ name?: string; /** * The schedule of the ScanConfig. */ schedule?: Schema$Schedule; /** * Required. The starting URLs from which the scanner finds site pages. */ startingUrls?: string[]; /** * Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be * used as a default. */ targetPlatforms?: string[]; /** * The user agent used during scanning. */ userAgent?: string; } /** * A ScanRun is a output-only resource representing an actual run of the scan. */ interface Schema$ScanRun { /** * Output only. The time at which the ScanRun reached termination state - * that the ScanRun is either finished or stopped by user. */ endTime?: string; /** * Output only. The execution state of the ScanRun. */ executionState?: string; /** * Output only. Whether the scan run has found any vulnerabilities. */ hasVulnerabilities?: boolean; /** * Output only. The resource name of the ScanRun. The name follows the * format of * 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. * The ScanRun IDs are generated by the system. */ name?: string; /** * Output only. The percentage of total completion ranging from 0 to 100. If * the scan is in queue, the value is 0. If the scan is running, the value * ranges from 0 to 100. If the scan is finished, the value is 100. */ progressPercent?: number; /** * Output only. The result state of the ScanRun. This field is only * available after the execution state reaches "FINISHED". */ resultState?: string; /** * Output only. The time at which the ScanRun started. */ startTime?: string; /** * Output only. The number of URLs crawled during this ScanRun. If the scan * is in progress, the value represents the number of URLs crawled up to * now. */ urlsCrawledCount?: string; /** * Output only. The number of URLs tested during this ScanRun. If the scan * is in progress, the value represents the number of URLs tested up to now. * The number of URLs tested is usually larger than the number URLS crawled * because typically a crawled URL is tested with multiple test payloads. */ urlsTestedCount?: string; } /** * Scan schedule configuration. */ interface Schema$Schedule { /** * Required. The duration of time between executions in days. */ intervalDurationDays?: number; /** * A timestamp indicates when the next run will be scheduled. The value is * refreshed by the server after each run. If unspecified, it will default * to current server time, which means the scan will be scheduled to start * immediately. */ scheduleTime?: string; } /** * Request for the `StartScanRun` method. */ interface Schema$StartScanRunRequest { } /** * Request for the `StopScanRun` method. */ interface Schema$StopScanRunRequest { } /** * Information regarding any resource causing the vulnerability such as * JavaScript sources, image, audio files, etc. */ interface Schema$ViolatingResource { /** * The MIME type of this resource. */ contentType?: string; /** * URL of this violating resource. */ resourceUrl?: string; } /** * Information about vulnerable or missing HTTP Headers. */ interface Schema$VulnerableHeaders { /** * List of vulnerable headers. */ headers?: Schema$Header[]; /** * List of missing headers. */ missingHeaders?: Schema$Header[]; } /** * Information about vulnerable request parameters. */ interface Schema$VulnerableParameters { /** * The vulnerable parameter names. */ parameterNames?: string[]; } /** * Information reported for an XSS. */ interface Schema$Xss { /** * An error message generated by a javascript breakage. */ errorMessage?: string; /** * Stack traces leading to the point where the XSS occurred. */ stackTraces?: string[]; } class Resource$Projects { scanConfigs: Resource$Projects$Scanconfigs; constructor(); } class Resource$Projects$Scanconfigs { scanRuns: Resource$Projects$Scanconfigs$Scanruns; constructor(); /** * websecurityscanner.projects.scanConfigs.create * @desc Creates a new ScanConfig. * @alias websecurityscanner.projects.scanConfigs.create * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.parent Required. The parent resource name where the scan is created, which should be a project resource name in the format 'projects/{projectId}'. * @param {().ScanConfig} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ create(params?: Params$Resource$Projects$Scanconfigs$Create, options?: MethodOptions): GaxiosPromise; create(params: Params$Resource$Projects$Scanconfigs$Create, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; create(params: Params$Resource$Projects$Scanconfigs$Create, callback: BodyResponseCallback): void; create(callback: BodyResponseCallback): void; /** * websecurityscanner.projects.scanConfigs.delete * @desc Deletes an existing ScanConfig and its child resources. * @alias websecurityscanner.projects.scanConfigs.delete * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.name Required. The resource name of the ScanConfig to be deleted. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ delete(params?: Params$Resource$Projects$Scanconfigs$Delete, options?: MethodOptions): GaxiosPromise; delete(params: Params$Resource$Projects$Scanconfigs$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; delete(params: Params$Resource$Projects$Scanconfigs$Delete, callback: BodyResponseCallback): void; delete(callback: BodyResponseCallback): void; /** * websecurityscanner.projects.scanConfigs.get * @desc Gets a ScanConfig. * @alias websecurityscanner.projects.scanConfigs.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.name Required. The resource name of the ScanConfig to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: Params$Resource$Projects$Scanconfigs$Get, options?: MethodOptions): GaxiosPromise; get(params: Params$Resource$Projects$Scanconfigs$Get, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; get(params: Params$Resource$Projects$Scanconfigs$Get, callback: BodyResponseCallback): void; get(callback: BodyResponseCallback): void; /** * websecurityscanner.projects.scanConfigs.list * @desc Lists ScanConfigs under a given project. * @alias websecurityscanner.projects.scanConfigs.list * @memberOf! () * * @param {object} params Parameters for request * @param {integer=} params.pageSize 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. * @param {string=} params.pageToken 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. * @param {string} params.parent Required. The parent resource name, which should be a project resource name in the format 'projects/{projectId}'. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: Params$Resource$Projects$Scanconfigs$List, options?: MethodOptions): GaxiosPromise; list(params: Params$Resource$Projects$Scanconfigs$List, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; list(params: Params$Resource$Projects$Scanconfigs$List, callback: BodyResponseCallback): void; list(callback: BodyResponseCallback): void; /** * websecurityscanner.projects.scanConfigs.patch * @desc Updates a ScanConfig. This method support partial update of a * ScanConfig. * @alias websecurityscanner.projects.scanConfigs.patch * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.name The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system. * @param {string=} params.updateMask Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask * @param {().ScanConfig} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ patch(params?: Params$Resource$Projects$Scanconfigs$Patch, options?: MethodOptions): GaxiosPromise; patch(params: Params$Resource$Projects$Scanconfigs$Patch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; patch(params: Params$Resource$Projects$Scanconfigs$Patch, callback: BodyResponseCallback): void; patch(callback: BodyResponseCallback): void; /** * websecurityscanner.projects.scanConfigs.start * @desc Start a ScanRun according to the given ScanConfig. * @alias websecurityscanner.projects.scanConfigs.start * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.name Required. The resource name of the ScanConfig to be used. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. * @param {().StartScanRunRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ start(params?: Params$Resource$Projects$Scanconfigs$Start, options?: MethodOptions): GaxiosPromise; start(params: Params$Resource$Projects$Scanconfigs$Start, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; start(params: Params$Resource$Projects$Scanconfigs$Start, callback: BodyResponseCallback): void; start(callback: BodyResponseCallback): void; } interface Params$Resource$Projects$Scanconfigs$Create extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Required. The parent resource name where the scan is created, which * should be a project resource name in the format 'projects/{projectId}'. */ parent?: string; /** * Request body metadata */ requestBody?: Schema$ScanConfig; } interface Params$Resource$Projects$Scanconfigs$Delete extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Required. The resource name of the ScanConfig to be deleted. The name * follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. */ name?: string; } interface Params$Resource$Projects$Scanconfigs$Get extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Required. The resource name of the ScanConfig to be returned. The name * follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. */ name?: string; } interface Params$Resource$Projects$Scanconfigs$List extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * 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. */ pageSize?: number; /** * 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. */ pageToken?: string; /** * Required. The parent resource name, which should be a project resource * name in the format 'projects/{projectId}'. */ parent?: string; } interface Params$Resource$Projects$Scanconfigs$Patch extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * The resource name of the ScanConfig. The name follows the format of * 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are * generated by the system. */ name?: string; /** * Required. The update mask applies to the resource. For the `FieldMask` * definition, see * https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask */ updateMask?: string; /** * Request body metadata */ requestBody?: Schema$ScanConfig; } interface Params$Resource$Projects$Scanconfigs$Start extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Required. The resource name of the ScanConfig to be used. The name * follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. */ name?: string; /** * Request body metadata */ requestBody?: Schema$StartScanRunRequest; } class Resource$Projects$Scanconfigs$Scanruns { crawledUrls: Resource$Projects$Scanconfigs$Scanruns$Crawledurls; findings: Resource$Projects$Scanconfigs$Scanruns$Findings; findingTypeStats: Resource$Projects$Scanconfigs$Scanruns$Findingtypestats; constructor(); /** * websecurityscanner.projects.scanConfigs.scanRuns.get * @desc Gets a ScanRun. * @alias websecurityscanner.projects.scanConfigs.scanRuns.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.name Required. The resource name of the ScanRun to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: Params$Resource$Projects$Scanconfigs$Scanruns$Get, options?: MethodOptions): GaxiosPromise; get(params: Params$Resource$Projects$Scanconfigs$Scanruns$Get, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; get(params: Params$Resource$Projects$Scanconfigs$Scanruns$Get, callback: BodyResponseCallback): void; get(callback: BodyResponseCallback): void; /** * websecurityscanner.projects.scanConfigs.scanRuns.list * @desc Lists ScanRuns under a given ScanConfig, in descending order of * ScanRun stop time. * @alias websecurityscanner.projects.scanConfigs.scanRuns.list * @memberOf! () * * @param {object} params Parameters for request * @param {integer=} params.pageSize 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. * @param {string=} params.pageToken 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. * @param {string} params.parent Required. The parent resource name, which should be a scan resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}'. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: Params$Resource$Projects$Scanconfigs$Scanruns$List, options?: MethodOptions): GaxiosPromise; list(params: Params$Resource$Projects$Scanconfigs$Scanruns$List, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; list(params: Params$Resource$Projects$Scanconfigs$Scanruns$List, callback: BodyResponseCallback): void; list(callback: BodyResponseCallback): void; /** * websecurityscanner.projects.scanConfigs.scanRuns.stop * @desc Stops a ScanRun. The stopped ScanRun is returned. * @alias websecurityscanner.projects.scanConfigs.scanRuns.stop * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.name Required. The resource name of the ScanRun to be stopped. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. * @param {().StopScanRunRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ stop(params?: Params$Resource$Projects$Scanconfigs$Scanruns$Stop, options?: MethodOptions): GaxiosPromise; stop(params: Params$Resource$Projects$Scanconfigs$Scanruns$Stop, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; stop(params: Params$Resource$Projects$Scanconfigs$Scanruns$Stop, callback: BodyResponseCallback): void; stop(callback: BodyResponseCallback): void; } interface Params$Resource$Projects$Scanconfigs$Scanruns$Get extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Required. The resource name of the ScanRun to be returned. The name * follows the format of * 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. */ name?: string; } interface Params$Resource$Projects$Scanconfigs$Scanruns$List extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * 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. */ pageSize?: number; /** * 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. */ pageToken?: string; /** * Required. The parent resource name, which should be a scan resource name * in the format 'projects/{projectId}/scanConfigs/{scanConfigId}'. */ parent?: string; } interface Params$Resource$Projects$Scanconfigs$Scanruns$Stop extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Required. The resource name of the ScanRun to be stopped. The name * follows the format of * 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. */ name?: string; /** * Request body metadata */ requestBody?: Schema$StopScanRunRequest; } class Resource$Projects$Scanconfigs$Scanruns$Crawledurls { constructor(); /** * websecurityscanner.projects.scanConfigs.scanRuns.crawledUrls.list * @desc List CrawledUrls under a given ScanRun. * @alias websecurityscanner.projects.scanConfigs.scanRuns.crawledUrls.list * @memberOf! () * * @param {object} params Parameters for request * @param {integer=} params.pageSize 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. * @param {string=} params.pageToken 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. * @param {string} params.parent Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: Params$Resource$Projects$Scanconfigs$Scanruns$Crawledurls$List, options?: MethodOptions): GaxiosPromise; list(params: Params$Resource$Projects$Scanconfigs$Scanruns$Crawledurls$List, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; list(params: Params$Resource$Projects$Scanconfigs$Scanruns$Crawledurls$List, callback: BodyResponseCallback): void; list(callback: BodyResponseCallback): void; } interface Params$Resource$Projects$Scanconfigs$Scanruns$Crawledurls$List extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * 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. */ pageSize?: number; /** * 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. */ pageToken?: string; /** * Required. The parent resource name, which should be a scan run resource * name in the format * 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. */ parent?: string; } class Resource$Projects$Scanconfigs$Scanruns$Findings { constructor(); /** * websecurityscanner.projects.scanConfigs.scanRuns.findings.get * @desc Gets a Finding. * @alias websecurityscanner.projects.scanConfigs.scanRuns.findings.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.name Required. The resource name of the Finding to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}/findings/{findingId}'. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: Params$Resource$Projects$Scanconfigs$Scanruns$Findings$Get, options?: MethodOptions): GaxiosPromise; get(params: Params$Resource$Projects$Scanconfigs$Scanruns$Findings$Get, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; get(params: Params$Resource$Projects$Scanconfigs$Scanruns$Findings$Get, callback: BodyResponseCallback): void; get(callback: BodyResponseCallback): void; /** * websecurityscanner.projects.scanConfigs.scanRuns.findings.list * @desc List Findings under a given ScanRun. * @alias websecurityscanner.projects.scanConfigs.scanRuns.findings.list * @memberOf! () * * @param {object} params Parameters for request * @param {string=} params.filter The filter expression. The expression must be in the format: . Supported field: 'finding_type'. Supported operator: '='. * @param {integer=} params.pageSize The maximum number of Findings to return, can be limited by server. If not specified or not positive, the implementation will select a reasonable value. * @param {string=} params.pageToken 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. * @param {string} params.parent Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: Params$Resource$Projects$Scanconfigs$Scanruns$Findings$List, options?: MethodOptions): GaxiosPromise; list(params: Params$Resource$Projects$Scanconfigs$Scanruns$Findings$List, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; list(params: Params$Resource$Projects$Scanconfigs$Scanruns$Findings$List, callback: BodyResponseCallback): void; list(callback: BodyResponseCallback): void; } interface Params$Resource$Projects$Scanconfigs$Scanruns$Findings$Get extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Required. The resource name of the Finding to be returned. The name * follows the format of * 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}/findings/{findingId}'. */ name?: string; } interface Params$Resource$Projects$Scanconfigs$Scanruns$Findings$List extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * The filter expression. The expression must be in the format: * . Supported field: 'finding_type'. Supported operator: * '='. */ filter?: string; /** * The maximum number of Findings to return, can be limited by server. If * not specified or not positive, the implementation will select a * reasonable value. */ pageSize?: number; /** * 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. */ pageToken?: string; /** * Required. The parent resource name, which should be a scan run resource * name in the format * 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. */ parent?: string; } class Resource$Projects$Scanconfigs$Scanruns$Findingtypestats { constructor(); /** * websecurityscanner.projects.scanConfigs.scanRuns.findingTypeStats.list * @desc List all FindingTypeStats under a given ScanRun. * @alias * websecurityscanner.projects.scanConfigs.scanRuns.findingTypeStats.list * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.parent Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: Params$Resource$Projects$Scanconfigs$Scanruns$Findingtypestats$List, options?: MethodOptions): GaxiosPromise; list(params: Params$Resource$Projects$Scanconfigs$Scanruns$Findingtypestats$List, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; list(params: Params$Resource$Projects$Scanconfigs$Scanruns$Findingtypestats$List, callback: BodyResponseCallback): void; list(callback: BodyResponseCallback): void; } interface Params$Resource$Projects$Scanconfigs$Scanruns$Findingtypestats$List extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Required. The parent resource name, which should be a scan run resource * name in the format * 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. */ parent?: string; } }