Class ApiKey

Namespace

Temporalio.Api.Cloud.Identity.V1

Assembly

Temporalio.dll

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

Inheritance

object

ApiKey

Implements

IMessage<ApiKey>

IEquatable<ApiKey>

IDeepCloneable<ApiKey>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

ApiKey()

public ApiKey()

ApiKey(ApiKey)

public ApiKey(ApiKey other)

Parameters

other ApiKey

Fields

AsyncOperationIdFieldNumber

Field number for the "async_operation_id" field.

public const int AsyncOperationIdFieldNumber = 5

Field Value

int

CreatedTimeFieldNumber

Field number for the "created_time" field.

public const int CreatedTimeFieldNumber = 6

Field Value

int

IdFieldNumber

Field number for the "id" field.

public const int IdFieldNumber = 1

Field Value

int

LastModifiedTimeFieldNumber

Field number for the "last_modified_time" field.

public const int LastModifiedTimeFieldNumber = 7

Field Value

int

ResourceVersionFieldNumber

Field number for the "resource_version" field.

public const int ResourceVersionFieldNumber = 2

Field Value

int

SpecFieldNumber

Field number for the "spec" field.

public const int SpecFieldNumber = 3

Field Value

int

StateDeprecatedFieldNumber

Field number for the "state_deprecated" field.

public const int StateDeprecatedFieldNumber = 4

Field Value

int

StateFieldNumber

Field number for the "state" field.

public const int StateFieldNumber = 8

Field Value

int

Properties

AsyncOperationId

The id of the async operation that is creating/updating/deleting the API key, if any.

public string AsyncOperationId { get; set; }

Property Value

string

CreatedTime

The date and time when the API key was created.

public Timestamp CreatedTime { get; set; }

Property Value

Timestamp

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Id

The id of the API Key.

public string Id { get; set; }

Property Value

string

LastModifiedTime

The date and time when the API key was last modified. Will not be set if the API key has never been modified.

public Timestamp LastModifiedTime { get; set; }

Property Value

Timestamp

Parser

public static MessageParser<ApiKey> Parser { get; }

Property Value

MessageParser<ApiKey>

ResourceVersion

The current version of the API key specification. The next update operation will have to include this version.

public string ResourceVersion { get; set; }

Property Value

string

Spec

The API key specification.

public ApiKeySpec Spec { get; set; }

Property Value

ApiKeySpec

State

The current state of the API key. temporal:versioning:min_version=v0.3.0 temporal:enums:replaces=state_deprecated

public ResourceState State { get; set; }

Property Value

ResourceState

StateDeprecated

The current state of the API key. Possible values: activating, activationfailed, active, updating, updatefailed, deleting, deletefailed, deleted, suspending, suspendfailed, suspended. For any failed state, reach out to Temporal Cloud support for remediation. Deprecated: Not supported after v0.3.0 api version. Use state instead. temporal:versioning:max_version=v0.3.0

[Obsolete]
public string StateDeprecated { 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 ApiKey Clone()

Returns

ApiKey

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

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

public bool Equals(ApiKey other)

Parameters

other ApiKey

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

Merges the given message into this one.

public void MergeFrom(ApiKey other)

Parameters

other ApiKey

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.