Class: OCI::Redis::Models::CreateOciCacheBackupDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/redis/models/create_oci_cache_backup_details.rb

Overview

The information to create a new OCI Cache Backup.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateOciCacheBackupDetails

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

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :source_cluster_id (String) —

    The value to assign to the #source_cluster_id property

  • :retention_period_in_days (Integer) —

    The value to assign to the #retention_period_in_days property

  • :backup_source (String) —

    The value to assign to the #backup_source 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



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
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
 
# File 'lib/oci/redis/models/create_oci_cache_backup_details.rb', line 93

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

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

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

  self.source_cluster_id = attributes[:'sourceClusterId'] if attributes[:'sourceClusterId']

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

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

  self.retention_period_in_days = attributes[:'retentionPeriodInDays'] if attributes[:'retentionPeriodInDays']

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

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

  self.backup_source = attributes[:'backupSource'] if attributes[:'backupSource']
  self.backup_source = "REPLICA" if backup_source.nil? && !attributes.key?(:'backupSource') # rubocop:disable Style/StringLiterals

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

  self.backup_source = attributes[:'backup_source'] if attributes[:'backup_source']
  self.backup_source = "REPLICA" if backup_source.nil? && !attributes.key?(:'backupSource') && !attributes.key?(:'backup_source') # rubocop:disable Style/StringLiterals

  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']
end

Instance Attribute Details

#backup_source ⇒ String

Specifies whether the backup was created from a replica or primary node

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/redis/models/create_oci_cache_backup_details.rb', line 33

def backup_source
  @backup_source
end

#compartment_id ⇒ String

[Required] Compartment identifier

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/redis/models/create_oci_cache_backup_details.rb', line 21

def compartment_id
  @compartment_id
end

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


45
46
47
 
# File 'lib/oci/redis/models/create_oci_cache_backup_details.rb', line 45

def defined_tags
  @defined_tags
end

#description ⇒ String

Backup description

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/redis/models/create_oci_cache_backup_details.rb', line 17

def description
  @description
end

#display_name ⇒ String

[Required] Backup display name.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/redis/models/create_oci_cache_backup_details.rb', line 13

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


39
40
41
 
# File 'lib/oci/redis/models/create_oci_cache_backup_details.rb', line 39

def freeform_tags
  @freeform_tags
end

#retention_period_in_days ⇒ Integer

Backup retention period in days.

Returns:

  • (Integer) 


29
30
31
 
# File 'lib/oci/redis/models/create_oci_cache_backup_details.rb', line 29

def retention_period_in_days
  @retention_period_in_days
end

#source_cluster_id ⇒ String

[Required] OCI Cache cluster identifier

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/redis/models/create_oci_cache_backup_details.rb', line 25

def source_cluster_id
  @source_cluster_id
end

Class Method Details

.attribute_map ⇒ Object

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



48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/oci/redis/models/create_oci_cache_backup_details.rb', line 48

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'description': :'description',
    'compartment_id': :'compartmentId',
    'source_cluster_id': :'sourceClusterId',
    'retention_period_in_days': :'retentionPeriodInDays',
    'backup_source': :'backupSource',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/oci/redis/models/create_oci_cache_backup_details.rb', line 64

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'description': :'String',
    'compartment_id': :'String',
    'source_cluster_id': :'String',
    'retention_period_in_days': :'Integer',
    'backup_source': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_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



153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/oci/redis/models/create_oci_cache_backup_details.rb', line 153

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

  self.class == other.class &&
    display_name == other.display_name &&
    description == other.description &&
    compartment_id == other.compartment_id &&
    source_cluster_id == other.source_cluster_id &&
    retention_period_in_days == other.retention_period_in_days &&
    backup_source == other.backup_source &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_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



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/oci/redis/models/create_oci_cache_backup_details.rb', line 190

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


170
171
172
 
# File 'lib/oci/redis/models/create_oci_cache_backup_details.rb', line 170

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



179
180
181
 
# File 'lib/oci/redis/models/create_oci_cache_backup_details.rb', line 179

def hash
  [display_name, description, compartment_id, source_cluster_id, retention_period_in_days, backup_source, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



223
224
225
226
227
228
229
230
231
232
 
# File 'lib/oci/redis/models/create_oci_cache_backup_details.rb', line 223

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



217
218
219
 
# File 'lib/oci/redis/models/create_oci_cache_backup_details.rb', line 217

def to_s
  to_hash.to_s
end