Class: OCI::GenerativeAiAgent::Models::DataIngestionJobSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/generative_ai_agent/models/data_ingestion_job_summary.rb

Overview

Summary information about a data ingestion job.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DataIngestionJobSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/oci/generative_ai_agent/models/data_ingestion_job_summary.rb', line 151

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

  self.data_source_id = attributes[:'dataSourceId'] if attributes[:'dataSourceId']

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

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

  self.data_ingestion_job_type = attributes[:'dataIngestionJobType'] if attributes[:'dataIngestionJobType']

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

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

  self.data_ingestion_job_statistics = attributes[:'dataIngestionJobStatistics'] if attributes[:'dataIngestionJobStatistics']

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

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

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

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

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

  self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

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

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

  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_details = attributes[:'lifecycleDetails'] if attributes[:'lifecycleDetails']

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

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

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

  self.system_tags = attributes[:'systemTags'] if attributes[:'systemTags']

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

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of the compartment.

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/generative_ai_agent/models/data_ingestion_job_summary.rb', line 38

def compartment_id
  @compartment_id
end

#data_ingestion_job_statistics ⇒ OCI::GenerativeAiAgent::Models::DataIngestionJobStatistics

This attribute is required.

Returns:



34
35
36
 
# File 'lib/oci/generative_ai_agent/models/data_ingestion_job_summary.rb', line 34

def data_ingestion_job_statistics
  @data_ingestion_job_statistics
end

#data_ingestion_job_type ⇒ OCI::GenerativeAiAgent::Models::DataIngestionJobType

This attribute is required.

Returns:



30
31
32
 
# File 'lib/oci/generative_ai_agent/models/data_ingestion_job_summary.rb', line 30

def data_ingestion_job_type
  @data_ingestion_job_type
end

#data_source_id ⇒ String

[Required] The OCID of the parent DataSource.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/generative_ai_agent/models/data_ingestion_job_summary.rb', line 26

def data_source_id
  @data_source_id
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

[Required] 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>>) 


78
79
80
 
# File 'lib/oci/generative_ai_agent/models/data_ingestion_job_summary.rb', line 78

def defined_tags
  @defined_tags
end

#description ⇒ String

A user-friendly description of the DataSource.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/generative_ai_agent/models/data_ingestion_job_summary.rb', line 22

def description
  @description
end

#display_name ⇒ String

[Required] A user-friendly name. Does not have to be unique, and it's changeable.

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/generative_ai_agent/models/data_ingestion_job_summary.rb', line 18

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

[Required] 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>) 


70
71
72
 
# File 'lib/oci/generative_ai_agent/models/data_ingestion_job_summary.rb', line 70

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the data ingestion job.

Returns:

  • (String) 


14
15
16
 
# File 'lib/oci/generative_ai_agent/models/data_ingestion_job_summary.rb', line 14

def id
  @id
end

#lifecycle_details ⇒ String

A message that describes the current state of the data ingestion job in more detail. For example, can be used to provide actionable information for a resource in the Failed state.

Returns:

  • (String) 


62
63
64
 
# File 'lib/oci/generative_ai_agent/models/data_ingestion_job_summary.rb', line 62

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the data ingestion job.

Returns:

  • (String) 


56
57
58
 
# File 'lib/oci/generative_ai_agent/models/data_ingestion_job_summary.rb', line 56

def lifecycle_state
  @lifecycle_state
end

#system_tags ⇒ Hash<String, Hash<String, Object>>

System tags for this resource. Each key is predefined and scoped to a namespace.

Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

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


85
86
87
 
# File 'lib/oci/generative_ai_agent/models/data_ingestion_job_summary.rb', line 85

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The date and time the data ingestion job was created, in the format defined by RFC 3339.

Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


45
46
47
 
# File 'lib/oci/generative_ai_agent/models/data_ingestion_job_summary.rb', line 45

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The date and time the data ingestion job was updated, in the format defined by RFC 3339.

Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


52
53
54
 
# File 'lib/oci/generative_ai_agent/models/data_ingestion_job_summary.rb', line 52

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/oci/generative_ai_agent/models/data_ingestion_job_summary.rb', line 88

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'description': :'description',
    'data_source_id': :'dataSourceId',
    'data_ingestion_job_type': :'dataIngestionJobType',
    'data_ingestion_job_statistics': :'dataIngestionJobStatistics',
    'compartment_id': :'compartmentId',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/oci/generative_ai_agent/models/data_ingestion_job_summary.rb', line 110

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'description': :'String',
    'data_source_id': :'String',
    'data_ingestion_job_type': :'OCI::GenerativeAiAgent::Models::DataIngestionJobType',
    'data_ingestion_job_statistics': :'OCI::GenerativeAiAgent::Models::DataIngestionJobStatistics',
    'compartment_id': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_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



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/oci/generative_ai_agent/models/data_ingestion_job_summary.rb', line 241

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    description == other.description &&
    data_source_id == other.data_source_id &&
    data_ingestion_job_type == other.data_ingestion_job_type &&
    data_ingestion_job_statistics == other.data_ingestion_job_statistics &&
    compartment_id == other.compartment_id &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_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



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/oci/generative_ai_agent/models/data_ingestion_job_summary.rb', line 284

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


264
265
266
 
# File 'lib/oci/generative_ai_agent/models/data_ingestion_job_summary.rb', line 264

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



273
274
275
 
# File 'lib/oci/generative_ai_agent/models/data_ingestion_job_summary.rb', line 273

def hash
  [id, display_name, description, data_source_id, data_ingestion_job_type, data_ingestion_job_statistics, compartment_id, time_created, time_updated, lifecycle_state, lifecycle_details, freeform_tags, defined_tags, system_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



317
318
319
320
321
322
323
324
325
326
 
# File 'lib/oci/generative_ai_agent/models/data_ingestion_job_summary.rb', line 317

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_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



311
312
313
 
# File 'lib/oci/generative_ai_agent/models/data_ingestion_job_summary.rb', line 311

def to_s
  to_hash.to_s
end