generated/google/apis/websecurityscanner_v1alpha/classes.rb in google-api-client-0.30.4 vs generated/google/apis/websecurityscanner_v1alpha/classes.rb in google-api-client-0.30.5

- old
+ new

@@ -51,25 +51,22 @@ # Security Scanner Service crawls the web applications, following all links # within the scope of sites, to find the URLs to test against. class CrawledUrl include Google::Apis::Core::Hashable - # Output only. - # The body of the request that was used to visit the URL. + # Output only. The body of the request that was used to visit the URL. # Corresponds to the JSON property `body` # @return [String] attr_accessor :body - # Output only. - # The http method of the request that was used to visit the URL, in + # Output only. 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 - # Output only. - # The URL that was crawled. + # Output only. The URL that was crawled. # Corresponds to the JSON property `url` # @return [String] attr_accessor :url def initialize(**args) @@ -86,26 +83,23 @@ # Describes authentication configuration that uses a custom account. class CustomAccount include Google::Apis::Core::Hashable - # Required. - # The login form URL of the website. + # Required. The login form URL of the website. # Corresponds to the JSON property `loginUrl` # @return [String] attr_accessor :login_url - # Input only. - # Required. - # The password of the custom account. The credential is stored encrypted + # 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. # Corresponds to the JSON property `password` # @return [String] attr_accessor :password - # Required. - # The user name of the custom account. + # Required. The user name of the custom account. # Corresponds to the JSON property `username` # @return [String] attr_accessor :username def initialize(**args) @@ -142,57 +136,53 @@ # A Finding resource represents a vulnerability instance identified during a # ScanRun. class Finding include Google::Apis::Core::Hashable - # Output only. - # The body of the request that triggered the vulnerability. + # Output only. The body of the request that triggered the vulnerability. # Corresponds to the JSON property `body` # @return [String] attr_accessor :body - # Output only. - # The description of the vulnerability. + # Output only. The description of the vulnerability. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # Output only. - # The URL where the browser lands when the vulnerability is detected. + # Output only. The URL where the browser lands when the vulnerability is + # detected. # Corresponds to the JSON property `finalUrl` # @return [String] attr_accessor :final_url - # Output only. - # The type of the Finding. + # Output only. The type of the Finding. # Corresponds to the JSON property `findingType` # @return [String] attr_accessor :finding_type - # Output only. - # If the vulnerability was originated from nested IFrame, the immediate + # Output only. 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 - # Output only. - # The URL produced by the server-side fuzzer and used in the request that + # Output only. 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 - # Output only. - # The http method of the request that triggered the vulnerability, in + # Output only. The http method of the request that triggered the vulnerability, + # in # uppercase. # Corresponds to the JSON property `httpMethod` # @return [String] attr_accessor :http_method - # Output only. - # The resource name of the Finding. The name follows the format of + # Output only. 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] @@ -201,19 +191,19 @@ # Information reported for an outdated library. # Corresponds to the JSON property `outdatedLibrary` # @return [Google::Apis::WebsecurityscannerV1alpha::OutdatedLibrary] attr_accessor :outdated_library - # Output only. - # The URL containing human-readable payload that user can leverage to + # Output only. 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 - # Output only. - # The tracking ID uniquely identifies a vulnerability instance across + # Output only. The tracking ID uniquely identifies a vulnerability instance + # across # multiple ScanRuns. # Corresponds to the JSON property `trackingId` # @return [String] attr_accessor :tracking_id @@ -265,18 +255,16 @@ # A FindingTypeStats resource represents stats regarding a specific FindingType # of Findings under a given ScanRun. class FindingTypeStats include Google::Apis::Core::Hashable - # Output only. - # The count of findings belonging to this finding type. + # Output only. The count of findings belonging to this finding type. # Corresponds to the JSON property `findingCount` # @return [Fixnum] attr_accessor :finding_count - # Output only. - # The finding type associated with the stats. + # Output only. The finding type associated with the stats. # Corresponds to the JSON property `findingType` # @return [String] attr_accessor :finding_type def initialize(**args) @@ -292,20 +280,18 @@ # Describes authentication configuration that uses a Google account. class GoogleAccount include Google::Apis::Core::Hashable - # Input only. - # Required. - # The password of the Google account. The credential is stored encrypted + # 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. # Corresponds to the JSON property `password` # @return [String] attr_accessor :password - # Required. - # The user name of the Google account. + # Required. The user name of the Google account. # Corresponds to the JSON property `username` # @return [String] attr_accessor :username def initialize(**args) @@ -512,12 +498,11 @@ # https://cloud.google.com/security-scanner/docs/excluded-urls # Corresponds to the JSON property `blacklistPatterns` # @return [Array<String>] attr_accessor :blacklist_patterns - # Required. - # The user provided display name of the ScanConfig. + # Required. The user provided display name of the ScanConfig. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name # A ScanRun is a output-only resource representing an actual run of the scan. @@ -543,12 +528,11 @@ # Scan schedule configuration. # Corresponds to the JSON property `schedule` # @return [Google::Apis::WebsecurityscannerV1alpha::Schedule] attr_accessor :schedule - # Required. - # The starting URLs from which the scanner finds site pages. + # Required. The starting URLs from which the scanner finds site pages. # Corresponds to the JSON property `startingUrls` # @return [Array<String>] attr_accessor :starting_urls # Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be @@ -583,69 +567,64 @@ # A ScanRun is a output-only resource representing an actual run of the scan. class ScanRun include Google::Apis::Core::Hashable - # Output only. - # The time at which the ScanRun reached termination state - that the ScanRun + # Output only. 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. - # The execution state of the ScanRun. + # Output only. The execution state of the ScanRun. # Corresponds to the JSON property `executionState` # @return [String] attr_accessor :execution_state - # Output only. - # Whether the scan run has found any vulnerabilities. + # Output only. Whether the scan run has found any vulnerabilities. # Corresponds to the JSON property `hasVulnerabilities` # @return [Boolean] attr_accessor :has_vulnerabilities alias_method :has_vulnerabilities?, :has_vulnerabilities - # Output only. - # The resource name of the ScanRun. The name follows the format of + # Output only. 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 - # Output only. - # The percentage of total completion ranging from 0 to 100. + # Output only. 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 - # Output only. - # The result state of the ScanRun. This field is only available after the + # Output only. The result state of the ScanRun. This field is only available + # after the # execution state reaches "FINISHED". # Corresponds to the JSON property `resultState` # @return [String] attr_accessor :result_state - # Output only. - # The time at which the ScanRun started. + # Output only. The time at which the ScanRun started. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time - # Output only. - # The number of URLs crawled during this ScanRun. If the scan is in progress, + # Output only. 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. # Corresponds to the JSON property `urlsCrawledCount` # @return [Fixnum] attr_accessor :urls_crawled_count - # Output only. - # The number of URLs tested during this ScanRun. If the scan is in progress, + # Output only. 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] @@ -671,11 +650,10 @@ # Scan schedule configuration. class Schedule include Google::Apis::Core::Hashable - # Required. - # The duration of time between executions in days. + # Required. The duration of time between executions in days. # 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