Class: OCI::FleetAppsManagement::Models::StringVariable

Inherits:
BaseVariable
  • Object
show all
Defined in:
lib/oci/fleet_apps_management/models/string_variable.rb

Overview

String variable.

Constant Summary

Constants inherited from BaseVariable

BaseVariable::TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from BaseVariable

#description, #is_required, #title, #type, #visible

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseVariable

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ StringVariable

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :title (String) —

    The value to assign to the #title proprety

  • :description (String) —

    The value to assign to the #description proprety

  • :is_required (BOOLEAN) —

    The value to assign to the #is_required proprety

  • :visible (String) —

    The value to assign to the #visible proprety

  • :default_value (String) —

    The value to assign to the #default_value property

  • :pattern (String) —

    The value to assign to the #pattern property

  • :max_length (Integer) —

    The value to assign to the #max_length property

  • :min_length (Integer) —

    The value to assign to the #min_length property



76
77
78
79
80
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
 
# File 'lib/oci/fleet_apps_management/models/string_variable.rb', line 76

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['type'] = 'STRING'

  super(attributes)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

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

  self.max_length = attributes[:'maxLength'] if attributes[:'maxLength']

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

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

  self.min_length = attributes[:'minLength'] if attributes[:'minLength']

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

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

Instance Attribute Details

#default_value ⇒ String

The default string value.

Returns:

  • (String) 


14
15
16
 
# File 'lib/oci/fleet_apps_management/models/string_variable.rb', line 14

def default_value
  @default_value
end

#max_length ⇒ Integer

Maximum allowed length for the string.

Returns:

  • (Integer) 


22
23
24
 
# File 'lib/oci/fleet_apps_management/models/string_variable.rb', line 22

def max_length
  @max_length
end

#min_length ⇒ Integer

Minimum allowed length for the string.

Returns:

  • (Integer) 


26
27
28
 
# File 'lib/oci/fleet_apps_management/models/string_variable.rb', line 26

def min_length
  @min_length
end

#pattern ⇒ String

Regex pattern that the string must match.

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/fleet_apps_management/models/string_variable.rb', line 18

def pattern
  @pattern
end

Class Method Details

.attribute_map ⇒ Object

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



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/oci/fleet_apps_management/models/string_variable.rb', line 29

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'type',
    'title': :'title',
    'description': :'description',
    'is_required': :'isRequired',
    'visible': :'visible',
    'default_value': :'defaultValue',
    'pattern': :'pattern',
    'max_length': :'maxLength',
    'min_length': :'minLength'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/oci/fleet_apps_management/models/string_variable.rb', line 46

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'String',
    'title': :'String',
    'description': :'String',
    'is_required': :'BOOLEAN',
    'visible': :'String',
    'default_value': :'String',
    'pattern': :'String',
    'max_length': :'Integer',
    'min_length': :'Integer'
    # 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



114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/oci/fleet_apps_management/models/string_variable.rb', line 114

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

  self.class == other.class &&
    type == other.type &&
    title == other.title &&
    description == other.description &&
    is_required == other.is_required &&
    visible == other.visible &&
    default_value == other.default_value &&
    pattern == other.pattern &&
    max_length == other.max_length &&
    min_length == other.min_length
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



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/oci/fleet_apps_management/models/string_variable.rb', line 152

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


132
133
134
 
# File 'lib/oci/fleet_apps_management/models/string_variable.rb', line 132

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



141
142
143
 
# File 'lib/oci/fleet_apps_management/models/string_variable.rb', line 141

def hash
  [type, title, description, is_required, visible, default_value, pattern, max_length, min_length].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



185
186
187
188
189
190
191
192
193
194
 
# File 'lib/oci/fleet_apps_management/models/string_variable.rb', line 185

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



179
180
181
 
# File 'lib/oci/fleet_apps_management/models/string_variable.rb', line 179

def to_s
  to_hash.to_s
end