Class: OCI::MarketplacePublisher::Models::ListingRevisionNote

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

Overview

The model for the listing revision notes.

Constant Summary collapse

NOTE_SOURCE_ENUM = 
[
  NOTE_SOURCE_PUBLISHER = 'PUBLISHER'.freeze,
  NOTE_SOURCE_ADMINISTRATOR = 'ADMINISTRATOR'.freeze,
  NOTE_SOURCE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.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 = {}) ⇒ ListingRevisionNote

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :listing_revision_id (String) —

    The value to assign to the #listing_revision_id property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :note_source (String) —

    The value to assign to the #note_source property

  • :note_details (String) —

    The value to assign to the #note_details 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

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

  • :system_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #system_tags property



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_note.rb', line 137

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

  self.listing_revision_id = attributes[:'listingRevisionId'] if attributes[:'listingRevisionId']

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

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

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

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

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

  self.note_source = attributes[:'noteSource'] if attributes[:'noteSource']

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

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

  self.note_details = attributes[:'noteDetails'] if attributes[:'noteDetails']

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

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

  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']

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

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

  self.system_tags = attributes[:'systemTags'] if attributes[:'systemTags']

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

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] The unique identifier for the compartment.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_note.rb', line 34

def compartment_id
  @compartment_id
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


74
75
76
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_note.rb', line 74

def defined_tags
  @defined_tags
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


68
69
70
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_note.rb', line 68

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the listing revision note.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_note.rb', line 26

def id
  @id
end

#lifecycle_state ⇒ String

The current state of the listing revision note.

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_note.rb', line 46

def lifecycle_state
  @lifecycle_state
end

#listing_revision_id ⇒ String

[Required] The unique identifier of the listing revision that the specified note belongs to.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_note.rb', line 30

def listing_revision_id
  @listing_revision_id
end

#note_details ⇒ String

[Required] Notes provided for the listing revision.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_note.rb', line 42

def note_details
  @note_details
end

#note_source ⇒ String

[Required] type of the note.

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_note.rb', line 38

def note_source
  @note_source
end

#system_tags ⇒ Hash<String, Hash<String, Object>>

System tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


80
81
82
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_note.rb', line 80

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The date and time the listing revision note was created, expressed in RFC 3339 timestamp format.

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

Returns:

  • (DateTime) 


54
55
56
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_note.rb', line 54

def time_created
  @time_created
end

#time_updated ⇒ DateTime

[Required] The date and time the listing revision note was updated, expressed in RFC 3339 timestamp format.

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

Returns:

  • (DateTime) 


62
63
64
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_note.rb', line 62

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_note.rb', line 83

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'listing_revision_id': :'listingRevisionId',
    'compartment_id': :'compartmentId',
    'note_source': :'noteSource',
    'note_details': :'noteDetails',
    'lifecycle_state': :'lifecycleState',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_note.rb', line 102

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'listing_revision_id': :'String',
    'compartment_id': :'String',
    'note_source': :'String',
    'note_details': :'String',
    'lifecycle_state': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>'
    # 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



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_note.rb', line 239

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

  self.class == other.class &&
    id == other.id &&
    listing_revision_id == other.listing_revision_id &&
    compartment_id == other.compartment_id &&
    note_source == other.note_source &&
    note_details == other.note_details &&
    lifecycle_state == other.lifecycle_state &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags
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



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_note.rb', line 279

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


259
260
261
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_note.rb', line 259

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



268
269
270
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_note.rb', line 268

def hash
  [id, listing_revision_id, compartment_id, note_source, note_details, lifecycle_state, time_created, time_updated, freeform_tags, defined_tags, system_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



312
313
314
315
316
317
318
319
320
321
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_note.rb', line 312

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



306
307
308
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_note.rb', line 306

def to_s
  to_hash.to_s
end