Class: OCI::Core::Models::CreateVolumeBackupPolicyAssignmentDetails

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

Overview

CreateVolumeBackupPolicyAssignmentDetails model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateVolumeBackupPolicyAssignmentDetails

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

  • :policy_id (String) —

    The value to assign to the #policy_id property

  • :xrc_kms_key_id (String) —

    The value to assign to the #xrc_kms_key_id property



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/oci/core/models/create_volume_backup_policy_assignment_details.rb', line 58

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.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.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 to assign the policy to.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/core/models/create_volume_backup_policy_assignment_details.rb', line 13

def asset_id
  @asset_id
end

#policy_id ⇒ String

[Required] The OCID of the volume backup policy to assign to the volume.

Returns:

  • (String) 


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

def policy_id
  @policy_id
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) 


25
26
27
 
# File 'lib/oci/core/models/create_volume_backup_policy_assignment_details.rb', line 25

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.



28
29
30
31
32
33
34
35
36
 
# File 'lib/oci/core/models/create_volume_backup_policy_assignment_details.rb', line 28

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

.swagger_types ⇒ Object

Attribute type mapping.



39
40
41
42
43
44
45
46
47
 
# File 'lib/oci/core/models/create_volume_backup_policy_assignment_details.rb', line 39

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



90
91
92
93
94
95
96
97
 
# File 'lib/oci/core/models/create_volume_backup_policy_assignment_details.rb', line 90

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

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



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/core/models/create_volume_backup_policy_assignment_details.rb', line 122

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


102
103
104
 
# File 'lib/oci/core/models/create_volume_backup_policy_assignment_details.rb', line 102

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



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

def hash
  [asset_id, policy_id, 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



155
156
157
158
159
160
161
162
163
164
 
# File 'lib/oci/core/models/create_volume_backup_policy_assignment_details.rb', line 155

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



149
150
151
 
# File 'lib/oci/core/models/create_volume_backup_policy_assignment_details.rb', line 149

def to_s
  to_hash.to_s
end