class EmassClient::PoamGet
Attributes
- Optional
-
CCI associated with POA&M Item..
- Conditional
-
Field is required for completed and risk accepted POA&M items. 2000 Characters
- Conditional
-
Field is required for completed POA&M items. Unix time format.
- Optional
-
System acronym name.
- Required
-
Globally unique identifier for individual POA&M Items, seen on the front-end as “ID”.
- Read-Only
-
Value returned for a POA&M Item with review status Approved” and has a milestone with a scheduled completion date that extends beyond the POA&M Item’s scheduled completion date.
- Optional
-
Unique identifier external to the eMASS application for use with associating POA&Ms. 100 Characters.
- Optional
-
Values include the following options: (Very Low,Low,Moderate,High,Very High)
- Optional
-
Include description of Security Control’s impact.
- Conditional
-
Optionally used in PUT to delete milestones when updating a POA&M.
- Read-only
-
Indicates whether a test result is inherited.
- Optional
-
Values include the following options: (Very Low,Low,Moderate,High,Very High)
- Optional
-
Include mitigation explanation. 2000 Characters.
- Required
-
Unique item identifier
- Conditional
-
Email address of POC. 100 Characters.
- Conditional
-
First name of POC. 100 Characters.
- Conditional
-
Last name of POC. 100 Characters.
- Required
-
Organization/Office represented. 100 Characters.
- Conditional
-
Phone number of POC (area code) ***-**** format. 100 Characters.
- Optional
-
Values include the following options (I,II,III)
- Optional
-
Include recommendations. Character Limit = 2,000.
- Optional
-
Values include the following options: (Very Low,Low,Moderate,High,Very High)
- Optional
-
Values include the following options: (Very Low,Low,Moderate,High,Very High)
- Required
-
List of resources used. 250 Characters.
- Read-Only
-
Values include the following options: (Not Approved,Under Review,Approved)
- Conditional
-
Required for ongoing and completed POA&M items. Unix time format.
- Optional
-
Security Checks that are associated with the POA&M.
- Conditional
-
Required for approved items. Values include the following options (Very Low,Low,Moderate,High,Very High)
- Required
-
Include Source Identifying Vulnerability text. 2000 Characters.
- Required
-
Values include the following: (Ongoing,Risk Accepted,Completed,Not Applicable
- Required
-
Unique eMASS system identifier.
- Required
-
Provide a description of the POA&M Item. 2000 Characters.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/emass_client/models/poam_get.rb, line 137 def self.attribute_map { :'system_id' => :'systemId', :'poam_id' => :'poamId', :'display_poam_id' => :'displayPoamId', :'is_inherited' => :'isInherited', :'external_uid' => :'externalUid', :'control_acronyms' => :'controlAcronyms', :'cci' => :'cci', :'status' => :'status', :'review_status' => :'reviewStatus', :'vulnerability_description' => :'vulnerabilityDescription', :'source_ident_vuln' => :'sourceIdentVuln', :'security_checks' => :'securityChecks', :'milestones' => :'milestones', :'poc_organization' => :'pocOrganization', :'poc_first_name' => :'pocFirstName', :'poc_last_name' => :'pocLastName', :'poc_email' => :'pocEmail', :'poc_phone_number' => :'pocPhoneNumber', :'severity' => :'severity', :'raw_severity' => :'rawSeverity', :'relevance_of_threat' => :'relevanceOfThreat', :'likelihood' => :'likelihood', :'impact' => :'impact', :'impact_description' => :'impactDescription', :'residual_risk_level' => :'residualRiskLevel', :'recommendations' => :'recommendations', :'resources' => :'resources', :'scheduled_completion_date' => :'scheduledCompletionDate', :'completion_date' => :'completionDate', :'extension_date' => :'extensionDate', :'comments' => :'comments', :'mitigation' => :'mitigation', :'is_active' => :'isActive' } end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/emass_client/models/poam_get.rb, line 534 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/emass_client/models/poam_get.rb, line 222 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `EmassClient::PoamGet` initialize method" end # check to see if the attribute exists and convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.attribute_map.key?(k.to_sym)) fail ArgumentError, "`#{k}` is not a valid attribute in `EmassClient::PoamGet`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect end h[k.to_sym] = v } if attributes.key?(:'system_id') self.system_id = attributes[:'system_id'] end if attributes.key?(:'poam_id') self.poam_id = attributes[:'poam_id'] end if attributes.key?(:'display_poam_id') self.display_poam_id = attributes[:'display_poam_id'] end if attributes.key?(:'is_inherited') self.is_inherited = attributes[:'is_inherited'] end if attributes.key?(:'external_uid') self.external_uid = attributes[:'external_uid'] end if attributes.key?(:'control_acronyms') self.control_acronyms = attributes[:'control_acronyms'] end if attributes.key?(:'cci') self.cci = attributes[:'cci'] end if attributes.key?(:'status') self.status = attributes[:'status'] end if attributes.key?(:'review_status') self.review_status = attributes[:'review_status'] end if attributes.key?(:'vulnerability_description') self.vulnerability_description = attributes[:'vulnerability_description'] end if attributes.key?(:'source_ident_vuln') self.source_ident_vuln = attributes[:'source_ident_vuln'] end if attributes.key?(:'security_checks') self.security_checks = attributes[:'security_checks'] end if attributes.key?(:'milestones') if (value = attributes[:'milestones']).is_a?(Array) self.milestones = value end end if attributes.key?(:'poc_organization') self.poc_organization = attributes[:'poc_organization'] end if attributes.key?(:'poc_first_name') self.poc_first_name = attributes[:'poc_first_name'] end if attributes.key?(:'poc_last_name') self.poc_last_name = attributes[:'poc_last_name'] end if attributes.key?(:'poc_email') self.poc_email = attributes[:'poc_email'] end if attributes.key?(:'poc_phone_number') self.poc_phone_number = attributes[:'poc_phone_number'] end if attributes.key?(:'severity') self.severity = attributes[:'severity'] end if attributes.key?(:'raw_severity') self.raw_severity = attributes[:'raw_severity'] end if attributes.key?(:'relevance_of_threat') self.relevance_of_threat = attributes[:'relevance_of_threat'] end if attributes.key?(:'likelihood') self.likelihood = attributes[:'likelihood'] end if attributes.key?(:'impact') self.impact = attributes[:'impact'] end if attributes.key?(:'impact_description') self.impact_description = attributes[:'impact_description'] end if attributes.key?(:'residual_risk_level') self.residual_risk_level = attributes[:'residual_risk_level'] end if attributes.key?(:'recommendations') self.recommendations = attributes[:'recommendations'] end if attributes.key?(:'resources') self.resources = attributes[:'resources'] end if attributes.key?(:'scheduled_completion_date') self.scheduled_completion_date = attributes[:'scheduled_completion_date'] end if attributes.key?(:'completion_date') self.completion_date = attributes[:'completion_date'] end if attributes.key?(:'extension_date') self.extension_date = attributes[:'extension_date'] end if attributes.key?(:'comments') self.comments = attributes[:'comments'] end if attributes.key?(:'mitigation') self.mitigation = attributes[:'mitigation'] end if attributes.key?(:'is_active') self.is_active = attributes[:'is_active'] end end
List of attributes with nullable: true
# File lib/emass_client/models/poam_get.rb, line 215 def self.openapi_nullable Set.new([ ]) end
Attribute type mapping.
# File lib/emass_client/models/poam_get.rb, line 176 def self.openapi_types { :'system_id' => :'Object', :'poam_id' => :'Object', :'display_poam_id' => :'Object', :'is_inherited' => :'Object', :'external_uid' => :'Object', :'control_acronyms' => :'Object', :'cci' => :'Object', :'status' => :'Object', :'review_status' => :'Object', :'vulnerability_description' => :'Object', :'source_ident_vuln' => :'Object', :'security_checks' => :'Object', :'milestones' => :'Object', :'poc_organization' => :'Object', :'poc_first_name' => :'Object', :'poc_last_name' => :'Object', :'poc_email' => :'Object', :'poc_phone_number' => :'Object', :'severity' => :'Object', :'raw_severity' => :'Object', :'relevance_of_threat' => :'Object', :'likelihood' => :'Object', :'impact' => :'Object', :'impact_description' => :'Object', :'residual_risk_level' => :'Object', :'recommendations' => :'Object', :'resources' => :'Object', :'scheduled_completion_date' => :'Object', :'completion_date' => :'Object', :'extension_date' => :'Object', :'comments' => :'Object', :'mitigation' => :'Object', :'is_active' => :'Object' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/emass_client/models/poam_get.rb, line 481 def ==(o) return true if self.equal?(o) self.class == o.class && system_id == o.system_id && poam_id == o.poam_id && display_poam_id == o.display_poam_id && is_inherited == o.is_inherited && external_uid == o.external_uid && control_acronyms == o.control_acronyms && cci == o.cci && status == o.status && review_status == o.review_status && vulnerability_description == o.vulnerability_description && source_ident_vuln == o.source_ident_vuln && security_checks == o.security_checks && milestones == o.milestones && poc_organization == o.poc_organization && poc_first_name == o.poc_first_name && poc_last_name == o.poc_last_name && poc_email == o.poc_email && poc_phone_number == o.poc_phone_number && severity == o.severity && raw_severity == o.raw_severity && relevance_of_threat == o.relevance_of_threat && likelihood == o.likelihood && impact == o.impact && impact_description == o.impact_description && residual_risk_level == o.residual_risk_level && recommendations == o.recommendations && resources == o.resources && scheduled_completion_date == o.scheduled_completion_date && completion_date == o.completion_date && extension_date == o.extension_date && comments == o.comments && mitigation == o.mitigation && is_active == o.is_active end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/emass_client/models/poam_get.rb, line 564 def _deserialize(type, value) case type.to_sym when :DateTime DateTime.parse(value) when :Date Date.parse(value) when :String value.to_s when :Integer value.to_i when :Float value.to_f when :Boolean if value.to_s =~ /\A(true|t|yes|y|1)\z/i true else false end when :Object # generic object (usually a Hash), return directly value when /\AArray<(?<inner_type>.+)>\z/ inner_type = Regexp.last_match[:inner_type] value.map { |v| _deserialize(inner_type, v) } when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/ k_type = Regexp.last_match[:k_type] v_type = Regexp.last_match[:v_type] {}.tap do |hash| value.each do |k, v| hash[_deserialize(k_type, k)] = _deserialize(v_type, v) end end else # model EmassClient.const_get(type).build_from_hash(value) end end
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/emass_client/models/poam_get.rb, line 633 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/emass_client/models/poam_get.rb, line 541 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.openapi_types.each_pair do |key, type| if type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that the attribute # is documented as an array but the input is not if attributes[self.class.attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key) self.send("#{key}=", nil) end end self end
@see the ‘==` method @param [Object] Object to be compared
# File lib/emass_client/models/poam_get.rb, line 521 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/emass_client/models/poam_get.rb, line 527 def hash [system_id, poam_id, display_poam_id, is_inherited, external_uid, control_acronyms, cci, status, review_status, vulnerability_description, source_ident_vuln, security_checks, milestones, poc_organization, poc_first_name, poc_last_name, poc_email, poc_phone_number, severity, raw_severity, relevance_of_threat, likelihood, impact, impact_description, residual_risk_level, recommendations, resources, scheduled_completion_date, completion_date, extension_date, comments, mitigation, is_active].hash end
Custom attribute writer method checking allowed values (enum). @param [Object] impact Object to be assigned
# File lib/emass_client/models/poam_get.rb, line 461 def impact=(impact) validator = EnumAttributeValidator.new('Object', ['Very Low', 'Low', 'Moderate', 'High', 'Very High']) unless validator.valid?(impact) fail ArgumentError, "invalid value for \"impact\", must be one of #{validator.allowable_values}." end @impact = impact end
Custom attribute writer method checking allowed values (enum). @param [Object] likelihood Object to be assigned
# File lib/emass_client/models/poam_get.rb, line 451 def likelihood=(likelihood) validator = EnumAttributeValidator.new('Object', ['Very Low', 'Low', 'Moderate', 'High', 'Very High']) unless validator.valid?(likelihood) fail ArgumentError, "invalid value for \"likelihood\", must be one of #{validator.allowable_values}." end @likelihood = likelihood end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/emass_client/models/poam_get.rb, line 372 def list_invalid_properties invalid_properties = Array.new invalid_properties end
Custom attribute writer method checking allowed values (enum). @param [Object] raw_severity
Object to be assigned
# File lib/emass_client/models/poam_get.rb, line 431 def raw_severity=(raw_severity) validator = EnumAttributeValidator.new('Object', ['I', 'II', 'III']) unless validator.valid?(raw_severity) fail ArgumentError, "invalid value for \"raw_severity\", must be one of #{validator.allowable_values}." end @raw_severity = raw_severity end
Custom attribute writer method checking allowed values (enum). @param [Object] relevance_of_threat
Object to be assigned
# File lib/emass_client/models/poam_get.rb, line 441 def relevance_of_threat=(relevance_of_threat) validator = EnumAttributeValidator.new('Object', ['Very Low', 'Low', 'Moderate', 'High', 'Very High']) unless validator.valid?(relevance_of_threat) fail ArgumentError, "invalid value for \"relevance_of_threat\", must be one of #{validator.allowable_values}." end @relevance_of_threat = relevance_of_threat end
Custom attribute writer method checking allowed values (enum). @param [Object] residual_risk_level
Object to be assigned
# File lib/emass_client/models/poam_get.rb, line 471 def residual_risk_level=(residual_risk_level) validator = EnumAttributeValidator.new('Object', ['Very Low', 'Low', 'Moderate', 'High', 'Very High']) unless validator.valid?(residual_risk_level) fail ArgumentError, "invalid value for \"residual_risk_level\", must be one of #{validator.allowable_values}." end @residual_risk_level = residual_risk_level end
Custom attribute writer method checking allowed values (enum). @param [Object] review_status
Object to be assigned
# File lib/emass_client/models/poam_get.rb, line 411 def review_status=(review_status) validator = EnumAttributeValidator.new('Object', ['Not Approved', 'Under Review', 'Approved']) unless validator.valid?(review_status) fail ArgumentError, "invalid value for \"review_status\", must be one of #{validator.allowable_values}." end @review_status = review_status end
Custom attribute writer method checking allowed values (enum). @param [Object] severity Object to be assigned
# File lib/emass_client/models/poam_get.rb, line 421 def severity=(severity) validator = EnumAttributeValidator.new('Object', ['Very Low', 'Low', 'Moderate', 'High', 'Very High']) unless validator.valid?(severity) fail ArgumentError, "invalid value for \"severity\", must be one of #{validator.allowable_values}." end @severity = severity end
Custom attribute writer method checking allowed values (enum). @param [Object] status Object to be assigned
# File lib/emass_client/models/poam_get.rb, line 401 def status=(status) validator = EnumAttributeValidator.new('Object', ['Ongoing', 'Risk Accepted', 'Completed', 'Not Applicable']) unless validator.valid?(status) fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}." end @status = status end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/emass_client/models/poam_get.rb, line 615 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) if value.nil? is_nullable = self.class.openapi_nullable.include?(attr) next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) end hash[param] = _to_hash(value) end hash end
Returns the string representation of the object @return [String] String presentation of the object
# File lib/emass_client/models/poam_get.rb, line 603 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/emass_client/models/poam_get.rb, line 379 def valid? status_validator = EnumAttributeValidator.new('Object', ['Ongoing', 'Risk Accepted', 'Completed', 'Not Applicable']) return false unless status_validator.valid?(@status) review_status_validator = EnumAttributeValidator.new('Object', ['Not Approved', 'Under Review', 'Approved']) return false unless review_status_validator.valid?(@review_status) severity_validator = EnumAttributeValidator.new('Object', ['Very Low', 'Low', 'Moderate', 'High', 'Very High']) return false unless severity_validator.valid?(@severity) raw_severity_validator = EnumAttributeValidator.new('Object', ['I', 'II', 'III']) return false unless raw_severity_validator.valid?(@raw_severity) relevance_of_threat_validator = EnumAttributeValidator.new('Object', ['Very Low', 'Low', 'Moderate', 'High', 'Very High']) return false unless relevance_of_threat_validator.valid?(@relevance_of_threat) likelihood_validator = EnumAttributeValidator.new('Object', ['Very Low', 'Low', 'Moderate', 'High', 'Very High']) return false unless likelihood_validator.valid?(@likelihood) impact_validator = EnumAttributeValidator.new('Object', ['Very Low', 'Low', 'Moderate', 'High', 'Very High']) return false unless impact_validator.valid?(@impact) residual_risk_level_validator = EnumAttributeValidator.new('Object', ['Very Low', 'Low', 'Moderate', 'High', 'Very High']) return false unless residual_risk_level_validator.valid?(@residual_risk_level) true end