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

[View source]

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
117
 
# File 'lib/oci/marketplace/models/orchestration_variable.rb', line 82

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_type ⇒ String

The data type of the variable.

Returns:

  • (String) 

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

def data_type
  @data_type
end

#default_value ⇒ String

The variable's default value.

Returns:

  • (String) 

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

def default_value
  @default_value
end

#description ⇒ String

A description of the variable.

Returns:

  • (String) 

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

def description
  @description
end

#hint_message ⇒ String

A brief textual description that helps to explain the variable.

Returns:

  • (String) 

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

def hint_message
  @hint_message
end

#is_mandatory ⇒ BOOLEAN

Whether the variable is mandatory.

Returns:

  • (BOOLEAN) 

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

def is_mandatory
  @is_mandatory
end

#name ⇒ String

The name of the variable.

Returns:

  • (String) 

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

def name
  @name
end

Class Method Details

.attribute_map ⇒ Object

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

[View source]

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

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_types ⇒ Object

Attribute type mapping.

[View source]

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

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

[View source]

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

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

[View source]

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

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
[View source]

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

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code

[View source]

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

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash

[View source]

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

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

[View source]

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

def to_s
  to_hash.to_s
end