Class CredentialHandle

Namespace

Openshell.Datamodel.V1

Assembly

OpenShell.Sdk.dll

Opaque handle for a provider credential stored by gateway credential storage. Handles are created by OpenShell and must not be authored by users.

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

Inheritance

object

CredentialHandle

Implements

IMessage<CredentialHandle>

IEquatable<CredentialHandle>

IDeepCloneable<CredentialHandle>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

CredentialHandle()

public CredentialHandle()

CredentialHandle(CredentialHandle)

public CredentialHandle(CredentialHandle other)

Parameters

other CredentialHandle

Fields

DriverFieldNumber

Field number for the "driver" field.

public const int DriverFieldNumber = 1

Field Value

int

HandleFieldNumber

Field number for the "handle" field.

public const int HandleFieldNumber = 2

Field Value

int

MetadataFieldNumber

Field number for the "metadata" field.

public const int MetadataFieldNumber = 3

Field Value

int

Properties

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Driver

Internal storage owner or credential driver that owns this handle.

public string Driver { get; set; }

Property Value

string

Handle

Owner-owned opaque handle string.

public string Handle { get; set; }

Property Value

string

Metadata

Owner-owned non-secret metadata.

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

Property Value

MapField<string, string>

Parser

public static MessageParser<CredentialHandle> Parser { get; }

Property Value

MessageParser<CredentialHandle>

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 CredentialHandle Clone()

Returns

CredentialHandle

A deep clone of this object.

Equals(CredentialHandle)

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

public bool Equals(CredentialHandle other)

Parameters

other CredentialHandle

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

Merges the given message into this one.

public void MergeFrom(CredentialHandle other)

Parameters

other CredentialHandle

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.