Class: OCI::MarketplacePublisher::Models::Product

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

Overview

The model for the product details.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Product

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
128
129
130
131
132
133
134
 
# File 'lib/oci/marketplace_publisher/models/product.rb', line 95

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

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

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

  self.product_group = attributes[:'productGroup'] if attributes[:'productGroup']

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

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

  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

#additional_filters ⇒ Array<OCI::MarketplacePublisher::Models::AdditionalFilter>

Additional filter properties for product

Returns:



28
29
30
 
# File 'lib/oci/marketplace_publisher/models/product.rb', line 28

def additional_filters
  @additional_filters
end

#code ⇒ String

[Required] The code for the product.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/marketplace_publisher/models/product.rb', line 24

def code
  @code
end

#lifecycle_state ⇒ String

[Required] The current state for the product.

Returns:

  • (String) 


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

def lifecycle_state
  @lifecycle_state
end

#name ⇒ String

[Required] The name for the product.

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/marketplace_publisher/models/product.rb', line 20

def name
  @name
end

#product_group ⇒ String

[Required] The product group for the product.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/marketplace_publisher/models/product.rb', line 32

def product_group
  @product_group
end

#time_created ⇒ DateTime

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

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

Returns:

  • (DateTime) 


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

def time_created
  @time_created
end

#time_updated ⇒ DateTime

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

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

Returns:

  • (DateTime) 


50
51
52
 
# File 'lib/oci/marketplace_publisher/models/product.rb', line 50

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/oci/marketplace_publisher/models/product.rb', line 53

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'code': :'code',
    'additional_filters': :'additionalFilters',
    'product_group': :'productGroup',
    'lifecycle_state': :'lifecycleState',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/oci/marketplace_publisher/models/product.rb', line 68

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'code': :'String',
    'additional_filters': :'Array<OCI::MarketplacePublisher::Models::AdditionalFilter>',
    'product_group': :'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



156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/oci/marketplace_publisher/models/product.rb', line 156

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

  self.class == other.class &&
    name == other.name &&
    code == other.code &&
    additional_filters == other.additional_filters &&
    product_group == other.product_group &&
    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



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/oci/marketplace_publisher/models/product.rb', line 192

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


172
173
174
 
# File 'lib/oci/marketplace_publisher/models/product.rb', line 172

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



181
182
183
 
# File 'lib/oci/marketplace_publisher/models/product.rb', line 181

def hash
  [name, code, additional_filters, product_group, 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



225
226
227
228
229
230
231
232
233
234
 
# File 'lib/oci/marketplace_publisher/models/product.rb', line 225

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



219
220
221
 
# File 'lib/oci/marketplace_publisher/models/product.rb', line 219

def to_s
  to_hash.to_s
end