Class: OCI::Dts::Models::UpdateApplianceExportJobDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/dts/models/update_appliance_export_job_details.rb

Overview

UpdateApplianceExportJobDetails model.

Constant Summary collapse

LIFECYCLE_STATE_ENUM =
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_INPROGRESS = 'INPROGRESS'.freeze,
  LIFECYCLE_STATE_SUCCEEDED = 'SUCCEEDED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_CANCELLED = 'CANCELLED'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateApplianceExportJobDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :bucket_name (String)

    The value to assign to the #bucket_name property

  • :prefix (String)

    The value to assign to the #prefix property

  • :range_start (String)

    The value to assign to the #range_start property

  • :range_end (String)

    The value to assign to the #range_end property

  • :display_name (String)

    The value to assign to the #display_name property

  • :lifecycle_state (String)

    The value to assign to the #lifecycle_state property

  • :lifecycle_state_details (String)

    The value to assign to the #lifecycle_state_details property

  • :manifest_file (String)

    The value to assign to the #manifest_file property

  • :manifest_md5 (String)

    The value to assign to the #manifest_md5 property

  • :number_of_objects (String)

    The value to assign to the #number_of_objects property

  • :total_size_in_bytes (String)

    The value to assign to the #total_size_in_bytes property

  • :first_object (String)

    The value to assign to the #first_object property

  • :last_object (String)

    The value to assign to the #last_object property

  • :next_object (String)

    The value to assign to the #next_object property

  • :customer_shipping_address (OCI::Dts::Models::ShippingAddress)

    The value to assign to the #customer_shipping_address 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



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
# File 'lib/oci/dts/models/update_appliance_export_job_details.rb', line 165

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

  self.range_start = attributes[:'rangeStart'] if attributes[:'rangeStart']

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

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

  self.range_end = attributes[:'rangeEnd'] if attributes[:'rangeEnd']

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

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

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

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

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

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

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

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

  self.lifecycle_state_details = attributes[:'lifecycleStateDetails'] if attributes[:'lifecycleStateDetails']

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

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

  self.manifest_file = attributes[:'manifestFile'] if attributes[:'manifestFile']

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

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

  self.manifest_md5 = attributes[:'manifestMd5'] if attributes[:'manifestMd5']

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

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

  self.number_of_objects = attributes[:'numberOfObjects'] if attributes[:'numberOfObjects']

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

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

  self.total_size_in_bytes = attributes[:'totalSizeInBytes'] if attributes[:'totalSizeInBytes']

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

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

  self.first_object = attributes[:'firstObject'] if attributes[:'firstObject']

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

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

  self.last_object = attributes[:'lastObject'] if attributes[:'lastObject']

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

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

  self.next_object = attributes[:'nextObject'] if attributes[:'nextObject']

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

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

  self.customer_shipping_address = attributes[:'customerShippingAddress'] if attributes[:'customerShippingAddress']

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

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

  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

#bucket_nameString

Returns:

  • (String)


21
22
23
# File 'lib/oci/dts/models/update_appliance_export_job_details.rb', line 21

def bucket_name
  @bucket_name
end

#customer_shipping_addressOCI::Dts::Models::ShippingAddress



74
75
76
# File 'lib/oci/dts/models/update_appliance_export_job_details.rb', line 74

def customer_shipping_address
  @customer_shipping_address
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.

Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

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


90
91
92
# File 'lib/oci/dts/models/update_appliance_export_job_details.rb', line 90

def defined_tags
  @defined_tags
end

#display_nameString

Returns:

  • (String)


36
37
38
# File 'lib/oci/dts/models/update_appliance_export_job_details.rb', line 36

def display_name
  @display_name
end

#first_objectString

First object in the list of objects that are exported in this job.

Returns:

  • (String)


63
64
65
# File 'lib/oci/dts/models/update_appliance_export_job_details.rb', line 63

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


82
83
84
# File 'lib/oci/dts/models/update_appliance_export_job_details.rb', line 82

def freeform_tags
  @freeform_tags
end

#last_objectString

Last object in the list of objects that are exported in this job.

Returns:

  • (String)


67
68
69
# File 'lib/oci/dts/models/update_appliance_export_job_details.rb', line 67

def last_object
  @last_object
end

#lifecycle_stateString

Returns:

  • (String)


39
40
41
# File 'lib/oci/dts/models/update_appliance_export_job_details.rb', line 39

def lifecycle_state
  @lifecycle_state
end

#lifecycle_state_detailsString

A property that can contain details on the lifecycle.

Returns:

  • (String)


43
44
45
# File 'lib/oci/dts/models/update_appliance_export_job_details.rb', line 43

def lifecycle_state_details
  @lifecycle_state_details
end

#manifest_fileString

Manifest File associated with this export job.

Returns:

  • (String)


47
48
49
# File 'lib/oci/dts/models/update_appliance_export_job_details.rb', line 47

def manifest_file
  @manifest_file
end

#manifest_md5String

md5 digest of the manifest file.

Returns:

  • (String)


51
52
53
# File 'lib/oci/dts/models/update_appliance_export_job_details.rb', line 51

def manifest_md5
  @manifest_md5
end

#next_objectString

First object from which the next potential export job could start.

Returns:

  • (String)


71
72
73
# File 'lib/oci/dts/models/update_appliance_export_job_details.rb', line 71

def next_object
  @next_object
end

#number_of_objectsString

Total number of objects that are exported in this job.

Returns:

  • (String)


55
56
57
# File 'lib/oci/dts/models/update_appliance_export_job_details.rb', line 55

def number_of_objects
  @number_of_objects
end

#prefixString

List of objects with names matching this prefix would be part of this export job.

Returns:

  • (String)


25
26
27
# File 'lib/oci/dts/models/update_appliance_export_job_details.rb', line 25

def prefix
  @prefix
end

#range_endString

Object names returned by a list query must be strictly less than this parameter.

Returns:

  • (String)


33
34
35
# File 'lib/oci/dts/models/update_appliance_export_job_details.rb', line 33

def range_end
  @range_end
end

#range_startString

Object names returned by a list query must be greater or equal to this parameter.

Returns:

  • (String)


29
30
31
# File 'lib/oci/dts/models/update_appliance_export_job_details.rb', line 29

def range_start
  @range_start
end

#total_size_in_bytesString

Total size of objects in Bytes that are exported in this job.

Returns:

  • (String)


59
60
61
# File 'lib/oci/dts/models/update_appliance_export_job_details.rb', line 59

def total_size_in_bytes
  @total_size_in_bytes
end

Class Method Details

.attribute_mapObject

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



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
# File 'lib/oci/dts/models/update_appliance_export_job_details.rb', line 93

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'bucket_name': :'bucketName',
    'prefix': :'prefix',
    'range_start': :'rangeStart',
    'range_end': :'rangeEnd',
    'display_name': :'displayName',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_state_details': :'lifecycleStateDetails',
    'manifest_file': :'manifestFile',
    'manifest_md5': :'manifestMd5',
    'number_of_objects': :'numberOfObjects',
    'total_size_in_bytes': :'totalSizeInBytes',
    'first_object': :'firstObject',
    'last_object': :'lastObject',
    'next_object': :'nextObject',
    'customer_shipping_address': :'customerShippingAddress',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
# File 'lib/oci/dts/models/update_appliance_export_job_details.rb', line 118

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'bucket_name': :'String',
    'prefix': :'String',
    'range_start': :'String',
    'range_end': :'String',
    'display_name': :'String',
    'lifecycle_state': :'String',
    'lifecycle_state_details': :'String',
    'manifest_file': :'String',
    'manifest_md5': :'String',
    'number_of_objects': :'String',
    'total_size_in_bytes': :'String',
    'first_object': :'String',
    'last_object': :'String',
    'next_object': :'String',
    'customer_shipping_address': :'OCI::Dts::Models::ShippingAddress',
    '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



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
# File 'lib/oci/dts/models/update_appliance_export_job_details.rb', line 285

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

  self.class == other.class &&
    bucket_name == other.bucket_name &&
    prefix == other.prefix &&
    range_start == other.range_start &&
    range_end == other.range_end &&
    display_name == other.display_name &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_state_details == other.lifecycle_state_details &&
    manifest_file == other.manifest_file &&
    manifest_md5 == other.manifest_md5 &&
    number_of_objects == other.number_of_objects &&
    total_size_in_bytes == other.total_size_in_bytes &&
    first_object == other.first_object &&
    last_object == other.last_object &&
    next_object == other.next_object &&
    customer_shipping_address == other.customer_shipping_address &&
    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



331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
# File 'lib/oci/dts/models/update_appliance_export_job_details.rb', line 331

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


311
312
313
# File 'lib/oci/dts/models/update_appliance_export_job_details.rb', line 311

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



320
321
322
# File 'lib/oci/dts/models/update_appliance_export_job_details.rb', line 320

def hash
  [bucket_name, prefix, range_start, range_end, display_name, lifecycle_state, lifecycle_state_details, manifest_file, manifest_md5, number_of_objects, total_size_in_bytes, first_object, last_object, next_object, customer_shipping_address, 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



364
365
366
367
368
369
370
371
372
373
# File 'lib/oci/dts/models/update_appliance_export_job_details.rb', line 364

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



358
359
360
# File 'lib/oci/dts/models/update_appliance_export_job_details.rb', line 358

def to_s
  to_hash.to_s
end