Class: OCI::Core::Models::AppCatalogListingSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/core/models/app_catalog_listing_summary.rb

Overview

A summary of a listing.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AppCatalogListingSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :listing_id (String)

    The value to assign to the #listing_id property

  • :display_name (String)

    The value to assign to the #display_name property

  • :summary (String)

    The value to assign to the #summary property

  • :publisher_name (String)

    The value to assign to the #publisher_name property



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
# File 'lib/oci/core/models/app_catalog_listing_summary.rb', line 63

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.listing_id = attributes[:'listingId'] if attributes[:'listingId']

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

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

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

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

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

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

  self.publisher_name = attributes[:'publisherName'] if attributes[:'publisherName']

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

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

Instance Attribute Details

#display_nameString

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Returns:

  • (String)


19
20
21
# File 'lib/oci/core/models/app_catalog_listing_summary.rb', line 19

def display_name
  @display_name
end

#listing_idString

the region free ocid of the listing resource.

Returns:

  • (String)


13
14
15
# File 'lib/oci/core/models/app_catalog_listing_summary.rb', line 13

def listing_id
  @listing_id
end

#publisher_nameString

The name of the publisher who published this listing.

Returns:

  • (String)


27
28
29
# File 'lib/oci/core/models/app_catalog_listing_summary.rb', line 27

def publisher_name
  @publisher_name
end

#summaryString

The short summary for the listing.

Returns:

  • (String)


23
24
25
# File 'lib/oci/core/models/app_catalog_listing_summary.rb', line 23

def summary
  @summary
end

Class Method Details

.attribute_mapObject

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



30
31
32
33
34
35
36
37
38
39
# File 'lib/oci/core/models/app_catalog_listing_summary.rb', line 30

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'listing_id': :'listingId',
    'display_name': :'displayName',
    'summary': :'summary',
    'publisher_name': :'publisherName'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



42
43
44
45
46
47
48
49
50
51
# File 'lib/oci/core/models/app_catalog_listing_summary.rb', line 42

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'listing_id': :'String',
    'display_name': :'String',
    'summary': :'String',
    'publisher_name': :'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



97
98
99
100
101
102
103
104
105
# File 'lib/oci/core/models/app_catalog_listing_summary.rb', line 97

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

  self.class == other.class &&
    listing_id == other.listing_id &&
    display_name == other.display_name &&
    summary == other.summary &&
    publisher_name == other.publisher_name
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



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
# File 'lib/oci/core/models/app_catalog_listing_summary.rb', line 130

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


110
111
112
# File 'lib/oci/core/models/app_catalog_listing_summary.rb', line 110

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



119
120
121
# File 'lib/oci/core/models/app_catalog_listing_summary.rb', line 119

def hash
  [listing_id, display_name, summary, publisher_name].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



163
164
165
166
167
168
169
170
171
172
# File 'lib/oci/core/models/app_catalog_listing_summary.rb', line 163

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



157
158
159
# File 'lib/oci/core/models/app_catalog_listing_summary.rb', line 157

def to_s
  to_hash.to_s
end