Class: OCI::OspGateway::Models::Field

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/osp_gateway/models/field.rb

Overview

Field information

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Field

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/oci/osp_gateway/models/field.rb', line 66

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.is_required = attributes[:'isRequired'] unless attributes[:'isRequired'].nil?

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

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

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

Instance Attribute Details

#format ⇒ OCI::OspGateway::Models::Format

Returns:



20
21
22
 
# File 'lib/oci/osp_gateway/models/field.rb', line 20

def format
  @format
end

#is_required ⇒ BOOLEAN

[Required] The given field is requeired or not

Returns:

  • (BOOLEAN) 


17
18
19
 
# File 'lib/oci/osp_gateway/models/field.rb', line 17

def is_required
  @is_required
end

#label ⇒ OCI::OspGateway::Models::Label

Returns:



23
24
25
 
# File 'lib/oci/osp_gateway/models/field.rb', line 23

def label
  @label
end

#language ⇒ String

Locale code (rfc4646 format) of a forced language (e.g.: jp addresses require jp always)

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/osp_gateway/models/field.rb', line 27

def language
  @language
end

#name ⇒ String

[Required] The field name

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/osp_gateway/models/field.rb', line 13

def name
  @name
end

Class Method Details

.attribute_map ⇒ Object

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



30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/oci/osp_gateway/models/field.rb', line 30

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'is_required': :'isRequired',
    'format': :'format',
    'label': :'label',
    'language': :'language'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'is_required': :'BOOLEAN',
    'format': :'OCI::OspGateway::Models::Format',
    'label': :'OCI::OspGateway::Models::Label',
    'language': :'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



94
95
96
97
98
99
100
101
102
103
 
# File 'lib/oci/osp_gateway/models/field.rb', line 94

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

  self.class == other.class &&
    name == other.name &&
    is_required == other.is_required &&
    format == other.format &&
    label == other.label &&
    language == other.language
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



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/oci/osp_gateway/models/field.rb', line 128

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


108
109
110
 
# File 'lib/oci/osp_gateway/models/field.rb', line 108

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



117
118
119
 
# File 'lib/oci/osp_gateway/models/field.rb', line 117

def hash
  [name, is_required, format, label, language].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



161
162
163
164
165
166
167
168
169
170
 
# File 'lib/oci/osp_gateway/models/field.rb', line 161

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



155
156
157
 
# File 'lib/oci/osp_gateway/models/field.rb', line 155

def to_s
  to_hash.to_s
end