Class: OCI::DataSafe::Models::PeerTargetDatabaseSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/data_safe/models/peer_target_database_summary.rb

Overview

The details of the peer target database in Data Safe.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PeerTargetDatabaseSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description property

  • :key (Integer) —

    The value to assign to the #key property

  • :role (String) —

    The value to assign to the #role property

  • :database_unique_name (String) —

    The value to assign to the #database_unique_name property

  • :dataguard_association_id (String) —

    The value to assign to the #dataguard_association_id property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :lifecycle_details (String) —

    The value to assign to the #lifecycle_details property



109
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
 
# File 'lib/oci/data_safe/models/peer_target_database_summary.rb', line 109

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

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

  self.database_unique_name = attributes[:'databaseUniqueName'] if attributes[:'databaseUniqueName']

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

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

  self.dataguard_association_id = attributes[:'dataguardAssociationId'] if attributes[:'dataguardAssociationId']

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

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

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

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

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

  self.lifecycle_details = attributes[:'lifecycleDetails'] if attributes[:'lifecycleDetails']

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

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

Instance Attribute Details

#database_unique_name ⇒ String

Unique name of the database associated to the peer target database.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/data_safe/models/peer_target_database_summary.rb', line 42

def database_unique_name
  @database_unique_name
end

#dataguard_association_id ⇒ String

[Required] The OCID of the Data Guard Association resource in which the database associated to the peer target database is considered as peer database to the primary database.

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/data_safe/models/peer_target_database_summary.rb', line 46

def dataguard_association_id
  @dataguard_association_id
end

#description ⇒ String

The description of the peer target database in Data Safe.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/data_safe/models/peer_target_database_summary.rb', line 30

def description
  @description
end

#display_name ⇒ String

[Required] The display name of the peer target database in Data Safe.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/data_safe/models/peer_target_database_summary.rb', line 26

def display_name
  @display_name
end

#key ⇒ Integer

[Required] The secondary id assigned for the peer target database in Data Safe.

Returns:

  • (Integer) 


34
35
36
 
# File 'lib/oci/data_safe/models/peer_target_database_summary.rb', line 34

def key
  @key
end

#lifecycle_details ⇒ String

Details about the current state of the peer target database in Data Safe.

Returns:

  • (String) 


58
59
60
 
# File 'lib/oci/data_safe/models/peer_target_database_summary.rb', line 58

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the peer target database in Data Safe.

Returns:

  • (String) 


54
55
56
 
# File 'lib/oci/data_safe/models/peer_target_database_summary.rb', line 54

def lifecycle_state
  @lifecycle_state
end

#role ⇒ String

Role of the database associated to the peer target database.

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/data_safe/models/peer_target_database_summary.rb', line 38

def role
  @role
end

#time_created ⇒ DateTime

[Required] The date and time of the peer target database registration in Data Safe.

Returns:

  • (DateTime) 


50
51
52
 
# File 'lib/oci/data_safe/models/peer_target_database_summary.rb', line 50

def time_created
  @time_created
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'description': :'description',
    'key': :'key',
    'role': :'role',
    'database_unique_name': :'databaseUniqueName',
    'dataguard_association_id': :'dataguardAssociationId',
    'time_created': :'timeCreated',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'description': :'String',
    'key': :'Integer',
    'role': :'String',
    'database_unique_name': :'String',
    'dataguard_association_id': :'String',
    'time_created': :'DateTime',
    'lifecycle_state': :'String',
    'lifecycle_details': :'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



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

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

  self.class == other.class &&
    display_name == other.display_name &&
    description == other.description &&
    key == other.key &&
    role == other.role &&
    database_unique_name == other.database_unique_name &&
    dataguard_association_id == other.dataguard_association_id &&
    time_created == other.time_created &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details
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



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

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


196
197
198
 
# File 'lib/oci/data_safe/models/peer_target_database_summary.rb', line 196

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



205
206
207
 
# File 'lib/oci/data_safe/models/peer_target_database_summary.rb', line 205

def hash
  [display_name, description, key, role, database_unique_name, dataguard_association_id, time_created, lifecycle_state, lifecycle_details].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



249
250
251
252
253
254
255
256
257
258
 
# File 'lib/oci/data_safe/models/peer_target_database_summary.rb', line 249

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



243
244
245
 
# File 'lib/oci/data_safe/models/peer_target_database_summary.rb', line 243

def to_s
  to_hash.to_s
end