Class: Google::Apis::ContaineranalysisV1alpha1::ComplianceNote
- Inherits:
 - 
      Object
      
        
- Object
 - Google::Apis::ContaineranalysisV1alpha1::ComplianceNote
 
 
- Includes:
 - Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
 
- Defined in:
 - lib/google/apis/containeranalysis_v1alpha1/classes.rb,
lib/google/apis/containeranalysis_v1alpha1/representations.rb,
lib/google/apis/containeranalysis_v1alpha1/representations.rb 
Overview
ComplianceNote encapsulates all information about a specific compliance check.
Instance Attribute Summary collapse
- 
  
    
      #cis_benchmark  ⇒ Google::Apis::ContaineranalysisV1alpha1::CisBenchmark 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
A compliance check that is a CIS benchmark.
 - 
  
    
      #description  ⇒ String 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
A description about this compliance check.
 - 
  
    
      #impact  ⇒ String 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Potential impact of the suggested remediation Corresponds to the JSON property
impact. - 
  
    
      #rationale  ⇒ String 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
A rationale for the existence of this compliance check.
 - 
  
    
      #remediation  ⇒ String 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
A description of remediation steps if the compliance check fails.
 - 
  
    
      #scan_instructions  ⇒ String 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Serialized scan instructions with a predefined format.
 - 
  
    
      #title  ⇒ String 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
The title that identifies this compliance check.
 - 
  
    
      #version  ⇒ Array<Google::Apis::ContaineranalysisV1alpha1::ComplianceVersion> 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
The OS and config versions the benchmark applies to.
 
Instance Method Summary collapse
- 
  
    
      #initialize(**args)  ⇒ ComplianceNote 
    
    
  
  
  
    constructor
  
  
  
  
  
  
  
    
A new instance of ComplianceNote.
 - 
  
    
      #update!(**args)  ⇒ Object 
    
    
  
  
  
  
  
  
  
  
  
    
Update properties of this object.
 
Constructor Details
#initialize(**args) ⇒ ComplianceNote
Returns a new instance of ComplianceNote.
      1113 1114 1115  | 
    
      # File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 1113 def initialize(**args) update!(**args) end  | 
  
Instance Attribute Details
#cis_benchmark ⇒ Google::Apis::ContaineranalysisV1alpha1::CisBenchmark
A compliance check that is a CIS benchmark.
Corresponds to the JSON property cisBenchmark
      1075 1076 1077  | 
    
      # File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 1075 def cis_benchmark @cis_benchmark end  | 
  
#description ⇒ String
A description about this compliance check.
Corresponds to the JSON property description
      1080 1081 1082  | 
    
      # File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 1080 def description @description end  | 
  
#impact ⇒ String
Potential impact of the suggested remediation
Corresponds to the JSON property impact
      1085 1086 1087  | 
    
      # File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 1085 def impact @impact end  | 
  
#rationale ⇒ String
A rationale for the existence of this compliance check.
Corresponds to the JSON property rationale
      1090 1091 1092  | 
    
      # File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 1090 def rationale @rationale end  | 
  
#remediation ⇒ String
A description of remediation steps if the compliance check fails.
Corresponds to the JSON property remediation
      1095 1096 1097  | 
    
      # File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 1095 def remediation @remediation end  | 
  
#scan_instructions ⇒ String
Serialized scan instructions with a predefined format.
Corresponds to the JSON property scanInstructions
NOTE: Values are automatically base64 encoded/decoded in the client library.
      1101 1102 1103  | 
    
      # File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 1101 def scan_instructions @scan_instructions end  | 
  
#title ⇒ String
The title that identifies this compliance check.
Corresponds to the JSON property title
      1106 1107 1108  | 
    
      # File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 1106 def title @title end  | 
  
#version ⇒ Array<Google::Apis::ContaineranalysisV1alpha1::ComplianceVersion>
The OS and config versions the benchmark applies to.
Corresponds to the JSON property version
      1111 1112 1113  | 
    
      # File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 1111 def version @version end  | 
  
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
      1118 1119 1120 1121 1122 1123 1124 1125 1126 1127  | 
    
      # File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 1118 def update!(**args) @cis_benchmark = args[:cis_benchmark] if args.key?(:cis_benchmark) @description = args[:description] if args.key?(:description) @impact = args[:impact] if args.key?(:impact) @rationale = args[:rationale] if args.key?(:rationale) @remediation = args[:remediation] if args.key?(:remediation) @scan_instructions = args[:scan_instructions] if args.key?(:scan_instructions) @title = args[:title] if args.key?(:title) @version = args[:version] if args.key?(:version) end  |