class OCI::Marketplace::Models::Agreement

The model for an end user license agreement.

Constants

AUTHOR_ENUM

Attributes

author[R]

Who authored the agreement. @return [String]

compartment_id[RW]

The unique identifier for the compartment. @return [String]

content_url[RW]

[Required] The content URL of the agreement. @return [String]

id[RW]

[Required] The unique identifier for the agreement. @return [String]

prompt[RW]

Textual prompt to read and accept the agreement. @return [String]

signature[RW]

[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.

@return [String]

Public Class Methods

attribute_map() click to toggle source

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

# 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
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :id The value to assign to the {#id} property @option attributes [String] :content_url The value to assign to the {#content_url} property @option attributes [String] :signature The value to assign to the {#signature} property @option attributes [String] :compartment_id The value to assign to the {#compartment_id} property @option attributes [String] :author The value to assign to the {#author} property @option attributes [String] :prompt The value to assign to the {#prompt} property

# 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
swagger_types() click to toggle source

Attribute type mapping.

# 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

Public Instance Methods

==(other) click to toggle source

Checks equality by comparing each attribute. @param [Object] other the other object to be compared

# 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
author=(author) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] author Object to be assigned

# File lib/oci/marketplace/models/agreement.rb, line 114
def author=(author)
  # rubocop:disable Style/ConditionalAssignment
  if author && !AUTHOR_ENUM.include?(author)
    OCI.logger.debug("Unknown value for 'author' [" + author + "]. Mapping to 'AUTHOR_UNKNOWN_ENUM_VALUE'") if OCI.logger
    @author = AUTHOR_UNKNOWN_ENUM_VALUE
  else
    @author = author
  end
  # rubocop:enable Style/ConditionalAssignment
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# 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) click to toggle source

@see the `==` method @param [Object] other the other object to be compared

# File lib/oci/marketplace/models/agreement.rb, line 145
def eql?(other)
  self == other
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/oci/marketplace/models/agreement.rb, line 154
def hash
  [id, content_url, signature, compartment_id, author, prompt].hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# 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_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/oci/marketplace/models/agreement.rb, line 192
def to_s
  to_hash.to_s
end

Private Instance Methods

_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/oci/marketplace/models/agreement.rb, line 215
def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end