Table of Contents

Class VersionDrainageInfo

Namespace
Temporalio.Api.Deployment.V1
Assembly
Temporalio.dll

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. Experimental. Worker Deployments are experimental and might significantly change in the future.

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

Constructors

VersionDrainageInfo() 

public VersionDrainageInfo()

VersionDrainageInfo(VersionDrainageInfo) 

public VersionDrainageInfo(VersionDrainageInfo other)

Parameters

other VersionDrainageInfo

Fields

LastChangedTimeFieldNumber

Field number for the "last_changed_time" field.

public const int LastChangedTimeFieldNumber = 2

Field Value

int

LastCheckedTimeFieldNumber

Field number for the "last_checked_time" field.

public const int LastCheckedTimeFieldNumber = 3

Field Value

int

StatusFieldNumber

Field number for the "status" field.

public const int StatusFieldNumber = 1

Field Value

int

Properties

Descriptor 

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

LastChangedTime

Last time the drainage status changed.

public Timestamp LastChangedTime { get; set; }

Property Value

Timestamp

LastCheckedTime

Last time the system checked for drainage of this version.

public Timestamp LastCheckedTime { get; set; }

Property Value

Timestamp

Parser 

public static MessageParser<VersionDrainageInfo> Parser { get; }

Property Value

MessageParser<VersionDrainageInfo>

Status

Set to DRAINING when the version first stops accepting new executions (is no longer current or ramping). Set to DRAINED when no more open pinned workflows exist on this version.

public VersionDrainageStatus Status { get; set; }

Property Value

VersionDrainageStatus

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

Returns

VersionDrainageInfo

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

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

public bool Equals(VersionDrainageInfo other)

Parameters

other VersionDrainageInfo

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

Merges the given message into this one.

public void MergeFrom(VersionDrainageInfo other)

Parameters

other VersionDrainageInfo

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.