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
Name | Description |
opts |
ClientOptions
|
Properties
apiEndpoint
static get apiEndpoint(): string;
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
Property Value
auth
Property Value
Type | Description |
gax.GoogleAuth | |
descriptors
descriptors: Descriptors;
Property Value
Type | Description |
Descriptors | |
innerApiCalls
innerApiCalls: {
[name: string]: Function;
};
Property Value
Type | Description |
{
[name: string]: Function;
} | |
pathTemplates
pathTemplates: {
[name: string]: gax.PathTemplate;
};
Property Value
Type | Description |
{
[name: string]: gax.PathTemplate;
} | |
port
static get port(): number;
The port for this API service.
Property Value
scopes
static get scopes(): string[];
The scopes needed to make gRPC calls for every method defined in this service.
Property Value
servicePath
static get servicePath(): string;
The DNS address for this API service.
Property Value
warn
warn: (code: string, message: string, warnType?: string) => void;
Property Value
Type | Description |
(code: string, message: string, warnType?: string) => void | |
webSecurityScannerStub
webSecurityScannerStub?: Promise<{
[name: string]: Function;
}>;
Property Value
Type | Description |
Promise<{
[name: string]: Function;
}> | |
Methods
close()
Terminate the gRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
Returns
Type | Description |
Promise<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
]>;
Parameters
Name | Description |
request |
protos.google.cloud.websecurityscanner.v1beta.ICreateScanConfigRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
protos.google.cloud.websecurityscanner.v1beta.IScanConfig,
(protos.google.cloud.websecurityscanner.v1beta.ICreateScanConfigRequest | undefined),
{} | undefined
]> | |
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
Name | Description |
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
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
Name | Description |
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
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
]>;
Parameters
Name | Description |
request |
protos.google.cloud.websecurityscanner.v1beta.IDeleteScanConfigRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
protos.google.protobuf.IEmpty,
(protos.google.cloud.websecurityscanner.v1beta.IDeleteScanConfigRequest | undefined),
{} | undefined
]> | |
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
Name | Description |
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
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
Name | Description |
request |
protos.google.cloud.websecurityscanner.v1beta.IDeleteScanConfigRequest
|
callback |
Callback<protos.google.protobuf.IEmpty, protos.google.cloud.websecurityscanner.v1beta.IDeleteScanConfigRequest | null | undefined, {} | null | undefined>
|
Returns
findingPath(project, scanConfig, scanRun, finding)
findingPath(project: string, scanConfig: string, scanRun: string, finding: string): string;
Return a fully-qualified finding resource name string.
Parameters
Name | Description |
project |
string
|
scanConfig |
string
|
scanRun |
string
|
finding |
string
|
Returns
Type | Description |
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
]>;
Parameters
Name | Description |
request |
protos.google.cloud.websecurityscanner.v1beta.IGetFindingRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
protos.google.cloud.websecurityscanner.v1beta.IFinding,
(protos.google.cloud.websecurityscanner.v1beta.IGetFindingRequest | undefined),
{} | undefined
]> | |
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
Name | Description |
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
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
Name | Description |
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
getProjectId()
getProjectId(): Promise<string>;
Returns
Type | Description |
Promise<string> | |
getProjectId(callback)
getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
Name | Description |
callback |
Callback<string, undefined, undefined>
|
Returns
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
]>;
Parameters
Name | Description |
request |
protos.google.cloud.websecurityscanner.v1beta.IGetScanConfigRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
protos.google.cloud.websecurityscanner.v1beta.IScanConfig,
(protos.google.cloud.websecurityscanner.v1beta.IGetScanConfigRequest | undefined),
{} | undefined
]> | |
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
Name | Description |
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
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
Name | Description |
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
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
]>;
Parameters
Name | Description |
request |
protos.google.cloud.websecurityscanner.v1beta.IGetScanRunRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
protos.google.cloud.websecurityscanner.v1beta.IScanRun,
(protos.google.cloud.websecurityscanner.v1beta.IGetScanRunRequest | undefined),
{} | undefined
]> | |
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
Name | Description |
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
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
Name | Description |
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
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
Type | Description |
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
]>;
Parameters
Name | Description |
request |
protos.google.cloud.websecurityscanner.v1beta.IListCrawledUrlsRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
protos.google.cloud.websecurityscanner.v1beta.ICrawledUrl[],
protos.google.cloud.websecurityscanner.v1beta.IListCrawledUrlsRequest | null,
protos.google.cloud.websecurityscanner.v1beta.IListCrawledUrlsResponse
]> | |
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
Name | Description |
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
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
Name | Description |
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
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
Name | Description |
request |
protos.google.cloud.websecurityscanner.v1beta.IListCrawledUrlsRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
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.
|
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
Name | Description |
request |
protos.google.cloud.websecurityscanner.v1beta.IListCrawledUrlsRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
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
]>;
Parameters
Name | Description |
request |
protos.google.cloud.websecurityscanner.v1beta.IListFindingsRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
protos.google.cloud.websecurityscanner.v1beta.IFinding[],
protos.google.cloud.websecurityscanner.v1beta.IListFindingsRequest | null,
protos.google.cloud.websecurityscanner.v1beta.IListFindingsResponse
]> | |
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
Name | Description |
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
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
Name | Description |
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
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
Name | Description |
request |
protos.google.cloud.websecurityscanner.v1beta.IListFindingsRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
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.
|
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
Name | Description |
request |
protos.google.cloud.websecurityscanner.v1beta.IListFindingsRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
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
]>;
Parameters
Name | Description |
request |
protos.google.cloud.websecurityscanner.v1beta.IListFindingTypeStatsRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
protos.google.cloud.websecurityscanner.v1beta.IListFindingTypeStatsResponse,
(protos.google.cloud.websecurityscanner.v1beta.IListFindingTypeStatsRequest | undefined),
{} | undefined
]> | |
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
Name | Description |
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
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
Name | Description |
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
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
]>;
Parameters
Name | Description |
request |
protos.google.cloud.websecurityscanner.v1beta.IListScanConfigsRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
protos.google.cloud.websecurityscanner.v1beta.IScanConfig[],
protos.google.cloud.websecurityscanner.v1beta.IListScanConfigsRequest | null,
protos.google.cloud.websecurityscanner.v1beta.IListScanConfigsResponse
]> | |
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
Name | Description |
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
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
Name | Description |
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
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
Name | Description |
request |
protos.google.cloud.websecurityscanner.v1beta.IListScanConfigsRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
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.
|
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
Name | Description |
request |
protos.google.cloud.websecurityscanner.v1beta.IListScanConfigsRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
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
]>;
Parameters
Name | Description |
request |
protos.google.cloud.websecurityscanner.v1beta.IListScanRunsRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
protos.google.cloud.websecurityscanner.v1beta.IScanRun[],
protos.google.cloud.websecurityscanner.v1beta.IListScanRunsRequest | null,
protos.google.cloud.websecurityscanner.v1beta.IListScanRunsResponse
]> | |
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
Name | Description |
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
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
Name | Description |
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
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
Name | Description |
request |
protos.google.cloud.websecurityscanner.v1beta.IListScanRunsRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
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.
|
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
Name | Description |
request |
protos.google.cloud.websecurityscanner.v1beta.IListScanRunsRequest
The request object that will be sent.
|
options |
CallOptions
Call options. See CallOptions for more details.
|
Returns
Type | Description |
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
Name | Description |
findingName |
string
A fully-qualified path representing Finding resource.
|
Returns
Type | Description |
string | number | {string} A string representing the finding.
|
matchProjectFromFindingName(findingName)
matchProjectFromFindingName(findingName: string): string | number;
Parse the project from Finding resource.
Parameter
Name | Description |
findingName |
string
A fully-qualified path representing Finding resource.
|
Returns
Type | Description |
string | number | {string} A string representing the project.
|
matchProjectFromProjectName(projectName)
matchProjectFromProjectName(projectName: string): string | number;
Parse the project from Project resource.
Parameter
Name | Description |
projectName |
string
A fully-qualified path representing Project resource.
|
Returns
Type | Description |
string | number | {string} A string representing the project.
|
matchProjectFromScanConfigName(scanConfigName)
matchProjectFromScanConfigName(scanConfigName: string): string | number;
Parse the project from ScanConfig resource.
Parameter
Name | Description |
scanConfigName |
string
A fully-qualified path representing ScanConfig resource.
|
Returns
Type | Description |
string | number | {string} A string representing the project.
|
matchProjectFromScanRunName(scanRunName)
matchProjectFromScanRunName(scanRunName: string): string | number;
Parse the project from ScanRun resource.
Parameter
Name | Description |
scanRunName |
string
A fully-qualified path representing ScanRun resource.
|
Returns
Type | Description |
string | number | {string} A string representing the project.
|
matchScanConfigFromFindingName(findingName)
matchScanConfigFromFindingName(findingName: string): string | number;
Parse the scan_config from Finding resource.
Parameter
Name | Description |
findingName |
string
A fully-qualified path representing Finding resource.
|
Returns
Type | Description |
string | number | {string} A string representing the scan_config.
|
matchScanConfigFromScanConfigName(scanConfigName)
matchScanConfigFromScanConfigName(scanConfigName: string): string | number;
Parse the scan_config from ScanConfig resource.
Parameter
Name | Description |
scanConfigName |
string
A fully-qualified path representing ScanConfig resource.
|
Returns
Type | Description |
string | number | {string} A string representing the scan_config.
|
matchScanConfigFromScanRunName(scanRunName)
matchScanConfigFromScanRunName(scanRunName: string): string | number;
Parse the scan_config from ScanRun resource.
Parameter
Name | Description |
scanRunName |
string
A fully-qualified path representing ScanRun resource.
|
Returns
Type | Description |
string | number | {string} A string representing the scan_config.
|
matchScanRunFromFindingName(findingName)
matchScanRunFromFindingName(findingName: string): string | number;
Parse the scan_run from Finding resource.
Parameter
Name | Description |
findingName |
string
A fully-qualified path representing Finding resource.
|
Returns
Type | Description |
string | number | {string} A string representing the scan_run.
|
matchScanRunFromScanRunName(scanRunName)
matchScanRunFromScanRunName(scanRunName: string): string | number;
Parse the scan_run from ScanRun resource.
Parameter
Name | Description |
scanRunName |
string
A fully-qualified path representing ScanRun resource.
|
Returns
Type | Description |
string | number | {string} A string representing the scan_run.
|
projectPath(project)
projectPath(project: string): string;
Return a fully-qualified project resource name string.
Parameter
Name | Description |
project |
string
|
Returns
Type | Description |
string | {string} Resource name string.
|
scanConfigPath(project, scanConfig)
scanConfigPath(project: string, scanConfig: string): string;
Return a fully-qualified scanConfig resource name string.
Parameters
Name | Description |
project |
string
|
scanConfig |
string
|
Returns
Type | Description |
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
Name | Description |
project |
string
|
scanConfig |
string
|
scanRun |
string
|
Returns
Type | Description |
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
]>;
Parameters
Name | Description |
request |
protos.google.cloud.websecurityscanner.v1beta.IStartScanRunRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
protos.google.cloud.websecurityscanner.v1beta.IScanRun,
(protos.google.cloud.websecurityscanner.v1beta.IStartScanRunRequest | undefined),
{} | undefined
]> | |
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
Name | Description |
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
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
Name | Description |
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
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
]>;
Parameters
Name | Description |
request |
protos.google.cloud.websecurityscanner.v1beta.IStopScanRunRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
protos.google.cloud.websecurityscanner.v1beta.IScanRun,
(protos.google.cloud.websecurityscanner.v1beta.IStopScanRunRequest | undefined),
{} | undefined
]> | |
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
Name | Description |
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
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
Name | Description |
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
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
]>;
Parameters
Name | Description |
request |
protos.google.cloud.websecurityscanner.v1beta.IUpdateScanConfigRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
protos.google.cloud.websecurityscanner.v1beta.IScanConfig,
(protos.google.cloud.websecurityscanner.v1beta.IUpdateScanConfigRequest | undefined),
{} | undefined
]> | |
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
Name | Description |
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
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
Name | Description |
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