Class ProviderProfileFile

Namespace

Openshell.V1

Assembly

OpenShell.Sdk.dll

EXPERIMENTAL: Provider file templates may change or be removed.

public sealed class ProviderProfileFile : IMessage<ProviderProfileFile>, IEquatable<ProviderProfileFile>, IDeepCloneable<ProviderProfileFile>, IBufferMessage, IMessage

Inheritance

object

ProviderProfileFile

Implements

IMessage<ProviderProfileFile>

IEquatable<ProviderProfileFile>

IDeepCloneable<ProviderProfileFile>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

ProviderProfileFile()

public ProviderProfileFile()

ProviderProfileFile(ProviderProfileFile)

public ProviderProfileFile(ProviderProfileFile other)

Parameters

other ProviderProfileFile

Fields

ContentFieldNumber

Field number for the "content" field.

public const int ContentFieldNumber = 2

Field Value

int

EnvVarFieldNumber

Field number for the "env_var" field.

public const int EnvVarFieldNumber = 3

Field Value

int

PathFieldNumber

Field number for the "path" field.

public const int PathFieldNumber = 1

Field Value

int

Properties

Content

UTF-8 template. Only {{config.KEY}} references are supported.

public string Content { get; set; }

Property Value

string

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

EnvVar

Optional environment variable containing the virtual absolute path.

public string EnvVar { get; set; }

Property Value

string

Parser

public static MessageParser<ProviderProfileFile> Parser { get; }

Property Value

MessageParser<ProviderProfileFile>

Path

One virtual file name below /run/openshell/providers/<provider>/.

public string Path { 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 ProviderProfileFile Clone()

Returns

ProviderProfileFile

A deep clone of this object.

Equals(ProviderProfileFile)

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

public bool Equals(ProviderProfileFile other)

Parameters

other ProviderProfileFile

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(ProviderProfileFile)

Merges the given message into this one.

public void MergeFrom(ProviderProfileFile other)

Parameters

other ProviderProfileFile

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.