class OCI::Database::Models::UpdateBackupDestinationDetails

For a RECOVERY_APPLIANCE backup destination, used to update the connection string and/or the list of VPC users. For an NFS backup destination, there are 2 mount types - Self mount used for non-autonomous ExaCC and automated mount used for autonomous on ExaCC.

Constants

NFS_MOUNT_TYPE_ENUM

Attributes

connection_string[RW]

For a RECOVERY_APPLIANCE backup destination, the connection string for connecting to the Recovery Appliance. @return [String]

defined_tags[RW]

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).

@return [Hash<String, Hash<String, Object>>]

freeform_tags[RW]

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).

Example: `{"Department": "Finance"}`

@return [Hash<String, String>]

local_mount_point_path[RW]

The local directory path on each VM cluster node where the NFS server location is mounted. The local directory path and the NFS server location must each be the same across all of the VM cluster nodes. Ensure that the NFS mount is maintained continuously on all of the VM cluster nodes.

@return [String]

nfs_mount_type[R]

NFS Mount type for backup destination. @return [String]

nfs_server[RW]

IP addresses for NFS Auto mount. @return [Array<String>]

nfs_server_export[RW]

Specifies the directory on which to mount the file system @return [String]

vpc_users[RW]

For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) users that are used to access the Recovery Appliance. @return [Array<String>]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/oci/database/models/update_backup_destination_details.rb, line 57
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'vpc_users': :'vpcUsers',
    'connection_string': :'connectionString',
    'local_mount_point_path': :'localMountPointPath',
    'nfs_mount_type': :'nfsMountType',
    'nfs_server': :'nfsServer',
    'nfs_server_export': :'nfsServerExport',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [Array<String>] :vpc_users The value to assign to the {#vpc_users} property @option attributes [String] :connection_string The value to assign to the {#connection_string} property @option attributes [String] :local_mount_point_path The value to assign to the {#local_mount_point_path} property @option attributes [String] :nfs_mount_type The value to assign to the {#nfs_mount_type} property @option attributes [Array<String>] :nfs_server The value to assign to the {#nfs_server} property @option attributes [String] :nfs_server_export The value to assign to the {#nfs_server_export} property @option attributes [Hash<String, String>] :freeform_tags The value to assign to the {#freeform_tags} property @option attributes [Hash<String, Hash<String, Object>>] :defined_tags The value to assign to the {#defined_tags} property

# File lib/oci/database/models/update_backup_destination_details.rb, line 102
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.vpc_users = attributes[:'vpcUsers'] if attributes[:'vpcUsers']

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

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

  self.connection_string = attributes[:'connectionString'] if attributes[:'connectionString']

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

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

  self.local_mount_point_path = attributes[:'localMountPointPath'] if attributes[:'localMountPointPath']

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

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

  self.nfs_mount_type = attributes[:'nfsMountType'] if attributes[:'nfsMountType']

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

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

  self.nfs_server = attributes[:'nfsServer'] if attributes[:'nfsServer']

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

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

  self.nfs_server_export = attributes[:'nfsServerExport'] if attributes[:'nfsServerExport']

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

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

  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
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/database/models/update_backup_destination_details.rb, line 73
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'vpc_users': :'Array<String>',
    'connection_string': :'String',
    'local_mount_point_path': :'String',
    'nfs_mount_type': :'String',
    'nfs_server': :'Array<String>',
    'nfs_server_export': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>'
    # rubocop:enable Style/SymbolLiteral
  }
end

Public Instance Methods

==(other) click to toggle source

Checks equality by comparing each attribute. @param [Object] other the other object to be compared

# File lib/oci/database/models/update_backup_destination_details.rb, line 172
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    vpc_users == other.vpc_users &&
    connection_string == other.connection_string &&
    local_mount_point_path == other.local_mount_point_path &&
    nfs_mount_type == other.nfs_mount_type &&
    nfs_server == other.nfs_server &&
    nfs_server_export == other.nfs_server_export &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/oci/database/models/update_backup_destination_details.rb, line 209
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) click to toggle source

@see the `==` method @param [Object] other the other object to be compared

# File lib/oci/database/models/update_backup_destination_details.rb, line 189
def eql?(other)
  self == other
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/oci/database/models/update_backup_destination_details.rb, line 198
def hash
  [vpc_users, connection_string, local_mount_point_path, nfs_mount_type, nfs_server, nfs_server_export, freeform_tags, defined_tags].hash
end
nfs_mount_type=(nfs_mount_type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] nfs_mount_type Object to be assigned

# File lib/oci/database/models/update_backup_destination_details.rb, line 161
def nfs_mount_type=(nfs_mount_type)
  raise "Invalid value for 'nfs_mount_type': this must be one of the values in NFS_MOUNT_TYPE_ENUM." if nfs_mount_type && !NFS_MOUNT_TYPE_ENUM.include?(nfs_mount_type)

  @nfs_mount_type = nfs_mount_type
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/oci/database/models/update_backup_destination_details.rb, line 242
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/oci/database/models/update_backup_destination_details.rb, line 236
def to_s
  to_hash.to_s
end

Private Instance Methods

_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/oci/database/models/update_backup_destination_details.rb, line 259
def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end