Class: OCI::Database::Models::ExternalBackupJob

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

Overview

Provides all the details that apply to an external backup job.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ExternalBackupJob

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :backup_id (String) —

    The value to assign to the #backup_id property

  • :provisioning (BOOLEAN) —

    The value to assign to the #provisioning property

  • :swift_path (String) —

    The value to assign to the #swift_path property

  • :bucket_name (String) —

    The value to assign to the #bucket_name property

  • :tag (String) —

    The value to assign to the #tag property

  • :user_name (String) —

    The value to assign to the #user_name property

  • :swift_password (String) —

    The value to assign to the #swift_password 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
119
120
121
122
123
124
 
# File 'lib/oci/database/models/external_backup_job.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.backup_id = attributes[:'backupId'] if attributes[:'backupId']

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

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

  self.provisioning = attributes[:'provisioning'] unless attributes[:'provisioning'].nil?

  self.swift_path = attributes[:'swiftPath'] if attributes[:'swiftPath']

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

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

  self.bucket_name = attributes[:'bucketName'] if attributes[:'bucketName']

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

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

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

  self.user_name = attributes[:'userName'] if attributes[:'userName']

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

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

  self.swift_password = attributes[:'swiftPassword'] if attributes[:'swiftPassword']

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

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

Instance Attribute Details

#backup_id ⇒ String

[Required] The OCID of the associated backup resource.

Returns:

  • (String) 


14
15
16
 
# File 'lib/oci/database/models/external_backup_job.rb', line 14

def backup_id
  @backup_id
end

#bucket_name ⇒ String

[Required] The name of the Swift compartment bucket where the backup should be stored.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/database/models/external_backup_job.rb', line 26

def bucket_name
  @bucket_name
end

#provisioning ⇒ BOOLEAN

[Required] An indicator for the provisioning state of the resource. If TRUE, the resource is still being provisioned.

Returns:

  • (BOOLEAN) 


18
19
20
 
# File 'lib/oci/database/models/external_backup_job.rb', line 18

def provisioning
  @provisioning
end

#swift_password ⇒ String

The auth token to use for access to the Swift compartment bucket that will store the standalone backup. For information about auth tokens, see Working with Auth Tokens.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/database/models/external_backup_job.rb', line 40

def swift_password
  @swift_password
end

#swift_path ⇒ String

[Required] The Swift path to use as a destination for the standalone backup.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/database/models/external_backup_job.rb', line 22

def swift_path
  @swift_path
end

#tag ⇒ String

[Required] The tag for RMAN to apply to the backup.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/database/models/external_backup_job.rb', line 30

def tag
  @tag
end

#user_name ⇒ String

[Required] The Swift user name to use for transferring the standalone backup to the designated Swift compartment bucket.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/database/models/external_backup_job.rb', line 34

def user_name
  @user_name
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
54
55
 
# File 'lib/oci/database/models/external_backup_job.rb', line 43

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'backup_id': :'backupId',
    'provisioning': :'provisioning',
    'swift_path': :'swiftPath',
    'bucket_name': :'bucketName',
    'tag': :'tag',
    'user_name': :'userName',
    'swift_password': :'swiftPassword'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'backup_id': :'String',
    'provisioning': :'BOOLEAN',
    'swift_path': :'String',
    'bucket_name': :'String',
    'tag': :'String',
    'user_name': :'String',
    'swift_password': :'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



133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/oci/database/models/external_backup_job.rb', line 133

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

  self.class == other.class &&
    backup_id == other.backup_id &&
    provisioning == other.provisioning &&
    swift_path == other.swift_path &&
    bucket_name == other.bucket_name &&
    tag == other.tag &&
    user_name == other.user_name &&
    swift_password == other.swift_password
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



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/oci/database/models/external_backup_job.rb', line 169

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


149
150
151
 
# File 'lib/oci/database/models/external_backup_job.rb', line 149

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



158
159
160
 
# File 'lib/oci/database/models/external_backup_job.rb', line 158

def hash
  [backup_id, provisioning, swift_path, bucket_name, tag, user_name, swift_password].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



202
203
204
205
206
207
208
209
210
211
 
# File 'lib/oci/database/models/external_backup_job.rb', line 202

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



196
197
198
 
# File 'lib/oci/database/models/external_backup_job.rb', line 196

def to_s
  to_hash.to_s
end