Class ResourceReference

Namespace

FoundationaLLM.Common.Models.ResourceProviders

Assembly

FoundationaLLM.Common.dll

Resource reference used by resource providers to index the resources they manage.

public class ResourceReference

Inheritance

object

ResourceReference

Derived

AzureAIReference

AIModelReference

AgentReference

FileReference

APIEndpointReference

ContextReference

DataPipelineReference

DataSourceReference

PluginReference

VectorReference

PromptReference

Inherited Members

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

ObjectExtensions.GetPropertyValues(object, List<string>)

Properties

Deleted

Indicates whether the resource has been logically deleted.

public bool Deleted { get; set; }

Property Value

bool

Filename

The filename of the resource.

public required string Filename { get; set; }

Property Value

string

Name

The name of the resource.

public required string Name { get; set; }

Property Value

string

ObjectId

The unique identifier of the resource.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? ObjectId { get; set; }

Property Value

string

ResourceType

The object type of the resource.

[JsonIgnore]
public virtual Type ResourceType { get; }

Property Value

Type

Remarks

Derived classes should override this property to provide the type of the resource reference.

Type

The type of the resource.

public required string Type { get; set; }

Property Value

string

Methods

Equals(object?)

Determines whether the specified object is equal to the current ResourceReference.

public override bool Equals(object? obj)

Parameters

obj object

The object to compare with the current ResourceReference.

Returns

bool

true if the specified object is equal to the current ResourceReference; otherwise, false.

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current ResourceReference.

Operators

operator ==(ResourceReference, ResourceReference)

Determines whether two specified instances of ResourceReference are equal.

public static bool operator ==(ResourceReference left, ResourceReference right)

Parameters

left ResourceReference

The first ResourceReference to compare.

right ResourceReference

The second ResourceReference to compare.

Returns

bool

true if the two ResourceReference instances are equal; otherwise, false.

operator !=(ResourceReference, ResourceReference)

Determines whether two specified instances of ResourceReference are not equal.

public static bool operator !=(ResourceReference left, ResourceReference right)

Parameters

left ResourceReference

The first ResourceReference to compare.

right ResourceReference

The second ResourceReference to compare.

Returns

bool

true if the two ResourceReference instances are not equal; otherwise, false.