Class: OCI::Adm::Models::ApplicationDependencyRecommendationSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/adm/models/application_dependency_recommendation_summary.rb

Overview

An application dependency with the recommended version that does not contain any CVE. Each application dependency has a property specifying multiple node identifiers on which which this current node depends.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ApplicationDependencyRecommendationSummary

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {})

    Model attributes in the form of hash

Options Hash (attributes):

  • :gav (String)

    The value to assign to the #gav property

  • :purl (String)

    The value to assign to the #purl property

  • :node_id (String)

    The value to assign to the #node_id property

  • :application_dependency_node_ids (Array<String>)

    The value to assign to the #application_dependency_node_ids property

  • :recommended_gav (String)

    The value to assign to the #recommended_gav property

  • :recommended_purl (String)

    The value to assign to the #recommended_purl property



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
# File 'lib/oci/adm/models/application_dependency_recommendation_summary.rb', line 77

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.gav = attributes[:'gav'] if attributes[:'gav']

  self.purl = attributes[:'purl'] if attributes[:'purl']

  self.node_id = attributes[:'nodeId'] if attributes[:'nodeId']

  raise 'You cannot provide both :nodeId and :node_id' if attributes.key?(:'nodeId') && attributes.key?(:'node_id')

  self.node_id = attributes[:'node_id'] if attributes[:'node_id']

  self.application_dependency_node_ids = attributes[:'applicationDependencyNodeIds'] if attributes[:'applicationDependencyNodeIds']

  raise 'You cannot provide both :applicationDependencyNodeIds and :application_dependency_node_ids' if attributes.key?(:'applicationDependencyNodeIds') && attributes.key?(:'application_dependency_node_ids')

  self.application_dependency_node_ids = attributes[:'application_dependency_node_ids'] if attributes[:'application_dependency_node_ids']

  self.recommended_gav = attributes[:'recommendedGav'] if attributes[:'recommendedGav']

  raise 'You cannot provide both :recommendedGav and :recommended_gav' if attributes.key?(:'recommendedGav') && attributes.key?(:'recommended_gav')

  self.recommended_gav = attributes[:'recommended_gav'] if attributes[:'recommended_gav']

  self.recommended_purl = attributes[:'recommendedPurl'] if attributes[:'recommendedPurl']

  raise 'You cannot provide both :recommendedPurl and :recommended_purl' if attributes.key?(:'recommendedPurl') && attributes.key?(:'recommended_purl')

  self.recommended_purl = attributes[:'recommended_purl'] if attributes[:'recommended_purl']
end

Instance Attribute Details

#application_dependency_node_idsArray<String>

[Required] List of (application dependencies) node identifiers from which this node depends.

Returns:

  • (Array<String>)


27
28
29
# File 'lib/oci/adm/models/application_dependency_recommendation_summary.rb', line 27

def application_dependency_node_ids
  @application_dependency_node_ids
end

#gavString

[Required] Unique Group Artifact Version (GAV) identifier in the format Group:Artifact:Version, e.g. org.graalvm.nativeimage:svm:21.1.0.

Returns:

  • (String)


15
16
17
# File 'lib/oci/adm/models/application_dependency_recommendation_summary.rb', line 15

def gav
  @gav
end

#node_idString

[Required] Unique node identifier of an application dependency with an associated Recommendation, e.g. nodeId1.

Returns:

  • (String)


23
24
25
# File 'lib/oci/adm/models/application_dependency_recommendation_summary.rb', line 23

def node_id
  @node_id
end

#purlString

Package URL defined in github.com/package-url/purl-spec, e.g. pkg:maven/org.graalvm.nativeimage/svm@21.1.0

Returns:

  • (String)


19
20
21
# File 'lib/oci/adm/models/application_dependency_recommendation_summary.rb', line 19

def purl
  @purl
end

Recommended application dependency in "group:artifact:version" (GAV) format, e.g. org.graalvm.nativeimage:svm:21.2.0.

Returns:

  • (String)


31
32
33
# File 'lib/oci/adm/models/application_dependency_recommendation_summary.rb', line 31

def recommended_gav
  @recommended_gav
end

Recommended application dependency in PURL format, e.g. pkg:maven/org.graalvm.nativeimage/svm@21.2.0

Returns:

  • (String)


35
36
37
# File 'lib/oci/adm/models/application_dependency_recommendation_summary.rb', line 35

def recommended_purl
  @recommended_purl
end

Class Method Details

.attribute_mapObject

Attribute mapping from ruby-style variable name to JSON key.



38
39
40
41
42
43
44
45
46
47
48
49
# File 'lib/oci/adm/models/application_dependency_recommendation_summary.rb', line 38

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'gav': :'gav',
    'purl': :'purl',
    'node_id': :'nodeId',
    'application_dependency_node_ids': :'applicationDependencyNodeIds',
    'recommended_gav': :'recommendedGav',
    'recommended_purl': :'recommendedPurl'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



52
53
54
55
56
57
58
59
60
61
62
63
# File 'lib/oci/adm/models/application_dependency_recommendation_summary.rb', line 52

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'gav': :'String',
    'purl': :'String',
    'node_id': :'String',
    'application_dependency_node_ids': :'Array<String>',
    'recommended_gav': :'String',
    'recommended_purl': :'String'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object)

    the other object to be compared



119
120
121
122
123
124
125
126
127
128
129
# File 'lib/oci/adm/models/application_dependency_recommendation_summary.rb', line 119

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    gav == other.gav &&
    purl == other.purl &&
    node_id == other.node_id &&
    application_dependency_node_ids == other.application_dependency_node_ids &&
    recommended_gav == other.recommended_gav &&
    recommended_purl == other.recommended_purl
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
# File 'lib/oci/adm/models/application_dependency_recommendation_summary.rb', line 154

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object)

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


134
135
136
# File 'lib/oci/adm/models/application_dependency_recommendation_summary.rb', line 134

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



143
144
145
# File 'lib/oci/adm/models/application_dependency_recommendation_summary.rb', line 143

def hash
  [gav, purl, node_id, application_dependency_node_ids, recommended_gav, recommended_purl].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



187
188
189
190
191
192
193
194
195
196
# File 'lib/oci/adm/models/application_dependency_recommendation_summary.rb', line 187

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



181
182
183
# File 'lib/oci/adm/models/application_dependency_recommendation_summary.rb', line 181

def to_s
  to_hash.to_s
end