Class: OCI::DisasterRecovery::Models::DrPlanGroup

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/disaster_recovery/models/dr_plan_group.rb

Overview

Details of a group in a DR plan.

Constant Summary collapse

TYPE_ENUM = 
[
  TYPE_USER_DEFINED = 'USER_DEFINED'.freeze,
  TYPE_BUILT_IN = 'BUILT_IN'.freeze,
  TYPE_BUILT_IN_PRECHECK = 'BUILT_IN_PRECHECK'.freeze,
  TYPE_USER_DEFINED_PAUSE = 'USER_DEFINED_PAUSE'.freeze,
  TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DrPlanGroup

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/oci/disaster_recovery/models/dr_plan_group.rb', line 91

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

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

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

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

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

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

Instance Attribute Details

#display_name ⇒ String

[Required] The display name of the group.

Example: DATABASE_SWITCHOVER

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/disaster_recovery/models/dr_plan_group.rb', line 39

def display_name
  @display_name
end

#id ⇒ String

[Required] The unique id of the group. Must not be modified by user.

Example: sgid1.group..uniqueID

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/disaster_recovery/models/dr_plan_group.rb', line 25

def id
  @id
end

#is_pause_enabled ⇒ BOOLEAN

A flag indicating whether this group should be enabled for execution. This flag is only applicable to the USER_DEFINED_PAUSE group. The flag should be null for the remaining group types.

Example: true

Returns:

  • (BOOLEAN) 


47
48
49
 
# File 'lib/oci/disaster_recovery/models/dr_plan_group.rb', line 47

def is_pause_enabled
  @is_pause_enabled
end

#steps ⇒ Array<OCI::DisasterRecovery::Models::DrPlanStep>

[Required] The list of steps in the group.

Returns:



52
53
54
 
# File 'lib/oci/disaster_recovery/models/dr_plan_group.rb', line 52

def steps
  @steps
end

#type ⇒ String

[Required] The group type.

Example: BUILT_IN

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/disaster_recovery/models/dr_plan_group.rb', line 32

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/oci/disaster_recovery/models/dr_plan_group.rb', line 55

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'type': :'type',
    'display_name': :'displayName',
    'is_pause_enabled': :'isPauseEnabled',
    'steps': :'steps'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/oci/disaster_recovery/models/dr_plan_group.rb', line 68

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'type': :'String',
    'display_name': :'String',
    'is_pause_enabled': :'BOOLEAN',
    'steps': :'Array<OCI::DisasterRecovery::Models::DrPlanStep>'
    # 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



136
137
138
139
140
141
142
143
144
145
 
# File 'lib/oci/disaster_recovery/models/dr_plan_group.rb', line 136

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

  self.class == other.class &&
    id == other.id &&
    type == other.type &&
    display_name == other.display_name &&
    is_pause_enabled == other.is_pause_enabled &&
    steps == other.steps
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



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/oci/disaster_recovery/models/dr_plan_group.rb', line 170

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


150
151
152
 
# File 'lib/oci/disaster_recovery/models/dr_plan_group.rb', line 150

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



159
160
161
 
# File 'lib/oci/disaster_recovery/models/dr_plan_group.rb', line 159

def hash
  [id, type, display_name, is_pause_enabled, steps].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



203
204
205
206
207
208
209
210
211
212
 
# File 'lib/oci/disaster_recovery/models/dr_plan_group.rb', line 203

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



197
198
199
 
# File 'lib/oci/disaster_recovery/models/dr_plan_group.rb', line 197

def to_s
  to_hash.to_s
end