Class: Google::Cloud::WebSecurityScanner::V1beta::WebSecurityScanner::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/web_security_scanner/v1beta/web_security_scanner/client.rb

Overview

Client for the WebSecurityScanner service.

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.

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#finding_path, #project_path, #scan_config_path, #scan_run_path

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new WebSecurityScanner client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::WebSecurityScanner::V1beta::WebSecurityScanner::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::WebSecurityScanner::V1beta::WebSecurityScanner::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the WebSecurityScanner client.

Yield Parameters:



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/google/cloud/web_security_scanner/v1beta/web_security_scanner/client.rb', line 176

def initialize
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "gapic/grpc"
  require "google/cloud/websecurityscanner/v1beta/web_security_scanner_services_pb"

  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint.nil? ||
                           (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
                           !@config.endpoint.split(".").first.include?("-"))
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end
  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @web_security_scanner_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::WebSecurityScanner::V1beta::WebSecurityScanner::Stub,
    credentials: credentials,
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors,
    channel_pool_config: @config.channel_pool
  )
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the WebSecurityScanner Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all WebSecurityScanner clients
::Google::Cloud::WebSecurityScanner::V1beta::WebSecurityScanner::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/google/cloud/web_security_scanner/v1beta/web_security_scanner/client.rb', line 61

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "WebSecurityScanner", "V1beta"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config.rpcs.create_scan_config.timeout = 600.0

    default_config.rpcs.delete_scan_config.timeout = 600.0
    default_config.rpcs.delete_scan_config.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.get_scan_config.timeout = 600.0
    default_config.rpcs.get_scan_config.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.list_scan_configs.timeout = 600.0
    default_config.rpcs.list_scan_configs.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.update_scan_config.timeout = 600.0

    default_config.rpcs.start_scan_run.timeout = 600.0

    default_config.rpcs.get_scan_run.timeout = 600.0
    default_config.rpcs.get_scan_run.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.list_scan_runs.timeout = 600.0
    default_config.rpcs.list_scan_runs.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.stop_scan_run.timeout = 600.0

    default_config.rpcs.list_crawled_urls.timeout = 600.0
    default_config.rpcs.list_crawled_urls.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.get_finding.timeout = 600.0
    default_config.rpcs.get_finding.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.list_findings.timeout = 600.0
    default_config.rpcs.list_findings.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.list_finding_type_stats.timeout = 600.0
    default_config.rpcs.list_finding_type_stats.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#configure {|config| ... } ⇒ Client::Configuration

Configure the WebSecurityScanner Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on configure.

See Configuration for a description of the configuration fields.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



146
147
148
149
 
# File 'lib/google/cloud/web_security_scanner/v1beta/web_security_scanner/client.rb', line 146

def configure
  yield @config if block_given?
  @config
end

#create_scan_config(request, options = nil) ⇒ ::Google::Cloud::WebSecurityScanner::V1beta::ScanConfig #create_scan_config(parent: nil, scan_config: nil) ⇒ ::Google::Cloud::WebSecurityScanner::V1beta::ScanConfig

Creates a new ScanConfig.

Examples:

Basic example

require "google/cloud/web_security_scanner/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::WebSecurityScanner::V1beta::WebSecurityScanner::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::WebSecurityScanner::V1beta::CreateScanConfigRequest.new

# Call the create_scan_config method.
result = client.create_scan_config request

# The returned object is of type Google::Cloud::WebSecurityScanner::V1beta::ScanConfig.
p result

Overloads:

  • #create_scan_config(request, options = nil) ⇒ ::Google::Cloud::WebSecurityScanner::V1beta::ScanConfig

    Pass arguments to create_scan_config via a request object, either of type CreateScanConfigRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::WebSecurityScanner::V1beta::CreateScanConfigRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #create_scan_config(parent: nil, scan_config: nil) ⇒ ::Google::Cloud::WebSecurityScanner::V1beta::ScanConfig

    Pass arguments to create_scan_config via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

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

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

    • scan_config (::Google::Cloud::WebSecurityScanner::V1beta::ScanConfig, ::Hash) (defaults to: nil) —

      Required. The ScanConfig to be created.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/google/cloud/web_security_scanner/v1beta/web_security_scanner/client.rb', line 265

def create_scan_config request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::WebSecurityScanner::V1beta::CreateScanConfigRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_scan_config.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::WebSecurityScanner::V1beta::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_scan_config.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_scan_config.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @web_security_scanner_stub.call_rpc :create_scan_config, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_scan_config(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_scan_config(name: nil) ⇒ ::Google::Protobuf::Empty

Deletes an existing ScanConfig and its child resources.

Examples:

Basic example

require "google/cloud/web_security_scanner/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::WebSecurityScanner::V1beta::WebSecurityScanner::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::WebSecurityScanner::V1beta::DeleteScanConfigRequest.new

# Call the delete_scan_config method.
result = client.delete_scan_config request

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

  • #delete_scan_config(request, options = nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_scan_config via a request object, either of type DeleteScanConfigRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::WebSecurityScanner::V1beta::DeleteScanConfigRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #delete_scan_config(name: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_scan_config via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

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

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/google/cloud/web_security_scanner/v1beta/web_security_scanner/client.rb', line 351

def delete_scan_config request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::WebSecurityScanner::V1beta::DeleteScanConfigRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_scan_config.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::WebSecurityScanner::V1beta::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_scan_config.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_scan_config.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @web_security_scanner_stub.call_rpc :delete_scan_config, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_finding(request, options = nil) ⇒ ::Google::Cloud::WebSecurityScanner::V1beta::Finding #get_finding(name: nil) ⇒ ::Google::Cloud::WebSecurityScanner::V1beta::Finding

Gets a Finding.

Examples:

Basic example

require "google/cloud/web_security_scanner/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::WebSecurityScanner::V1beta::WebSecurityScanner::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::WebSecurityScanner::V1beta::GetFindingRequest.new

# Call the get_finding method.
result = client.get_finding request

# The returned object is of type Google::Cloud::WebSecurityScanner::V1beta::Finding.
p result

Overloads:

  • #get_finding(request, options = nil) ⇒ ::Google::Cloud::WebSecurityScanner::V1beta::Finding

    Pass arguments to get_finding via a request object, either of type GetFindingRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::WebSecurityScanner::V1beta::GetFindingRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #get_finding(name: nil) ⇒ ::Google::Cloud::WebSecurityScanner::V1beta::Finding

    Pass arguments to get_finding via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

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

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
 
# File 'lib/google/cloud/web_security_scanner/v1beta/web_security_scanner/client.rb', line 1174

def get_finding request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::WebSecurityScanner::V1beta::GetFindingRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_finding.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::WebSecurityScanner::V1beta::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_finding.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_finding.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @web_security_scanner_stub.call_rpc :get_finding, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_scan_config(request, options = nil) ⇒ ::Google::Cloud::WebSecurityScanner::V1beta::ScanConfig #get_scan_config(name: nil) ⇒ ::Google::Cloud::WebSecurityScanner::V1beta::ScanConfig

Gets a ScanConfig.

Examples:

Basic example

require "google/cloud/web_security_scanner/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::WebSecurityScanner::V1beta::WebSecurityScanner::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::WebSecurityScanner::V1beta::GetScanConfigRequest.new

# Call the get_scan_config method.
result = client.get_scan_config request

# The returned object is of type Google::Cloud::WebSecurityScanner::V1beta::ScanConfig.
p result

Overloads:

  • #get_scan_config(request, options = nil) ⇒ ::Google::Cloud::WebSecurityScanner::V1beta::ScanConfig

    Pass arguments to get_scan_config via a request object, either of type GetScanConfigRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::WebSecurityScanner::V1beta::GetScanConfigRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #get_scan_config(name: nil) ⇒ ::Google::Cloud::WebSecurityScanner::V1beta::ScanConfig

    Pass arguments to get_scan_config via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

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

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
 
# File 'lib/google/cloud/web_security_scanner/v1beta/web_security_scanner/client.rb', line 437

def get_scan_config request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::WebSecurityScanner::V1beta::GetScanConfigRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_scan_config.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::WebSecurityScanner::V1beta::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_scan_config.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_scan_config.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @web_security_scanner_stub.call_rpc :get_scan_config, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_scan_run(request, options = nil) ⇒ ::Google::Cloud::WebSecurityScanner::V1beta::ScanRun #get_scan_run(name: nil) ⇒ ::Google::Cloud::WebSecurityScanner::V1beta::ScanRun

Gets a ScanRun.

Examples:

Basic example

require "google/cloud/web_security_scanner/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::WebSecurityScanner::V1beta::WebSecurityScanner::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::WebSecurityScanner::V1beta::GetScanRunRequest.new

# Call the get_scan_run method.
result = client.get_scan_run request

# The returned object is of type Google::Cloud::WebSecurityScanner::V1beta::ScanRun.
p result

Overloads:

  • #get_scan_run(request, options = nil) ⇒ ::Google::Cloud::WebSecurityScanner::V1beta::ScanRun

    Pass arguments to get_scan_run via a request object, either of type GetScanRunRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::WebSecurityScanner::V1beta::GetScanRunRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #get_scan_run(name: nil) ⇒ ::Google::Cloud::WebSecurityScanner::V1beta::ScanRun

    Pass arguments to get_scan_run via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

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

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
 
# File 'lib/google/cloud/web_security_scanner/v1beta/web_security_scanner/client.rb', line 800

def get_scan_run request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::WebSecurityScanner::V1beta::GetScanRunRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_scan_run.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::WebSecurityScanner::V1beta::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_scan_run.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_scan_run.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @web_security_scanner_stub.call_rpc :get_scan_run, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_crawled_urls(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::WebSecurityScanner::V1beta::CrawledUrl> #list_crawled_urls(parent: nil, page_token: nil, page_size: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::WebSecurityScanner::V1beta::CrawledUrl>

List CrawledUrls under a given ScanRun.

Examples:

Basic example

require "google/cloud/web_security_scanner/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::WebSecurityScanner::V1beta::WebSecurityScanner::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::WebSecurityScanner::V1beta::ListCrawledUrlsRequest.new

# Call the list_crawled_urls method.
result = client.list_crawled_urls request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::WebSecurityScanner::V1beta::CrawledUrl.
  p item
end

Overloads:

  • #list_crawled_urls(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::WebSecurityScanner::V1beta::CrawledUrl>

    Pass arguments to list_crawled_urls via a request object, either of type ListCrawledUrlsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::WebSecurityScanner::V1beta::ListCrawledUrlsRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_crawled_urls(parent: nil, page_token: nil, page_size: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::WebSecurityScanner::V1beta::CrawledUrl>

    Pass arguments to list_crawled_urls via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

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

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

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

    • page_size (::Integer) (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.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
 
# File 'lib/google/cloud/web_security_scanner/v1beta/web_security_scanner/client.rb', line 1086

def list_crawled_urls request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::WebSecurityScanner::V1beta::ListCrawledUrlsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_crawled_urls.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::WebSecurityScanner::V1beta::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_crawled_urls.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_crawled_urls.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @web_security_scanner_stub.call_rpc :list_crawled_urls, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @web_security_scanner_stub, :list_crawled_urls, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_finding_type_stats(request, options = nil) ⇒ ::Google::Cloud::WebSecurityScanner::V1beta::ListFindingTypeStatsResponse #list_finding_type_stats(parent: nil) ⇒ ::Google::Cloud::WebSecurityScanner::V1beta::ListFindingTypeStatsResponse

List all FindingTypeStats under a given ScanRun.

Examples:

Basic example

require "google/cloud/web_security_scanner/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::WebSecurityScanner::V1beta::WebSecurityScanner::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::WebSecurityScanner::V1beta::ListFindingTypeStatsRequest.new

# Call the list_finding_type_stats method.
result = client.list_finding_type_stats request

# The returned object is of type Google::Cloud::WebSecurityScanner::V1beta::ListFindingTypeStatsResponse.
p result

Overloads:

  • #list_finding_type_stats(request, options = nil) ⇒ ::Google::Cloud::WebSecurityScanner::V1beta::ListFindingTypeStatsResponse

    Pass arguments to list_finding_type_stats via a request object, either of type ListFindingTypeStatsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::WebSecurityScanner::V1beta::ListFindingTypeStatsRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_finding_type_stats(parent: nil) ⇒ ::Google::Cloud::WebSecurityScanner::V1beta::ListFindingTypeStatsResponse

    Pass arguments to list_finding_type_stats via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

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

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
 
# File 'lib/google/cloud/web_security_scanner/v1beta/web_security_scanner/client.rb', line 1366

def list_finding_type_stats request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::WebSecurityScanner::V1beta::ListFindingTypeStatsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_finding_type_stats.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::WebSecurityScanner::V1beta::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_finding_type_stats.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_finding_type_stats.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @web_security_scanner_stub.call_rpc :list_finding_type_stats, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_findings(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::WebSecurityScanner::V1beta::Finding> #list_findings(parent: nil, filter: nil, page_token: nil, page_size: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::WebSecurityScanner::V1beta::Finding>

List Findings under a given ScanRun.

Examples:

Basic example

require "google/cloud/web_security_scanner/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::WebSecurityScanner::V1beta::WebSecurityScanner::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::WebSecurityScanner::V1beta::ListFindingsRequest.new

# Call the list_findings method.
result = client.list_findings request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::WebSecurityScanner::V1beta::Finding.
  p item
end

Overloads:

  • #list_findings(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::WebSecurityScanner::V1beta::Finding>

    Pass arguments to list_findings via a request object, either of type ListFindingsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::WebSecurityScanner::V1beta::ListFindingsRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_findings(parent: nil, filter: nil, page_token: nil, page_size: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::WebSecurityScanner::V1beta::Finding>

    Pass arguments to list_findings via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

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

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

    • page_size (::Integer) (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.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
 
# File 'lib/google/cloud/web_security_scanner/v1beta/web_security_scanner/client.rb', line 1278

def list_findings request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::WebSecurityScanner::V1beta::ListFindingsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_findings.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::WebSecurityScanner::V1beta::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_findings.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_findings.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @web_security_scanner_stub.call_rpc :list_findings, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @web_security_scanner_stub, :list_findings, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_scan_configs(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::WebSecurityScanner::V1beta::ScanConfig> #list_scan_configs(parent: nil, page_token: nil, page_size: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::WebSecurityScanner::V1beta::ScanConfig>

Lists ScanConfigs under a given project.

Examples:

Basic example

require "google/cloud/web_security_scanner/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::WebSecurityScanner::V1beta::WebSecurityScanner::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::WebSecurityScanner::V1beta::ListScanConfigsRequest.new

# Call the list_scan_configs method.
result = client.list_scan_configs request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::WebSecurityScanner::V1beta::ScanConfig.
  p item
end

Overloads:

  • #list_scan_configs(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::WebSecurityScanner::V1beta::ScanConfig>

    Pass arguments to list_scan_configs via a request object, either of type ListScanConfigsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::WebSecurityScanner::V1beta::ListScanConfigsRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_scan_configs(parent: nil, page_token: nil, page_size: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::WebSecurityScanner::V1beta::ScanConfig>

    Pass arguments to list_scan_configs via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

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

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

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

    • page_size (::Integer) (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.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
 
# File 'lib/google/cloud/web_security_scanner/v1beta/web_security_scanner/client.rb', line 535

def list_scan_configs request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::WebSecurityScanner::V1beta::ListScanConfigsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_scan_configs.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::WebSecurityScanner::V1beta::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_scan_configs.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_scan_configs.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @web_security_scanner_stub.call_rpc :list_scan_configs, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @web_security_scanner_stub, :list_scan_configs, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_scan_runs(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::WebSecurityScanner::V1beta::ScanRun> #list_scan_runs(parent: nil, page_token: nil, page_size: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::WebSecurityScanner::V1beta::ScanRun>

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

Examples:

Basic example

require "google/cloud/web_security_scanner/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::WebSecurityScanner::V1beta::WebSecurityScanner::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::WebSecurityScanner::V1beta::ListScanRunsRequest.new

# Call the list_scan_runs method.
result = client.list_scan_runs request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::WebSecurityScanner::V1beta::ScanRun.
  p item
end

Overloads:

  • #list_scan_runs(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::WebSecurityScanner::V1beta::ScanRun>

    Pass arguments to list_scan_runs via a request object, either of type ListScanRunsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::WebSecurityScanner::V1beta::ListScanRunsRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_scan_runs(parent: nil, page_token: nil, page_size: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::WebSecurityScanner::V1beta::ScanRun>

    Pass arguments to list_scan_runs via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

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

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

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

    • page_size (::Integer) (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.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
 
# File 'lib/google/cloud/web_security_scanner/v1beta/web_security_scanner/client.rb', line 899

def list_scan_runs request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::WebSecurityScanner::V1beta::ListScanRunsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_scan_runs.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::WebSecurityScanner::V1beta::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_scan_runs.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_scan_runs.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @web_security_scanner_stub.call_rpc :list_scan_runs, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @web_security_scanner_stub, :list_scan_runs, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#start_scan_run(request, options = nil) ⇒ ::Google::Cloud::WebSecurityScanner::V1beta::ScanRun #start_scan_run(name: nil) ⇒ ::Google::Cloud::WebSecurityScanner::V1beta::ScanRun

Start a ScanRun according to the given ScanConfig.

Examples:

Basic example

require "google/cloud/web_security_scanner/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::WebSecurityScanner::V1beta::WebSecurityScanner::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::WebSecurityScanner::V1beta::StartScanRunRequest.new

# Call the start_scan_run method.
result = client.start_scan_run request

# The returned object is of type Google::Cloud::WebSecurityScanner::V1beta::ScanRun.
p result

Overloads:

  • #start_scan_run(request, options = nil) ⇒ ::Google::Cloud::WebSecurityScanner::V1beta::ScanRun

    Pass arguments to start_scan_run via a request object, either of type StartScanRunRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::WebSecurityScanner::V1beta::StartScanRunRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #start_scan_run(name: nil) ⇒ ::Google::Cloud::WebSecurityScanner::V1beta::ScanRun

    Pass arguments to start_scan_run via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

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

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
 
# File 'lib/google/cloud/web_security_scanner/v1beta/web_security_scanner/client.rb', line 713

def start_scan_run request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::WebSecurityScanner::V1beta::StartScanRunRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.start_scan_run.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::WebSecurityScanner::V1beta::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.start_scan_run.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.start_scan_run.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @web_security_scanner_stub.call_rpc :start_scan_run, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#stop_scan_run(request, options = nil) ⇒ ::Google::Cloud::WebSecurityScanner::V1beta::ScanRun #stop_scan_run(name: nil) ⇒ ::Google::Cloud::WebSecurityScanner::V1beta::ScanRun

Stops a ScanRun. The stopped ScanRun is returned.

Examples:

Basic example

require "google/cloud/web_security_scanner/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::WebSecurityScanner::V1beta::WebSecurityScanner::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::WebSecurityScanner::V1beta::StopScanRunRequest.new

# Call the stop_scan_run method.
result = client.stop_scan_run request

# The returned object is of type Google::Cloud::WebSecurityScanner::V1beta::ScanRun.
p result

Overloads:

  • #stop_scan_run(request, options = nil) ⇒ ::Google::Cloud::WebSecurityScanner::V1beta::ScanRun

    Pass arguments to stop_scan_run via a request object, either of type StopScanRunRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::WebSecurityScanner::V1beta::StopScanRunRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #stop_scan_run(name: nil) ⇒ ::Google::Cloud::WebSecurityScanner::V1beta::ScanRun

    Pass arguments to stop_scan_run via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

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

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
 
# File 'lib/google/cloud/web_security_scanner/v1beta/web_security_scanner/client.rb', line 987

def stop_scan_run request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::WebSecurityScanner::V1beta::StopScanRunRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.stop_scan_run.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::WebSecurityScanner::V1beta::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.stop_scan_run.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.stop_scan_run.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @web_security_scanner_stub.call_rpc :stop_scan_run, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


156
157
158
 
# File 'lib/google/cloud/web_security_scanner/v1beta/web_security_scanner/client.rb', line 156

def universe_domain
  @web_security_scanner_stub.universe_domain
end

#update_scan_config(request, options = nil) ⇒ ::Google::Cloud::WebSecurityScanner::V1beta::ScanConfig #update_scan_config(scan_config: nil, update_mask: nil) ⇒ ::Google::Cloud::WebSecurityScanner::V1beta::ScanConfig

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

Examples:

Basic example

require "google/cloud/web_security_scanner/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::WebSecurityScanner::V1beta::WebSecurityScanner::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::WebSecurityScanner::V1beta::UpdateScanConfigRequest.new

# Call the update_scan_config method.
result = client.update_scan_config request

# The returned object is of type Google::Cloud::WebSecurityScanner::V1beta::ScanConfig.
p result

Overloads:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
 
# File 'lib/google/cloud/web_security_scanner/v1beta/web_security_scanner/client.rb', line 627

def update_scan_config request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::WebSecurityScanner::V1beta::UpdateScanConfigRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_scan_config.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::WebSecurityScanner::V1beta::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.scan_config&.name
    header_params["scan_config.name"] = request.scan_config.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_scan_config.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_scan_config.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @web_security_scanner_stub.call_rpc :update_scan_config, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end