Class: OCI::Dts::Models::TransferJobSummary

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

Overview

TransferJobSummary 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 = {}) ⇒ TransferJobSummary

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

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

  • :device_type (String)

    The value to assign to the #device_type property

  • :creation_time (DateTime)

    The value to assign to the #creation_time property

  • :lifecycle_state (String)

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



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

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

#creation_timeDateTime

Returns:

  • (DateTime)


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

def creation_time
  @creation_time
end

#defined_tagsHash<String, Hash<String, Object>>

Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: ‘{"bar-key": "foo-value"}`

Returns:

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


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

def defined_tags
  @defined_tags
end

#device_typeString

Returns:

  • (String)


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

def device_type
  @device_type
end

#display_nameString

Returns:

  • (String)


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

def display_name
  @display_name
end

#freeform_tagsHash<String, String>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: ‘"value"`

Returns:

  • (Hash<String, String>)


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

def freeform_tags
  @freeform_tags
end

#idString

Returns:

  • (String)


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

def id
  @id
end

#labelString

Returns:

  • (String)


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

def label
  @label
end

#lifecycle_stateString

Returns:

  • (String)


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

def lifecycle_state
  @lifecycle_state
end

#upload_bucket_nameString

Returns:

  • (String)


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

def upload_bucket_name
  @upload_bucket_name
end

Class Method Details

.attribute_mapObject

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



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
# File 'lib/oci/dts/models/transfer_job_summary.rb', line 59

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

.swagger_typesObject

Attribute type mapping.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
# File 'lib/oci/dts/models/transfer_job_summary.rb', line 76

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



193
194
195
196
197
198
199
200
201
202
203
204
205
206
# File 'lib/oci/dts/models/transfer_job_summary.rb', line 193

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

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



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
# File 'lib/oci/dts/models/transfer_job_summary.rb', line 231

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


211
212
213
# File 'lib/oci/dts/models/transfer_job_summary.rb', line 211

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



220
221
222
# File 'lib/oci/dts/models/transfer_job_summary.rb', line 220

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



264
265
266
267
268
269
270
271
272
273
# File 'lib/oci/dts/models/transfer_job_summary.rb', line 264

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



258
259
260
# File 'lib/oci/dts/models/transfer_job_summary.rb', line 258

def to_s
  to_hash.to_s
end