Class: OCI::DatabaseMigration::Models::UserDefinedProperties

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/database_migration/models/user_defined_properties.rb

Overview

User defined properties

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UserDefinedProperties

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/oci/database_migration/models/user_defined_properties.rb', line 72

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

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

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

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

  self.help_link_url = attributes[:'helpLinkUrl'] if attributes[:'helpLinkUrl']

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

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

  self.help_link_text = attributes[:'helpLinkText'] if attributes[:'helpLinkText']

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

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

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

Instance Attribute Details

#description ⇒ String

A user-friendly description. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/database_migration/models/user_defined_properties.rb', line 21

def description
  @description
end

#display_name ⇒ String

[Required] A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Returns:

  • (String) 


15
16
17
 
# File 'lib/oci/database_migration/models/user_defined_properties.rb', line 15

def display_name
  @display_name
end

#help_link_text ⇒ String

The Help link text.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/database_migration/models/user_defined_properties.rb', line 29

def help_link_text
  @help_link_text
end

#help_link_url ⇒ String

The Help URL.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/database_migration/models/user_defined_properties.rb', line 25

def help_link_url
  @help_link_url
end

#properties ⇒ Array<OCI::DatabaseMigration::Models::UserDefinedProperty>

Array of user defined properties.

Returns:



33
34
35
 
# File 'lib/oci/database_migration/models/user_defined_properties.rb', line 33

def properties
  @properties
end

Class Method Details

.attribute_map ⇒ Object

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



36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/oci/database_migration/models/user_defined_properties.rb', line 36

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'description': :'description',
    'help_link_url': :'helpLinkUrl',
    'help_link_text': :'helpLinkText',
    'properties': :'properties'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/oci/database_migration/models/user_defined_properties.rb', line 49

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'description': :'String',
    'help_link_url': :'String',
    'help_link_text': :'String',
    'properties': :'Array<OCI::DatabaseMigration::Models::UserDefinedProperty>'
    # 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



108
109
110
111
112
113
114
115
116
117
 
# File 'lib/oci/database_migration/models/user_defined_properties.rb', line 108

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

  self.class == other.class &&
    display_name == other.display_name &&
    description == other.description &&
    help_link_url == other.help_link_url &&
    help_link_text == other.help_link_text &&
    properties == other.properties
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



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/oci/database_migration/models/user_defined_properties.rb', line 142

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


122
123
124
 
# File 'lib/oci/database_migration/models/user_defined_properties.rb', line 122

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



131
132
133
 
# File 'lib/oci/database_migration/models/user_defined_properties.rb', line 131

def hash
  [display_name, description, help_link_url, help_link_text, properties].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



175
176
177
178
179
180
181
182
183
184
 
# File 'lib/oci/database_migration/models/user_defined_properties.rb', line 175

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



169
170
171
 
# File 'lib/oci/database_migration/models/user_defined_properties.rb', line 169

def to_s
  to_hash.to_s
end