Class VectorStoreConnectorSummary

Summary information for a VectorStoreConnector

Inheritance

object

VectorStoreConnectorSummary

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 VectorStoreConnectorSummary

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 VectorStoreConnector.

Remarks

Required

Configuration

Declaration

[Required(ErrorMessage = "Configuration is required.")]
[JsonProperty(PropertyName = "configuration")]
public ConnectorConfiguration Configuration { get; set; }

Property Value

Type	Description
ConnectorConfiguration

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

Description

Declaration

[JsonProperty(PropertyName = "description")]
public string Description { get; set; }

Property Value

Type	Description
string	An optional description of the VectorStoreConnector

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

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 VectorStoreConnector

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(StringEnumConverter))]
public VectorStoreConnector.LifecycleStateEnum? LifecycleState { get; set; }

Property Value

Type	Description
VectorStoreConnector.LifecycleStateEnum?	The lifecycle state of a VectorStoreConnector. Allowed values are: ACTIVE CREATING UPDATING DELETING DELETED FAILED

Type

Description

VectorStoreConnector.LifecycleStateEnum?

The lifecycle state of a VectorStoreConnector.
Allowed values are:

ACTIVE
CREATING
UPDATING
DELETING
DELETED
FAILED

Remarks

Required

ScheduleConfig

Declaration

[JsonProperty(PropertyName = "scheduleConfig")]
public ScheduleConfig ScheduleConfig { get; set; }

Property Value

Type	Description
ScheduleConfig

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 VectorStoreConnector was created in the format of an RFC3339 datetime string.

Remarks

Required

TimeUpdated

Declaration

[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }

Property Value

Type	Description
DateTime?	The date and time that the VectorStoreConnector was updated in the format of an RFC3339 datetime string.

VectorStoreId

Declaration

[Required(ErrorMessage = "VectorStoreId is required.")]
[JsonProperty(PropertyName = "vectorStoreId")]
public string VectorStoreId { get; set; }

Property Value

Type	Description
string	An OCID that identifies the Vector Store to which this connector is connected.

Remarks

Required