Class: OCI::Marketplace::Models::OrchestrationVariable

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

Overview

The model of a variable for an orchestration resource.

Constant Summary collapse

DATA_TYPE_ENUM =
[
  DATA_TYPE_STRING = 'STRING'.freeze,
  DATA_TYPE_INTEGER = 'INTEGER'.freeze,
  DATA_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OrchestrationVariable

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :name (String)

    The value to assign to the #name property

  • :default_value (String)

    The value to assign to the #default_value property

  • :description (String)

    The value to assign to the #description property

  • :data_type (String)

    The value to assign to the #data_type property

  • :is_mandatory (BOOLEAN)

    The value to assign to the #is_mandatory property

  • :hint_message (String)

    The value to assign to the #hint_message property



81
82
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
109
110
111
112
113
114
115
116
# File 'lib/oci/marketplace/models/orchestration_variable.rb', line 81

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

  self.default_value = attributes[:'defaultValue'] if attributes[:'defaultValue']

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

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

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

  self.data_type = attributes[:'dataType'] if attributes[:'dataType']

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

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

  self.is_mandatory = attributes[:'isMandatory'] unless attributes[:'isMandatory'].nil?
  self.is_mandatory = false if is_mandatory.nil? && !attributes.key?(:'isMandatory') # rubocop:disable Style/StringLiterals

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

  self.is_mandatory = attributes[:'is_mandatory'] unless attributes[:'is_mandatory'].nil?
  self.is_mandatory = false if is_mandatory.nil? && !attributes.key?(:'isMandatory') && !attributes.key?(:'is_mandatory') # rubocop:disable Style/StringLiterals

  self.hint_message = attributes[:'hintMessage'] if attributes[:'hintMessage']

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

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

Instance Attribute Details

#data_typeString

The data type of the variable.

Returns:

  • (String)


31
32
33
# File 'lib/oci/marketplace/models/orchestration_variable.rb', line 31

def data_type
  @data_type
end

#default_valueString

The variable's default value.

Returns:

  • (String)


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

def default_value
  @default_value
end

#descriptionString

A description of the variable.

Returns:

  • (String)


27
28
29
# File 'lib/oci/marketplace/models/orchestration_variable.rb', line 27

def description
  @description
end

#hint_messageString

A brief textual description that helps to explain the variable.

Returns:

  • (String)


39
40
41
# File 'lib/oci/marketplace/models/orchestration_variable.rb', line 39

def hint_message
  @hint_message
end

#is_mandatoryBOOLEAN

Whether the variable is mandatory.

Returns:

  • (BOOLEAN)


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

def is_mandatory
  @is_mandatory
end

#nameString

The name of the variable.

Returns:

  • (String)


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

def name
  @name
end

Class Method Details

.attribute_mapObject

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



42
43
44
45
46
47
48
49
50
51
52
53
# File 'lib/oci/marketplace/models/orchestration_variable.rb', line 42

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'default_value': :'defaultValue',
    'description': :'description',
    'data_type': :'dataType',
    'is_mandatory': :'isMandatory',
    'hint_message': :'hintMessage'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



56
57
58
59
60
61
62
63
64
65
66
67
# File 'lib/oci/marketplace/models/orchestration_variable.rb', line 56

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'default_value': :'String',
    'description': :'String',
    'data_type': :'String',
    'is_mandatory': :'BOOLEAN',
    'hint_message': :'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



138
139
140
141
142
143
144
145
146
147
148
# File 'lib/oci/marketplace/models/orchestration_variable.rb', line 138

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

  self.class == other.class &&
    name == other.name &&
    default_value == other.default_value &&
    description == other.description &&
    data_type == other.data_type &&
    is_mandatory == other.is_mandatory &&
    hint_message == other.hint_message
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



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
# File 'lib/oci/marketplace/models/orchestration_variable.rb', line 173

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


153
154
155
# File 'lib/oci/marketplace/models/orchestration_variable.rb', line 153

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



162
163
164
# File 'lib/oci/marketplace/models/orchestration_variable.rb', line 162

def hash
  [name, default_value, description, data_type, is_mandatory, hint_message].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



206
207
208
209
210
211
212
213
214
215
# File 'lib/oci/marketplace/models/orchestration_variable.rb', line 206

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



200
201
202
# File 'lib/oci/marketplace/models/orchestration_variable.rb', line 200

def to_s
  to_hash.to_s
end