Class: OCI::Bds::Models::CreateNodeBackupConfigurationDetails

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

Overview

The information about the NodeBackupConfiguration.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateNodeBackupConfigurationDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
# File 'lib/oci/bds/models/create_node_backup_configuration_details.rb', line 76

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.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.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.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']
  self.backup_type = "FULL" if backup_type.nil? && !attributes.key?(:'backupType') # rubocop:disable Style/StringLiterals

  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']
  self.backup_type = "FULL" if backup_type.nil? && !attributes.key?(:'backupType') && !attributes.key?(:'backup_type') # rubocop:disable Style/StringLiterals
end

Instance Attribute Details

#backup_typeString

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

Returns:

  • (String)


34
35
36
# File 'lib/oci/bds/models/create_node_backup_configuration_details.rb', line 34

def backup_type
  @backup_type
end

#display_nameString

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)


17
18
19
# File 'lib/oci/bds/models/create_node_backup_configuration_details.rb', line 17

def display_name
  @display_name
end

#level_type_detailsOCI::Bds::Models::LevelTypeDetails

This attribute is required.



13
14
15
# File 'lib/oci/bds/models/create_node_backup_configuration_details.rb', line 13

def level_type_details
  @level_type_details
end

#number_of_backups_to_retainInteger

Number of backup copies to retain.

Returns:

  • (Integer)


30
31
32
# File 'lib/oci/bds/models/create_node_backup_configuration_details.rb', line 30

def number_of_backups_to_retain
  @number_of_backups_to_retain
end

#scheduleString

[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)


26
27
28
# File 'lib/oci/bds/models/create_node_backup_configuration_details.rb', line 26

def schedule
  @schedule
end

#timezoneString

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

Returns:

  • (String)


21
22
23
# File 'lib/oci/bds/models/create_node_backup_configuration_details.rb', line 21

def timezone
  @timezone
end

Class Method Details

.attribute_mapObject

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



37
38
39
40
41
42
43
44
45
46
47
48
# File 'lib/oci/bds/models/create_node_backup_configuration_details.rb', line 37

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'level_type_details': :'levelTypeDetails',
    'display_name': :'displayName',
    'timezone': :'timezone',
    'schedule': :'schedule',
    'number_of_backups_to_retain': :'numberOfBackupsToRetain',
    'backup_type': :'backupType'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



51
52
53
54
55
56
57
58
59
60
61
62
# File 'lib/oci/bds/models/create_node_backup_configuration_details.rb', line 51

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'level_type_details': :'OCI::Bds::Models::LevelTypeDetails',
    'display_name': :'String',
    '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



121
122
123
124
125
126
127
128
129
130
131
# File 'lib/oci/bds/models/create_node_backup_configuration_details.rb', line 121

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

  self.class == other.class &&
    level_type_details == other.level_type_details &&
    display_name == other.display_name &&
    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



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
# File 'lib/oci/bds/models/create_node_backup_configuration_details.rb', line 156

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


136
137
138
# File 'lib/oci/bds/models/create_node_backup_configuration_details.rb', line 136

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



145
146
147
# File 'lib/oci/bds/models/create_node_backup_configuration_details.rb', line 145

def hash
  [level_type_details, display_name, timezone, schedule, number_of_backups_to_retain, backup_type].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



189
190
191
192
193
194
195
196
197
198
# File 'lib/oci/bds/models/create_node_backup_configuration_details.rb', line 189

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



183
184
185
# File 'lib/oci/bds/models/create_node_backup_configuration_details.rb', line 183

def to_s
  to_hash.to_s
end