Class: OCI::Dts::Models::TransferPackage

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

Overview

TransferPackage model.

Constant Summary collapse

LIFECYCLE_STATE_ENUM =
[
  LIFECYCLE_STATE_PREPARING = 'PREPARING'.freeze,
  LIFECYCLE_STATE_SHIPPING = 'SHIPPING'.freeze,
  LIFECYCLE_STATE_RECEIVED = 'RECEIVED'.freeze,
  LIFECYCLE_STATE_PROCESSING = 'PROCESSING'.freeze,
  LIFECYCLE_STATE_PROCESSED = 'PROCESSED'.freeze,
  LIFECYCLE_STATE_RETURNED = 'RETURNED'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_CANCELLED = 'CANCELLED'.freeze,
  LIFECYCLE_STATE_CANCELLED_RETURNED = 'CANCELLED_RETURNED'.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 = {}) ⇒ TransferPackage

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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

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

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

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

  self.return_package_delivery_tracking_number = attributes[:'returnPackageDeliveryTrackingNumber'] if attributes[:'returnPackageDeliveryTrackingNumber']

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

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

  self.package_delivery_vendor = attributes[:'packageDeliveryVendor'] if attributes[:'packageDeliveryVendor']

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

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

  self.transfer_site_shipping_address = attributes[:'transferSiteShippingAddress'] if attributes[:'transferSiteShippingAddress']

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

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

  self.attached_transfer_device_labels = attributes[:'attachedTransferDeviceLabels'] if attributes[:'attachedTransferDeviceLabels']

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

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

Instance Attribute Details

#attached_transfer_device_labelsArray<String>

Transfer Devices attached to this Transfer Package

Returns:

  • (Array<String>)


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

def attached_transfer_device_labels
  @attached_transfer_device_labels
end

#creation_timeDateTime

Returns:

  • (DateTime)


35
36
37
# File 'lib/oci/dts/models/transfer_package.rb', line 35

def creation_time
  @creation_time
end

#labelString

This attribute is required.

Returns:

  • (String)


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

def label
  @label
end

#lifecycle_stateString

Returns:

  • (String)


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

def lifecycle_state
  @lifecycle_state
end

#original_package_delivery_tracking_numberString

Returns:

  • (String)


38
39
40
# File 'lib/oci/dts/models/transfer_package.rb', line 38

def original_package_delivery_tracking_number
  @original_package_delivery_tracking_number
end

#package_delivery_vendorString

Returns:

  • (String)


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

def package_delivery_vendor
  @package_delivery_vendor
end

#return_package_delivery_tracking_numberString

Returns:

  • (String)


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

def return_package_delivery_tracking_number
  @return_package_delivery_tracking_number
end

#transfer_job_idString

Returns:

  • (String)


32
33
34
# File 'lib/oci/dts/models/transfer_package.rb', line 32

def transfer_job_id
  @transfer_job_id
end

#transfer_site_shipping_addressString

Returns:

  • (String)


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

def transfer_site_shipping_address
  @transfer_site_shipping_address
end

Class Method Details

.attribute_mapObject

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



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
# File 'lib/oci/dts/models/transfer_package.rb', line 54

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'label': :'label',
    'lifecycle_state': :'lifecycleState',
    'transfer_job_id': :'transferJobId',
    'creation_time': :'creationTime',
    'original_package_delivery_tracking_number': :'originalPackageDeliveryTrackingNumber',
    'return_package_delivery_tracking_number': :'returnPackageDeliveryTrackingNumber',
    'package_delivery_vendor': :'packageDeliveryVendor',
    'transfer_site_shipping_address': :'transferSiteShippingAddress',
    'attached_transfer_device_labels': :'attachedTransferDeviceLabels'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
# File 'lib/oci/dts/models/transfer_package.rb', line 71

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'label': :'String',
    'lifecycle_state': :'String',
    'transfer_job_id': :'String',
    'creation_time': :'DateTime',
    'original_package_delivery_tracking_number': :'String',
    'return_package_delivery_tracking_number': :'String',
    'package_delivery_vendor': :'String',
    'transfer_site_shipping_address': :'String',
    'attached_transfer_device_labels': :'Array<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



179
180
181
182
183
184
185
186
187
188
189
190
191
192
# File 'lib/oci/dts/models/transfer_package.rb', line 179

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 &&
    creation_time == other.creation_time &&
    original_package_delivery_tracking_number == other.original_package_delivery_tracking_number &&
    return_package_delivery_tracking_number == other.return_package_delivery_tracking_number &&
    package_delivery_vendor == other.package_delivery_vendor &&
    transfer_site_shipping_address == other.transfer_site_shipping_address &&
    attached_transfer_device_labels == other.attached_transfer_device_labels
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



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
# File 'lib/oci/dts/models/transfer_package.rb', line 217

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


197
198
199
# File 'lib/oci/dts/models/transfer_package.rb', line 197

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



206
207
208
# File 'lib/oci/dts/models/transfer_package.rb', line 206

def hash
  [label, lifecycle_state, transfer_job_id, creation_time, original_package_delivery_tracking_number, return_package_delivery_tracking_number, package_delivery_vendor, transfer_site_shipping_address, attached_transfer_device_labels].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



250
251
252
253
254
255
256
257
258
259
# File 'lib/oci/dts/models/transfer_package.rb', line 250

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



244
245
246
# File 'lib/oci/dts/models/transfer_package.rb', line 244

def to_s
  to_hash.to_s
end