Table of Contents

Class DescribeScheduleResponse

Namespace
Temporalio.Api.WorkflowService.V1
Assembly
Temporalio.dll
public sealed class DescribeScheduleResponse : IMessage<DescribeScheduleResponse>, IEquatable<DescribeScheduleResponse>, IDeepCloneable<DescribeScheduleResponse>, IBufferMessage, IMessage
Inheritance
DescribeScheduleResponse
Implements
Inherited Members

Constructors

DescribeScheduleResponse() 

public DescribeScheduleResponse()

DescribeScheduleResponse(DescribeScheduleResponse) 

public DescribeScheduleResponse(DescribeScheduleResponse other)

Parameters

other DescribeScheduleResponse

Fields

ConflictTokenFieldNumber

Field number for the "conflict_token" field.

public const int ConflictTokenFieldNumber = 5

Field Value

int

InfoFieldNumber

Field number for the "info" field.

public const int InfoFieldNumber = 2

Field Value

int

MemoFieldNumber

Field number for the "memo" field.

public const int MemoFieldNumber = 3

Field Value

int

ScheduleFieldNumber

Field number for the "schedule" field.

public const int ScheduleFieldNumber = 1

Field Value

int

SearchAttributesFieldNumber

Field number for the "search_attributes" field.

public const int SearchAttributesFieldNumber = 4

Field Value

int

Properties

ConflictToken

This value can be passed back to UpdateSchedule to ensure that the schedule was not modified between a Describe and an Update, which could lead to lost updates and other confusion.

public ByteString ConflictToken { get; set; }

Property Value

ByteString

Descriptor 

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Info

Extra schedule state info.

public ScheduleInfo Info { get; set; }

Property Value

ScheduleInfo

Memo

The memo and search attributes that the schedule was created with.

public Memo Memo { get; set; }

Property Value

Memo

Parser 

public static MessageParser<DescribeScheduleResponse> Parser { get; }

Property Value

MessageParser<DescribeScheduleResponse>

Schedule

The complete current schedule details. This may not match the schedule as created because:

  • some types of schedule specs may get compiled into others (e.g. CronString into StructuredCalendarSpec)
  • some unspecified fields may be replaced by defaults
  • some fields in the state are modified automatically
  • the schedule may have been modified by UpdateSchedule or PatchSchedule
public Schedule Schedule { get; set; }

Property Value

Schedule

SearchAttributes 

public SearchAttributes SearchAttributes { get; set; }

Property Value

SearchAttributes

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

Returns

DescribeScheduleResponse

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

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

public bool Equals(DescribeScheduleResponse other)

Parameters

other DescribeScheduleResponse

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

Merges the given message into this one.

public void MergeFrom(DescribeScheduleResponse other)

Parameters

other DescribeScheduleResponse

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.