Class: OCI::Database::Models::UpdateBackupDestinationDetails

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

Overview

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.

Constant Summary collapse

NFS_MOUNT_TYPE_ENUM =
[
  NFS_MOUNT_TYPE_SELF_MOUNT = 'SELF_MOUNT'.freeze,
  NFS_MOUNT_TYPE_AUTOMATED_MOUNT = 'AUTOMATED_MOUNT'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateBackupDestinationDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :vpc_users (Array<String>)

    The value to assign to the #vpc_users property

  • :connection_string (String)

    The value to assign to the #connection_string property

  • :local_mount_point_path (String)

    The value to assign to the #local_mount_point_path property

  • :nfs_mount_type (String)

    The value to assign to the #nfs_mount_type property

  • :nfs_server (Array<String>)

    The value to assign to the #nfs_server property

  • :nfs_server_export (String)

    The value to assign to the #nfs_server_export property

  • :freeform_tags (Hash<String, String>)

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>)

    The value to assign to the #defined_tags property



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
# File 'lib/oci/database/models/update_backup_destination_details.rb', line 103

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

Instance Attribute Details

#connection_stringString

For a RECOVERY_APPLIANCE backup destination, the connection string for connecting to the Recovery Appliance.

Returns:

  • (String)


24
25
26
# File 'lib/oci/database/models/update_backup_destination_details.rb', line 24

def connection_string
  @connection_string
end

#defined_tagsHash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Returns:

  • (Hash<String, Hash<String, Object>>)


55
56
57
# File 'lib/oci/database/models/update_backup_destination_details.rb', line 55

def defined_tags
  @defined_tags
end

#freeform_tagsHash<String, String>

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.

Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>)


49
50
51
# File 'lib/oci/database/models/update_backup_destination_details.rb', line 49

def freeform_tags
  @freeform_tags
end

#local_mount_point_pathString

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.

Returns:

  • (String)


29
30
31
# File 'lib/oci/database/models/update_backup_destination_details.rb', line 29

def local_mount_point_path
  @local_mount_point_path
end

#nfs_mount_typeString

NFS Mount type for backup destination.

Returns:

  • (String)


33
34
35
# File 'lib/oci/database/models/update_backup_destination_details.rb', line 33

def nfs_mount_type
  @nfs_mount_type
end

#nfs_serverArray<String>

IP addresses for NFS Auto mount.

Returns:

  • (Array<String>)


37
38
39
# File 'lib/oci/database/models/update_backup_destination_details.rb', line 37

def nfs_server
  @nfs_server
end

#nfs_server_exportString

Specifies the directory on which to mount the file system

Returns:

  • (String)


41
42
43
# File 'lib/oci/database/models/update_backup_destination_details.rb', line 41

def nfs_server_export
  @nfs_server_export
end

#vpc_usersArray<String>

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

Returns:

  • (Array<String>)


20
21
22
# File 'lib/oci/database/models/update_backup_destination_details.rb', line 20

def vpc_users
  @vpc_users
end

Class Method Details

.attribute_mapObject

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



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

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

.swagger_typesObject

Attribute type mapping.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
# File 'lib/oci/database/models/update_backup_destination_details.rb', line 74

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

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object)

    the other object to be compared



173
174
175
176
177
178
179
180
181
182
183
184
185
# File 'lib/oci/database/models/update_backup_destination_details.rb', line 173

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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
# File 'lib/oci/database/models/update_backup_destination_details.rb', line 210

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


190
191
192
# File 'lib/oci/database/models/update_backup_destination_details.rb', line 190

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



199
200
201
# File 'lib/oci/database/models/update_backup_destination_details.rb', line 199

def hash
  [vpc_users, connection_string, local_mount_point_path, nfs_mount_type, nfs_server, nfs_server_export, freeform_tags, defined_tags].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



243
244
245
246
247
248
249
250
251
252
# File 'lib/oci/database/models/update_backup_destination_details.rb', line 243

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



237
238
239
# File 'lib/oci/database/models/update_backup_destination_details.rb', line 237

def to_s
  to_hash.to_s
end