Class: OCI::Marketplace::Models::CreateAcceptedAgreementDetails

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

Overview

The model for the parameters needed to accept a terms of use agreement.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateAcceptedAgreementDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :display_name (String) —

    The value to assign to the #display_name property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :listing_id (String) —

    The value to assign to the #listing_id property

  • :package_version (String) —

    The value to assign to the #package_version property

  • :agreement_id (String) —

    The value to assign to the #agreement_id property

  • :signature (String) —

    The value to assign to the #signature property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
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
 
# File 'lib/oci/marketplace/models/create_accepted_agreement_details.rb', line 97

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

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

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

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

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

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

  self.package_version = attributes[:'packageVersion'] if attributes[:'packageVersion']

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

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

  self.agreement_id = attributes[:'agreementId'] if attributes[:'agreementId']

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

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

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

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

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

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

Instance Attribute Details

#agreement_id ⇒ String

[Required] The agreement to accept.

Returns:

  • (String) 


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

def agreement_id
  @agreement_id
end

#compartment_id ⇒ String

[Required] The unique identifier for the compartment where the agreement will be accepted.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/marketplace/models/create_accepted_agreement_details.rb', line 17

def compartment_id
  @compartment_id
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


42
43
44
 
# File 'lib/oci/marketplace/models/create_accepted_agreement_details.rb', line 42

def defined_tags
  @defined_tags
end

#display_name ⇒ String

A display name for the accepted agreement.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/marketplace/models/create_accepted_agreement_details.rb', line 13

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


49
50
51
 
# File 'lib/oci/marketplace/models/create_accepted_agreement_details.rb', line 49

def freeform_tags
  @freeform_tags
end

#listing_id ⇒ String

[Required] The unique identifier for the listing associated with the agreement.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/marketplace/models/create_accepted_agreement_details.rb', line 21

def listing_id
  @listing_id
end

#package_version ⇒ String

[Required] The package version associated with the agreement.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/marketplace/models/create_accepted_agreement_details.rb', line 25

def package_version
  @package_version
end

#signature ⇒ String

[Required] A signature generated for the listing package agreements that you can retrieve with GetAgreement.

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/marketplace/models/create_accepted_agreement_details.rb', line 35

def signature
  @signature
end

Class Method Details

.attribute_map ⇒ Object

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



52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/oci/marketplace/models/create_accepted_agreement_details.rb', line 52

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'listing_id': :'listingId',
    'package_version': :'packageVersion',
    'agreement_id': :'agreementId',
    'signature': :'signature',
    'defined_tags': :'definedTags',
    'freeform_tags': :'freeformTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'compartment_id': :'String',
    'listing_id': :'String',
    'package_version': :'String',
    'agreement_id': :'String',
    'signature': :'String',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'freeform_tags': :'Hash<String, 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



155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/oci/marketplace/models/create_accepted_agreement_details.rb', line 155

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

  self.class == other.class &&
    display_name == other.display_name &&
    compartment_id == other.compartment_id &&
    listing_id == other.listing_id &&
    package_version == other.package_version &&
    agreement_id == other.agreement_id &&
    signature == other.signature &&
    defined_tags == other.defined_tags &&
    freeform_tags == other.freeform_tags
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



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/oci/marketplace/models/create_accepted_agreement_details.rb', line 192

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


172
173
174
 
# File 'lib/oci/marketplace/models/create_accepted_agreement_details.rb', line 172

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



181
182
183
 
# File 'lib/oci/marketplace/models/create_accepted_agreement_details.rb', line 181

def hash
  [display_name, compartment_id, listing_id, package_version, agreement_id, signature, defined_tags, freeform_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



225
226
227
228
229
230
231
232
233
234
 
# File 'lib/oci/marketplace/models/create_accepted_agreement_details.rb', line 225

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



219
220
221
 
# File 'lib/oci/marketplace/models/create_accepted_agreement_details.rb', line 219

def to_s
  to_hash.to_s
end