Class: OCI::DatabaseMigration::Models::ParameterFileVersionSummary

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

Overview

Details of a parameter file

Constant Summary collapse

KIND_ENUM = 
[
  KIND_EXTRACT = 'EXTRACT'.freeze,
  KIND_REPLICAT = 'REPLICAT'.freeze,
  KIND_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ParameterFileVersionSummary

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

  • :kind (String) —

    The value to assign to the #kind property

  • :description (String) —

    The value to assign to the #description property

  • :is_current (BOOLEAN) —

    The value to assign to the #is_current property

  • :is_factory (BOOLEAN) —

    The value to assign to the #is_factory property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

  • :system_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #system_tags property



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/oci/database_migration/models/parameter_file_version_summary.rb', line 110

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

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

  self.is_current = attributes[:'isCurrent'] unless attributes[:'isCurrent'].nil?

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

  self.is_current = attributes[:'is_current'] unless attributes[:'is_current'].nil?

  self.is_factory = attributes[:'isFactory'] unless attributes[:'isFactory'].nil?

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

  self.is_factory = attributes[:'is_factory'] unless attributes[:'is_factory'].nil?

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

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

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

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

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

  self.system_tags = attributes[:'systemTags'] if attributes[:'systemTags']

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

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

Instance Attribute Details

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


53
54
55
 
# File 'lib/oci/database_migration/models/parameter_file_version_summary.rb', line 53

def defined_tags
  @defined_tags
end

#description ⇒ String

A description to discribe the current parameter file version

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/database_migration/models/parameter_file_version_summary.rb', line 28

def description
  @description
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: "Finance"

Returns:

  • (Hash<String, String>) 


47
48
49
 
# File 'lib/oci/database_migration/models/parameter_file_version_summary.rb', line 47

def freeform_tags
  @freeform_tags
end

#is_current ⇒ BOOLEAN

[Required] Return boolean true/false for the currently in-use parameter file (factory or a versioned file)

Returns:

  • (BOOLEAN) 


32
33
34
 
# File 'lib/oci/database_migration/models/parameter_file_version_summary.rb', line 32

def is_current
  @is_current
end

#is_factory ⇒ BOOLEAN

[Required] Return true/false for whether the parameter file is oracle provided (Factory)

Returns:

  • (BOOLEAN) 


36
37
38
 
# File 'lib/oci/database_migration/models/parameter_file_version_summary.rb', line 36

def is_factory
  @is_factory
end

#kind ⇒ String

[Required] Indicator of Parameter File 'kind' (for an EXTRACT or a REPLICAT)

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/database_migration/models/parameter_file_version_summary.rb', line 24

def kind
  @kind
end

#name ⇒ String

[Required] A unique name associated with the current migration/job and extract/replicat name

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/database_migration/models/parameter_file_version_summary.rb', line 20

def name
  @name
end

#system_tags ⇒ Hash<String, Hash<String, Object>>

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


59
60
61
 
# File 'lib/oci/database_migration/models/parameter_file_version_summary.rb', line 59

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The time when this parameter file was applied on the process

Returns:

  • (DateTime) 


41
42
43
 
# File 'lib/oci/database_migration/models/parameter_file_version_summary.rb', line 41

def time_created
  @time_created
end

Class Method Details

.attribute_map ⇒ Object

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



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/oci/database_migration/models/parameter_file_version_summary.rb', line 62

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'kind': :'kind',
    'description': :'description',
    'is_current': :'isCurrent',
    'is_factory': :'isFactory',
    'time_created': :'timeCreated',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/oci/database_migration/models/parameter_file_version_summary.rb', line 79

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'kind': :'String',
    'description': :'String',
    'is_current': :'BOOLEAN',
    'is_factory': :'BOOLEAN',
    'time_created': :'DateTime',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>'
    # 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



179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/oci/database_migration/models/parameter_file_version_summary.rb', line 179

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

  self.class == other.class &&
    name == other.name &&
    kind == other.kind &&
    description == other.description &&
    is_current == other.is_current &&
    is_factory == other.is_factory &&
    time_created == other.time_created &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags
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



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/oci/database_migration/models/parameter_file_version_summary.rb', line 217

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


197
198
199
 
# File 'lib/oci/database_migration/models/parameter_file_version_summary.rb', line 197

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



206
207
208
 
# File 'lib/oci/database_migration/models/parameter_file_version_summary.rb', line 206

def hash
  [name, kind, description, is_current, is_factory, time_created, freeform_tags, defined_tags, system_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



250
251
252
253
254
255
256
257
258
259
 
# File 'lib/oci/database_migration/models/parameter_file_version_summary.rb', line 250

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



244
245
246
 
# File 'lib/oci/database_migration/models/parameter_file_version_summary.rb', line 244

def to_s
  to_hash.to_s
end