Class: OCI::Bds::Models::NodeBackupConfiguration

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/bds/models/node_backup_configuration.rb

Overview

The information about the NodeBackupConfiguration.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.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 = {}) ⇒ NodeBackupConfiguration

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/oci/bds/models/node_backup_configuration.rb', line 123

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

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

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

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

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

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

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

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

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

  self.timezone = attributes[:'timezone'] if attributes[:'timezone']
  self.timezone = "Etc/UTC" if timezone.nil? && !attributes.key?(:'timezone') # rubocop:disable Style/StringLiterals

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

  self.number_of_backups_to_retain = attributes[:'numberOfBackupsToRetain'] if attributes[:'numberOfBackupsToRetain']

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

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

  self.backup_type = attributes[:'backupType'] if attributes[:'backupType']

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

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

Instance Attribute Details

#backup_type ⇒ String

Incremental backup type includes only the changes since the last backup. Full backup type includes all changes since the volume was created.

Returns:

  • (String) 


66
67
68
 
# File 'lib/oci/bds/models/node_backup_configuration.rb', line 66

def backup_type
  @backup_type
end

#bds_instance_id ⇒ String

[Required] The OCID of the bdsInstance which is the parent resource id.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/bds/models/node_backup_configuration.rb', line 28

def bds_instance_id
  @bds_instance_id
end

#display_name ⇒ String

[Required] A user-friendly name. Only ASCII alphanumeric characters with no spaces allowed. The name does not have to be unique, and it may be changed. Avoid entering confidential information.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/bds/models/node_backup_configuration.rb', line 32

def display_name
  @display_name
end

#id ⇒ String

[Required] The unique identifier for the NodeBackupConfiguration.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/bds/models/node_backup_configuration.rb', line 24

def id
  @id
end

#level_type_details ⇒ OCI::Bds::Models::LevelTypeDetails

This attribute is required.

Returns:



36
37
38
 
# File 'lib/oci/bds/models/node_backup_configuration.rb', line 36

def level_type_details
  @level_type_details
end

#lifecycle_state ⇒ String

[Required] The state of the NodeBackupConfiguration.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/bds/models/node_backup_configuration.rb', line 40

def lifecycle_state
  @lifecycle_state
end

#number_of_backups_to_retain ⇒ Integer

[Required] Number of backup copies to retain.

Returns:

  • (Integer) 


62
63
64
 
# File 'lib/oci/bds/models/node_backup_configuration.rb', line 62

def number_of_backups_to_retain
  @number_of_backups_to_retain
end

#schedule ⇒ String

[Required] Day/time recurrence (specified following RFC 5545) at which to trigger the backup process. Currently only DAILY, WEEKLY and MONTHLY frequency is supported. Days of the week are specified using BYDAY field. Time of the day is specified using BYHOUR. Other fields are not supported.

Returns:

  • (String) 


58
59
60
 
# File 'lib/oci/bds/models/node_backup_configuration.rb', line 58

def schedule
  @schedule
end

#time_created ⇒ DateTime

[Required] The time the NodeBackupConfiguration was created, shown as an RFC 3339 formatted datetime string.

Returns:

  • (DateTime) 


44
45
46
 
# File 'lib/oci/bds/models/node_backup_configuration.rb', line 44

def time_created
  @time_created
end

#time_updated ⇒ DateTime

[Required] The time the NodeBackupConfiguration was updated, shown as an RFC 3339 formatted datetime string.

Returns:

  • (DateTime) 


49
50
51
 
# File 'lib/oci/bds/models/node_backup_configuration.rb', line 49

def time_updated
  @time_updated
end

#timezone ⇒ String

[Required] The time zone of the execution schedule, in IANA time zone database name format

Returns:

  • (String) 


53
54
55
 
# File 'lib/oci/bds/models/node_backup_configuration.rb', line 53

def timezone
  @timezone
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'bds_instance_id': :'bdsInstanceId',
    'display_name': :'displayName',
    'level_type_details': :'levelTypeDetails',
    'lifecycle_state': :'lifecycleState',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'timezone': :'timezone',
    'schedule': :'schedule',
    'number_of_backups_to_retain': :'numberOfBackupsToRetain',
    'backup_type': :'backupType'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/oci/bds/models/node_backup_configuration.rb', line 88

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'bds_instance_id': :'String',
    'display_name': :'String',
    'level_type_details': :'OCI::Bds::Models::LevelTypeDetails',
    'lifecycle_state': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'timezone': :'String',
    'schedule': :'String',
    'number_of_backups_to_retain': :'Integer',
    'backup_type': :'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



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/oci/bds/models/node_backup_configuration.rb', line 205

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

  self.class == other.class &&
    id == other.id &&
    bds_instance_id == other.bds_instance_id &&
    display_name == other.display_name &&
    level_type_details == other.level_type_details &&
    lifecycle_state == other.lifecycle_state &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    timezone == other.timezone &&
    schedule == other.schedule &&
    number_of_backups_to_retain == other.number_of_backups_to_retain &&
    backup_type == other.backup_type
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



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/oci/bds/models/node_backup_configuration.rb', line 245

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


225
226
227
 
# File 'lib/oci/bds/models/node_backup_configuration.rb', line 225

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



234
235
236
 
# File 'lib/oci/bds/models/node_backup_configuration.rb', line 234

def hash
  [id, bds_instance_id, display_name, level_type_details, lifecycle_state, time_created, time_updated, timezone, schedule, number_of_backups_to_retain, backup_type].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



278
279
280
281
282
283
284
285
286
287
 
# File 'lib/oci/bds/models/node_backup_configuration.rb', line 278

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



272
273
274
 
# File 'lib/oci/bds/models/node_backup_configuration.rb', line 272

def to_s
  to_hash.to_s
end