Class: Google::Cloud::WebSecurityScanner::V1beta::ScanRun

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/websecurityscanner/v1beta/scan_run.rb

Overview

A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12

Defined Under Namespace

Modules: ExecutionState, ResultState

Instance Attribute Summary collapse

Instance Attribute Details

#end_time ⇒ ::Google::Protobuf::Timestamp

Returns The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.

Returns:

  • (::Google::Protobuf::Timestamp) —

    The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.



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
 
# File 'proto_docs/google/cloud/websecurityscanner/v1beta/scan_run.rb', line 71

class ScanRun
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Types of ScanRun execution state.
  module ExecutionState
    # Represents an invalid state caused by internal server error. This value
    # should never be returned.
    EXECUTION_STATE_UNSPECIFIED = 0

    # The scan is waiting in the queue.
    QUEUED = 1

    # The scan is in progress.
    SCANNING = 2

    # The scan is either finished or stopped by user.
    FINISHED = 3
  end

  # Types of ScanRun result state.
  module ResultState
    # Default value. This value is returned when the ScanRun is not yet
    # finished.
    RESULT_STATE_UNSPECIFIED = 0

    # The scan finished without errors.
    SUCCESS = 1

    # The scan finished with errors.
    ERROR = 2

    # The scan was terminated by user.
    KILLED = 3
  end
end

#error_trace ⇒ ::Google::Cloud::WebSecurityScanner::V1beta::ScanRunErrorTrace

Returns If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available.

Returns:



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
 
# File 'proto_docs/google/cloud/websecurityscanner/v1beta/scan_run.rb', line 71

class ScanRun
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Types of ScanRun execution state.
  module ExecutionState
    # Represents an invalid state caused by internal server error. This value
    # should never be returned.
    EXECUTION_STATE_UNSPECIFIED = 0

    # The scan is waiting in the queue.
    QUEUED = 1

    # The scan is in progress.
    SCANNING = 2

    # The scan is either finished or stopped by user.
    FINISHED = 3
  end

  # Types of ScanRun result state.
  module ResultState
    # Default value. This value is returned when the ScanRun is not yet
    # finished.
    RESULT_STATE_UNSPECIFIED = 0

    # The scan finished without errors.
    SUCCESS = 1

    # The scan finished with errors.
    ERROR = 2

    # The scan was terminated by user.
    KILLED = 3
  end
end

#execution_state ⇒ ::Google::Cloud::WebSecurityScanner::V1beta::ScanRun::ExecutionState

Returns The execution state of the ScanRun.

Returns:



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
 
# File 'proto_docs/google/cloud/websecurityscanner/v1beta/scan_run.rb', line 71

class ScanRun
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Types of ScanRun execution state.
  module ExecutionState
    # Represents an invalid state caused by internal server error. This value
    # should never be returned.
    EXECUTION_STATE_UNSPECIFIED = 0

    # The scan is waiting in the queue.
    QUEUED = 1

    # The scan is in progress.
    SCANNING = 2

    # The scan is either finished or stopped by user.
    FINISHED = 3
  end

  # Types of ScanRun result state.
  module ResultState
    # Default value. This value is returned when the ScanRun is not yet
    # finished.
    RESULT_STATE_UNSPECIFIED = 0

    # The scan finished without errors.
    SUCCESS = 1

    # The scan finished with errors.
    ERROR = 2

    # The scan was terminated by user.
    KILLED = 3
  end
end

#has_vulnerabilities ⇒ ::Boolean

Returns Whether the scan run has found any vulnerabilities.

Returns:

  • (::Boolean) —

    Whether the scan run has found any vulnerabilities.



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
 
# File 'proto_docs/google/cloud/websecurityscanner/v1beta/scan_run.rb', line 71

class ScanRun
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Types of ScanRun execution state.
  module ExecutionState
    # Represents an invalid state caused by internal server error. This value
    # should never be returned.
    EXECUTION_STATE_UNSPECIFIED = 0

    # The scan is waiting in the queue.
    QUEUED = 1

    # The scan is in progress.
    SCANNING = 2

    # The scan is either finished or stopped by user.
    FINISHED = 3
  end

  # Types of ScanRun result state.
  module ResultState
    # Default value. This value is returned when the ScanRun is not yet
    # finished.
    RESULT_STATE_UNSPECIFIED = 0

    # The scan finished without errors.
    SUCCESS = 1

    # The scan finished with errors.
    ERROR = 2

    # The scan was terminated by user.
    KILLED = 3
  end
end

#name ⇒ ::String

Returns The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system.

Returns:

  • (::String) —

    The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system.



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
 
# File 'proto_docs/google/cloud/websecurityscanner/v1beta/scan_run.rb', line 71

class ScanRun
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Types of ScanRun execution state.
  module ExecutionState
    # Represents an invalid state caused by internal server error. This value
    # should never be returned.
    EXECUTION_STATE_UNSPECIFIED = 0

    # The scan is waiting in the queue.
    QUEUED = 1

    # The scan is in progress.
    SCANNING = 2

    # The scan is either finished or stopped by user.
    FINISHED = 3
  end

  # Types of ScanRun result state.
  module ResultState
    # Default value. This value is returned when the ScanRun is not yet
    # finished.
    RESULT_STATE_UNSPECIFIED = 0

    # The scan finished without errors.
    SUCCESS = 1

    # The scan finished with errors.
    ERROR = 2

    # The scan was terminated by user.
    KILLED = 3
  end
end

#progress_percent ⇒ ::Integer

Returns The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100.

Returns:

  • (::Integer) —

    The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100.



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
 
# File 'proto_docs/google/cloud/websecurityscanner/v1beta/scan_run.rb', line 71

class ScanRun
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Types of ScanRun execution state.
  module ExecutionState
    # Represents an invalid state caused by internal server error. This value
    # should never be returned.
    EXECUTION_STATE_UNSPECIFIED = 0

    # The scan is waiting in the queue.
    QUEUED = 1

    # The scan is in progress.
    SCANNING = 2

    # The scan is either finished or stopped by user.
    FINISHED = 3
  end

  # Types of ScanRun result state.
  module ResultState
    # Default value. This value is returned when the ScanRun is not yet
    # finished.
    RESULT_STATE_UNSPECIFIED = 0

    # The scan finished without errors.
    SUCCESS = 1

    # The scan finished with errors.
    ERROR = 2

    # The scan was terminated by user.
    KILLED = 3
  end
end

#result_state ⇒ ::Google::Cloud::WebSecurityScanner::V1beta::ScanRun::ResultState

Returns The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".

Returns:



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
 
# File 'proto_docs/google/cloud/websecurityscanner/v1beta/scan_run.rb', line 71

class ScanRun
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Types of ScanRun execution state.
  module ExecutionState
    # Represents an invalid state caused by internal server error. This value
    # should never be returned.
    EXECUTION_STATE_UNSPECIFIED = 0

    # The scan is waiting in the queue.
    QUEUED = 1

    # The scan is in progress.
    SCANNING = 2

    # The scan is either finished or stopped by user.
    FINISHED = 3
  end

  # Types of ScanRun result state.
  module ResultState
    # Default value. This value is returned when the ScanRun is not yet
    # finished.
    RESULT_STATE_UNSPECIFIED = 0

    # The scan finished without errors.
    SUCCESS = 1

    # The scan finished with errors.
    ERROR = 2

    # The scan was terminated by user.
    KILLED = 3
  end
end

#start_time ⇒ ::Google::Protobuf::Timestamp

Returns The time at which the ScanRun started.

Returns:



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
 
# File 'proto_docs/google/cloud/websecurityscanner/v1beta/scan_run.rb', line 71

class ScanRun
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Types of ScanRun execution state.
  module ExecutionState
    # Represents an invalid state caused by internal server error. This value
    # should never be returned.
    EXECUTION_STATE_UNSPECIFIED = 0

    # The scan is waiting in the queue.
    QUEUED = 1

    # The scan is in progress.
    SCANNING = 2

    # The scan is either finished or stopped by user.
    FINISHED = 3
  end

  # Types of ScanRun result state.
  module ResultState
    # Default value. This value is returned when the ScanRun is not yet
    # finished.
    RESULT_STATE_UNSPECIFIED = 0

    # The scan finished without errors.
    SUCCESS = 1

    # The scan finished with errors.
    ERROR = 2

    # The scan was terminated by user.
    KILLED = 3
  end
end

#urls_crawled_count ⇒ ::Integer

Returns The number of URLs crawled during this ScanRun. If the scan is in progress, the value represents the number of URLs crawled up to now.

Returns:

  • (::Integer) —

    The number of URLs crawled during this ScanRun. If the scan is in progress, the value represents the number of URLs crawled up to now.



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
 
# File 'proto_docs/google/cloud/websecurityscanner/v1beta/scan_run.rb', line 71

class ScanRun
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Types of ScanRun execution state.
  module ExecutionState
    # Represents an invalid state caused by internal server error. This value
    # should never be returned.
    EXECUTION_STATE_UNSPECIFIED = 0

    # The scan is waiting in the queue.
    QUEUED = 1

    # The scan is in progress.
    SCANNING = 2

    # The scan is either finished or stopped by user.
    FINISHED = 3
  end

  # Types of ScanRun result state.
  module ResultState
    # Default value. This value is returned when the ScanRun is not yet
    # finished.
    RESULT_STATE_UNSPECIFIED = 0

    # The scan finished without errors.
    SUCCESS = 1

    # The scan finished with errors.
    ERROR = 2

    # The scan was terminated by user.
    KILLED = 3
  end
end

#urls_tested_count ⇒ ::Integer

Returns The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads.

Returns:

  • (::Integer) —

    The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads.



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
 
# File 'proto_docs/google/cloud/websecurityscanner/v1beta/scan_run.rb', line 71

class ScanRun
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Types of ScanRun execution state.
  module ExecutionState
    # Represents an invalid state caused by internal server error. This value
    # should never be returned.
    EXECUTION_STATE_UNSPECIFIED = 0

    # The scan is waiting in the queue.
    QUEUED = 1

    # The scan is in progress.
    SCANNING = 2

    # The scan is either finished or stopped by user.
    FINISHED = 3
  end

  # Types of ScanRun result state.
  module ResultState
    # Default value. This value is returned when the ScanRun is not yet
    # finished.
    RESULT_STATE_UNSPECIFIED = 0

    # The scan finished without errors.
    SUCCESS = 1

    # The scan finished with errors.
    ERROR = 2

    # The scan was terminated by user.
    KILLED = 3
  end
end

#warning_traces ⇒ ::Array<::Google::Cloud::WebSecurityScanner::V1beta::ScanRunWarningTrace>

Returns A list of warnings, if such are encountered during this scan run.

Returns:



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
 
# File 'proto_docs/google/cloud/websecurityscanner/v1beta/scan_run.rb', line 71

class ScanRun
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Types of ScanRun execution state.
  module ExecutionState
    # Represents an invalid state caused by internal server error. This value
    # should never be returned.
    EXECUTION_STATE_UNSPECIFIED = 0

    # The scan is waiting in the queue.
    QUEUED = 1

    # The scan is in progress.
    SCANNING = 2

    # The scan is either finished or stopped by user.
    FINISHED = 3
  end

  # Types of ScanRun result state.
  module ResultState
    # Default value. This value is returned when the ScanRun is not yet
    # finished.
    RESULT_STATE_UNSPECIFIED = 0

    # The scan finished without errors.
    SUCCESS = 1

    # The scan finished with errors.
    ERROR = 2

    # The scan was terminated by user.
    KILLED = 3
  end
end