Class: Google::Cloud::WebSecurityScanner::V1beta::ScanConfig

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

Overview

A ScanConfig resource contains the configurations to launch a scan.

Defined Under Namespace

Modules: ExportToSecurityCommandCenter, RiskLevel, TargetPlatform, UserAgent Classes: Authentication, Schedule

Instance Attribute Summary collapse

Instance Attribute Details

#authentication ⇒ ::Google::Cloud::WebSecurityScanner::V1beta::ScanConfig::Authentication

Returns The authentication configuration. If specified, service will use the authentication configuration during scanning.

Returns:



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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'proto_docs/google/cloud/websecurityscanner/v1beta/scan_config.rb', line 70

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

  # Scan authentication configuration.
  # @!attribute [rw] google_account
  #   @return [::Google::Cloud::WebSecurityScanner::V1beta::ScanConfig::Authentication::GoogleAccount]
  #     Authentication using a Google account.
  # @!attribute [rw] custom_account
  #   @return [::Google::Cloud::WebSecurityScanner::V1beta::ScanConfig::Authentication::CustomAccount]
  #     Authentication using a custom account.
  class Authentication
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Describes authentication configuration that uses a Google account.
    # @!attribute [rw] username
    #   @return [::String]
    #     Required. The user name of the Google account.
    # @!attribute [rw] password
    #   @return [::String]
    #     Required. Input only. The password of the Google account. The credential is stored encrypted
    #     and not returned in any response nor included in audit logs.
    class GoogleAccount
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Describes authentication configuration that uses a custom account.
    # @!attribute [rw] username
    #   @return [::String]
    #     Required. The user name of the custom account.
    # @!attribute [rw] password
    #   @return [::String]
    #     Required. Input only. The password of the custom account. The credential is stored encrypted
    #     and not returned in any response nor included in audit logs.
    # @!attribute [rw] login_url
    #   @return [::String]
    #     Required. The login form URL of the website.
    class CustomAccount
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Scan schedule configuration.
  # @!attribute [rw] schedule_time
  #   @return [::Google::Protobuf::Timestamp]
  #     A timestamp indicates when the next run will be scheduled. The value is
  #     refreshed by the server after each run. If unspecified, it will default
  #     to current server time, which means the scan will be scheduled to start
  #     immediately.
  # @!attribute [rw] interval_duration_days
  #   @return [::Integer]
  #     Required. The duration of time between executions in days.
  class Schedule
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Type of user agents used for scanning.
  module UserAgent
    # The user agent is unknown. Service will default to CHROME_LINUX.
    USER_AGENT_UNSPECIFIED = 0

    # Chrome on Linux. This is the service default if unspecified.
    CHROME_LINUX = 1

    # Chrome on Android.
    CHROME_ANDROID = 2

    # Safari on IPhone.
    SAFARI_IPHONE = 3
  end

  # Cloud platforms supported by Cloud Web Security Scanner.
  module TargetPlatform
    # The target platform is unknown. Requests with this enum value will be
    # rejected with INVALID_ARGUMENT error.
    TARGET_PLATFORM_UNSPECIFIED = 0

    # Google App Engine service.
    APP_ENGINE = 1

    # Google Compute Engine service.
    COMPUTE = 2
  end

  # Scan risk levels supported by Cloud Web Security Scanner. LOW impact
  # scanning will minimize requests with the potential to modify data. To
  # achieve the maximum scan coverage, NORMAL risk level is recommended.
  module RiskLevel
    # Use default, which is NORMAL.
    RISK_LEVEL_UNSPECIFIED = 0

    # Normal scanning (Recommended)
    NORMAL = 1

    # Lower impact scanning
    LOW = 2
  end

  # Controls export of scan configurations and results to Cloud Security
  # Command Center.
  module ExportToSecurityCommandCenter
    # Use default, which is ENABLED.
    EXPORT_TO_SECURITY_COMMAND_CENTER_UNSPECIFIED = 0

    # Export results of this scan to Cloud Security Command Center.
    ENABLED = 1

    # Do not export results of this scan to Cloud Security Command Center.
    DISABLED = 2
  end
end

#blacklist_patterns ⇒ ::Array<::String>

Returns The blacklist URL patterns as described in https://cloud.google.com/security-scanner/docs/excluded-urls.

Returns:



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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'proto_docs/google/cloud/websecurityscanner/v1beta/scan_config.rb', line 70

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

  # Scan authentication configuration.
  # @!attribute [rw] google_account
  #   @return [::Google::Cloud::WebSecurityScanner::V1beta::ScanConfig::Authentication::GoogleAccount]
  #     Authentication using a Google account.
  # @!attribute [rw] custom_account
  #   @return [::Google::Cloud::WebSecurityScanner::V1beta::ScanConfig::Authentication::CustomAccount]
  #     Authentication using a custom account.
  class Authentication
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Describes authentication configuration that uses a Google account.
    # @!attribute [rw] username
    #   @return [::String]
    #     Required. The user name of the Google account.
    # @!attribute [rw] password
    #   @return [::String]
    #     Required. Input only. The password of the Google account. The credential is stored encrypted
    #     and not returned in any response nor included in audit logs.
    class GoogleAccount
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Describes authentication configuration that uses a custom account.
    # @!attribute [rw] username
    #   @return [::String]
    #     Required. The user name of the custom account.
    # @!attribute [rw] password
    #   @return [::String]
    #     Required. Input only. The password of the custom account. The credential is stored encrypted
    #     and not returned in any response nor included in audit logs.
    # @!attribute [rw] login_url
    #   @return [::String]
    #     Required. The login form URL of the website.
    class CustomAccount
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Scan schedule configuration.
  # @!attribute [rw] schedule_time
  #   @return [::Google::Protobuf::Timestamp]
  #     A timestamp indicates when the next run will be scheduled. The value is
  #     refreshed by the server after each run. If unspecified, it will default
  #     to current server time, which means the scan will be scheduled to start
  #     immediately.
  # @!attribute [rw] interval_duration_days
  #   @return [::Integer]
  #     Required. The duration of time between executions in days.
  class Schedule
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Type of user agents used for scanning.
  module UserAgent
    # The user agent is unknown. Service will default to CHROME_LINUX.
    USER_AGENT_UNSPECIFIED = 0

    # Chrome on Linux. This is the service default if unspecified.
    CHROME_LINUX = 1

    # Chrome on Android.
    CHROME_ANDROID = 2

    # Safari on IPhone.
    SAFARI_IPHONE = 3
  end

  # Cloud platforms supported by Cloud Web Security Scanner.
  module TargetPlatform
    # The target platform is unknown. Requests with this enum value will be
    # rejected with INVALID_ARGUMENT error.
    TARGET_PLATFORM_UNSPECIFIED = 0

    # Google App Engine service.
    APP_ENGINE = 1

    # Google Compute Engine service.
    COMPUTE = 2
  end

  # Scan risk levels supported by Cloud Web Security Scanner. LOW impact
  # scanning will minimize requests with the potential to modify data. To
  # achieve the maximum scan coverage, NORMAL risk level is recommended.
  module RiskLevel
    # Use default, which is NORMAL.
    RISK_LEVEL_UNSPECIFIED = 0

    # Normal scanning (Recommended)
    NORMAL = 1

    # Lower impact scanning
    LOW = 2
  end

  # Controls export of scan configurations and results to Cloud Security
  # Command Center.
  module ExportToSecurityCommandCenter
    # Use default, which is ENABLED.
    EXPORT_TO_SECURITY_COMMAND_CENTER_UNSPECIFIED = 0

    # Export results of this scan to Cloud Security Command Center.
    ENABLED = 1

    # Do not export results of this scan to Cloud Security Command Center.
    DISABLED = 2
  end
end

#display_name ⇒ ::String

Returns Required. The user provided display name of the ScanConfig.

Returns:

  • (::String) —

    Required. The user provided display name of the ScanConfig.



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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'proto_docs/google/cloud/websecurityscanner/v1beta/scan_config.rb', line 70

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

  # Scan authentication configuration.
  # @!attribute [rw] google_account
  #   @return [::Google::Cloud::WebSecurityScanner::V1beta::ScanConfig::Authentication::GoogleAccount]
  #     Authentication using a Google account.
  # @!attribute [rw] custom_account
  #   @return [::Google::Cloud::WebSecurityScanner::V1beta::ScanConfig::Authentication::CustomAccount]
  #     Authentication using a custom account.
  class Authentication
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Describes authentication configuration that uses a Google account.
    # @!attribute [rw] username
    #   @return [::String]
    #     Required. The user name of the Google account.
    # @!attribute [rw] password
    #   @return [::String]
    #     Required. Input only. The password of the Google account. The credential is stored encrypted
    #     and not returned in any response nor included in audit logs.
    class GoogleAccount
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Describes authentication configuration that uses a custom account.
    # @!attribute [rw] username
    #   @return [::String]
    #     Required. The user name of the custom account.
    # @!attribute [rw] password
    #   @return [::String]
    #     Required. Input only. The password of the custom account. The credential is stored encrypted
    #     and not returned in any response nor included in audit logs.
    # @!attribute [rw] login_url
    #   @return [::String]
    #     Required. The login form URL of the website.
    class CustomAccount
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Scan schedule configuration.
  # @!attribute [rw] schedule_time
  #   @return [::Google::Protobuf::Timestamp]
  #     A timestamp indicates when the next run will be scheduled. The value is
  #     refreshed by the server after each run. If unspecified, it will default
  #     to current server time, which means the scan will be scheduled to start
  #     immediately.
  # @!attribute [rw] interval_duration_days
  #   @return [::Integer]
  #     Required. The duration of time between executions in days.
  class Schedule
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Type of user agents used for scanning.
  module UserAgent
    # The user agent is unknown. Service will default to CHROME_LINUX.
    USER_AGENT_UNSPECIFIED = 0

    # Chrome on Linux. This is the service default if unspecified.
    CHROME_LINUX = 1

    # Chrome on Android.
    CHROME_ANDROID = 2

    # Safari on IPhone.
    SAFARI_IPHONE = 3
  end

  # Cloud platforms supported by Cloud Web Security Scanner.
  module TargetPlatform
    # The target platform is unknown. Requests with this enum value will be
    # rejected with INVALID_ARGUMENT error.
    TARGET_PLATFORM_UNSPECIFIED = 0

    # Google App Engine service.
    APP_ENGINE = 1

    # Google Compute Engine service.
    COMPUTE = 2
  end

  # Scan risk levels supported by Cloud Web Security Scanner. LOW impact
  # scanning will minimize requests with the potential to modify data. To
  # achieve the maximum scan coverage, NORMAL risk level is recommended.
  module RiskLevel
    # Use default, which is NORMAL.
    RISK_LEVEL_UNSPECIFIED = 0

    # Normal scanning (Recommended)
    NORMAL = 1

    # Lower impact scanning
    LOW = 2
  end

  # Controls export of scan configurations and results to Cloud Security
  # Command Center.
  module ExportToSecurityCommandCenter
    # Use default, which is ENABLED.
    EXPORT_TO_SECURITY_COMMAND_CENTER_UNSPECIFIED = 0

    # Export results of this scan to Cloud Security Command Center.
    ENABLED = 1

    # Do not export results of this scan to Cloud Security Command Center.
    DISABLED = 2
  end
end

#export_to_security_command_center ⇒ ::Google::Cloud::WebSecurityScanner::V1beta::ScanConfig::ExportToSecurityCommandCenter

Returns Controls export of scan configurations and results to Cloud Security Command Center.

Returns:



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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'proto_docs/google/cloud/websecurityscanner/v1beta/scan_config.rb', line 70

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

  # Scan authentication configuration.
  # @!attribute [rw] google_account
  #   @return [::Google::Cloud::WebSecurityScanner::V1beta::ScanConfig::Authentication::GoogleAccount]
  #     Authentication using a Google account.
  # @!attribute [rw] custom_account
  #   @return [::Google::Cloud::WebSecurityScanner::V1beta::ScanConfig::Authentication::CustomAccount]
  #     Authentication using a custom account.
  class Authentication
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Describes authentication configuration that uses a Google account.
    # @!attribute [rw] username
    #   @return [::String]
    #     Required. The user name of the Google account.
    # @!attribute [rw] password
    #   @return [::String]
    #     Required. Input only. The password of the Google account. The credential is stored encrypted
    #     and not returned in any response nor included in audit logs.
    class GoogleAccount
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Describes authentication configuration that uses a custom account.
    # @!attribute [rw] username
    #   @return [::String]
    #     Required. The user name of the custom account.
    # @!attribute [rw] password
    #   @return [::String]
    #     Required. Input only. The password of the custom account. The credential is stored encrypted
    #     and not returned in any response nor included in audit logs.
    # @!attribute [rw] login_url
    #   @return [::String]
    #     Required. The login form URL of the website.
    class CustomAccount
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Scan schedule configuration.
  # @!attribute [rw] schedule_time
  #   @return [::Google::Protobuf::Timestamp]
  #     A timestamp indicates when the next run will be scheduled. The value is
  #     refreshed by the server after each run. If unspecified, it will default
  #     to current server time, which means the scan will be scheduled to start
  #     immediately.
  # @!attribute [rw] interval_duration_days
  #   @return [::Integer]
  #     Required. The duration of time between executions in days.
  class Schedule
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Type of user agents used for scanning.
  module UserAgent
    # The user agent is unknown. Service will default to CHROME_LINUX.
    USER_AGENT_UNSPECIFIED = 0

    # Chrome on Linux. This is the service default if unspecified.
    CHROME_LINUX = 1

    # Chrome on Android.
    CHROME_ANDROID = 2

    # Safari on IPhone.
    SAFARI_IPHONE = 3
  end

  # Cloud platforms supported by Cloud Web Security Scanner.
  module TargetPlatform
    # The target platform is unknown. Requests with this enum value will be
    # rejected with INVALID_ARGUMENT error.
    TARGET_PLATFORM_UNSPECIFIED = 0

    # Google App Engine service.
    APP_ENGINE = 1

    # Google Compute Engine service.
    COMPUTE = 2
  end

  # Scan risk levels supported by Cloud Web Security Scanner. LOW impact
  # scanning will minimize requests with the potential to modify data. To
  # achieve the maximum scan coverage, NORMAL risk level is recommended.
  module RiskLevel
    # Use default, which is NORMAL.
    RISK_LEVEL_UNSPECIFIED = 0

    # Normal scanning (Recommended)
    NORMAL = 1

    # Lower impact scanning
    LOW = 2
  end

  # Controls export of scan configurations and results to Cloud Security
  # Command Center.
  module ExportToSecurityCommandCenter
    # Use default, which is ENABLED.
    EXPORT_TO_SECURITY_COMMAND_CENTER_UNSPECIFIED = 0

    # Export results of this scan to Cloud Security Command Center.
    ENABLED = 1

    # Do not export results of this scan to Cloud Security Command Center.
    DISABLED = 2
  end
end

#latest_run ⇒ ::Google::Cloud::WebSecurityScanner::V1beta::ScanRun

Returns Latest ScanRun if available.

Returns:



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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'proto_docs/google/cloud/websecurityscanner/v1beta/scan_config.rb', line 70

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

  # Scan authentication configuration.
  # @!attribute [rw] google_account
  #   @return [::Google::Cloud::WebSecurityScanner::V1beta::ScanConfig::Authentication::GoogleAccount]
  #     Authentication using a Google account.
  # @!attribute [rw] custom_account
  #   @return [::Google::Cloud::WebSecurityScanner::V1beta::ScanConfig::Authentication::CustomAccount]
  #     Authentication using a custom account.
  class Authentication
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Describes authentication configuration that uses a Google account.
    # @!attribute [rw] username
    #   @return [::String]
    #     Required. The user name of the Google account.
    # @!attribute [rw] password
    #   @return [::String]
    #     Required. Input only. The password of the Google account. The credential is stored encrypted
    #     and not returned in any response nor included in audit logs.
    class GoogleAccount
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Describes authentication configuration that uses a custom account.
    # @!attribute [rw] username
    #   @return [::String]
    #     Required. The user name of the custom account.
    # @!attribute [rw] password
    #   @return [::String]
    #     Required. Input only. The password of the custom account. The credential is stored encrypted
    #     and not returned in any response nor included in audit logs.
    # @!attribute [rw] login_url
    #   @return [::String]
    #     Required. The login form URL of the website.
    class CustomAccount
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Scan schedule configuration.
  # @!attribute [rw] schedule_time
  #   @return [::Google::Protobuf::Timestamp]
  #     A timestamp indicates when the next run will be scheduled. The value is
  #     refreshed by the server after each run. If unspecified, it will default
  #     to current server time, which means the scan will be scheduled to start
  #     immediately.
  # @!attribute [rw] interval_duration_days
  #   @return [::Integer]
  #     Required. The duration of time between executions in days.
  class Schedule
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Type of user agents used for scanning.
  module UserAgent
    # The user agent is unknown. Service will default to CHROME_LINUX.
    USER_AGENT_UNSPECIFIED = 0

    # Chrome on Linux. This is the service default if unspecified.
    CHROME_LINUX = 1

    # Chrome on Android.
    CHROME_ANDROID = 2

    # Safari on IPhone.
    SAFARI_IPHONE = 3
  end

  # Cloud platforms supported by Cloud Web Security Scanner.
  module TargetPlatform
    # The target platform is unknown. Requests with this enum value will be
    # rejected with INVALID_ARGUMENT error.
    TARGET_PLATFORM_UNSPECIFIED = 0

    # Google App Engine service.
    APP_ENGINE = 1

    # Google Compute Engine service.
    COMPUTE = 2
  end

  # Scan risk levels supported by Cloud Web Security Scanner. LOW impact
  # scanning will minimize requests with the potential to modify data. To
  # achieve the maximum scan coverage, NORMAL risk level is recommended.
  module RiskLevel
    # Use default, which is NORMAL.
    RISK_LEVEL_UNSPECIFIED = 0

    # Normal scanning (Recommended)
    NORMAL = 1

    # Lower impact scanning
    LOW = 2
  end

  # Controls export of scan configurations and results to Cloud Security
  # Command Center.
  module ExportToSecurityCommandCenter
    # Use default, which is ENABLED.
    EXPORT_TO_SECURITY_COMMAND_CENTER_UNSPECIFIED = 0

    # Export results of this scan to Cloud Security Command Center.
    ENABLED = 1

    # Do not export results of this scan to Cloud Security Command Center.
    DISABLED = 2
  end
end

#max_qps ⇒ ::Integer

Returns The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error.

Returns:

  • (::Integer) —

    The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error.



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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'proto_docs/google/cloud/websecurityscanner/v1beta/scan_config.rb', line 70

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

  # Scan authentication configuration.
  # @!attribute [rw] google_account
  #   @return [::Google::Cloud::WebSecurityScanner::V1beta::ScanConfig::Authentication::GoogleAccount]
  #     Authentication using a Google account.
  # @!attribute [rw] custom_account
  #   @return [::Google::Cloud::WebSecurityScanner::V1beta::ScanConfig::Authentication::CustomAccount]
  #     Authentication using a custom account.
  class Authentication
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Describes authentication configuration that uses a Google account.
    # @!attribute [rw] username
    #   @return [::String]
    #     Required. The user name of the Google account.
    # @!attribute [rw] password
    #   @return [::String]
    #     Required. Input only. The password of the Google account. The credential is stored encrypted
    #     and not returned in any response nor included in audit logs.
    class GoogleAccount
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Describes authentication configuration that uses a custom account.
    # @!attribute [rw] username
    #   @return [::String]
    #     Required. The user name of the custom account.
    # @!attribute [rw] password
    #   @return [::String]
    #     Required. Input only. The password of the custom account. The credential is stored encrypted
    #     and not returned in any response nor included in audit logs.
    # @!attribute [rw] login_url
    #   @return [::String]
    #     Required. The login form URL of the website.
    class CustomAccount
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Scan schedule configuration.
  # @!attribute [rw] schedule_time
  #   @return [::Google::Protobuf::Timestamp]
  #     A timestamp indicates when the next run will be scheduled. The value is
  #     refreshed by the server after each run. If unspecified, it will default
  #     to current server time, which means the scan will be scheduled to start
  #     immediately.
  # @!attribute [rw] interval_duration_days
  #   @return [::Integer]
  #     Required. The duration of time between executions in days.
  class Schedule
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Type of user agents used for scanning.
  module UserAgent
    # The user agent is unknown. Service will default to CHROME_LINUX.
    USER_AGENT_UNSPECIFIED = 0

    # Chrome on Linux. This is the service default if unspecified.
    CHROME_LINUX = 1

    # Chrome on Android.
    CHROME_ANDROID = 2

    # Safari on IPhone.
    SAFARI_IPHONE = 3
  end

  # Cloud platforms supported by Cloud Web Security Scanner.
  module TargetPlatform
    # The target platform is unknown. Requests with this enum value will be
    # rejected with INVALID_ARGUMENT error.
    TARGET_PLATFORM_UNSPECIFIED = 0

    # Google App Engine service.
    APP_ENGINE = 1

    # Google Compute Engine service.
    COMPUTE = 2
  end

  # Scan risk levels supported by Cloud Web Security Scanner. LOW impact
  # scanning will minimize requests with the potential to modify data. To
  # achieve the maximum scan coverage, NORMAL risk level is recommended.
  module RiskLevel
    # Use default, which is NORMAL.
    RISK_LEVEL_UNSPECIFIED = 0

    # Normal scanning (Recommended)
    NORMAL = 1

    # Lower impact scanning
    LOW = 2
  end

  # Controls export of scan configurations and results to Cloud Security
  # Command Center.
  module ExportToSecurityCommandCenter
    # Use default, which is ENABLED.
    EXPORT_TO_SECURITY_COMMAND_CENTER_UNSPECIFIED = 0

    # Export results of this scan to Cloud Security Command Center.
    ENABLED = 1

    # Do not export results of this scan to Cloud Security Command Center.
    DISABLED = 2
  end
end

#name ⇒ ::String

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

Returns:

  • (::String) —

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



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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'proto_docs/google/cloud/websecurityscanner/v1beta/scan_config.rb', line 70

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

  # Scan authentication configuration.
  # @!attribute [rw] google_account
  #   @return [::Google::Cloud::WebSecurityScanner::V1beta::ScanConfig::Authentication::GoogleAccount]
  #     Authentication using a Google account.
  # @!attribute [rw] custom_account
  #   @return [::Google::Cloud::WebSecurityScanner::V1beta::ScanConfig::Authentication::CustomAccount]
  #     Authentication using a custom account.
  class Authentication
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Describes authentication configuration that uses a Google account.
    # @!attribute [rw] username
    #   @return [::String]
    #     Required. The user name of the Google account.
    # @!attribute [rw] password
    #   @return [::String]
    #     Required. Input only. The password of the Google account. The credential is stored encrypted
    #     and not returned in any response nor included in audit logs.
    class GoogleAccount
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Describes authentication configuration that uses a custom account.
    # @!attribute [rw] username
    #   @return [::String]
    #     Required. The user name of the custom account.
    # @!attribute [rw] password
    #   @return [::String]
    #     Required. Input only. The password of the custom account. The credential is stored encrypted
    #     and not returned in any response nor included in audit logs.
    # @!attribute [rw] login_url
    #   @return [::String]
    #     Required. The login form URL of the website.
    class CustomAccount
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Scan schedule configuration.
  # @!attribute [rw] schedule_time
  #   @return [::Google::Protobuf::Timestamp]
  #     A timestamp indicates when the next run will be scheduled. The value is
  #     refreshed by the server after each run. If unspecified, it will default
  #     to current server time, which means the scan will be scheduled to start
  #     immediately.
  # @!attribute [rw] interval_duration_days
  #   @return [::Integer]
  #     Required. The duration of time between executions in days.
  class Schedule
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Type of user agents used for scanning.
  module UserAgent
    # The user agent is unknown. Service will default to CHROME_LINUX.
    USER_AGENT_UNSPECIFIED = 0

    # Chrome on Linux. This is the service default if unspecified.
    CHROME_LINUX = 1

    # Chrome on Android.
    CHROME_ANDROID = 2

    # Safari on IPhone.
    SAFARI_IPHONE = 3
  end

  # Cloud platforms supported by Cloud Web Security Scanner.
  module TargetPlatform
    # The target platform is unknown. Requests with this enum value will be
    # rejected with INVALID_ARGUMENT error.
    TARGET_PLATFORM_UNSPECIFIED = 0

    # Google App Engine service.
    APP_ENGINE = 1

    # Google Compute Engine service.
    COMPUTE = 2
  end

  # Scan risk levels supported by Cloud Web Security Scanner. LOW impact
  # scanning will minimize requests with the potential to modify data. To
  # achieve the maximum scan coverage, NORMAL risk level is recommended.
  module RiskLevel
    # Use default, which is NORMAL.
    RISK_LEVEL_UNSPECIFIED = 0

    # Normal scanning (Recommended)
    NORMAL = 1

    # Lower impact scanning
    LOW = 2
  end

  # Controls export of scan configurations and results to Cloud Security
  # Command Center.
  module ExportToSecurityCommandCenter
    # Use default, which is ENABLED.
    EXPORT_TO_SECURITY_COMMAND_CENTER_UNSPECIFIED = 0

    # Export results of this scan to Cloud Security Command Center.
    ENABLED = 1

    # Do not export results of this scan to Cloud Security Command Center.
    DISABLED = 2
  end
end

#risk_level ⇒ ::Google::Cloud::WebSecurityScanner::V1beta::ScanConfig::RiskLevel

Returns The risk level selected for the scan.

Returns:



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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'proto_docs/google/cloud/websecurityscanner/v1beta/scan_config.rb', line 70

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

  # Scan authentication configuration.
  # @!attribute [rw] google_account
  #   @return [::Google::Cloud::WebSecurityScanner::V1beta::ScanConfig::Authentication::GoogleAccount]
  #     Authentication using a Google account.
  # @!attribute [rw] custom_account
  #   @return [::Google::Cloud::WebSecurityScanner::V1beta::ScanConfig::Authentication::CustomAccount]
  #     Authentication using a custom account.
  class Authentication
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Describes authentication configuration that uses a Google account.
    # @!attribute [rw] username
    #   @return [::String]
    #     Required. The user name of the Google account.
    # @!attribute [rw] password
    #   @return [::String]
    #     Required. Input only. The password of the Google account. The credential is stored encrypted
    #     and not returned in any response nor included in audit logs.
    class GoogleAccount
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Describes authentication configuration that uses a custom account.
    # @!attribute [rw] username
    #   @return [::String]
    #     Required. The user name of the custom account.
    # @!attribute [rw] password
    #   @return [::String]
    #     Required. Input only. The password of the custom account. The credential is stored encrypted
    #     and not returned in any response nor included in audit logs.
    # @!attribute [rw] login_url
    #   @return [::String]
    #     Required. The login form URL of the website.
    class CustomAccount
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Scan schedule configuration.
  # @!attribute [rw] schedule_time
  #   @return [::Google::Protobuf::Timestamp]
  #     A timestamp indicates when the next run will be scheduled. The value is
  #     refreshed by the server after each run. If unspecified, it will default
  #     to current server time, which means the scan will be scheduled to start
  #     immediately.
  # @!attribute [rw] interval_duration_days
  #   @return [::Integer]
  #     Required. The duration of time between executions in days.
  class Schedule
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Type of user agents used for scanning.
  module UserAgent
    # The user agent is unknown. Service will default to CHROME_LINUX.
    USER_AGENT_UNSPECIFIED = 0

    # Chrome on Linux. This is the service default if unspecified.
    CHROME_LINUX = 1

    # Chrome on Android.
    CHROME_ANDROID = 2

    # Safari on IPhone.
    SAFARI_IPHONE = 3
  end

  # Cloud platforms supported by Cloud Web Security Scanner.
  module TargetPlatform
    # The target platform is unknown. Requests with this enum value will be
    # rejected with INVALID_ARGUMENT error.
    TARGET_PLATFORM_UNSPECIFIED = 0

    # Google App Engine service.
    APP_ENGINE = 1

    # Google Compute Engine service.
    COMPUTE = 2
  end

  # Scan risk levels supported by Cloud Web Security Scanner. LOW impact
  # scanning will minimize requests with the potential to modify data. To
  # achieve the maximum scan coverage, NORMAL risk level is recommended.
  module RiskLevel
    # Use default, which is NORMAL.
    RISK_LEVEL_UNSPECIFIED = 0

    # Normal scanning (Recommended)
    NORMAL = 1

    # Lower impact scanning
    LOW = 2
  end

  # Controls export of scan configurations and results to Cloud Security
  # Command Center.
  module ExportToSecurityCommandCenter
    # Use default, which is ENABLED.
    EXPORT_TO_SECURITY_COMMAND_CENTER_UNSPECIFIED = 0

    # Export results of this scan to Cloud Security Command Center.
    ENABLED = 1

    # Do not export results of this scan to Cloud Security Command Center.
    DISABLED = 2
  end
end

#schedule ⇒ ::Google::Cloud::WebSecurityScanner::V1beta::ScanConfig::Schedule

Returns The schedule of the ScanConfig.

Returns:



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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'proto_docs/google/cloud/websecurityscanner/v1beta/scan_config.rb', line 70

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

  # Scan authentication configuration.
  # @!attribute [rw] google_account
  #   @return [::Google::Cloud::WebSecurityScanner::V1beta::ScanConfig::Authentication::GoogleAccount]
  #     Authentication using a Google account.
  # @!attribute [rw] custom_account
  #   @return [::Google::Cloud::WebSecurityScanner::V1beta::ScanConfig::Authentication::CustomAccount]
  #     Authentication using a custom account.
  class Authentication
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Describes authentication configuration that uses a Google account.
    # @!attribute [rw] username
    #   @return [::String]
    #     Required. The user name of the Google account.
    # @!attribute [rw] password
    #   @return [::String]
    #     Required. Input only. The password of the Google account. The credential is stored encrypted
    #     and not returned in any response nor included in audit logs.
    class GoogleAccount
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Describes authentication configuration that uses a custom account.
    # @!attribute [rw] username
    #   @return [::String]
    #     Required. The user name of the custom account.
    # @!attribute [rw] password
    #   @return [::String]
    #     Required. Input only. The password of the custom account. The credential is stored encrypted
    #     and not returned in any response nor included in audit logs.
    # @!attribute [rw] login_url
    #   @return [::String]
    #     Required. The login form URL of the website.
    class CustomAccount
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Scan schedule configuration.
  # @!attribute [rw] schedule_time
  #   @return [::Google::Protobuf::Timestamp]
  #     A timestamp indicates when the next run will be scheduled. The value is
  #     refreshed by the server after each run. If unspecified, it will default
  #     to current server time, which means the scan will be scheduled to start
  #     immediately.
  # @!attribute [rw] interval_duration_days
  #   @return [::Integer]
  #     Required. The duration of time between executions in days.
  class Schedule
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Type of user agents used for scanning.
  module UserAgent
    # The user agent is unknown. Service will default to CHROME_LINUX.
    USER_AGENT_UNSPECIFIED = 0

    # Chrome on Linux. This is the service default if unspecified.
    CHROME_LINUX = 1

    # Chrome on Android.
    CHROME_ANDROID = 2

    # Safari on IPhone.
    SAFARI_IPHONE = 3
  end

  # Cloud platforms supported by Cloud Web Security Scanner.
  module TargetPlatform
    # The target platform is unknown. Requests with this enum value will be
    # rejected with INVALID_ARGUMENT error.
    TARGET_PLATFORM_UNSPECIFIED = 0

    # Google App Engine service.
    APP_ENGINE = 1

    # Google Compute Engine service.
    COMPUTE = 2
  end

  # Scan risk levels supported by Cloud Web Security Scanner. LOW impact
  # scanning will minimize requests with the potential to modify data. To
  # achieve the maximum scan coverage, NORMAL risk level is recommended.
  module RiskLevel
    # Use default, which is NORMAL.
    RISK_LEVEL_UNSPECIFIED = 0

    # Normal scanning (Recommended)
    NORMAL = 1

    # Lower impact scanning
    LOW = 2
  end

  # Controls export of scan configurations and results to Cloud Security
  # Command Center.
  module ExportToSecurityCommandCenter
    # Use default, which is ENABLED.
    EXPORT_TO_SECURITY_COMMAND_CENTER_UNSPECIFIED = 0

    # Export results of this scan to Cloud Security Command Center.
    ENABLED = 1

    # Do not export results of this scan to Cloud Security Command Center.
    DISABLED = 2
  end
end

#starting_urls ⇒ ::Array<::String>

Returns Required. The starting URLs from which the scanner finds site pages.

Returns:

  • (::Array<::String>) —

    Required. The starting URLs from which the scanner finds site pages.



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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'proto_docs/google/cloud/websecurityscanner/v1beta/scan_config.rb', line 70

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

  # Scan authentication configuration.
  # @!attribute [rw] google_account
  #   @return [::Google::Cloud::WebSecurityScanner::V1beta::ScanConfig::Authentication::GoogleAccount]
  #     Authentication using a Google account.
  # @!attribute [rw] custom_account
  #   @return [::Google::Cloud::WebSecurityScanner::V1beta::ScanConfig::Authentication::CustomAccount]
  #     Authentication using a custom account.
  class Authentication
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Describes authentication configuration that uses a Google account.
    # @!attribute [rw] username
    #   @return [::String]
    #     Required. The user name of the Google account.
    # @!attribute [rw] password
    #   @return [::String]
    #     Required. Input only. The password of the Google account. The credential is stored encrypted
    #     and not returned in any response nor included in audit logs.
    class GoogleAccount
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Describes authentication configuration that uses a custom account.
    # @!attribute [rw] username
    #   @return [::String]
    #     Required. The user name of the custom account.
    # @!attribute [rw] password
    #   @return [::String]
    #     Required. Input only. The password of the custom account. The credential is stored encrypted
    #     and not returned in any response nor included in audit logs.
    # @!attribute [rw] login_url
    #   @return [::String]
    #     Required. The login form URL of the website.
    class CustomAccount
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Scan schedule configuration.
  # @!attribute [rw] schedule_time
  #   @return [::Google::Protobuf::Timestamp]
  #     A timestamp indicates when the next run will be scheduled. The value is
  #     refreshed by the server after each run. If unspecified, it will default
  #     to current server time, which means the scan will be scheduled to start
  #     immediately.
  # @!attribute [rw] interval_duration_days
  #   @return [::Integer]
  #     Required. The duration of time between executions in days.
  class Schedule
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Type of user agents used for scanning.
  module UserAgent
    # The user agent is unknown. Service will default to CHROME_LINUX.
    USER_AGENT_UNSPECIFIED = 0

    # Chrome on Linux. This is the service default if unspecified.
    CHROME_LINUX = 1

    # Chrome on Android.
    CHROME_ANDROID = 2

    # Safari on IPhone.
    SAFARI_IPHONE = 3
  end

  # Cloud platforms supported by Cloud Web Security Scanner.
  module TargetPlatform
    # The target platform is unknown. Requests with this enum value will be
    # rejected with INVALID_ARGUMENT error.
    TARGET_PLATFORM_UNSPECIFIED = 0

    # Google App Engine service.
    APP_ENGINE = 1

    # Google Compute Engine service.
    COMPUTE = 2
  end

  # Scan risk levels supported by Cloud Web Security Scanner. LOW impact
  # scanning will minimize requests with the potential to modify data. To
  # achieve the maximum scan coverage, NORMAL risk level is recommended.
  module RiskLevel
    # Use default, which is NORMAL.
    RISK_LEVEL_UNSPECIFIED = 0

    # Normal scanning (Recommended)
    NORMAL = 1

    # Lower impact scanning
    LOW = 2
  end

  # Controls export of scan configurations and results to Cloud Security
  # Command Center.
  module ExportToSecurityCommandCenter
    # Use default, which is ENABLED.
    EXPORT_TO_SECURITY_COMMAND_CENTER_UNSPECIFIED = 0

    # Export results of this scan to Cloud Security Command Center.
    ENABLED = 1

    # Do not export results of this scan to Cloud Security Command Center.
    DISABLED = 2
  end
end

#target_platforms ⇒ ::Array<::Google::Cloud::WebSecurityScanner::V1beta::ScanConfig::TargetPlatform>

Returns Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.

Returns:



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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'proto_docs/google/cloud/websecurityscanner/v1beta/scan_config.rb', line 70

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

  # Scan authentication configuration.
  # @!attribute [rw] google_account
  #   @return [::Google::Cloud::WebSecurityScanner::V1beta::ScanConfig::Authentication::GoogleAccount]
  #     Authentication using a Google account.
  # @!attribute [rw] custom_account
  #   @return [::Google::Cloud::WebSecurityScanner::V1beta::ScanConfig::Authentication::CustomAccount]
  #     Authentication using a custom account.
  class Authentication
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Describes authentication configuration that uses a Google account.
    # @!attribute [rw] username
    #   @return [::String]
    #     Required. The user name of the Google account.
    # @!attribute [rw] password
    #   @return [::String]
    #     Required. Input only. The password of the Google account. The credential is stored encrypted
    #     and not returned in any response nor included in audit logs.
    class GoogleAccount
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Describes authentication configuration that uses a custom account.
    # @!attribute [rw] username
    #   @return [::String]
    #     Required. The user name of the custom account.
    # @!attribute [rw] password
    #   @return [::String]
    #     Required. Input only. The password of the custom account. The credential is stored encrypted
    #     and not returned in any response nor included in audit logs.
    # @!attribute [rw] login_url
    #   @return [::String]
    #     Required. The login form URL of the website.
    class CustomAccount
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Scan schedule configuration.
  # @!attribute [rw] schedule_time
  #   @return [::Google::Protobuf::Timestamp]
  #     A timestamp indicates when the next run will be scheduled. The value is
  #     refreshed by the server after each run. If unspecified, it will default
  #     to current server time, which means the scan will be scheduled to start
  #     immediately.
  # @!attribute [rw] interval_duration_days
  #   @return [::Integer]
  #     Required. The duration of time between executions in days.
  class Schedule
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Type of user agents used for scanning.
  module UserAgent
    # The user agent is unknown. Service will default to CHROME_LINUX.
    USER_AGENT_UNSPECIFIED = 0

    # Chrome on Linux. This is the service default if unspecified.
    CHROME_LINUX = 1

    # Chrome on Android.
    CHROME_ANDROID = 2

    # Safari on IPhone.
    SAFARI_IPHONE = 3
  end

  # Cloud platforms supported by Cloud Web Security Scanner.
  module TargetPlatform
    # The target platform is unknown. Requests with this enum value will be
    # rejected with INVALID_ARGUMENT error.
    TARGET_PLATFORM_UNSPECIFIED = 0

    # Google App Engine service.
    APP_ENGINE = 1

    # Google Compute Engine service.
    COMPUTE = 2
  end

  # Scan risk levels supported by Cloud Web Security Scanner. LOW impact
  # scanning will minimize requests with the potential to modify data. To
  # achieve the maximum scan coverage, NORMAL risk level is recommended.
  module RiskLevel
    # Use default, which is NORMAL.
    RISK_LEVEL_UNSPECIFIED = 0

    # Normal scanning (Recommended)
    NORMAL = 1

    # Lower impact scanning
    LOW = 2
  end

  # Controls export of scan configurations and results to Cloud Security
  # Command Center.
  module ExportToSecurityCommandCenter
    # Use default, which is ENABLED.
    EXPORT_TO_SECURITY_COMMAND_CENTER_UNSPECIFIED = 0

    # Export results of this scan to Cloud Security Command Center.
    ENABLED = 1

    # Do not export results of this scan to Cloud Security Command Center.
    DISABLED = 2
  end
end

#user_agent ⇒ ::Google::Cloud::WebSecurityScanner::V1beta::ScanConfig::UserAgent

Returns The user agent used during scanning.

Returns:



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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'proto_docs/google/cloud/websecurityscanner/v1beta/scan_config.rb', line 70

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

  # Scan authentication configuration.
  # @!attribute [rw] google_account
  #   @return [::Google::Cloud::WebSecurityScanner::V1beta::ScanConfig::Authentication::GoogleAccount]
  #     Authentication using a Google account.
  # @!attribute [rw] custom_account
  #   @return [::Google::Cloud::WebSecurityScanner::V1beta::ScanConfig::Authentication::CustomAccount]
  #     Authentication using a custom account.
  class Authentication
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Describes authentication configuration that uses a Google account.
    # @!attribute [rw] username
    #   @return [::String]
    #     Required. The user name of the Google account.
    # @!attribute [rw] password
    #   @return [::String]
    #     Required. Input only. The password of the Google account. The credential is stored encrypted
    #     and not returned in any response nor included in audit logs.
    class GoogleAccount
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Describes authentication configuration that uses a custom account.
    # @!attribute [rw] username
    #   @return [::String]
    #     Required. The user name of the custom account.
    # @!attribute [rw] password
    #   @return [::String]
    #     Required. Input only. The password of the custom account. The credential is stored encrypted
    #     and not returned in any response nor included in audit logs.
    # @!attribute [rw] login_url
    #   @return [::String]
    #     Required. The login form URL of the website.
    class CustomAccount
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Scan schedule configuration.
  # @!attribute [rw] schedule_time
  #   @return [::Google::Protobuf::Timestamp]
  #     A timestamp indicates when the next run will be scheduled. The value is
  #     refreshed by the server after each run. If unspecified, it will default
  #     to current server time, which means the scan will be scheduled to start
  #     immediately.
  # @!attribute [rw] interval_duration_days
  #   @return [::Integer]
  #     Required. The duration of time between executions in days.
  class Schedule
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Type of user agents used for scanning.
  module UserAgent
    # The user agent is unknown. Service will default to CHROME_LINUX.
    USER_AGENT_UNSPECIFIED = 0

    # Chrome on Linux. This is the service default if unspecified.
    CHROME_LINUX = 1

    # Chrome on Android.
    CHROME_ANDROID = 2

    # Safari on IPhone.
    SAFARI_IPHONE = 3
  end

  # Cloud platforms supported by Cloud Web Security Scanner.
  module TargetPlatform
    # The target platform is unknown. Requests with this enum value will be
    # rejected with INVALID_ARGUMENT error.
    TARGET_PLATFORM_UNSPECIFIED = 0

    # Google App Engine service.
    APP_ENGINE = 1

    # Google Compute Engine service.
    COMPUTE = 2
  end

  # Scan risk levels supported by Cloud Web Security Scanner. LOW impact
  # scanning will minimize requests with the potential to modify data. To
  # achieve the maximum scan coverage, NORMAL risk level is recommended.
  module RiskLevel
    # Use default, which is NORMAL.
    RISK_LEVEL_UNSPECIFIED = 0

    # Normal scanning (Recommended)
    NORMAL = 1

    # Lower impact scanning
    LOW = 2
  end

  # Controls export of scan configurations and results to Cloud Security
  # Command Center.
  module ExportToSecurityCommandCenter
    # Use default, which is ENABLED.
    EXPORT_TO_SECURITY_COMMAND_CENTER_UNSPECIFIED = 0

    # Export results of this scan to Cloud Security Command Center.
    ENABLED = 1

    # Do not export results of this scan to Cloud Security Command Center.
    DISABLED = 2
  end
end