Class: OCI::Core::Models::CopyVolumeBackupDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/core/models/copy_volume_backup_details.rb

Overview

CopyVolumeBackupDetails model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CopyVolumeBackupDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :destination_region (String)

    The value to assign to the #destination_region property

  • :display_name (String)

    The value to assign to the #display_name property

  • :kms_key_id (String)

    The value to assign to the #kms_key_id property



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
# File 'lib/oci/core/models/copy_volume_backup_details.rb', line 67

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

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

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

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

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

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

Instance Attribute Details

#destination_regionString

[Required] The name of the destination region.

Example: us-ashburn-1

Returns:

  • (String)


15
16
17
# File 'lib/oci/core/models/copy_volume_backup_details.rb', line 15

def destination_region
  @destination_region
end

#display_nameString

A user-friendly name for the volume backup. Does not have to be unique and it's changeable. Avoid entering confidential information.

Returns:

  • (String)


21
22
23
# File 'lib/oci/core/models/copy_volume_backup_details.rb', line 21

def display_name
  @display_name
end

#kms_key_idString

The OCID of the Key Management key in the destination region which will be the master encryption key for the copied volume backup. If you do not specify this attribute the volume backup will be encrypted with the Oracle-provided encryption key when it is copied to the destination region.

For more information about the Key Management service and encryption keys, see Overview of Key Management and Using Keys.

Returns:

  • (String)


34
35
36
# File 'lib/oci/core/models/copy_volume_backup_details.rb', line 34

def kms_key_id
  @kms_key_id
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
# File 'lib/oci/core/models/copy_volume_backup_details.rb', line 37

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'destination_region': :'destinationRegion',
    'display_name': :'displayName',
    'kms_key_id': :'kmsKeyId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



48
49
50
51
52
53
54
55
56
# File 'lib/oci/core/models/copy_volume_backup_details.rb', line 48

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'destination_region': :'String',
    'display_name': :'String',
    'kms_key_id': :'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



99
100
101
102
103
104
105
106
# File 'lib/oci/core/models/copy_volume_backup_details.rb', line 99

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

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



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
# File 'lib/oci/core/models/copy_volume_backup_details.rb', line 131

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


111
112
113
# File 'lib/oci/core/models/copy_volume_backup_details.rb', line 111

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



120
121
122
# File 'lib/oci/core/models/copy_volume_backup_details.rb', line 120

def hash
  [destination_region, display_name, kms_key_id].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



164
165
166
167
168
169
170
171
172
173
# File 'lib/oci/core/models/copy_volume_backup_details.rb', line 164

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



158
159
160
# File 'lib/oci/core/models/copy_volume_backup_details.rb', line 158

def to_s
  to_hash.to_s
end