Class WorkerDeploymentInfo.Types.WorkerDeploymentVersionSummary

Namespace

Temporalio.Api.Deployment.V1

Assembly

Temporalio.dll

public sealed class WorkerDeploymentInfo.Types.WorkerDeploymentVersionSummary : IMessage<WorkerDeploymentInfo.Types.WorkerDeploymentVersionSummary>, IEquatable<WorkerDeploymentInfo.Types.WorkerDeploymentVersionSummary>, IDeepCloneable<WorkerDeploymentInfo.Types.WorkerDeploymentVersionSummary>, IBufferMessage, IMessage

Inheritance

object

WorkerDeploymentInfo.Types.WorkerDeploymentVersionSummary

Implements

IMessage<WorkerDeploymentInfo.Types.WorkerDeploymentVersionSummary>

IEquatable<WorkerDeploymentInfo.Types.WorkerDeploymentVersionSummary>

IDeepCloneable<WorkerDeploymentInfo.Types.WorkerDeploymentVersionSummary>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

WorkerDeploymentVersionSummary()

public WorkerDeploymentVersionSummary()

WorkerDeploymentVersionSummary(WorkerDeploymentVersionSummary)

public WorkerDeploymentVersionSummary(WorkerDeploymentInfo.Types.WorkerDeploymentVersionSummary other)

Parameters

other WorkerDeploymentInfo.Types.WorkerDeploymentVersionSummary

Fields

CreateTimeFieldNumber

Field number for the "create_time" field.

public const int CreateTimeFieldNumber = 2

Field Value

int

CurrentSinceTimeFieldNumber

Field number for the "current_since_time" field.

public const int CurrentSinceTimeFieldNumber = 6

Field Value

int

DeploymentVersionFieldNumber

Field number for the "deployment_version" field.

public const int DeploymentVersionFieldNumber = 4

Field Value

int

DrainageInfoFieldNumber

Field number for the "drainage_info" field.

public const int DrainageInfoFieldNumber = 5

Field Value

int

DrainageStatusFieldNumber

Field number for the "drainage_status" field.

public const int DrainageStatusFieldNumber = 3

Field Value

int

FirstActivationTimeFieldNumber

Field number for the "first_activation_time" field.

public const int FirstActivationTimeFieldNumber = 9

Field Value

int

LastDeactivationTimeFieldNumber

Field number for the "last_deactivation_time" field.

public const int LastDeactivationTimeFieldNumber = 10

Field Value

int

RampingSinceTimeFieldNumber

Field number for the "ramping_since_time" field.

public const int RampingSinceTimeFieldNumber = 7

Field Value

int

RoutingUpdateTimeFieldNumber

Field number for the "routing_update_time" field.

public const int RoutingUpdateTimeFieldNumber = 8

Field Value

int

StatusFieldNumber

Field number for the "status" field.

public const int StatusFieldNumber = 11

Field Value

int

VersionFieldNumber

Field number for the "version" field.

public const int VersionFieldNumber = 1

Field Value

int

Properties

CreateTime

public Timestamp CreateTime { get; set; }

Property Value

Timestamp

CurrentSinceTime

Unset if not current. (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: 'Since' captures the field semantics despite being a preposition. --)

public Timestamp CurrentSinceTime { get; set; }

Property Value

Timestamp

DeploymentVersion

Required.

public WorkerDeploymentVersion DeploymentVersion { get; set; }

Property Value

WorkerDeploymentVersion

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

DrainageInfo

Information about workflow drainage to help the user determine when it is safe to decommission a Version. Not present while version is current or ramping

public VersionDrainageInfo DrainageInfo { get; set; }

Property Value

VersionDrainageInfo

DrainageStatus

Deprecated. Use drainage_info instead.

public VersionDrainageStatus DrainageStatus { get; set; }

Property Value

VersionDrainageStatus

FirstActivationTime

Timestamp when this version first became current or ramping.

public Timestamp FirstActivationTime { get; set; }

Property Value

Timestamp

LastDeactivationTime

Timestamp when this version last stopped being current or ramping.

public Timestamp LastDeactivationTime { get; set; }

Property Value

Timestamp

Parser

public static MessageParser<WorkerDeploymentInfo.Types.WorkerDeploymentVersionSummary> Parser { get; }

Property Value

MessageParser<WorkerDeploymentInfo.Types.WorkerDeploymentVersionSummary>

RampingSinceTime

Unset if not ramping. Updated when the version first starts ramping, not on each ramp change. (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: 'Since' captures the field semantics despite being a preposition. --)

public Timestamp RampingSinceTime { get; set; }

Property Value

Timestamp

RoutingUpdateTime

Last time current_since_time, ramping_since_time, or ramp_percentage` of this version changed.

public Timestamp RoutingUpdateTime { get; set; }

Property Value

Timestamp

Status

The status of the Worker Deployment Version.

public WorkerDeploymentVersionStatus Status { get; set; }

Property Value

WorkerDeploymentVersionStatus

Version

Deprecated. Use deployment_version.

[Obsolete]
public string Version { 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 WorkerDeploymentInfo.Types.WorkerDeploymentVersionSummary Clone()

Returns

WorkerDeploymentInfo.Types.WorkerDeploymentVersionSummary

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

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

public bool Equals(WorkerDeploymentInfo.Types.WorkerDeploymentVersionSummary other)

Parameters

other WorkerDeploymentInfo.Types.WorkerDeploymentVersionSummary

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

Merges the given message into this one.

public void MergeFrom(WorkerDeploymentInfo.Types.WorkerDeploymentVersionSummary other)

Parameters

other WorkerDeploymentInfo.Types.WorkerDeploymentVersionSummary

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.