Class: OCI::Dts::Models::TransferJob

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

Overview

TransferJob model.

Constant Summary collapse

DEVICE_TYPE_ENUM =
[
  DEVICE_TYPE_DISK = 'DISK'.freeze,
  DEVICE_TYPE_APPLIANCE = 'APPLIANCE'.freeze,
  DEVICE_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM =
[
  LIFECYCLE_STATE_INITIATED = 'INITIATED'.freeze,
  LIFECYCLE_STATE_PREPARING = 'PREPARING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_CLOSED = 'CLOSED'.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 = {}) ⇒ TransferJob

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String)

    The value to assign to the #id property

  • :compartment_id (String)

    The value to assign to the #compartment_id property

  • :upload_bucket_name (String)

    The value to assign to the #upload_bucket_name property

  • :display_name (String)

    The value to assign to the #display_name property

  • :label (String)

    The value to assign to the #label property

  • :creation_time (DateTime)

    The value to assign to the #creation_time property

  • :device_type (String)

    The value to assign to the #device_type property

  • :lifecycle_state (String)

    The value to assign to the #lifecycle_state property

  • :attached_transfer_appliance_labels (Array<String>)

    The value to assign to the #attached_transfer_appliance_labels property

  • :attached_transfer_package_labels (Array<String>)

    The value to assign to the #attached_transfer_package_labels property

  • :attached_transfer_device_labels (Array<String>)

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



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
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
# File 'lib/oci/dts/models/transfer_job.rb', line 140

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

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

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

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

  self.upload_bucket_name = attributes[:'uploadBucketName'] if attributes[:'uploadBucketName']

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

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

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

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

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

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

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

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

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

  self.attached_transfer_package_labels = attributes[:'attachedTransferPackageLabels'] if attributes[:'attachedTransferPackageLabels']

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

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

  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']

  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

#attached_transfer_appliance_labelsArray<String>

Transfer Appliance labels associated with this transfer Job

Returns:

  • (Array<String>)


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

def attached_transfer_appliance_labels
  @attached_transfer_appliance_labels
end

#attached_transfer_device_labelsArray<String>

Transfer Device labels associated with this transfer Job

Returns:

  • (Array<String>)


61
62
63
# File 'lib/oci/dts/models/transfer_job.rb', line 61

def attached_transfer_device_labels
  @attached_transfer_device_labels
end

#attached_transfer_package_labelsArray<String>

Transfer Package labels associated with this transfer Job

Returns:

  • (Array<String>)


57
58
59
# File 'lib/oci/dts/models/transfer_job.rb', line 57

def attached_transfer_package_labels
  @attached_transfer_package_labels
end

#compartment_idString

Returns:

  • (String)


31
32
33
# File 'lib/oci/dts/models/transfer_job.rb', line 31

def compartment_id
  @compartment_id
end

#creation_timeDateTime

Returns:

  • (DateTime)


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

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


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

def defined_tags
  @defined_tags
end

#device_typeString

Returns:

  • (String)


46
47
48
# File 'lib/oci/dts/models/transfer_job.rb', line 46

def device_type
  @device_type
end

#display_nameString

Returns:

  • (String)


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

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


69
70
71
# File 'lib/oci/dts/models/transfer_job.rb', line 69

def freeform_tags
  @freeform_tags
end

#idString

This attribute is required.

Returns:

  • (String)


28
29
30
# File 'lib/oci/dts/models/transfer_job.rb', line 28

def id
  @id
end

#labelString

Returns:

  • (String)


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

def label
  @label
end

#lifecycle_stateString

Returns:

  • (String)


49
50
51
# File 'lib/oci/dts/models/transfer_job.rb', line 49

def lifecycle_state
  @lifecycle_state
end

#upload_bucket_nameString

Returns:

  • (String)


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

def upload_bucket_name
  @upload_bucket_name
end

Class Method Details

.attribute_mapObject

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



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
# File 'lib/oci/dts/models/transfer_job.rb', line 80

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'upload_bucket_name': :'uploadBucketName',
    'display_name': :'displayName',
    'label': :'label',
    'creation_time': :'creationTime',
    'device_type': :'deviceType',
    'lifecycle_state': :'lifecycleState',
    'attached_transfer_appliance_labels': :'attachedTransferApplianceLabels',
    'attached_transfer_package_labels': :'attachedTransferPackageLabels',
    'attached_transfer_device_labels': :'attachedTransferDeviceLabels',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
# File 'lib/oci/dts/models/transfer_job.rb', line 101

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'upload_bucket_name': :'String',
    'display_name': :'String',
    'label': :'String',
    'creation_time': :'DateTime',
    'device_type': :'String',
    'lifecycle_state': :'String',
    'attached_transfer_appliance_labels': :'Array<String>',
    'attached_transfer_package_labels': :'Array<String>',
    'attached_transfer_device_labels': :'Array<String>',
    '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



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
# File 'lib/oci/dts/models/transfer_job.rb', line 250

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    upload_bucket_name == other.upload_bucket_name &&
    display_name == other.display_name &&
    label == other.label &&
    creation_time == other.creation_time &&
    device_type == other.device_type &&
    lifecycle_state == other.lifecycle_state &&
    attached_transfer_appliance_labels == other.attached_transfer_appliance_labels &&
    attached_transfer_package_labels == other.attached_transfer_package_labels &&
    attached_transfer_device_labels == other.attached_transfer_device_labels &&
    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



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
# File 'lib/oci/dts/models/transfer_job.rb', line 292

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


272
273
274
# File 'lib/oci/dts/models/transfer_job.rb', line 272

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



281
282
283
# File 'lib/oci/dts/models/transfer_job.rb', line 281

def hash
  [id, compartment_id, upload_bucket_name, display_name, label, creation_time, device_type, lifecycle_state, attached_transfer_appliance_labels, attached_transfer_package_labels, attached_transfer_device_labels, 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



325
326
327
328
329
330
331
332
333
334
# File 'lib/oci/dts/models/transfer_job.rb', line 325

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



319
320
321
# File 'lib/oci/dts/models/transfer_job.rb', line 319

def to_s
  to_hash.to_s
end