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):



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
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
# File 'lib/oci/dts/models/update_appliance_export_job_details.rb', line 187

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

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

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

  self.pickup_window_start_time = attributes[:'pickupWindowStartTime'] if attributes[:'pickupWindowStartTime']

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

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

  self.pickup_window_end_time = attributes[:'pickupWindowEndTime'] if attributes[:'pickupWindowEndTime']

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

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

  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)


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

def bucket_name
  @bucket_name
end

#customer_shipping_addressOCI::Dts::Models::ShippingAddress



87
88
89
# File 'lib/oci/dts/models/update_appliance_export_job_details.rb', line 87

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


103
104
105
# File 'lib/oci/dts/models/update_appliance_export_job_details.rb', line 103

def defined_tags
  @defined_tags
end

#display_nameString

Returns:

  • (String)


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

def display_name
  @display_name
end

#expected_return_dateDateTime

Expected return date from customer for the device, time portion should be zero.

Returns:

  • (DateTime)


76
77
78
# File 'lib/oci/dts/models/update_appliance_export_job_details.rb', line 76

def expected_return_date
  @expected_return_date
end

#first_objectString

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

Returns:

  • (String)


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

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


95
96
97
# File 'lib/oci/dts/models/update_appliance_export_job_details.rb', line 95

def freeform_tags
  @freeform_tags
end

#last_objectString

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

Returns:

  • (String)


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

def last_object
  @last_object
end

#lifecycle_stateString

Returns:

  • (String)


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

def lifecycle_state
  @lifecycle_state
end

#lifecycle_state_detailsString

A property that can contain details on the lifecycle.

Returns:

  • (String)


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

def lifecycle_state_details
  @lifecycle_state_details
end

#manifest_fileString

Manifest File associated with this export job.

Returns:

  • (String)


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

def manifest_file
  @manifest_file
end

#manifest_md5String

md5 digest of the manifest file.

Returns:

  • (String)


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

def manifest_md5
  @manifest_md5
end

#next_objectString

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

Returns:

  • (String)


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

def next_object
  @next_object
end

#number_of_objectsString

Total number of objects that are exported in this job.

Returns:

  • (String)


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

def number_of_objects
  @number_of_objects
end

#pickup_window_end_timeDateTime

End time for the window to pickup the device from customer.

Returns:

  • (DateTime)


84
85
86
# File 'lib/oci/dts/models/update_appliance_export_job_details.rb', line 84

def pickup_window_end_time
  @pickup_window_end_time
end

#pickup_window_start_timeDateTime

Start time for the window to pickup the device from customer.

Returns:

  • (DateTime)


80
81
82
# File 'lib/oci/dts/models/update_appliance_export_job_details.rb', line 80

def pickup_window_start_time
  @pickup_window_start_time
end

#prefixString

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

Returns:

  • (String)


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

def prefix
  @prefix
end

#range_endString

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

Returns:

  • (String)


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

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)


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

def range_start
  @range_start
end

#total_size_in_bytesString

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

Returns:

  • (String)


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

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.



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
# File 'lib/oci/dts/models/update_appliance_export_job_details.rb', line 106

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',
    'expected_return_date': :'expectedReturnDate',
    'pickup_window_start_time': :'pickupWindowStartTime',
    'pickup_window_end_time': :'pickupWindowEndTime',
    'customer_shipping_address': :'customerShippingAddress',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
# File 'lib/oci/dts/models/update_appliance_export_job_details.rb', line 134

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',
    'expected_return_date': :'DateTime',
    'pickup_window_start_time': :'DateTime',
    'pickup_window_end_time': :'DateTime',
    '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



325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
# File 'lib/oci/dts/models/update_appliance_export_job_details.rb', line 325

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 &&
    expected_return_date == other.expected_return_date &&
    pickup_window_start_time == other.pickup_window_start_time &&
    pickup_window_end_time == other.pickup_window_end_time &&
    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



374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
# File 'lib/oci/dts/models/update_appliance_export_job_details.rb', line 374

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


354
355
356
# File 'lib/oci/dts/models/update_appliance_export_job_details.rb', line 354

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



363
364
365
# File 'lib/oci/dts/models/update_appliance_export_job_details.rb', line 363

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, expected_return_date, pickup_window_start_time, pickup_window_end_time, 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



407
408
409
410
411
412
413
414
415
416
# File 'lib/oci/dts/models/update_appliance_export_job_details.rb', line 407

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



401
402
403
# File 'lib/oci/dts/models/update_appliance_export_job_details.rb', line 401

def to_s
  to_hash.to_s
end