Class: OCI::Dts::Models::TransferAppliance

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

Overview

TransferAppliance model.

Constant Summary collapse

LIFECYCLE_STATE_ENUM =
[
  LIFECYCLE_STATE_REQUESTED = 'REQUESTED'.freeze,
  LIFECYCLE_STATE_ORACLE_PREPARING = 'ORACLE_PREPARING'.freeze,
  LIFECYCLE_STATE_SHIPPING = 'SHIPPING'.freeze,
  LIFECYCLE_STATE_DELIVERED = 'DELIVERED'.freeze,
  LIFECYCLE_STATE_PREPARING = 'PREPARING'.freeze,
  LIFECYCLE_STATE_FINALIZED = 'FINALIZED'.freeze,
  LIFECYCLE_STATE_RETURN_LABEL_REQUESTED = 'RETURN_LABEL_REQUESTED'.freeze,
  LIFECYCLE_STATE_RETURN_LABEL_GENERATING = 'RETURN_LABEL_GENERATING'.freeze,
  LIFECYCLE_STATE_RETURN_LABEL_AVAILABLE = 'RETURN_LABEL_AVAILABLE'.freeze,
  LIFECYCLE_STATE_RETURN_DELAYED = 'RETURN_DELAYED'.freeze,
  LIFECYCLE_STATE_RETURN_SHIPPED = 'RETURN_SHIPPED'.freeze,
  LIFECYCLE_STATE_RETURN_SHIPPED_CANCELLED = 'RETURN_SHIPPED_CANCELLED'.freeze,
  LIFECYCLE_STATE_ORACLE_RECEIVED = 'ORACLE_RECEIVED'.freeze,
  LIFECYCLE_STATE_ORACLE_RECEIVED_CANCELLED = 'ORACLE_RECEIVED_CANCELLED'.freeze,
  LIFECYCLE_STATE_PROCESSING = 'PROCESSING'.freeze,
  LIFECYCLE_STATE_COMPLETE = 'COMPLETE'.freeze,
  LIFECYCLE_STATE_CUSTOMER_NEVER_RECEIVED = 'CUSTOMER_NEVER_RECEIVED'.freeze,
  LIFECYCLE_STATE_ORACLE_NEVER_RECEIVED = 'ORACLE_NEVER_RECEIVED'.freeze,
  LIFECYCLE_STATE_CUSTOMER_LOST = 'CUSTOMER_LOST'.freeze,
  LIFECYCLE_STATE_CANCELLED = 'CANCELLED'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_REJECTED = 'REJECTED'.freeze,
  LIFECYCLE_STATE_ERROR = 'ERROR'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TransferAppliance

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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

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

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

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

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

  self.serial_number = attributes[:'serialNumber'] if attributes[:'serialNumber']

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

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

  self.creation_time = attributes[:'creationTime'] if attributes[:'creationTime']

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

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

  self.customer_received_time = attributes[:'customerReceivedTime'] if attributes[:'customerReceivedTime']

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

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

  self.customer_returned_time = attributes[:'customerReturnedTime'] if attributes[:'customerReturnedTime']

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

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

  self.next_billing_time = attributes[:'nextBillingTime'] if attributes[:'nextBillingTime']

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

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

  self.delivery_security_tie_id = attributes[:'deliverySecurityTieId'] if attributes[:'deliverySecurityTieId']

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

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

  self.return_security_tie_id = attributes[:'returnSecurityTieId'] if attributes[:'returnSecurityTieId']

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

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

  self.appliance_delivery_tracking_number = attributes[:'applianceDeliveryTrackingNumber'] if attributes[:'applianceDeliveryTrackingNumber']

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

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

  self.appliance_return_delivery_tracking_number = attributes[:'applianceReturnDeliveryTrackingNumber'] if attributes[:'applianceReturnDeliveryTrackingNumber']

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

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

  self.appliance_delivery_vendor = attributes[:'applianceDeliveryVendor'] if attributes[:'applianceDeliveryVendor']

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

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

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

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

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

  self.return_shipping_label_uri = attributes[:'returnShippingLabelUri'] if attributes[:'returnShippingLabelUri']

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

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

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

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

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

Instance Attribute Details

#appliance_delivery_tracking_numberString

Returns:

  • (String)


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

def appliance_delivery_tracking_number
  @appliance_delivery_tracking_number
end

#appliance_delivery_vendorString

Returns:

  • (String)


77
78
79
# File 'lib/oci/dts/models/transfer_appliance.rb', line 77

def appliance_delivery_vendor
  @appliance_delivery_vendor
end

#appliance_return_delivery_tracking_numberString

Returns:

  • (String)


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

def appliance_return_delivery_tracking_number
  @appliance_return_delivery_tracking_number
end

#creation_timeDateTime

Returns:

  • (DateTime)


53
54
55
# File 'lib/oci/dts/models/transfer_appliance.rb', line 53

def creation_time
  @creation_time
end

#customer_received_timeDateTime

Returns:

  • (DateTime)


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

def customer_received_time
  @customer_received_time
end

#customer_returned_timeDateTime

Returns:

  • (DateTime)


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

def customer_returned_time
  @customer_returned_time
end

#customer_shipping_addressOCI::Dts::Models::ShippingAddress



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

def customer_shipping_address
  @customer_shipping_address
end

#delivery_security_tie_idString

Returns:

  • (String)


65
66
67
# File 'lib/oci/dts/models/transfer_appliance.rb', line 65

def delivery_security_tie_id
  @delivery_security_tie_id
end

#expected_return_dateDateTime

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

Returns:

  • (DateTime)


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

def expected_return_date
  @expected_return_date
end

#labelString

[Required] Unique alpha-numeric identifier for a transfer appliance auto generated during create.

Returns:

  • (String)


41
42
43
# File 'lib/oci/dts/models/transfer_appliance.rb', line 41

def label
  @label
end

#lifecycle_stateString

Returns:

  • (String)


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

def lifecycle_state
  @lifecycle_state
end

#minimum_storage_capacity_in_terabytesInteger

Minimum storage capacity of the device, in terabytes. Valid options are 50, 95 and 150.

Returns:

  • (Integer)


102
103
104
# File 'lib/oci/dts/models/transfer_appliance.rb', line 102

def minimum_storage_capacity_in_terabytes
  @minimum_storage_capacity_in_terabytes
end

#next_billing_timeDateTime

Returns:

  • (DateTime)


62
63
64
# File 'lib/oci/dts/models/transfer_appliance.rb', line 62

def next_billing_time
  @next_billing_time
end

#pickup_window_end_timeDateTime

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

Returns:

  • (DateTime)


98
99
100
# File 'lib/oci/dts/models/transfer_appliance.rb', line 98

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)


94
95
96
# File 'lib/oci/dts/models/transfer_appliance.rb', line 94

def pickup_window_start_time
  @pickup_window_start_time
end

#return_security_tie_idString

Returns:

  • (String)


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

def return_security_tie_id
  @return_security_tie_id
end

#return_shipping_label_uriString

Returns:

  • (String)


86
87
88
# File 'lib/oci/dts/models/transfer_appliance.rb', line 86

def return_shipping_label_uri
  @return_shipping_label_uri
end

#serial_numberString

Returns:

  • (String)


50
51
52
# File 'lib/oci/dts/models/transfer_appliance.rb', line 50

def serial_number
  @serial_number
end

#transfer_job_idString

Returns:

  • (String)


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

def transfer_job_id
  @transfer_job_id
end

#upload_status_log_uriString

Returns:

  • (String)


83
84
85
# File 'lib/oci/dts/models/transfer_appliance.rb', line 83

def upload_status_log_uri
  @upload_status_log_uri
end

Class Method Details

.attribute_mapObject

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'label': :'label',
    'lifecycle_state': :'lifecycleState',
    'transfer_job_id': :'transferJobId',
    'serial_number': :'serialNumber',
    'creation_time': :'creationTime',
    'customer_received_time': :'customerReceivedTime',
    'customer_returned_time': :'customerReturnedTime',
    'next_billing_time': :'nextBillingTime',
    'delivery_security_tie_id': :'deliverySecurityTieId',
    'return_security_tie_id': :'returnSecurityTieId',
    'appliance_delivery_tracking_number': :'applianceDeliveryTrackingNumber',
    'appliance_return_delivery_tracking_number': :'applianceReturnDeliveryTrackingNumber',
    'appliance_delivery_vendor': :'applianceDeliveryVendor',
    'customer_shipping_address': :'customerShippingAddress',
    'upload_status_log_uri': :'uploadStatusLogUri',
    'return_shipping_label_uri': :'returnShippingLabelUri',
    'expected_return_date': :'expectedReturnDate',
    'pickup_window_start_time': :'pickupWindowStartTime',
    'pickup_window_end_time': :'pickupWindowEndTime',
    'minimum_storage_capacity_in_terabytes': :'minimumStorageCapacityInTerabytes'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'label': :'String',
    'lifecycle_state': :'String',
    'transfer_job_id': :'String',
    'serial_number': :'String',
    'creation_time': :'DateTime',
    'customer_received_time': :'DateTime',
    'customer_returned_time': :'DateTime',
    'next_billing_time': :'DateTime',
    'delivery_security_tie_id': :'String',
    'return_security_tie_id': :'String',
    'appliance_delivery_tracking_number': :'String',
    'appliance_return_delivery_tracking_number': :'String',
    'appliance_delivery_vendor': :'String',
    'customer_shipping_address': :'OCI::Dts::Models::ShippingAddress',
    'upload_status_log_uri': :'String',
    'return_shipping_label_uri': :'String',
    'expected_return_date': :'DateTime',
    'pickup_window_start_time': :'DateTime',
    'pickup_window_end_time': :'DateTime',
    'minimum_storage_capacity_in_terabytes': :'Integer'
    # 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



329
330
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/transfer_appliance.rb', line 329

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

  self.class == other.class &&
    label == other.label &&
    lifecycle_state == other.lifecycle_state &&
    transfer_job_id == other.transfer_job_id &&
    serial_number == other.serial_number &&
    creation_time == other.creation_time &&
    customer_received_time == other.customer_received_time &&
    customer_returned_time == other.customer_returned_time &&
    next_billing_time == other.next_billing_time &&
    delivery_security_tie_id == other.delivery_security_tie_id &&
    return_security_tie_id == other.return_security_tie_id &&
    appliance_delivery_tracking_number == other.appliance_delivery_tracking_number &&
    appliance_return_delivery_tracking_number == other.appliance_return_delivery_tracking_number &&
    appliance_delivery_vendor == other.appliance_delivery_vendor &&
    customer_shipping_address == other.customer_shipping_address &&
    upload_status_log_uri == other.upload_status_log_uri &&
    return_shipping_label_uri == other.return_shipping_label_uri &&
    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 &&
    minimum_storage_capacity_in_terabytes == other.minimum_storage_capacity_in_terabytes
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



378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
# File 'lib/oci/dts/models/transfer_appliance.rb', line 378

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


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

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



367
368
369
# File 'lib/oci/dts/models/transfer_appliance.rb', line 367

def hash
  [label, lifecycle_state, transfer_job_id, serial_number, creation_time, customer_received_time, customer_returned_time, next_billing_time, delivery_security_tie_id, return_security_tie_id, appliance_delivery_tracking_number, appliance_return_delivery_tracking_number, appliance_delivery_vendor, customer_shipping_address, upload_status_log_uri, return_shipping_label_uri, expected_return_date, pickup_window_start_time, pickup_window_end_time, minimum_storage_capacity_in_terabytes].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



411
412
413
414
415
416
417
418
419
420
# File 'lib/oci/dts/models/transfer_appliance.rb', line 411

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



405
406
407
# File 'lib/oci/dts/models/transfer_appliance.rb', line 405

def to_s
  to_hash.to_s
end