Class CreateScheduleRequest

Namespace

Temporalio.Api.WorkflowService.V1

Assembly

Temporalio.dll

(-- api-linter: core::0203::optional=disabled aip.dev/not-precedent: field_behavior annotation not available in our gogo fork --)

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

Inheritance

object

CreateScheduleRequest

Implements

IMessage<CreateScheduleRequest>

IEquatable<CreateScheduleRequest>

IDeepCloneable<CreateScheduleRequest>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

CreateScheduleRequest()

public CreateScheduleRequest()

CreateScheduleRequest(CreateScheduleRequest)

public CreateScheduleRequest(CreateScheduleRequest other)

Parameters

other CreateScheduleRequest

Fields

IdentityFieldNumber

Field number for the "identity" field.

public const int IdentityFieldNumber = 5

Field Value

int

InitialPatchFieldNumber

Field number for the "initial_patch" field.

public const int InitialPatchFieldNumber = 4

Field Value

int

MemoFieldNumber

Field number for the "memo" field.

public const int MemoFieldNumber = 7

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 = 8

Field Value

int

Properties

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

InitialPatch

Optional initial patch (e.g. to run the action once immediately).

public SchedulePatch InitialPatch { get; set; }

Property Value

SchedulePatch

Memo

Memo and search attributes to attach to the schedule itself.

public Memo Memo { get; set; }

Property Value

Memo

Namespace

The namespace the schedule should be created in.

public string Namespace { get; set; }

Property Value

string

Parser

public static MessageParser<CreateScheduleRequest> Parser { get; }

Property Value

MessageParser<CreateScheduleRequest>

RequestId

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

public string RequestId { get; set; }

Property Value

string

Schedule

The schedule spec, policies, action, and initial state.

public Schedule Schedule { get; set; }

Property Value

Schedule

ScheduleId

The id of the new schedule.

public string ScheduleId { get; set; }

Property Value

string

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

Returns

CreateScheduleRequest

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

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

public bool Equals(CreateScheduleRequest other)

Parameters

other CreateScheduleRequest

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

Merges the given message into this one.

public void MergeFrom(CreateScheduleRequest other)

Parameters

other CreateScheduleRequest

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.