Table of Contents

Class ProviderEnvironmentValue

Namespace
Openshell.V1
Assembly
OpenShell.Sdk.dll

One environment value and all metadata that shares its key. Names are unique within a snapshot. static_credential_binding is present exactly when classification is STATIC_CREDENTIAL. Snapshots that violate either rule are invalid.

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

Constructors

ProviderEnvironmentValue()

public ProviderEnvironmentValue()

ProviderEnvironmentValue(ProviderEnvironmentValue)

public ProviderEnvironmentValue(ProviderEnvironmentValue other)

Parameters

other ProviderEnvironmentValue

Fields

ClassificationFieldNumber

Field number for the "classification" field.

public const int ClassificationFieldNumber = 4

Field Value

int

ExpirationTimeFieldNumber

Field number for the "expiration_time" field.

public const int ExpirationTimeFieldNumber = 3

Field Value

int

NameFieldNumber

Field number for the "name" field.

public const int NameFieldNumber = 1

Field Value

int

StablePlaceholderFieldNumber

Field number for the "stable_placeholder" field.

public const int StablePlaceholderFieldNumber = 6

Field Value

int

StaticCredentialBindingFieldNumber

Field number for the "static_credential_binding" field.

public const int StaticCredentialBindingFieldNumber = 5

Field Value

int

ValueFieldNumber

Field number for the "value" field.

public const int ValueFieldNumber = 2

Field Value

int

Properties

Classification

public ProviderEnvironmentValueClassification Classification { get; set; }

Property Value

ProviderEnvironmentValueClassification

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

ExpirationTime

Absolute expiration time. Absence means no expiry.

public Timestamp ExpirationTime { get; set; }

Property Value

Timestamp

Name

public string Name { get; set; }

Property Value

string

Parser

public static MessageParser<ProviderEnvironmentValue> Parser { get; }

Property Value

MessageParser<ProviderEnvironmentValue>

StablePlaceholder

The static credential keeps one opaque resolver handle across value-only provider revisions. Set only for STATIC_CREDENTIAL values whose binding carries a workload_credential_handle.

public bool StablePlaceholder { get; set; }

Property Value

bool

StaticCredentialBinding

public StaticCredentialBinding StaticCredentialBinding { get; set; }

Property Value

StaticCredentialBinding

Value

public string Value { 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 ProviderEnvironmentValue Clone()

Returns

ProviderEnvironmentValue

A deep clone of this object.

Equals(ProviderEnvironmentValue)

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

public bool Equals(ProviderEnvironmentValue other)

Parameters

other ProviderEnvironmentValue

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

Merges the given message into this one.

public void MergeFrom(ProviderEnvironmentValue other)

Parameters

other ProviderEnvironmentValue

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.