Class: OCI::GenerativeAi::Models::VectorStoreConnectorFileSync

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/generative_ai/models/vector_store_connector_file_sync.rb

Overview

The VectorStoreConnectorFileSync is an operation that carries out the data sync operation between the datasource and the VectorStore. The FileSync can be triggered either manually or at a scheduled interval by the VectorStoreConnector.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACCEPTED = 'ACCEPTED'.freeze,
  LIFECYCLE_STATE_IN_PROGRESS = 'IN_PROGRESS'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_SUCCEEDED = 'SUCCEEDED'.freeze,
  LIFECYCLE_STATE_CANCELING = 'CANCELING'.freeze,
  LIFECYCLE_STATE_CANCELED = 'CANCELED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
TRIGGER_TYPE_ENUM = 
[
  TRIGGER_TYPE_MANUAL = 'MANUAL'.freeze,
  TRIGGER_TYPE_SCHEDULED = 'SCHEDULED'.freeze,
  TRIGGER_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ VectorStoreConnectorFileSync

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

  • :display_name (String) —

    The value to assign to the #display_name property

  • :vector_store_connector_id (String) —

    The value to assign to the #vector_store_connector_id property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :tenant_id (String) —

    The value to assign to the #tenant_id property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :lifecycle_details (String) —

    The value to assign to the #lifecycle_details property

  • :time_started (DateTime) —

    The value to assign to the #time_started property

  • :time_ended (DateTime) —

    The value to assign to the #time_ended property

  • :duration_in_seconds (Integer) —

    The value to assign to the #duration_in_seconds property

  • :trigger_type (String) —

    The value to assign to the #trigger_type property

  • :stats (OCI::GenerativeAi::Models::VectorStoreConnectorStats) —

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

  • :system_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #system_tags property



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
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
 
# File 'lib/oci/generative_ai/models/vector_store_connector_file_sync.rb', line 175

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

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

  self.vector_store_connector_id = attributes[:'vector_store_connector_id'] if attributes[:'vector_store_connector_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.tenant_id = attributes[:'tenantId'] if attributes[:'tenantId']

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

  self.tenant_id = attributes[:'tenant_id'] if attributes[:'tenant_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.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.time_started = attributes[:'timeStarted'] if attributes[:'timeStarted']

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

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

  self.time_ended = attributes[:'timeEnded'] if attributes[:'timeEnded']

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

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

  self.duration_in_seconds = attributes[:'durationInSeconds'] if attributes[:'durationInSeconds']

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

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

  self.trigger_type = attributes[:'triggerType'] if attributes[:'triggerType']

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

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

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

  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] Owning compartment OCID for a VectorStoreConnectorFileSync.

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/generative_ai/models/vector_store_connector_file_sync.rb', line 45

def compartment_id
  @compartment_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>>) 


96
97
98
 
# File 'lib/oci/generative_ai/models/vector_store_connector_file_sync.rb', line 96

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] A user-friendly name.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/generative_ai/models/vector_store_connector_file_sync.rb', line 37

def display_name
  @display_name
end

#duration_in_seconds ⇒ Integer

The total time taken (in seconds) for the VectorStoreConnectorFileSync operation.

Returns:

  • (Integer) 


73
74
75
 
# File 'lib/oci/generative_ai/models/vector_store_connector_file_sync.rb', line 73

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


88
89
90
 
# File 'lib/oci/generative_ai/models/vector_store_connector_file_sync.rb', line 88

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] An OCID that uniquely identifies a VectorStoreConnectorFileSync operation.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/generative_ai/models/vector_store_connector_file_sync.rb', line 33

def id
  @id
end

#lifecycle_details ⇒ String

A message describing the current state in more detail that can provide actionable information.

Returns:

  • (String) 


61
62
63
 
# File 'lib/oci/generative_ai/models/vector_store_connector_file_sync.rb', line 61

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the VectorStoreConnectorFileSync operation.

Returns:

  • (String) 


57
58
59
 
# File 'lib/oci/generative_ai/models/vector_store_connector_file_sync.rb', line 57

def lifecycle_state
  @lifecycle_state
end

#stats ⇒ OCI::GenerativeAi::Models::VectorStoreConnectorStats

Returns:



80
81
82
 
# File 'lib/oci/generative_ai/models/vector_store_connector_file_sync.rb', line 80

def stats
  @stats
end

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

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


103
104
105
 
# File 'lib/oci/generative_ai/models/vector_store_connector_file_sync.rb', line 103

def system_tags
  @system_tags
end

#tenant_id ⇒ String

[Required] Owning tenant OCID for a VectorStoreConnector

Returns:

  • (String) 


49
50
51
 
# File 'lib/oci/generative_ai/models/vector_store_connector_file_sync.rb', line 49

def tenant_id
  @tenant_id
end

#time_created ⇒ DateTime

[Required] The date and time that the FileSync operation was created in the format of an RFC3339 datetime string.

Returns:

  • (DateTime) 


53
54
55
 
# File 'lib/oci/generative_ai/models/vector_store_connector_file_sync.rb', line 53

def time_created
  @time_created
end

#time_ended ⇒ DateTime

The date and time when the FileSync operation has ended in the format of an RFC3339 datetime string.

Returns:

  • (DateTime) 


69
70
71
 
# File 'lib/oci/generative_ai/models/vector_store_connector_file_sync.rb', line 69

def time_ended
  @time_ended
end

#time_started ⇒ DateTime

The date and time when the FileSync operation has started in the format of an RFC3339 datetime string.

Returns:

  • (DateTime) 


65
66
67
 
# File 'lib/oci/generative_ai/models/vector_store_connector_file_sync.rb', line 65

def time_started
  @time_started
end

#trigger_type ⇒ String

[Required] The type of the FileSync operation based on how it is triggered. The type can be either MANUAL or SCHEDULED

Returns:

  • (String) 


77
78
79
 
# File 'lib/oci/generative_ai/models/vector_store_connector_file_sync.rb', line 77

def trigger_type
  @trigger_type
end

#vector_store_connector_id ⇒ String

[Required] An OCID that identifies the VectorStoreConnector under which this FileSync operation is created.

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/generative_ai/models/vector_store_connector_file_sync.rb', line 41

def vector_store_connector_id
  @vector_store_connector_id
end

Class Method Details

.attribute_map ⇒ Object

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



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/oci/generative_ai/models/vector_store_connector_file_sync.rb', line 106

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'vector_store_connector_id': :'vectorStoreConnectorId',
    'compartment_id': :'compartmentId',
    'tenant_id': :'tenantId',
    'time_created': :'timeCreated',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'time_started': :'timeStarted',
    'time_ended': :'timeEnded',
    'duration_in_seconds': :'durationInSeconds',
    'trigger_type': :'triggerType',
    'stats': :'stats',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/oci/generative_ai/models/vector_store_connector_file_sync.rb', line 130

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'vector_store_connector_id': :'String',
    'compartment_id': :'String',
    'tenant_id': :'String',
    'time_created': :'DateTime',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'time_started': :'DateTime',
    'time_ended': :'DateTime',
    'duration_in_seconds': :'Integer',
    'trigger_type': :'String',
    'stats': :'OCI::GenerativeAi::Models::VectorStoreConnectorStats',
    '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



303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/oci/generative_ai/models/vector_store_connector_file_sync.rb', line 303

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    vector_store_connector_id == other.vector_store_connector_id &&
    compartment_id == other.compartment_id &&
    tenant_id == other.tenant_id &&
    time_created == other.time_created &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    time_started == other.time_started &&
    time_ended == other.time_ended &&
    duration_in_seconds == other.duration_in_seconds &&
    trigger_type == other.trigger_type &&
    stats == other.stats &&
    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



348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'lib/oci/generative_ai/models/vector_store_connector_file_sync.rb', line 348

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


328
329
330
 
# File 'lib/oci/generative_ai/models/vector_store_connector_file_sync.rb', line 328

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



337
338
339
 
# File 'lib/oci/generative_ai/models/vector_store_connector_file_sync.rb', line 337

def hash
  [id, display_name, vector_store_connector_id, compartment_id, tenant_id, time_created, lifecycle_state, lifecycle_details, time_started, time_ended, duration_in_seconds, trigger_type, stats, 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



381
382
383
384
385
386
387
388
389
390
 
# File 'lib/oci/generative_ai/models/vector_store_connector_file_sync.rb', line 381

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



375
376
377
 
# File 'lib/oci/generative_ai/models/vector_store_connector_file_sync.rb', line 375

def to_s
  to_hash.to_s
end