Class: OCI::ApplicationMigration::Models::ConfigurationField

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/application_migration/models/configuration_field.rb

Overview

Information required to migrate an application. Populated by the service as the source application is introspected

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ConfigurationField

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

  • :group (String)

    The value to assign to the #group property

  • :type (String)

    The value to assign to the #type property

  • :value (String)

    The value to assign to the #value property

  • :description (String)

    The value to assign to the #description property

  • :is_required (BOOLEAN)

    The value to assign to the #is_required property

  • :is_mutable (BOOLEAN)

    The value to assign to the #is_mutable property



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
# File 'lib/oci/application_migration/models/configuration_field.rb', line 84

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

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

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

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

  self.is_required = attributes[:'isRequired'] unless attributes[:'isRequired'].nil?
  self.is_required = true if is_required.nil? && !attributes.key?(:'isRequired') # rubocop:disable Style/StringLiterals

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

  self.is_required = attributes[:'is_required'] unless attributes[:'is_required'].nil?
  self.is_required = true if is_required.nil? && !attributes.key?(:'isRequired') && !attributes.key?(:'is_required') # rubocop:disable Style/StringLiterals

  self.is_mutable = attributes[:'isMutable'] unless attributes[:'isMutable'].nil?
  self.is_mutable = true if is_mutable.nil? && !attributes.key?(:'isMutable') # rubocop:disable Style/StringLiterals

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

  self.is_mutable = attributes[:'is_mutable'] unless attributes[:'is_mutable'].nil?
  self.is_mutable = true if is_mutable.nil? && !attributes.key?(:'isMutable') && !attributes.key?(:'is_mutable') # rubocop:disable Style/StringLiterals
end

Instance Attribute Details

#descriptionString

Help text to guide the customer in setting the configuration value

Returns:

  • (String)


29
30
31
# File 'lib/oci/application_migration/models/configuration_field.rb', line 29

def description
  @description
end

#groupString

The name of the group to which this field belongs, if any.

Returns:

  • (String)


17
18
19
# File 'lib/oci/application_migration/models/configuration_field.rb', line 17

def group
  @group
end

#is_mutableBOOLEAN

Indicates whether or not the field may be modified (defaults to true)

Returns:

  • (BOOLEAN)


39
40
41
# File 'lib/oci/application_migration/models/configuration_field.rb', line 39

def is_mutable
  @is_mutable
end

#is_requiredBOOLEAN

Indicates whether or not the field is required (defaults to true)

Returns:

  • (BOOLEAN)


34
35
36
# File 'lib/oci/application_migration/models/configuration_field.rb', line 34

def is_required
  @is_required
end

#nameString

The name of the configuration field

Returns:

  • (String)


13
14
15
# File 'lib/oci/application_migration/models/configuration_field.rb', line 13

def name
  @name
end

#typeString

The configuration field type

Returns:

  • (String)


21
22
23
# File 'lib/oci/application_migration/models/configuration_field.rb', line 21

def type
  @type
end

#valueString

The value of the field

Returns:

  • (String)


25
26
27
# File 'lib/oci/application_migration/models/configuration_field.rb', line 25

def value
  @value
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
54
# File 'lib/oci/application_migration/models/configuration_field.rb', line 42

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'group': :'group',
    'type': :'type',
    'value': :'value',
    'description': :'description',
    'is_required': :'isRequired',
    'is_mutable': :'isMutable'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'group': :'String',
    'type': :'String',
    'value': :'String',
    'description': :'String',
    'is_required': :'BOOLEAN',
    'is_mutable': :'BOOLEAN'
    # 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



124
125
126
127
128
129
130
131
132
133
134
135
# File 'lib/oci/application_migration/models/configuration_field.rb', line 124

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

  self.class == other.class &&
    name == other.name &&
    group == other.group &&
    type == other.type &&
    value == other.value &&
    description == other.description &&
    is_required == other.is_required &&
    is_mutable == other.is_mutable
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



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
# File 'lib/oci/application_migration/models/configuration_field.rb', line 160

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


140
141
142
# File 'lib/oci/application_migration/models/configuration_field.rb', line 140

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



149
150
151
# File 'lib/oci/application_migration/models/configuration_field.rb', line 149

def hash
  [name, group, type, value, description, is_required, is_mutable].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



193
194
195
196
197
198
199
200
201
202
# File 'lib/oci/application_migration/models/configuration_field.rb', line 193

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



187
188
189
# File 'lib/oci/application_migration/models/configuration_field.rb', line 187

def to_s
  to_hash.to_s
end