Class: OCI::MarketplacePublisher::Models::SupportDoc

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

Overview

The model for the supportDoc 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 = {}) ⇒ SupportDoc

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

  • :support_doc_group (String) —

    The value to assign to the #support_doc_group property

  • :description (String) —

    The value to assign to the #description property

  • :content_url (String) —

    The value to assign to the #content_url property

  • :mime_type (String) —

    The value to assign to the #mime_type property

  • :file_name (String) —

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



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
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
 
# File 'lib/oci/marketplace_publisher/models/support_doc.rb', line 116

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

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

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

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

  self.content_url = attributes[:'contentUrl'] if attributes[:'contentUrl']

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

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

  self.mime_type = attributes[:'mimeType'] if attributes[:'mimeType']

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

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

  self.file_name = attributes[:'fileName'] if attributes[:'fileName']

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

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

  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

#code ⇒ String

[Required] The code for the supportDoc.

Returns:

  • (String) 


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

def code
  @code
end

#content_url ⇒ String

The URL of the specified attachment.

Returns:

  • (String) 


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

def content_url
  @content_url
end

#description ⇒ String

The description of the supportDoc.

Returns:

  • (String) 


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

def description
  @description
end

#file_name ⇒ String

The file name of the attachment.

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/marketplace_publisher/models/support_doc.rb', line 44

def file_name
  @file_name
end

#lifecycle_state ⇒ String

[Required] The current state for the supportDoc.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/marketplace_publisher/models/support_doc.rb', line 48

def lifecycle_state
  @lifecycle_state
end

#mime_type ⇒ String

The MIME type of the attachment.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/marketplace_publisher/models/support_doc.rb', line 40

def mime_type
  @mime_type
end

#name ⇒ String

[Required] The name for the supportDoc.

Returns:

  • (String) 


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

def name
  @name
end

#support_doc_group ⇒ String

[Required] The supportDoc group for the supportDoc.

Returns:

  • (String) 


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

def support_doc_group
  @support_doc_group
end

#time_created ⇒ DateTime

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

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

Returns:

  • (DateTime) 


55
56
57
 
# File 'lib/oci/marketplace_publisher/models/support_doc.rb', line 55

def time_created
  @time_created
end

#time_updated ⇒ DateTime

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

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

Returns:

  • (DateTime) 


62
63
64
 
# File 'lib/oci/marketplace_publisher/models/support_doc.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.



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'code': :'code',
    'support_doc_group': :'supportDocGroup',
    'description': :'description',
    'content_url': :'contentUrl',
    'mime_type': :'mimeType',
    'file_name': :'fileName',
    'lifecycle_state': :'lifecycleState',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'code': :'String',
    'support_doc_group': :'String',
    'description': :'String',
    'content_url': :'String',
    'mime_type': :'String',
    'file_name': :'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



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/oci/marketplace_publisher/models/support_doc.rb', line 191

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

  self.class == other.class &&
    name == other.name &&
    code == other.code &&
    support_doc_group == other.support_doc_group &&
    description == other.description &&
    content_url == other.content_url &&
    mime_type == other.mime_type &&
    file_name == other.file_name &&
    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



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/oci/marketplace_publisher/models/support_doc.rb', line 230

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


210
211
212
 
# File 'lib/oci/marketplace_publisher/models/support_doc.rb', line 210

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



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

def hash
  [name, code, support_doc_group, description, content_url, mime_type, file_name, 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



263
264
265
266
267
268
269
270
271
272
 
# File 'lib/oci/marketplace_publisher/models/support_doc.rb', line 263

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



257
258
259
 
# File 'lib/oci/marketplace_publisher/models/support_doc.rb', line 257

def to_s
  to_hash.to_s
end