VectorStoreConnectorFileSync¶

class oci.generative_ai.models.VectorStoreConnectorFileSync(**kwargs)¶

Bases: object

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.

Attributes:

`LIFECYCLE_STATE_ACCEPTED`	A constant which can be used with the lifecycle_state property of a VectorStoreConnectorFileSync.
`LIFECYCLE_STATE_CANCELED`	A constant which can be used with the lifecycle_state property of a VectorStoreConnectorFileSync.
`LIFECYCLE_STATE_CANCELING`	A constant which can be used with the lifecycle_state property of a VectorStoreConnectorFileSync.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a VectorStoreConnectorFileSync.
`LIFECYCLE_STATE_IN_PROGRESS`	A constant which can be used with the lifecycle_state property of a VectorStoreConnectorFileSync.
`LIFECYCLE_STATE_SUCCEEDED`	A constant which can be used with the lifecycle_state property of a VectorStoreConnectorFileSync.
`TRIGGER_TYPE_MANUAL`	A constant which can be used with the trigger_type property of a VectorStoreConnectorFileSync.
`TRIGGER_TYPE_SCHEDULED`	A constant which can be used with the trigger_type property of a VectorStoreConnectorFileSync.
`compartment_id`	[Required] Gets the compartment_id of this VectorStoreConnectorFileSync.
`defined_tags`	[Required] Gets the defined_tags of this VectorStoreConnectorFileSync.
`display_name`	[Required] Gets the display_name of this VectorStoreConnectorFileSync.
`duration_in_seconds`	Gets the duration_in_seconds of this VectorStoreConnectorFileSync.
`freeform_tags`	[Required] Gets the freeform_tags of this VectorStoreConnectorFileSync.
`id`	[Required] Gets the id of this VectorStoreConnectorFileSync.
`lifecycle_details`	Gets the lifecycle_details of this VectorStoreConnectorFileSync.
`lifecycle_state`	[Required] Gets the lifecycle_state of this VectorStoreConnectorFileSync.
`stats`	Gets the stats of this VectorStoreConnectorFileSync.
`system_tags`	[Required] Gets the system_tags of this VectorStoreConnectorFileSync.
`tenant_id`	[Required] Gets the tenant_id of this VectorStoreConnectorFileSync.
`time_created`	[Required] Gets the time_created of this VectorStoreConnectorFileSync.
`time_ended`	Gets the time_ended of this VectorStoreConnectorFileSync.
`time_started`	Gets the time_started of this VectorStoreConnectorFileSync.
`trigger_type`	[Required] Gets the trigger_type of this VectorStoreConnectorFileSync.
`vector_store_connector_id`	[Required] Gets the vector_store_connector_id of this VectorStoreConnectorFileSync.

Methods:

__init__(**kwargs)

Initializes a new VectorStoreConnectorFileSync object with values from keyword arguments.

LIFECYCLE_STATE_ACCEPTED = 'ACCEPTED'¶: A constant which can be used with the lifecycle_state property of a VectorStoreConnectorFileSync. This constant has a value of “ACCEPTED”

LIFECYCLE_STATE_CANCELED = 'CANCELED'¶: A constant which can be used with the lifecycle_state property of a VectorStoreConnectorFileSync. This constant has a value of “CANCELED”

LIFECYCLE_STATE_CANCELING = 'CANCELING'¶: A constant which can be used with the lifecycle_state property of a VectorStoreConnectorFileSync. This constant has a value of “CANCELING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a VectorStoreConnectorFileSync. This constant has a value of “FAILED”

LIFECYCLE_STATE_IN_PROGRESS = 'IN_PROGRESS'¶: A constant which can be used with the lifecycle_state property of a VectorStoreConnectorFileSync. This constant has a value of “IN_PROGRESS”

LIFECYCLE_STATE_SUCCEEDED = 'SUCCEEDED'¶: A constant which can be used with the lifecycle_state property of a VectorStoreConnectorFileSync. This constant has a value of “SUCCEEDED”

TRIGGER_TYPE_MANUAL = 'MANUAL'¶: A constant which can be used with the trigger_type property of a VectorStoreConnectorFileSync. This constant has a value of “MANUAL”

TRIGGER_TYPE_SCHEDULED = 'SCHEDULED'¶: A constant which can be used with the trigger_type property of a VectorStoreConnectorFileSync. This constant has a value of “SCHEDULED”

__init__(**kwargs)¶

Initializes a new VectorStoreConnectorFileSync object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters

id (str) – The value to assign to the id property of this VectorStoreConnectorFileSync.
display_name (str) – The value to assign to the display_name property of this VectorStoreConnectorFileSync.
vector_store_connector_id (str) – The value to assign to the vector_store_connector_id property of this VectorStoreConnectorFileSync.
compartment_id (str) – The value to assign to the compartment_id property of this VectorStoreConnectorFileSync.
tenant_id (str) – The value to assign to the tenant_id property of this VectorStoreConnectorFileSync.
time_created (datetime) – The value to assign to the time_created property of this VectorStoreConnectorFileSync.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this VectorStoreConnectorFileSync. Allowed values for this property are: “ACCEPTED”, “IN_PROGRESS”, “FAILED”, “SUCCEEDED”, “CANCELING”, “CANCELED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this VectorStoreConnectorFileSync.
time_started (datetime) – The value to assign to the time_started property of this VectorStoreConnectorFileSync.
time_ended (datetime) – The value to assign to the time_ended property of this VectorStoreConnectorFileSync.
duration_in_seconds (int) – The value to assign to the duration_in_seconds property of this VectorStoreConnectorFileSync.
trigger_type (str) – The value to assign to the trigger_type property of this VectorStoreConnectorFileSync. Allowed values for this property are: “MANUAL”, “SCHEDULED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
stats (oci.generative_ai.models.VectorStoreConnectorStats) – The value to assign to the stats property of this VectorStoreConnectorFileSync.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this VectorStoreConnectorFileSync.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this VectorStoreConnectorFileSync.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this VectorStoreConnectorFileSync.

property compartment_id¶

[Required] Gets the compartment_id of this VectorStoreConnectorFileSync. Owning compartment OCID for a VectorStoreConnectorFileSync.

Returns: The compartment_id of this VectorStoreConnectorFileSync.
Return type: str

property defined_tags¶

[Required] Gets the defined_tags of this VectorStoreConnectorFileSync. 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: The defined_tags of this VectorStoreConnectorFileSync.
Return type: dict(str, dict(str, object))

property display_name¶

[Required] Gets the display_name of this VectorStoreConnectorFileSync. A user-friendly name.

Returns: The display_name of this VectorStoreConnectorFileSync.
Return type: str

property duration_in_seconds¶

Gets the duration_in_seconds of this VectorStoreConnectorFileSync. The total time taken (in seconds) for the VectorStoreConnectorFileSync operation.

Returns: The duration_in_seconds of this VectorStoreConnectorFileSync.
Return type: int

property freeform_tags¶

[Required] Gets the freeform_tags of this VectorStoreConnectorFileSync. 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: The freeform_tags of this VectorStoreConnectorFileSync.
Return type: dict(str, str)

property id¶

[Required] Gets the id of this VectorStoreConnectorFileSync. An OCID that uniquely identifies a VectorStoreConnectorFileSync operation.

Returns: The id of this VectorStoreConnectorFileSync.
Return type: str

property lifecycle_details¶

Gets the lifecycle_details of this VectorStoreConnectorFileSync. A message describing the current state in more detail that can provide actionable information.

Returns: The lifecycle_details of this VectorStoreConnectorFileSync.
Return type: str

property lifecycle_state¶

[Required] Gets the lifecycle_state of this VectorStoreConnectorFileSync. The current state of the VectorStoreConnectorFileSync operation.

Allowed values for this property are: “ACCEPTED”, “IN_PROGRESS”, “FAILED”, “SUCCEEDED”, “CANCELING”, “CANCELED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns: The lifecycle_state of this VectorStoreConnectorFileSync.
Return type: str

property stats¶

Gets the stats of this VectorStoreConnectorFileSync.

Returns: The stats of this VectorStoreConnectorFileSync.
Return type: oci.generative_ai.models.VectorStoreConnectorStats

property system_tags¶

[Required] Gets the system_tags of this VectorStoreConnectorFileSync. System tags for this resource. Each key is predefined and scoped to a namespace.

Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns: The system_tags of this VectorStoreConnectorFileSync.
Return type: dict(str, dict(str, object))

property tenant_id¶

[Required] Gets the tenant_id of this VectorStoreConnectorFileSync. Owning tenant OCID for a VectorStoreConnector

Returns: The tenant_id of this VectorStoreConnectorFileSync.
Return type: str

property time_created¶

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

Returns: The time_created of this VectorStoreConnectorFileSync.
Return type: datetime

property time_ended¶

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

Returns: The time_ended of this VectorStoreConnectorFileSync.
Return type: datetime

property time_started¶

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

Returns: The time_started of this VectorStoreConnectorFileSync.
Return type: datetime

property trigger_type¶

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

Allowed values for this property are: “MANUAL”, “SCHEDULED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns: The trigger_type of this VectorStoreConnectorFileSync.
Return type: str

property vector_store_connector_id¶

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

Returns: The vector_store_connector_id of this VectorStoreConnectorFileSync.
Return type: str