Class: Google::Apis::WebsecurityscannerV1alpha::WebSecurityScannerService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
generated/google/apis/websecurityscanner_v1alpha/service.rb

Overview

Web Security Scanner API

Scans your Compute and App Engine apps for common web vulnerabilities.

Examples:

require 'google/apis/websecurityscanner_v1alpha'

Websecurityscanner = Google::Apis::WebsecurityscannerV1alpha # Alias the module
service = Websecurityscanner::WebSecurityScannerService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initialize ⇒ WebSecurityScannerService

Returns a new instance of WebSecurityScannerService.



45
46
47
48
 
# File 'generated/google/apis/websecurityscanner_v1alpha/service.rb', line 45

def initialize
  super('https://websecurityscanner.googleapis.com/', '')
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

Returns 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.

Returns:

  • (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.



38
39
40
 
# File 'generated/google/apis/websecurityscanner_v1alpha/service.rb', line 38

def key
  @key
end

#quota_user ⇒ String

Returns 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.

Returns:

  • (String) —

    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.



43
44
45
 
# File 'generated/google/apis/websecurityscanner_v1alpha/service.rb', line 43

def quota_user
  @quota_user
end

Instance Method Details

#create_project_scan_config(parent, scan_config_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::WebsecurityscannerV1alpha::ScanConfig

Creates a new ScanConfig.

Parameters:

  • parent (String) —

    Required. The parent resource name where the scan is created, which should be a project resource name in the format 'projects/projectId'.

  • scan_config_object (Google::Apis::WebsecurityscannerV1alpha::ScanConfig) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



73
74
75
76
77
78
79
80
81
82
83
 
# File 'generated/google/apis/websecurityscanner_v1alpha/service.rb', line 73

def create_project_scan_config(parent, scan_config_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha/{+parent}/scanConfigs', options)
  command.request_representation = Google::Apis::WebsecurityscannerV1alpha::ScanConfig::Representation
  command.request_object = scan_config_object
  command.response_representation = Google::Apis::WebsecurityscannerV1alpha::ScanConfig::Representation
  command.response_class = Google::Apis::WebsecurityscannerV1alpha::ScanConfig
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_scan_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::WebsecurityscannerV1alpha::Empty

Deletes an existing ScanConfig and its child resources.

Parameters:

  • name (String) —

    Required. The resource name of the ScanConfig to be deleted. The name follows the format of 'projects/projectId/scanConfigs/scanConfigId'.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



107
108
109
110
111
112
113
114
115
 
# File 'generated/google/apis/websecurityscanner_v1alpha/service.rb', line 107

def delete_project_scan_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1alpha/{+name}', options)
  command.response_representation = Google::Apis::WebsecurityscannerV1alpha::Empty::Representation
  command.response_class = Google::Apis::WebsecurityscannerV1alpha::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_scan_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::WebsecurityscannerV1alpha::ScanConfig

Gets a ScanConfig.

Parameters:

  • name (String) —

    Required. The resource name of the ScanConfig to be returned. The name follows the format of 'projects/projectId/scanConfigs/scanConfigId'.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



139
140
141
142
143
144
145
146
147
 
# File 'generated/google/apis/websecurityscanner_v1alpha/service.rb', line 139

def get_project_scan_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/{+name}', options)
  command.response_representation = Google::Apis::WebsecurityscannerV1alpha::ScanConfig::Representation
  command.response_class = Google::Apis::WebsecurityscannerV1alpha::ScanConfig
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_scan_config_scan_run(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::WebsecurityscannerV1alpha::ScanRun

Gets a ScanRun.

Parameters:

  • name (String) —

    Required. The resource name of the ScanRun to be returned. The name follows the format of 'projects/projectId/scanConfigs/scanConfigId/scanRuns/scanRunId'.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



290
291
292
293
294
295
296
297
298
 
# File 'generated/google/apis/websecurityscanner_v1alpha/service.rb', line 290

def get_project_scan_config_scan_run(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/{+name}', options)
  command.response_representation = Google::Apis::WebsecurityscannerV1alpha::ScanRun::Representation
  command.response_class = Google::Apis::WebsecurityscannerV1alpha::ScanRun
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_scan_config_scan_run_finding(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::WebsecurityscannerV1alpha::Finding

Gets a Finding.

Parameters:

  • name (String) —

    Required. The resource name of the Finding to be returned. The name follows the format of 'projects/projectId/scanConfigs/scanConfigId/scanRuns/scanRunId/findings/ findingId'.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



478
479
480
481
482
483
484
485
486
 
# File 'generated/google/apis/websecurityscanner_v1alpha/service.rb', line 478

def get_project_scan_config_scan_run_finding(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/{+name}', options)
  command.response_representation = Google::Apis::WebsecurityscannerV1alpha::Finding::Representation
  command.response_class = Google::Apis::WebsecurityscannerV1alpha::Finding
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_scan_config_scan_run_crawled_urls(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::WebsecurityscannerV1alpha::ListCrawledUrlsResponse

List CrawledUrls under a given ScanRun.

Parameters:

  • parent (String) —

    Required. The parent resource name, which should be a scan run resource name in the format 'projects/projectId/scanConfigs/scanConfigId/scanRuns/scanRunId'.

  • page_size (Fixnum) (defaults to: nil) —

    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.

  • page_token (String) (defaults to: nil) —

    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.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



409
410
411
412
413
414
415
416
417
418
419
 
# File 'generated/google/apis/websecurityscanner_v1alpha/service.rb', line 409

def list_project_scan_config_scan_run_crawled_urls(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/{+parent}/crawledUrls', options)
  command.response_representation = Google::Apis::WebsecurityscannerV1alpha::ListCrawledUrlsResponse::Representation
  command.response_class = Google::Apis::WebsecurityscannerV1alpha::ListCrawledUrlsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_scan_config_scan_run_finding_type_stats(parent, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::WebsecurityscannerV1alpha::ListFindingTypeStatsResponse

List all FindingTypeStats under a given ScanRun.

Parameters:

  • parent (String) —

    Required. The parent resource name, which should be a scan run resource name in the format 'projects/projectId/scanConfigs/scanConfigId/scanRuns/scanRunId'.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



444
445
446
447
448
449
450
451
452
 
# File 'generated/google/apis/websecurityscanner_v1alpha/service.rb', line 444

def list_project_scan_config_scan_run_finding_type_stats(parent, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/{+parent}/findingTypeStats', options)
  command.response_representation = Google::Apis::WebsecurityscannerV1alpha::ListFindingTypeStatsResponse::Representation
  command.response_class = Google::Apis::WebsecurityscannerV1alpha::ListFindingTypeStatsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_scan_config_scan_run_findings(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::WebsecurityscannerV1alpha::ListFindingsResponse

List Findings under a given ScanRun.

Parameters:

  • parent (String) —

    Required. The parent resource name, which should be a scan run resource name in the format 'projects/projectId/scanConfigs/scanConfigId/scanRuns/scanRunId'.

  • filter (String) (defaults to: nil) —

    Required. The filter expression. The expression must be in the format: . Supported field: 'finding_type'. Supported operator: '='.

  • page_size (Fixnum) (defaults to: nil) —

    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.

  • page_token (String) (defaults to: nil) —

    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.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



524
525
526
527
528
529
530
531
532
533
534
535
 
# File 'generated/google/apis/websecurityscanner_v1alpha/service.rb', line 524

def list_project_scan_config_scan_run_findings(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/{+parent}/findings', options)
  command.response_representation = Google::Apis::WebsecurityscannerV1alpha::ListFindingsResponse::Representation
  command.response_class = Google::Apis::WebsecurityscannerV1alpha::ListFindingsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_scan_config_scan_runs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::WebsecurityscannerV1alpha::ListScanRunsResponse

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

Parameters:

  • parent (String) —

    Required. The parent resource name, which should be a scan resource name in the format 'projects/projectId/scanConfigs/scanConfigId'.

  • page_size (Fixnum) (defaults to: nil) —

    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.

  • page_token (String) (defaults to: nil) —

    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.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



331
332
333
334
335
336
337
338
339
340
341
 
# File 'generated/google/apis/websecurityscanner_v1alpha/service.rb', line 331

def list_project_scan_config_scan_runs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/{+parent}/scanRuns', options)
  command.response_representation = Google::Apis::WebsecurityscannerV1alpha::ListScanRunsResponse::Representation
  command.response_class = Google::Apis::WebsecurityscannerV1alpha::ListScanRunsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_scan_configs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::WebsecurityscannerV1alpha::ListScanConfigsResponse

Lists ScanConfigs under a given project.

Parameters:

  • parent (String) —

    Required. The parent resource name, which should be a project resource name in the format 'projects/projectId'.

  • page_size (Fixnum) (defaults to: nil) —

    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.

  • page_token (String) (defaults to: nil) —

    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.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



179
180
181
182
183
184
185
186
187
188
189
 
# File 'generated/google/apis/websecurityscanner_v1alpha/service.rb', line 179

def list_project_scan_configs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha/{+parent}/scanConfigs', options)
  command.response_representation = Google::Apis::WebsecurityscannerV1alpha::ListScanConfigsResponse::Representation
  command.response_class = Google::Apis::WebsecurityscannerV1alpha::ListScanConfigsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_scan_config(name, scan_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::WebsecurityscannerV1alpha::ScanConfig

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

Parameters:

  • name (String) —

    The resource name of the ScanConfig. The name follows the format of 'projects/projectId/scanConfigs/scanConfigId'. The ScanConfig IDs are generated by the system.

  • scan_config_object (Google::Apis::WebsecurityscannerV1alpha::ScanConfig) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Required. The update mask applies to the resource. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf# fieldmask

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'generated/google/apis/websecurityscanner_v1alpha/service.rb', line 220

def patch_project_scan_config(name, scan_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1alpha/{+name}', options)
  command.request_representation = Google::Apis::WebsecurityscannerV1alpha::ScanConfig::Representation
  command.request_object = scan_config_object
  command.response_representation = Google::Apis::WebsecurityscannerV1alpha::ScanConfig::Representation
  command.response_class = Google::Apis::WebsecurityscannerV1alpha::ScanConfig
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#start_scan_config_scan_run(name, start_scan_run_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::WebsecurityscannerV1alpha::ScanRun

Start a ScanRun according to the given ScanConfig.

Parameters:

  • name (String) —

    Required. The resource name of the ScanConfig to be used. The name follows the format of 'projects/projectId/scanConfigs/scanConfigId'.

  • start_scan_run_request_object (Google::Apis::WebsecurityscannerV1alpha::StartScanRunRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



255
256
257
258
259
260
261
262
263
264
265
 
# File 'generated/google/apis/websecurityscanner_v1alpha/service.rb', line 255

def start_scan_config_scan_run(name, start_scan_run_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha/{+name}:start', options)
  command.request_representation = Google::Apis::WebsecurityscannerV1alpha::StartScanRunRequest::Representation
  command.request_object = start_scan_run_request_object
  command.response_representation = Google::Apis::WebsecurityscannerV1alpha::ScanRun::Representation
  command.response_class = Google::Apis::WebsecurityscannerV1alpha::ScanRun
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#stop_scan_run(name, stop_scan_run_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::WebsecurityscannerV1alpha::ScanRun

Stops a ScanRun. The stopped ScanRun is returned.

Parameters:

  • name (String) —

    Required. The resource name of the ScanRun to be stopped. The name follows the format of 'projects/projectId/scanConfigs/scanConfigId/scanRuns/scanRunId'.

  • stop_scan_run_request_object (Google::Apis::WebsecurityscannerV1alpha::StopScanRunRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



366
367
368
369
370
371
372
373
374
375
376
 
# File 'generated/google/apis/websecurityscanner_v1alpha/service.rb', line 366

def stop_scan_run(name, stop_scan_run_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha/{+name}:stop', options)
  command.request_representation = Google::Apis::WebsecurityscannerV1alpha::StopScanRunRequest::Representation
  command.request_object = stop_scan_run_request_object
  command.response_representation = Google::Apis::WebsecurityscannerV1alpha::ScanRun::Representation
  command.response_class = Google::Apis::WebsecurityscannerV1alpha::ScanRun
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end