Class: CreateScheduleRequest
workflowservice.v1.CreateScheduleRequest
(-- api-linter: core::0203::optional=disabled aip.dev/not-precedent: field_behavior annotation not available in our gogo fork --)
Properties
identity
• identity: string
The identity of the client who initiated this request.
initialPatch
• Optional initialPatch: null | $Properties
Optional initial patch (e.g. to run the action once immediately).
memo
• Optional memo: null | $Properties
Memo and search attributes to attach to the schedule itself.
namespace
• namespace: string
The namespace the schedule should be created in.
requestId
• requestId: string
A unique identifier for this create request for idempotence. Typically UUIDv4.
schedule
• Optional schedule: null | $Properties
The schedule spec, policies, action, and initial state.
scheduleId
• scheduleId: string
The id of the new schedule.
searchAttributes
• Optional searchAttributes: null | $Properties
CreateScheduleRequest searchAttributes.
Methods
toJSON
▸ toJSON(): Object
Converts this CreateScheduleRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): CreateScheduleRequest & $Shape
Creates a new CreateScheduleRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Shape | Properties to set |
Returns
CreateScheduleRequest & $Shape
CreateScheduleRequest instance
▸ create(properties?): CreateScheduleRequest
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): CreateScheduleRequest & $Shape
Decodes a CreateScheduleRequest message from the specified reader or buffer.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
length? | number | Message length if known beforehand |
Returns
CreateScheduleRequest & $Shape
CreateScheduleRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): CreateScheduleRequest & $Shape
Decodes a CreateScheduleRequest message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
CreateScheduleRequest & $Shape
CreateScheduleRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
encode
▸ encode(message, writer?): Writer
Encodes the specified CreateScheduleRequest message. Does not implicitly temporal.api.workflowservice.v1.CreateScheduleRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | CreateScheduleRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified CreateScheduleRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.CreateScheduleRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | CreateScheduleRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): CreateScheduleRequest
Creates a CreateScheduleRequest message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
CreateScheduleRequest
toObject
▸ toObject(message, options?): Object
Creates a plain object from a CreateScheduleRequest message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | CreateScheduleRequest | CreateScheduleRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object