VectorStoreConnectorFileSyncSummary¶

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

Bases: object

Summary information for a VectorStoreConnectorFileSync

Attributes:

`TRIGGER_TYPE_MANUAL`	A constant which can be used with the trigger_type property of a VectorStoreConnectorFileSyncSummary.
`TRIGGER_TYPE_SCHEDULED`	A constant which can be used with the trigger_type property of a VectorStoreConnectorFileSyncSummary.
`compartment_id`	[Required] Gets the compartment_id of this VectorStoreConnectorFileSyncSummary.
`defined_tags`	[Required] Gets the defined_tags of this VectorStoreConnectorFileSyncSummary.
`display_name`	[Required] Gets the display_name of this VectorStoreConnectorFileSyncSummary.
`duration_in_seconds`	Gets the duration_in_seconds of this VectorStoreConnectorFileSyncSummary.
`freeform_tags`	[Required] Gets the freeform_tags of this VectorStoreConnectorFileSyncSummary.
`id`	[Required] Gets the id of this VectorStoreConnectorFileSyncSummary.
`lifecycle_details`	Gets the lifecycle_details of this VectorStoreConnectorFileSyncSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this VectorStoreConnectorFileSyncSummary. The current state of the VectorStoreConnectorFileSync operation. Accepted Values are: - ACCEPTED - IN_PROGRESS - FAILED - SUCCEEDED - CANCELING - CANCELED.
`stats`	Gets the stats of this VectorStoreConnectorFileSyncSummary.
`system_tags`	[Required] Gets the system_tags of this VectorStoreConnectorFileSyncSummary.
`tenant_id`	[Required] Gets the tenant_id of this VectorStoreConnectorFileSyncSummary.
`time_created`	[Required] Gets the time_created of this VectorStoreConnectorFileSyncSummary.
`time_ended`	Gets the time_ended of this VectorStoreConnectorFileSyncSummary.
`time_started`	Gets the time_started of this VectorStoreConnectorFileSyncSummary.
`trigger_type`	[Required] Gets the trigger_type of this VectorStoreConnectorFileSyncSummary.
`vector_store_connector_id`	[Required] Gets the vector_store_connector_id of this VectorStoreConnectorFileSyncSummary.

Methods:

__init__(**kwargs)

Initializes a new VectorStoreConnectorFileSyncSummary object with values from keyword arguments.

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

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

__init__(**kwargs)¶

Initializes a new VectorStoreConnectorFileSyncSummary 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 VectorStoreConnectorFileSyncSummary.
display_name (str) – The value to assign to the display_name property of this VectorStoreConnectorFileSyncSummary.
vector_store_connector_id (str) – The value to assign to the vector_store_connector_id property of this VectorStoreConnectorFileSyncSummary.
compartment_id (str) – The value to assign to the compartment_id property of this VectorStoreConnectorFileSyncSummary.
tenant_id (str) – The value to assign to the tenant_id property of this VectorStoreConnectorFileSyncSummary.
time_created (datetime) – The value to assign to the time_created property of this VectorStoreConnectorFileSyncSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this VectorStoreConnectorFileSyncSummary.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this VectorStoreConnectorFileSyncSummary.
time_started (datetime) – The value to assign to the time_started property of this VectorStoreConnectorFileSyncSummary.
time_ended (datetime) – The value to assign to the time_ended property of this VectorStoreConnectorFileSyncSummary.
duration_in_seconds (int) – The value to assign to the duration_in_seconds property of this VectorStoreConnectorFileSyncSummary.
trigger_type (str) – The value to assign to the trigger_type property of this VectorStoreConnectorFileSyncSummary. 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 VectorStoreConnectorFileSyncSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this VectorStoreConnectorFileSyncSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this VectorStoreConnectorFileSyncSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this VectorStoreConnectorFileSyncSummary.

property compartment_id¶

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

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

property defined_tags¶

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

property display_name¶

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

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

property duration_in_seconds¶

Gets the duration_in_seconds of this VectorStoreConnectorFileSyncSummary. The duration (in seconds) taken for the VectorStoreConnectorFileSync operation to complete.

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

property freeform_tags¶

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

property id¶

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

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

property lifecycle_details¶

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

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

property lifecycle_state¶

[Required] Gets the lifecycle_state of this VectorStoreConnectorFileSyncSummary. The current state of the VectorStoreConnectorFileSync operation. Accepted Values are:

ACCEPTED

IN_PROGRESS

FAILED

SUCCEEDED

CANCELING

CANCELED

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

property stats¶

Gets the stats of this VectorStoreConnectorFileSyncSummary.

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

property system_tags¶

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

property tenant_id¶

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

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

property time_created¶

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

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

property time_ended¶

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

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

property time_started¶

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

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

property trigger_type¶

[Required] Gets the trigger_type of this VectorStoreConnectorFileSyncSummary. 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 VectorStoreConnectorFileSyncSummary.
Return type: str

property vector_store_connector_id¶

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

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