Class UpdateScheduleRequest

Namespace

Temporalio.Api.WorkflowService.V1

Assembly

Temporalio.dll

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

Inheritance

object

UpdateScheduleRequest

Implements

IMessage<UpdateScheduleRequest>

IEquatable<UpdateScheduleRequest>

IDeepCloneable<UpdateScheduleRequest>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

UpdateScheduleRequest()

public UpdateScheduleRequest()

UpdateScheduleRequest(UpdateScheduleRequest)

public UpdateScheduleRequest(UpdateScheduleRequest other)

Parameters

other UpdateScheduleRequest

Fields

ConflictTokenFieldNumber

Field number for the "conflict_token" field.

public const int ConflictTokenFieldNumber = 4

Field Value

int

IdentityFieldNumber

Field number for the "identity" field.

public const int IdentityFieldNumber = 5

Field Value

int

NamespaceFieldNumber

Field number for the "namespace" field.

public const int NamespaceFieldNumber = 1

Field Value

int

RequestIdFieldNumber

Field number for the "request_id" field.

public const int RequestIdFieldNumber = 6

Field Value

int

ScheduleFieldNumber

Field number for the "schedule" field.

public const int ScheduleFieldNumber = 3

Field Value

int

ScheduleIdFieldNumber

Field number for the "schedule_id" field.

public const int ScheduleIdFieldNumber = 2

Field Value

int

SearchAttributesFieldNumber

Field number for the "search_attributes" field.

public const int SearchAttributesFieldNumber = 7

Field Value

int

Properties

ConflictToken

This can be the value of conflict_token from a DescribeScheduleResponse, which will cause this request to fail if the schedule has been modified between the Describe and this Update. If missing, the schedule will be updated unconditionally.

public ByteString ConflictToken { get; set; }

Property Value

ByteString

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Identity

The identity of the client who initiated this request.

public string Identity { get; set; }

Property Value

string

Namespace

The namespace of the schedule to update.

public string Namespace { get; set; }

Property Value

string

Parser

public static MessageParser<UpdateScheduleRequest> Parser { get; }

Property Value

MessageParser<UpdateScheduleRequest>

RequestId

A unique identifier for this update request for idempotence. Typically UUIDv4.

public string RequestId { get; set; }

Property Value

string

Schedule

The new schedule. The four main fields of the schedule (spec, action, policies, state) are replaced completely by the values in this message.

public Schedule Schedule { get; set; }

Property Value

Schedule

ScheduleId

The id of the schedule to update.

public string ScheduleId { get; set; }

Property Value

string

SearchAttributes

Schedule search attributes to be updated. Do not set this field if you do not want to update the search attributes. A non-null empty object will set the search attributes to an empty map. Note: you cannot only update the search attributes with UpdateScheduleRequest, you must also set the schedule field; otherwise, it will unset the schedule.

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

Returns

UpdateScheduleRequest

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

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

public bool Equals(UpdateScheduleRequest other)

Parameters

other UpdateScheduleRequest

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

Merges the given message into this one.

public void MergeFrom(UpdateScheduleRequest other)

Parameters

other UpdateScheduleRequest

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.