Class: OCI::MarketplacePublisher::Models::MarketSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/marketplace_publisher/models/market_summary.rb

Overview

The model for the market metadata.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MarketSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :name (String) —

    The value to assign to the #name property

  • :code (String) —

    The value to assign to the #code property

  • :category_code (String) —

    The value to assign to the #category_code property

  • :bill_to_countries (Array<String>) —

    The value to assign to the #bill_to_countries property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated property



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/oci/marketplace_publisher/models/market_summary.rb', line 88

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

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

  self.category_code = attributes[:'categoryCode'] if attributes[:'categoryCode']

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

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

  self.bill_to_countries = attributes[:'billToCountries'] if attributes[:'billToCountries']

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

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

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

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

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

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

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

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

  self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

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

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

Instance Attribute Details

#bill_to_countries ⇒ Array<String>

[Required] Bill to countries for the market.

Returns:

  • (Array<String>) 


25
26
27
 
# File 'lib/oci/marketplace_publisher/models/market_summary.rb', line 25

def bill_to_countries
  @bill_to_countries
end

#category_code ⇒ String

[Required] The category code for the market.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/marketplace_publisher/models/market_summary.rb', line 21

def category_code
  @category_code
end

#code ⇒ String

[Required] The code of the product.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/marketplace_publisher/models/market_summary.rb', line 17

def code
  @code
end

#lifecycle_state ⇒ String

[Required] The current state for the market.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/marketplace_publisher/models/market_summary.rb', line 29

def lifecycle_state
  @lifecycle_state
end

#name ⇒ String

[Required] The name of the product.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/marketplace_publisher/models/market_summary.rb', line 13

def name
  @name
end

#time_created ⇒ DateTime

[Required] The date and time the market was created, in the format defined by RFC3339.

Example: 2022-09-15T21:10:29.600Z

Returns:

  • (DateTime) 


36
37
38
 
# File 'lib/oci/marketplace_publisher/models/market_summary.rb', line 36

def time_created
  @time_created
end

#time_updated ⇒ DateTime

[Required] The date and time the market was updated, in the format defined by RFC3339.

Example: 2022-09-15T21:10:29.600Z

Returns:

  • (DateTime) 


43
44
45
 
# File 'lib/oci/marketplace_publisher/models/market_summary.rb', line 43

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/oci/marketplace_publisher/models/market_summary.rb', line 46

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'code': :'code',
    'category_code': :'categoryCode',
    'bill_to_countries': :'billToCountries',
    'lifecycle_state': :'lifecycleState',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/oci/marketplace_publisher/models/market_summary.rb', line 61

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'code': :'String',
    'category_code': :'String',
    'bill_to_countries': :'Array<String>',
    'lifecycle_state': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime'
    # 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



136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/oci/marketplace_publisher/models/market_summary.rb', line 136

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

  self.class == other.class &&
    name == other.name &&
    code == other.code &&
    category_code == other.category_code &&
    bill_to_countries == other.bill_to_countries &&
    lifecycle_state == other.lifecycle_state &&
    time_created == other.time_created &&
    time_updated == other.time_updated
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



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/oci/marketplace_publisher/models/market_summary.rb', line 172

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


152
153
154
 
# File 'lib/oci/marketplace_publisher/models/market_summary.rb', line 152

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



161
162
163
 
# File 'lib/oci/marketplace_publisher/models/market_summary.rb', line 161

def hash
  [name, code, category_code, bill_to_countries, lifecycle_state, time_created, time_updated].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



205
206
207
208
209
210
211
212
213
214
 
# File 'lib/oci/marketplace_publisher/models/market_summary.rb', line 205

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_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



199
200
201
 
# File 'lib/oci/marketplace_publisher/models/market_summary.rb', line 199

def to_s
  to_hash.to_s
end