Class Provider

Namespace

OpenShell

Assembly

OpenShell.Sdk.dll

A provider: a named set of credentials and configuration for one provider type.

public sealed record Provider : IEquatable<Provider>

Inheritance

object

Provider

Implements

IEquatable<Provider>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

Properties

Annotations

User annotations.

public IReadOnlyDictionary<string, string> Annotations { get; init; }

Property Value

IReadOnlyDictionary<string, string>

Config

Non-secret provider configuration.

public IReadOnlyDictionary<string, string> Config { get; init; }

Property Value

IReadOnlyDictionary<string, string>

CreatedAt

Creation time.

public DateTimeOffset? CreatedAt { get; init; }

Property Value

DateTimeOffset?

CredentialExpirationTimes

Expiration times by credential key; a missing key means the credential does not expire.

public IReadOnlyDictionary<string, DateTimeOffset> CredentialExpirationTimes { get; init; }

Property Value

IReadOnlyDictionary<string, DateTimeOffset>

CredentialHandles

Handles for secrets held by gateway credential storage (read-only).

public IReadOnlyDictionary<string, CredentialHandle> CredentialHandles { get; init; }

Property Value

IReadOnlyDictionary<string, CredentialHandle>

Credentials

Secret values used for authentication. Gateways normally return these redacted.

public IReadOnlyDictionary<string, string> Credentials { get; init; }

Property Value

IReadOnlyDictionary<string, string>

DeletedAt

Deletion time, when deletion is in progress.

public DateTimeOffset? DeletedAt { get; init; }

Property Value

DateTimeOffset?

Id

Immutable identifier; empty before creation.

public string Id { get; init; }

Property Value

string

Labels

User labels.

public IReadOnlyDictionary<string, string> Labels { get; init; }

Property Value

IReadOnlyDictionary<string, string>

Name

Canonical name within the workspace.

public required string Name { get; init; }

Property Value

string

ProfileWorkspace

Workspace storing this provider's type profile; empty means platform scope.

public string ProfileWorkspace { get; init; }

Property Value

string

ResourceVersion

Optimistic-concurrency version.

public ulong ResourceVersion { get; init; }

Property Value

ulong

Type

Provider profile id this provider is created from (for example github).

public required string Type { get; init; }

Property Value

string

Workspace

Owning workspace; filled by the gateway.

public string Workspace { get; init; }

Property Value

string

Methods

ToString()

Describes the provider without printing credential values.

public override string ToString()

Returns

string