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

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

Overview

REST 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 REST client object.

Examples:


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

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

Yields:

  • (config) —

    Configure the WebSecurityScanner client.

Yield Parameters:



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
215
216
217
218
219
220
221
 
# File 'lib/google/cloud/web_security_scanner/v1beta/web_security_scanner/rest/client.rb', line 181

def initialize
  # 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 = ::Google::Cloud::WebSecurityScanner::V1beta::WebSecurityScanner::Rest::ServiceStub.new(
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    credentials: credentials,
    logger: @config.logger
  )

  @web_security_scanner_stub.logger(stub: true)&.info do |entry|
    entry.set_system_name
    entry.set_service
    entry.message = "Created client for #{entry.service}"
    entry.set_credentials_fields credentials
    entry.set "customEndpoint", @config.endpoint if @config.endpoint
    entry.set "defaultTimeout", @config.timeout if @config.timeout
    entry.set "quotaProject", @quota_project_id if @quota_project_id
  end
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::Rest::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



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
130
131
132
133
134
 
# File 'lib/google/cloud/web_security_scanner/v1beta/web_security_scanner/rest/client.rb', line 66

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:



151
152
153
154
 
# File 'lib/google/cloud/web_security_scanner/v1beta/web_security_scanner/rest/client.rb', line 151

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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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
305
306
307
308
309
310
311
312
313
 
# File 'lib/google/cloud/web_security_scanner/v1beta/web_security_scanner/rest/client.rb', line 280

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
  call_metadata = @config.rpcs.create_scan_config.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_scan_config.timeout,
                         metadata:     call_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.create_scan_config request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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
391
392
 
# File 'lib/google/cloud/web_security_scanner/v1beta/web_security_scanner/rest/client.rb', line 359

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
  call_metadata = @config.rpcs.delete_scan_config.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_scan_config.timeout,
                         metadata:     call_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.delete_scan_config request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
 
# File 'lib/google/cloud/web_security_scanner/v1beta/web_security_scanner/rest/client.rb', line 1122

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
  call_metadata = @config.rpcs.get_finding.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_finding.timeout,
                         metadata:     call_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.get_finding request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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
 
# File 'lib/google/cloud/web_security_scanner/v1beta/web_security_scanner/rest/client.rb', line 438

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
  call_metadata = @config.rpcs.get_scan_config.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_scan_config.timeout,
                         metadata:     call_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.get_scan_config request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
 
# File 'lib/google/cloud/web_security_scanner/v1beta/web_security_scanner/rest/client.rb', line 774

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
  call_metadata = @config.rpcs.get_scan_run.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_scan_run.timeout,
                         metadata:     call_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.get_scan_run request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_crawled_urls(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::WebSecurityScanner::V1beta::CrawledUrl> #list_crawled_urls(parent: nil, page_token: nil, page_size: nil) ⇒ ::Gapic::Rest::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::Rest::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::Rest::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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
 
# File 'lib/google/cloud/web_security_scanner/v1beta/web_security_scanner/rest/client.rb', line 1040

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
  call_metadata = @config.rpcs.list_crawled_urls.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_crawled_urls.timeout,
                         metadata:     call_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.list_crawled_urls request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @web_security_scanner_stub, :list_crawled_urls, "crawled_urls", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
 
# File 'lib/google/cloud/web_security_scanner/v1beta/web_security_scanner/rest/client.rb', line 1301

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
  call_metadata = @config.rpcs.list_finding_type_stats.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_finding_type_stats.timeout,
                         metadata:     call_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.list_finding_type_stats request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_findings(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::WebSecurityScanner::V1beta::Finding> #list_findings(parent: nil, filter: nil, page_token: nil, page_size: nil) ⇒ ::Gapic::Rest::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::Rest::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::Rest::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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
 
# File 'lib/google/cloud/web_security_scanner/v1beta/web_security_scanner/rest/client.rb', line 1219

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
  call_metadata = @config.rpcs.list_findings.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_findings.timeout,
                         metadata:     call_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.list_findings request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @web_security_scanner_stub, :list_findings, "findings", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_scan_configs(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::WebSecurityScanner::V1beta::ScanConfig> #list_scan_configs(parent: nil, page_token: nil, page_size: nil) ⇒ ::Gapic::Rest::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::Rest::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::Rest::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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



529
530
531
532
533
534
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
 
# File 'lib/google/cloud/web_security_scanner/v1beta/web_security_scanner/rest/client.rb', line 529

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
  call_metadata = @config.rpcs.list_scan_configs.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_scan_configs.timeout,
                         metadata:     call_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.list_scan_configs request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @web_security_scanner_stub, :list_scan_configs, "scan_configs", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_scan_runs(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::WebSecurityScanner::V1beta::ScanRun> #list_scan_runs(parent: nil, page_token: nil, page_size: nil) ⇒ ::Gapic::Rest::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::Rest::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::Rest::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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
 
# File 'lib/google/cloud/web_security_scanner/v1beta/web_security_scanner/rest/client.rb', line 866

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
  call_metadata = @config.rpcs.list_scan_runs.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_scan_runs.timeout,
                         metadata:     call_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.list_scan_runs request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @web_security_scanner_stub, :list_scan_runs, "scan_runs", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


228
229
230
 
# File 'lib/google/cloud/web_security_scanner/v1beta/web_security_scanner/rest/client.rb', line 228

def logger
  @web_security_scanner_stub.logger
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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
 
# File 'lib/google/cloud/web_security_scanner/v1beta/web_security_scanner/rest/client.rb', line 694

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
  call_metadata = @config.rpcs.start_scan_run.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.start_scan_run.timeout,
                         metadata:     call_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.start_scan_run request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => 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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
 
# File 'lib/google/cloud/web_security_scanner/v1beta/web_security_scanner/rest/client.rb', line 948

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
  call_metadata = @config.rpcs.stop_scan_run.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.stop_scan_run.timeout,
                         metadata:     call_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.stop_scan_run request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


161
162
163
 
# File 'lib/google/cloud/web_security_scanner/v1beta/web_security_scanner/rest/client.rb', line 161

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::Rest::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
 
# File 'lib/google/cloud/web_security_scanner/v1beta/web_security_scanner/rest/client.rb', line 615

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
  call_metadata = @config.rpcs.update_scan_config.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_scan_config.timeout,
                         metadata:     call_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.update_scan_config request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end