Class ResourceProviderActionResult<T>

Namespace

FoundationaLLM.Common.Models.ResourceProviders

Assembly

FoundationaLLM.Common.dll

The result of an action executed by a resource provider.

public record ResourceProviderActionResult<T> : ResourceProviderActionResult, IEquatable<ResourceProviderActionResult>, IEquatable<ResourceProviderActionResult<T>> where T : ResourceBase

Type Parameters

T

Inheritance

object

ResourceProviderActionResult

ResourceProviderActionResult<T>

Implements

IEquatable<ResourceProviderActionResult>

IEquatable<ResourceProviderActionResult<T>>

Inherited Members

ResourceProviderActionResult.ObjectId

ResourceProviderActionResult.IsSuccess

ResourceProviderActionResult.ErrorMessage

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

ObjectExtensions.GetPropertyValues(object, List<string>)

Constructors

ResourceProviderActionResult(string, bool, string?)

The result of an action executed by a resource provider.

public ResourceProviderActionResult(string ObjectId, bool IsSuccessResult, string? ErrorMessage = null)

Parameters

ObjectId string

The object id to which the result refers to.

IsSuccessResult bool

Indicates whether the action executed successfully or not.

ErrorMessage string

When IsSuccess is false, contains an error message with details.

Properties

IsSuccessResult

Indicates whether the action executed successfully or not.

public bool IsSuccessResult { get; init; }

Property Value

bool

Resource

Gets or sets the resource resulting from the action.

[JsonPropertyName("resource")]
public T? Resource { get; set; }

Property Value

T

Remarks

Each resource provider will decide whether to return the resource in the action result or not.