Class: OCI::Core::Models::VolumeBackupPolicyAssignment

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

Overview

Specifies the volume that the volume backup policy is assigned to.

For more information about Oracle defined backup policies and custom backup policies, see Policy-Based Backups.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ VolumeBackupPolicyAssignment

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :asset_id (String) —

    The value to assign to the #asset_id property

  • :id (String) —

    The value to assign to the #id property

  • :policy_id (String) —

    The value to assign to the #policy_id property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :xrc_kms_key_id (String) —

    The value to assign to the #xrc_kms_key_id property



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
 
# File 'lib/oci/core/models/volume_backup_policy_assignment.rb', line 79

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

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

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

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

  self.policy_id = attributes[:'policyId'] if attributes[:'policyId']

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

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

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

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

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

Instance Attribute Details

#asset_id ⇒ String

[Required] The OCID of the volume the policy has been assigned to.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/core/models/volume_backup_policy_assignment.rb', line 17

def asset_id
  @asset_id
end

#id ⇒ String

[Required] The OCID of the volume backup policy assignment.

Returns:

  • (String) 


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

def id
  @id
end

#policy_id ⇒ String

[Required] The OCID of the volume backup policy that has been assigned to the volume.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/core/models/volume_backup_policy_assignment.rb', line 26

def policy_id
  @policy_id
end

#time_created ⇒ DateTime

[Required] The date and time the volume backup policy was assigned to the volume. The format is defined by RFC3339.

Returns:

  • (DateTime) 


32
33
34
 
# File 'lib/oci/core/models/volume_backup_policy_assignment.rb', line 32

def time_created
  @time_created
end

#xrc_kms_key_id ⇒ String

The OCID of the Vault service key which is the master encryption key for the block / boot volume cross region backups, which will be used in the destination region to encrypt the backup's encryption keys. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/core/models/volume_backup_policy_assignment.rb', line 40

def xrc_kms_key_id
  @xrc_kms_key_id
end

Class Method Details

.attribute_map ⇒ Object

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



43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/oci/core/models/volume_backup_policy_assignment.rb', line 43

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'asset_id': :'assetId',
    'id': :'id',
    'policy_id': :'policyId',
    'time_created': :'timeCreated',
    'xrc_kms_key_id': :'xrcKmsKeyId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/oci/core/models/volume_backup_policy_assignment.rb', line 56

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'asset_id': :'String',
    'id': :'String',
    'policy_id': :'String',
    'time_created': :'DateTime',
    'xrc_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



119
120
121
122
123
124
125
126
127
128
 
# File 'lib/oci/core/models/volume_backup_policy_assignment.rb', line 119

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

  self.class == other.class &&
    asset_id == other.asset_id &&
    id == other.id &&
    policy_id == other.policy_id &&
    time_created == other.time_created &&
    xrc_kms_key_id == other.xrc_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



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/oci/core/models/volume_backup_policy_assignment.rb', line 153

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


133
134
135
 
# File 'lib/oci/core/models/volume_backup_policy_assignment.rb', line 133

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



142
143
144
 
# File 'lib/oci/core/models/volume_backup_policy_assignment.rb', line 142

def hash
  [asset_id, id, policy_id, time_created, xrc_kms_key_id].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



186
187
188
189
190
191
192
193
194
195
 
# File 'lib/oci/core/models/volume_backup_policy_assignment.rb', line 186

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



180
181
182
 
# File 'lib/oci/core/models/volume_backup_policy_assignment.rb', line 180

def to_s
  to_hash.to_s
end