Class: OCI::Database::Models::BackupDestinationDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/database/models/backup_destination_details.rb

Overview

Backup destination details

Constant Summary collapse

TYPE_ENUM =
[
  TYPE_NFS = 'NFS'.freeze,
  TYPE_RECOVERY_APPLIANCE = 'RECOVERY_APPLIANCE'.freeze,
  TYPE_OBJECT_STORE = 'OBJECT_STORE'.freeze,
  TYPE_LOCAL = 'LOCAL'.freeze,
  TYPE_DBRS = 'DBRS'.freeze,
  TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BackupDestinationDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :type (String)

    The value to assign to the #type property

  • :id (String)

    The value to assign to the #id property

  • :vpc_user (String)

    The value to assign to the #vpc_user property

  • :vpc_password (String)

    The value to assign to the #vpc_password property

  • :internet_proxy (String)

    The value to assign to the #internet_proxy property

  • :dbrs_policy_id (String)

    The value to assign to the #dbrs_policy_id property



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
113
114
115
116
117
118
# File 'lib/oci/database/models/backup_destination_details.rb', line 85

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

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

  self.vpc_user = attributes[:'vpcUser'] if attributes[:'vpcUser']

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

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

  self.vpc_password = attributes[:'vpcPassword'] if attributes[:'vpcPassword']

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

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

  self.internet_proxy = attributes[:'internetProxy'] if attributes[:'internetProxy']

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

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

  self.dbrs_policy_id = attributes[:'dbrsPolicyId'] if attributes[:'dbrsPolicyId']

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

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

Instance Attribute Details

#dbrs_policy_idString

The OCID of the DBRS policy used for backup.

Returns:

  • (String)


43
44
45
# File 'lib/oci/database/models/backup_destination_details.rb', line 43

def dbrs_policy_id
  @dbrs_policy_id
end

#idString

The OCID of the backup destination.

Returns:

  • (String)


27
28
29
# File 'lib/oci/database/models/backup_destination_details.rb', line 27

def id
  @id
end

#internet_proxyString

Proxy URL to connect to object store.

Returns:

  • (String)


39
40
41
# File 'lib/oci/database/models/backup_destination_details.rb', line 39

def internet_proxy
  @internet_proxy
end

#typeString

[Required] Type of the database backup destination.

Returns:

  • (String)


23
24
25
# File 'lib/oci/database/models/backup_destination_details.rb', line 23

def type
  @type
end

#vpc_passwordString

For a RECOVERY_APPLIANCE backup destination, the password for the VPC user that is used to access the Recovery Appliance.

Returns:

  • (String)


35
36
37
# File 'lib/oci/database/models/backup_destination_details.rb', line 35

def vpc_password
  @vpc_password
end

#vpc_userString

For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) user that is used to access the Recovery Appliance.

Returns:

  • (String)


31
32
33
# File 'lib/oci/database/models/backup_destination_details.rb', line 31

def vpc_user
  @vpc_user
end

Class Method Details

.attribute_mapObject

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



46
47
48
49
50
51
52
53
54
55
56
57
# File 'lib/oci/database/models/backup_destination_details.rb', line 46

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'type',
    'id': :'id',
    'vpc_user': :'vpcUser',
    'vpc_password': :'vpcPassword',
    'internet_proxy': :'internetProxy',
    'dbrs_policy_id': :'dbrsPolicyId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



60
61
62
63
64
65
66
67
68
69
70
71
# File 'lib/oci/database/models/backup_destination_details.rb', line 60

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'String',
    'id': :'String',
    'vpc_user': :'String',
    'vpc_password': :'String',
    'internet_proxy': :'String',
    'dbrs_policy_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



140
141
142
143
144
145
146
147
148
149
150
# File 'lib/oci/database/models/backup_destination_details.rb', line 140

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

  self.class == other.class &&
    type == other.type &&
    id == other.id &&
    vpc_user == other.vpc_user &&
    vpc_password == other.vpc_password &&
    internet_proxy == other.internet_proxy &&
    dbrs_policy_id == other.dbrs_policy_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



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
# File 'lib/oci/database/models/backup_destination_details.rb', line 175

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


155
156
157
# File 'lib/oci/database/models/backup_destination_details.rb', line 155

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



164
165
166
# File 'lib/oci/database/models/backup_destination_details.rb', line 164

def hash
  [type, id, vpc_user, vpc_password, internet_proxy, dbrs_policy_id].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



208
209
210
211
212
213
214
215
216
217
# File 'lib/oci/database/models/backup_destination_details.rb', line 208

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



202
203
204
# File 'lib/oci/database/models/backup_destination_details.rb', line 202

def to_s
  to_hash.to_s
end