Show / Hide Table of Contents

Class VectorStoreConnectorFileSync

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.

Inheritance
object
VectorStoreConnectorFileSync
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.GenerativeaiService.Models
Assembly: OCI.DotNetSDK.Generativeai.dll
Syntax
public class VectorStoreConnectorFileSync

Properties

CompartmentId

Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type Description
string

Owning compartment OCID for a VectorStoreConnectorFileSync.

Remarks

Required

DefinedTags

Declaration
[Required(ErrorMessage = "DefinedTags is required.")]
[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }
Property Value
Type Description
Dictionary<string, Dictionary<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"}}

Remarks

Required

DisplayName

Declaration
[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }
Property Value
Type Description
string

A user-friendly name.

Remarks

Required

DurationInSeconds

Declaration
[JsonProperty(PropertyName = "durationInSeconds")]
public int? DurationInSeconds { get; set; }
Property Value
Type Description
int?

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

FreeformTags

Declaration
[Required(ErrorMessage = "FreeformTags is required.")]
[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }
Property Value
Type Description
Dictionary<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"}

Remarks

Required

Id

Declaration
[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }
Property Value
Type Description
string

An OCID that uniquely identifies a VectorStoreConnectorFileSync operation.

Remarks

Required

LifecycleDetails

Declaration
[JsonProperty(PropertyName = "lifecycleDetails")]
public string LifecycleDetails { get; set; }
Property Value
Type Description
string

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

LifecycleState

Declaration
[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public VectorStoreConnectorFileSync.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
Type Description
VectorStoreConnectorFileSync.LifecycleStateEnum?

The current state of the VectorStoreConnectorFileSync operation.

Remarks

Required

Stats

Declaration
[JsonProperty(PropertyName = "stats")]
public VectorStoreConnectorStats Stats { get; set; }
Property Value
Type Description
VectorStoreConnectorStats

SystemTags

Declaration
[Required(ErrorMessage = "SystemTags is required.")]
[JsonProperty(PropertyName = "systemTags")]
public Dictionary<string, Dictionary<string, object>> SystemTags { get; set; }
Property Value
Type Description
Dictionary<string, Dictionary<string, object>>

System tags for this resource. Each key is predefined and scoped to a namespace.
Example: {"orcl-cloud": {"free-tier-retained": "true"}}

Remarks

Required

TenantId

Declaration
[Required(ErrorMessage = "TenantId is required.")]
[JsonProperty(PropertyName = "tenantId")]
public string TenantId { get; set; }
Property Value
Type Description
string

Owning tenant OCID for a VectorStoreConnector

Remarks

Required

TimeCreated

Declaration
[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }
Property Value
Type Description
DateTime?

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

Remarks

Required

TimeEnded

Declaration
[JsonProperty(PropertyName = "timeEnded")]
public DateTime? TimeEnded { get; set; }
Property Value
Type Description
DateTime?

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

TimeStarted

Declaration
[JsonProperty(PropertyName = "timeStarted")]
public DateTime? TimeStarted { get; set; }
Property Value
Type Description
DateTime?

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

TriggerType

Declaration
[Required(ErrorMessage = "TriggerType is required.")]
[JsonProperty(PropertyName = "triggerType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public VectorStoreConnectorFileSync.TriggerTypeEnum? TriggerType { get; set; }
Property Value
Type Description
VectorStoreConnectorFileSync.TriggerTypeEnum?

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

Remarks

Required

VectorStoreConnectorId

Declaration
[Required(ErrorMessage = "VectorStoreConnectorId is required.")]
[JsonProperty(PropertyName = "vectorStoreConnectorId")]
public string VectorStoreConnectorId { get; set; }
Property Value
Type Description
string

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

Remarks

Required

In this article
Back to top