Table of Contents

Class ProviderProfile

Namespace
Openshell.V1
Assembly
OpenShell.Sdk.dll

Provider type profile metadata exposed to clients.

public sealed class ProviderProfile : IMessage<ProviderProfile>, IEquatable<ProviderProfile>, IDeepCloneable<ProviderProfile>, IBufferMessage, IMessage
Inheritance
ProviderProfile
Implements
IMessage<ProviderProfile>
IDeepCloneable<ProviderProfile>
IBufferMessage
IMessage
Inherited Members

Constructors

ProviderProfile() 

public ProviderProfile()

ProviderProfile(ProviderProfile) 

public ProviderProfile(ProviderProfile other)

Parameters

other ProviderProfile

Fields

AnnotationsFieldNumber

Field number for the "annotations" field.

public const int AnnotationsFieldNumber = 11

Field Value

int

BinariesFieldNumber

Field number for the "binaries" field.

public const int BinariesFieldNumber = 7

Field Value

int

CategoryFieldNumber

Field number for the "category" field.

public const int CategoryFieldNumber = 4

Field Value

int

CredentialsFieldNumber

Field number for the "credentials" field.

public const int CredentialsFieldNumber = 5

Field Value

int

DescriptionFieldNumber

Field number for the "description" field.

public const int DescriptionFieldNumber = 3

Field Value

int

DiscoveryFieldNumber

Field number for the "discovery" field.

public const int DiscoveryFieldNumber = 9

Field Value

int

DisplayNameFieldNumber

Field number for the "display_name" field.

public const int DisplayNameFieldNumber = 2

Field Value

int

EndpointsFieldNumber

Field number for the "endpoints" field.

public const int EndpointsFieldNumber = 6

Field Value

int

FilesFieldNumber

Field number for the "files" field.

public const int FilesFieldNumber = 14

Field Value

int

IdFieldNumber

Field number for the "id" field.

public const int IdFieldNumber = 1

Field Value

int

InferenceCapableFieldNumber

Field number for the "inference_capable" field.

public const int InferenceCapableFieldNumber = 8

Field Value

int

ResourceVersionFieldNumber

Field number for the "resource_version" field.

public const int ResourceVersionFieldNumber = 10

Field Value

int

ScopeFieldNumber

Field number for the "scope" field.

public const int ScopeFieldNumber = 13

Field Value

int

SourceFieldNumber

Field number for the "source" field.

public const int SourceFieldNumber = 12

Field Value

int

Properties

Annotations

Optional non-secret annotations attached by profile sources or importers.

public MapField<string, string> Annotations { get; }

Property Value

MapField<string, string>

Binaries 

public RepeatedField<NetworkBinary> Binaries { get; }

Property Value

RepeatedField<NetworkBinary>

Category 

public ProviderProfileCategory Category { get; set; }

Property Value

ProviderProfileCategory

Credentials 

public RepeatedField<ProviderProfileCredential> Credentials { get; }

Property Value

RepeatedField<ProviderProfileCredential>

Description 

public string Description { get; set; }

Property Value

string

Descriptor 

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Discovery 

public ProviderProfileDiscovery Discovery { get; set; }

Property Value

ProviderProfileDiscovery

DisplayName 

public string DisplayName { get; set; }

Property Value

string

Endpoints 

public RepeatedField<NetworkEndpoint> Endpoints { get; }

Property Value

RepeatedField<NetworkEndpoint>

Files

EXPERIMENTAL: Non-secret files rendered from provider configuration for the workload. This API and its behavior may change or be removed.

public RepeatedField<ProviderProfileFile> Files { get; }

Property Value

RepeatedField<ProviderProfileFile>

Id 

public string Id { get; set; }

Property Value

string

InferenceCapable 

public bool InferenceCapable { get; set; }

Property Value

bool

Parser 

public static MessageParser<ProviderProfile> Parser { get; }

Property Value

MessageParser<ProviderProfile>

ResourceVersion

Storage resource version for custom profiles. Built-in profiles and new profile files use 0. Gateway responses set this for stored custom profiles. Update calls use this for optimistic concurrency.

public ulong ResourceVersion { get; set; }

Property Value

ulong

Scope

Server-set visibility: "platform", "workspace", or empty for non-scoped sources. Ignored on import/update payloads.

public string Scope { get; set; }

Property Value

string

Source

Server-set provenance: "builtin", "user", or "interceptor/{name}". Ignored on import/update payloads.

public string Source { get; set; }

Property Value

string

Methods

CalculateSize()

Calculates the size of this message in Protocol Buffer wire format, in bytes.

public int CalculateSize()

Returns

int

The number of bytes required to write this message to a coded output stream.

Clone()

Creates a deep clone of this object.

public ProviderProfile Clone()

Returns

ProviderProfile

A deep clone of this object.

Equals(ProviderProfile)

Indicates whether the current object is equal to another object of the same type.

public bool Equals(ProviderProfile other)

Parameters

other ProviderProfile

An object to compare with this object.

Returns

bool

true if the current object is equal to the other parameter; otherwise, false.

Equals(object)

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

public override bool Equals(object other)

Parameters

other object

Returns

bool

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

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current object.

MergeFrom(CodedInputStream)

Merges the data from the specified coded input stream with the current message.

public void MergeFrom(CodedInputStream input)

Parameters

input CodedInputStream

Remarks

See the user guide for precise merge semantics.

MergeFrom(ProviderProfile)

Merges the given message into this one.

public void MergeFrom(ProviderProfile other)

Parameters

other ProviderProfile

Remarks

See the user guide for precise merge semantics.

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.

WriteTo(CodedOutputStream)

Writes the data to the given coded output stream.

public void WriteTo(CodedOutputStream output)

Parameters

output CodedOutputStream

Coded output stream to write the data to. Must not be null.