Class: OCI::Marketplace::Models::Agreement

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

Overview

The model for an end user license agreement.

Constant Summary collapse

AUTHOR_ENUM =
[
  AUTHOR_ORACLE = 'ORACLE'.freeze,
  AUTHOR_PARTNER = 'PARTNER'.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 = {}) ⇒ Agreement

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

  • :signature (String)

    The value to assign to the #signature property

  • :compartment_id (String)

    The value to assign to the #compartment_id property

  • :author (String)

    The value to assign to the #author property

  • :prompt (String)

    The value to assign to the #prompt property



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
# File 'lib/oci/marketplace/models/agreement.rb', line 83

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

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

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

Instance Attribute Details

#authorString

Who authored the agreement.

Returns:

  • (String)


37
38
39
# File 'lib/oci/marketplace/models/agreement.rb', line 37

def author
  @author
end

#compartment_idString

The unique identifier for the compartment.

Returns:

  • (String)


33
34
35
# File 'lib/oci/marketplace/models/agreement.rb', line 33

def compartment_id
  @compartment_id
end

#content_urlString

[Required] The content URL of the agreement.

Returns:

  • (String)


23
24
25
# File 'lib/oci/marketplace/models/agreement.rb', line 23

def content_url
  @content_url
end

#idString

[Required] The unique identifier for the agreement.

Returns:

  • (String)


19
20
21
# File 'lib/oci/marketplace/models/agreement.rb', line 19

def id
  @id
end

#promptString

Textual prompt to read and accept the agreement.

Returns:

  • (String)


41
42
43
# File 'lib/oci/marketplace/models/agreement.rb', line 41

def prompt
  @prompt
end

#signatureString

[Required] A time-based signature that can be used to accept an agreement or remove a previously accepted agreement from the list that Marketplace checks before a deployment.

Returns:

  • (String)


29
30
31
# File 'lib/oci/marketplace/models/agreement.rb', line 29

def signature
  @signature
end

Class Method Details

.attribute_mapObject

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



44
45
46
47
48
49
50
51
52
53
54
55
# File 'lib/oci/marketplace/models/agreement.rb', line 44

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

.swagger_typesObject

Attribute type mapping.



58
59
60
61
62
63
64
65
66
67
68
69
# File 'lib/oci/marketplace/models/agreement.rb', line 58

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



130
131
132
133
134
135
136
137
138
139
140
# File 'lib/oci/marketplace/models/agreement.rb', line 130

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

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



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
# File 'lib/oci/marketplace/models/agreement.rb', line 165

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


145
146
147
# File 'lib/oci/marketplace/models/agreement.rb', line 145

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



154
155
156
# File 'lib/oci/marketplace/models/agreement.rb', line 154

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

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



198
199
200
201
202
203
204
205
206
207
# File 'lib/oci/marketplace/models/agreement.rb', line 198

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



192
193
194
# File 'lib/oci/marketplace/models/agreement.rb', line 192

def to_s
  to_hash.to_s
end