Class: OCI::Artifacts::Models::ContainerRepositoryReadme

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/artifacts/models/container_repository_readme.rb

Overview

Container repository readme.

Constant Summary collapse

FORMAT_ENUM = 
[
  FORMAT_TEXT_MARKDOWN = 'TEXT_MARKDOWN'.freeze,
  FORMAT_TEXT_PLAIN = 'TEXT_PLAIN'.freeze,
  FORMAT_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ContainerRepositoryReadme

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :content (String) —

    The value to assign to the #content property

  • :format (String) —

    The value to assign to the #format property



54
55
56
57
58
59
60
61
62
63
 
# File 'lib/oci/artifacts/models/container_repository_readme.rb', line 54

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

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

Instance Attribute Details

#content ⇒ String

[Required] Readme content. Avoid entering confidential information.

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/artifacts/models/container_repository_readme.rb', line 20

def content
  @content
end

#format ⇒ String

[Required] Readme format. Supported formats are text/plain and text/markdown.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/artifacts/models/container_repository_readme.rb', line 24

def format
  @format
end

Class Method Details

.attribute_map ⇒ Object

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



27
28
29
30
31
32
33
34
 
# File 'lib/oci/artifacts/models/container_repository_readme.rb', line 27

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'content': :'content',
    'format': :'format'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



37
38
39
40
41
42
43
44
 
# File 'lib/oci/artifacts/models/container_repository_readme.rb', line 37

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'content': :'String',
    'format': :'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



85
86
87
88
89
90
91
 
# File 'lib/oci/artifacts/models/container_repository_readme.rb', line 85

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

  self.class == other.class &&
    content == other.content &&
    format == other.format
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



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/oci/artifacts/models/container_repository_readme.rb', line 116

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


96
97
98
 
# File 'lib/oci/artifacts/models/container_repository_readme.rb', line 96

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



105
106
107
 
# File 'lib/oci/artifacts/models/container_repository_readme.rb', line 105

def hash
  [content, format].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



149
150
151
152
153
154
155
156
157
158
 
# File 'lib/oci/artifacts/models/container_repository_readme.rb', line 149

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



143
144
145
 
# File 'lib/oci/artifacts/models/container_repository_readme.rb', line 143

def to_s
  to_hash.to_s
end