generated/google/apis/websecurityscanner_v1beta/classes.rb in google-api-client-0.42.2 vs generated/google/apis/websecurityscanner_v1beta/classes.rb in google-api-client-0.43.0

- old
+ new

@@ -62,12 +62,11 @@ # The body of the request that was used to visit the URL. # Corresponds to the JSON property `body` # @return [String] attr_accessor :body - # The http method of the request that was used to visit the URL, in - # uppercase. + # The http method of the request that was used to visit the URL, in uppercase. # Corresponds to the JSON property `httpMethod` # @return [String] attr_accessor :http_method # The URL that was crawled. @@ -95,12 +94,11 @@ # Corresponds to the JSON property `loginUrl` # @return [String] attr_accessor :login_url # 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. + # stored encrypted and not returned in any response nor included in audit logs. # Corresponds to the JSON property `password` # @return [String] attr_accessor :password # Required. The user name of the custom account. @@ -118,17 +116,15 @@ @password = args[:password] if args.key?(:password) @username = args[:username] if args.key?(:username) end end - # A generic empty message that you can re-use to avoid defining duplicated - # empty messages in your APIs. A typical example is to use it as the request - # or the response type of an API method. For instance: - # service Foo ` - # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); - # ` - # The JSON representation for `Empty` is empty JSON object ````. + # A generic empty message that you can re-use to avoid defining duplicated empty + # messages in your APIs. A typical example is to use it as the request or the + # response type of an API method. For instance: service Foo ` rpc Bar(google. + # protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for + # `Empty` is empty JSON object ````. class Empty include Google::Apis::Core::Hashable def initialize(**args) update!(**args) @@ -157,73 +153,70 @@ # The URL where the browser lands when the vulnerability is detected. # Corresponds to the JSON property `finalUrl` # @return [String] attr_accessor :final_url - # The type of the Finding. - # Detailed and up-to-date information on findings can be found here: - # https://cloud.google.com/security-command-center/docs/how-to-remediate-web- - # security-scanner + # The type of the Finding. Detailed and up-to-date information on findings can + # be found here: https://cloud.google.com/security-command-center/docs/how-to- + # remediate-web-security-scanner # Corresponds to the JSON property `findingType` # @return [String] attr_accessor :finding_type # ! Information about a vulnerability with an HTML. # Corresponds to the JSON property `form` # @return [Google::Apis::WebsecurityscannerV1beta::Form] attr_accessor :form - # If the vulnerability was originated from nested IFrame, the immediate - # parent IFrame is reported. + # If the vulnerability was originated from nested IFrame, the immediate parent + # IFrame is reported. # Corresponds to the JSON property `frameUrl` # @return [String] attr_accessor :frame_url # The URL produced by the server-side fuzzer and used in the request that # triggered the vulnerability. # Corresponds to the JSON property `fuzzedUrl` # @return [String] attr_accessor :fuzzed_url - # The http method of the request that triggered the vulnerability, in - # uppercase. + # The http method of the request that triggered the vulnerability, in uppercase. # Corresponds to the JSON property `httpMethod` # @return [String] attr_accessor :http_method - # The resource name of the Finding. The name follows the format of - # 'projects/`projectId`/scanConfigs/`scanConfigId`/scanruns/`scanRunId`/findings/ - # `findingId`'. - # The finding IDs are generated by the system. + # The resource name of the Finding. The name follows the format of 'projects/` + # projectId`/scanConfigs/`scanConfigId`/scanruns/`scanRunId`/findings/`findingId` + # '. The finding IDs are generated by the system. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Information reported for an outdated library. # Corresponds to the JSON property `outdatedLibrary` # @return [Google::Apis::WebsecurityscannerV1beta::OutdatedLibrary] attr_accessor :outdated_library - # The URL containing human-readable payload that user can leverage to - # reproduce the vulnerability. + # The URL containing human-readable payload that user can leverage to reproduce + # the vulnerability. # Corresponds to the JSON property `reproductionUrl` # @return [String] attr_accessor :reproduction_url # The severity level of the reported vulnerability. # Corresponds to the JSON property `severity` # @return [String] attr_accessor :severity - # The tracking ID uniquely identifies a vulnerability instance across - # multiple ScanRuns. + # The tracking ID uniquely identifies a vulnerability instance across multiple + # ScanRuns. # Corresponds to the JSON property `trackingId` # @return [String] attr_accessor :tracking_id - # Information regarding any resource causing the vulnerability such - # as JavaScript sources, image, audio files, etc. + # Information regarding any resource causing the vulnerability such as + # JavaScript sources, image, audio files, etc. # Corresponds to the JSON property `violatingResource` # @return [Google::Apis::WebsecurityscannerV1beta::ViolatingResource] attr_accessor :violating_resource # Information about vulnerable or missing HTTP Headers. @@ -321,12 +314,11 @@ # Describes authentication configuration that uses a Google account. class GoogleAccount include Google::Apis::Core::Hashable # 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. + # stored encrypted and not returned in any response nor included in audit logs. # Corresponds to the JSON property `password` # @return [String] attr_accessor :password # Required. The user name of the Google account. @@ -372,12 +364,12 @@ # Describes authentication configuration for Identity-Aware-Proxy (IAP). class IapCredential include Google::Apis::Core::Hashable - # Describes authentication configuration when Web-Security-Scanner - # service account is added in Identity-Aware-Proxy (IAP) access policies. + # Describes authentication configuration when Web-Security-Scanner service + # account is added in Identity-Aware-Proxy (IAP) access policies. # Corresponds to the JSON property `iapTestServiceAccountInfo` # @return [Google::Apis::WebsecurityscannerV1beta::IapTestServiceAccountInfo] attr_accessor :iap_test_service_account_info def initialize(**args) @@ -388,17 +380,17 @@ def update!(**args) @iap_test_service_account_info = args[:iap_test_service_account_info] if args.key?(:iap_test_service_account_info) end end - # Describes authentication configuration when Web-Security-Scanner - # service account is added in Identity-Aware-Proxy (IAP) access policies. + # Describes authentication configuration when Web-Security-Scanner service + # account is added in Identity-Aware-Proxy (IAP) access policies. class IapTestServiceAccountInfo include Google::Apis::Core::Hashable - # Required. Describes OAuth2 Client ID of resources protected by - # Identity-Aware-Proxy(IAP). + # Required. Describes OAuth2 Client ID of resources protected by Identity-Aware- + # Proxy(IAP). # Corresponds to the JSON property `targetAudienceClientId` # @return [String] attr_accessor :target_audience_client_id def initialize(**args) @@ -418,12 +410,12 @@ # The list of CrawledUrls returned. # Corresponds to the JSON property `crawledUrls` # @return [Array<Google::Apis::WebsecurityscannerV1beta::CrawledUrl>] attr_accessor :crawled_urls - # Token to retrieve the next page of results, or empty if there are no - # more results in the list. + # Token to retrieve the next page of results, or empty if there are no more + # results in the list. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token def initialize(**args) @@ -463,12 +455,12 @@ # The list of Findings returned. # Corresponds to the JSON property `findings` # @return [Array<Google::Apis::WebsecurityscannerV1beta::Finding>] attr_accessor :findings - # Token to retrieve the next page of results, or empty if there are no - # more results in the list. + # Token to retrieve the next page of results, or empty if there are no more + # results in the list. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token def initialize(**args) @@ -484,12 +476,12 @@ # Response for the `ListScanConfigs` method. class ListScanConfigsResponse include Google::Apis::Core::Hashable - # Token to retrieve the next page of results, or empty if there are no - # more results in the list. + # Token to retrieve the next page of results, or empty if there are no more + # results in the list. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # The list of ScanConfigs returned. @@ -510,12 +502,12 @@ # Response for the `ListScanRuns` method. class ListScanRunsResponse include Google::Apis::Core::Hashable - # Token to retrieve the next page of results, or empty if there are no - # more results in the list. + # Token to retrieve the next page of results, or empty if there are no more + # results in the list. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # The list of ScanRuns returned. @@ -572,52 +564,49 @@ # Scan authentication configuration. # Corresponds to the JSON property `authentication` # @return [Google::Apis::WebsecurityscannerV1beta::Authentication] attr_accessor :authentication - # The excluded URL patterns as described in - # https://cloud.google.com/security-command-center/docs/how-to-use-web-security- - # scanner#excluding_urls + # The excluded URL patterns as described in https://cloud.google.com/security- + # command-center/docs/how-to-use-web-security-scanner#excluding_urls # Corresponds to the JSON property `blacklistPatterns` # @return [Array<String>] attr_accessor :blacklist_patterns # Required. The user provided display name of the ScanConfig. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name - # Controls export of scan configurations and results to Security - # Command Center. + # Controls export of scan configurations and results to Security Command Center. # Corresponds to the JSON property `exportToSecurityCommandCenter` # @return [String] attr_accessor :export_to_security_command_center # A ScanRun is a output-only resource representing an actual run of the scan. # Next id: 12 # Corresponds to the JSON property `latestRun` # @return [Google::Apis::WebsecurityscannerV1beta::ScanRun] attr_accessor :latest_run - # Whether the scan config is managed by Web Security Scanner, output - # only. + # Whether the scan config is managed by Web Security Scanner, output only. # Corresponds to the JSON property `managedScan` # @return [Boolean] attr_accessor :managed_scan alias_method :managed_scan?, :managed_scan - # 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. + # 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. # Corresponds to the JSON property `maxQps` # @return [Fixnum] attr_accessor :max_qps - # The resource name of the ScanConfig. The name follows the format of - # 'projects/`projectId`/scanConfigs/`scanConfigId`'. The ScanConfig IDs are - # generated by the system. + # The resource name of the ScanConfig. The name follows the format of 'projects/` + # projectId`/scanConfigs/`scanConfigId`'. The ScanConfig IDs are generated by + # the system. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The risk level selected for the scan @@ -633,19 +622,19 @@ # Required. The starting URLs from which the scanner finds site pages. # Corresponds to the JSON property `startingUrls` # @return [Array<String>] attr_accessor :starting_urls - # Whether the scan configuration has enabled static IP address scan feature. - # If enabled, the scanner will access applications from static IP addresses. + # Whether the scan configuration has enabled static IP address scan feature. If + # enabled, the scanner will access applications from static IP addresses. # Corresponds to the JSON property `staticIpScan` # @return [Boolean] attr_accessor :static_ip_scan alias_method :static_ip_scan?, :static_ip_scan - # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE - # will be used as a default. + # Set of Google Cloud platforms targeted by the scan. If empty, APP_ENGINE will + # be used as a default. # Corresponds to the JSON property `targetPlatforms` # @return [Array<String>] attr_accessor :target_platforms # The user agent used during scanning. @@ -686,14 +675,13 @@ # Indicates the reason code for a configuration failure. # Corresponds to the JSON property `code` # @return [String] attr_accessor :code - # Indicates the full name of the ScanConfig field that triggers this error, - # for example "scan_config.max_qps". This field is provided for - # troubleshooting purposes only and its actual value can change in the - # future. + # Indicates the full name of the ScanConfig field that triggers this error, for + # example "scan_config.max_qps". This field is provided for troubleshooting + # purposes only and its actual value can change in the future. # Corresponds to the JSON property `fieldName` # @return [String] attr_accessor :field_name def initialize(**args) @@ -710,18 +698,17 @@ # A ScanRun is a output-only resource representing an actual run of the scan. # Next id: 12 class ScanRun include Google::Apis::Core::Hashable - # The time at which the ScanRun reached termination state - that the ScanRun - # is either finished or stopped by user. + # The time at which the ScanRun reached termination state - that the ScanRun is + # either finished or stopped by user. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time - # Output only. - # Defines an error trace message for a ScanRun. + # Output only. Defines an error trace message for a ScanRun. # Corresponds to the JSON property `errorTrace` # @return [Google::Apis::WebsecurityscannerV1beta::ScanRunErrorTrace] attr_accessor :error_trace # The execution state of the ScanRun. @@ -733,20 +720,19 @@ # Corresponds to the JSON property `hasVulnerabilities` # @return [Boolean] attr_accessor :has_vulnerabilities alias_method :has_vulnerabilities?, :has_vulnerabilities - # 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. + # 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. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # 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. + # 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. # Corresponds to the JSON property `progressPercent` # @return [Fixnum] attr_accessor :progress_percent @@ -765,14 +751,14 @@ # the value represents the number of URLs crawled up to now. # Corresponds to the JSON property `urlsCrawledCount` # @return [Fixnum] attr_accessor :urls_crawled_count - # 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. + # 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. # Corresponds to the JSON property `urlsTestedCount` # @return [Fixnum] attr_accessor :urls_tested_count # A list of warnings, if such are encountered during this scan run. @@ -798,23 +784,22 @@ @urls_tested_count = args[:urls_tested_count] if args.key?(:urls_tested_count) @warning_traces = args[:warning_traces] if args.key?(:warning_traces) end end - # Output only. - # Defines an error trace message for a ScanRun. + # Output only. Defines an error trace message for a ScanRun. class ScanRunErrorTrace include Google::Apis::Core::Hashable # Indicates the error reason code. # Corresponds to the JSON property `code` # @return [String] attr_accessor :code # If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most - # common HTTP error code, if such is available. For example, if this code is - # 404, the scan has encountered too many NOT_FOUND responses. + # common HTTP error code, if such is available. For example, if this code is 404, + # the scan has encountered too many NOT_FOUND responses. # Corresponds to the JSON property `mostCommonHttpErrorCode` # @return [Fixnum] attr_accessor :most_common_http_error_code # Defines a custom error message used by CreateScanConfig and UpdateScanConfig @@ -835,13 +820,13 @@ @most_common_http_error_code = args[:most_common_http_error_code] if args.key?(:most_common_http_error_code) @scan_config_error = args[:scan_config_error] if args.key?(:scan_config_error) end end - # Output only. - # Defines a warning trace message for ScanRun. Warning traces provide customers - # with useful information that helps make the scanning process more effective. + # Output only. Defines a warning trace message for ScanRun. Warning traces + # provide customers with useful information that helps make the scanning process + # more effective. class ScanRunWarningTrace include Google::Apis::Core::Hashable # Indicates the warning code. # Corresponds to the JSON property `code` @@ -866,12 +851,12 @@ # Corresponds to the JSON property `intervalDurationDays` # @return [Fixnum] attr_accessor :interval_duration_days # 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 + # 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. # Corresponds to the JSON property `scheduleTime` # @return [String] attr_accessor :schedule_time @@ -910,11 +895,11 @@ # Update properties of this object def update!(**args) end end - # Information regarding any resource causing the vulnerability such - # as JavaScript sources, image, audio files, etc. + # Information regarding any resource causing the vulnerability such as + # JavaScript sources, image, audio files, etc. class ViolatingResource include Google::Apis::Core::Hashable # The MIME type of this resource. # Corresponds to the JSON property `contentType`