Class ApiKeySpec

Namespace

Temporalio.Api.Cloud.Identity.V1

Assembly

Temporalio.dll

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

Inheritance

object

ApiKeySpec

Implements

IMessage<ApiKeySpec>

IEquatable<ApiKeySpec>

IDeepCloneable<ApiKeySpec>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

ApiKeySpec()

public ApiKeySpec()

ApiKeySpec(ApiKeySpec)

public ApiKeySpec(ApiKeySpec other)

Parameters

other ApiKeySpec

Fields

DescriptionFieldNumber

Field number for the "description" field.

public const int DescriptionFieldNumber = 4

Field Value

int

DisabledFieldNumber

Field number for the "disabled" field.

public const int DisabledFieldNumber = 6

Field Value

int

DisplayNameFieldNumber

Field number for the "display_name" field.

public const int DisplayNameFieldNumber = 3

Field Value

int

ExpiryTimeFieldNumber

Field number for the "expiry_time" field.

public const int ExpiryTimeFieldNumber = 5

Field Value

int

OwnerIdFieldNumber

Field number for the "owner_id" field.

public const int OwnerIdFieldNumber = 1

Field Value

int

OwnerTypeFieldNumber

Field number for the "owner_type" field.

public const int OwnerTypeFieldNumber = 2

Field Value

int

Properties

Description

The description of the API key.

public string Description { get; set; }

Property Value

string

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Disabled

True if the API key is disabled.

public bool Disabled { get; set; }

Property Value

bool

DisplayName

The display name of the API key.

public string DisplayName { get; set; }

Property Value

string

ExpiryTime

The expiry time of the API key.

public Timestamp ExpiryTime { get; set; }

Property Value

Timestamp

OwnerId

The id of the owner to create the API key for. The owner id is immutable. Once set during creation, it cannot be changed. The owner id is the id of the user when the owner type is 'user'. The owner id is the id of the service account when the owner type is 'service-account'.

public string OwnerId { get; set; }

Property Value

string

OwnerType

The type of the owner to create the API key for. The owner type is immutable. Once set during creation, it cannot be changed. Possible values: user, service-account.

public string OwnerType { get; set; }

Property Value

string

Parser

public static MessageParser<ApiKeySpec> Parser { get; }

Property Value

MessageParser<ApiKeySpec>

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

Returns

ApiKeySpec

A deep clone of this object.

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.

Equals(ApiKeySpec)

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

public bool Equals(ApiKeySpec other)

Parameters

other ApiKeySpec

An object to compare with this object.

Returns

bool

true if the current object is equal to the other parameter; 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(ApiKeySpec)

Merges the given message into this one.

public void MergeFrom(ApiKeySpec other)

Parameters

other ApiKeySpec

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.