Class: OCI::Marketplace::Models::AgreementSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/marketplace/models/agreement_summary.rb

Overview

The model for a summary of an end user license agreement.

Constant Summary collapse

AUTHOR_ENUM =
[
  AUTHOR_ORACLE = 'ORACLE'.freeze,
  AUTHOR_PARTNER = 'PARTNER'.freeze,
  AUTHOR_PII = 'PII'.freeze,
  AUTHOR_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AgreementSummary

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

  • :content_url (String)

    The value to assign to the #content_url property

  • :author (String)

    The value to assign to the #author property

  • :prompt (String)

    The value to assign to the #prompt property



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
# File 'lib/oci/marketplace/models/agreement_summary.rb', line 68

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

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

Instance Attribute Details

#authorString

Who authored the agreement.

Returns:

  • (String)


28
29
30
# File 'lib/oci/marketplace/models/agreement_summary.rb', line 28

def author
  @author
end

#content_urlString

The content URL of the agreement.

Returns:

  • (String)


24
25
26
# File 'lib/oci/marketplace/models/agreement_summary.rb', line 24

def content_url
  @content_url
end

#idString

The unique identifier for the agreement.

Returns:

  • (String)


20
21
22
# File 'lib/oci/marketplace/models/agreement_summary.rb', line 20

def id
  @id
end

#promptString

Textual prompt to read and accept the agreement.

Returns:

  • (String)


32
33
34
# File 'lib/oci/marketplace/models/agreement_summary.rb', line 32

def prompt
  @prompt
end

Class Method Details

.attribute_mapObject

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



35
36
37
38
39
40
41
42
43
44
# File 'lib/oci/marketplace/models/agreement_summary.rb', line 35

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'content_url': :'contentUrl',
    'author': :'author',
    'prompt': :'prompt'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



47
48
49
50
51
52
53
54
55
56
# File 'lib/oci/marketplace/models/agreement_summary.rb', line 47

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'content_url': :'String',
    'author': :'String',
    'prompt': :'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



107
108
109
110
111
112
113
114
115
# File 'lib/oci/marketplace/models/agreement_summary.rb', line 107

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

  self.class == other.class &&
    id == other.id &&
    content_url == other.content_url &&
    author == other.author &&
    prompt == other.prompt
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



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
# File 'lib/oci/marketplace/models/agreement_summary.rb', line 140

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


120
121
122
# File 'lib/oci/marketplace/models/agreement_summary.rb', line 120

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



129
130
131
# File 'lib/oci/marketplace/models/agreement_summary.rb', line 129

def hash
  [id, content_url, author, prompt].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



173
174
175
176
177
178
179
180
181
182
# File 'lib/oci/marketplace/models/agreement_summary.rb', line 173

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



167
168
169
# File 'lib/oci/marketplace/models/agreement_summary.rb', line 167

def to_s
  to_hash.to_s
end