Class: Google::Apis::ContaineranalysisV1alpha1::ComplianceNote

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ComplianceNote

Returns a new instance of ComplianceNote.



578
579
580
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 578

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

Returns:



545
546
547
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 545

def cis_benchmark
  @cis_benchmark
end

#description ⇒ String

A description about this compliance check. Corresponds to the JSON property description

Returns:

  • (String) 


550
551
552
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 550

def description
  @description
end

#rationale ⇒ String

A rationale for the existence of this compliance check. Corresponds to the JSON property rationale

Returns:

  • (String) 


555
556
557
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 555

def rationale
  @rationale
end

#remediation ⇒ String

A description of remediation steps if the compliance check fails. Corresponds to the JSON property remediation

Returns:

  • (String) 


560
561
562
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 560

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.

Returns:

  • (String) 


566
567
568
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 566

def scan_instructions
  @scan_instructions
end

#title ⇒ String

The title that identifies this compliance check. Corresponds to the JSON property title

Returns:

  • (String) 


571
572
573
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 571

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

Returns:



576
577
578
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 576

def version
  @version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



583
584
585
586
587
588
589
590
591
 
# File 'lib/google/apis/containeranalysis_v1alpha1/classes.rb', line 583

def update!(**args)
  @cis_benchmark = args[:cis_benchmark] if args.key?(:cis_benchmark)
  @description = args[:description] if args.key?(:description)
  @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