Class: PatchScheduleRequest
workflowservice.v1.PatchScheduleRequest
Represents a PatchScheduleRequest.
Implements
Constructors
constructor
• new PatchScheduleRequest(properties?): PatchScheduleRequest
Constructs a new PatchScheduleRequest.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IPatchScheduleRequest | Properties to set |
Returns
Properties
identity
• identity: string
The identity of the client who initiated this request.
Implementation of
IPatchScheduleRequest.identity
namespace
• namespace: string
The namespace of the schedule to patch.
Implementation of
IPatchScheduleRequest.namespace
patch
• Optional patch: null | ISchedulePatch
PatchScheduleRequest patch.
Implementation of
requestId
• requestId: string
A unique identifier for this update request for idempotence. Typically UUIDv4.
Implementation of
IPatchScheduleRequest.requestId
scheduleId
• scheduleId: string
The id of the schedule to patch.
Implementation of
IPatchScheduleRequest.scheduleId
Methods
toJSON
▸ toJSON(): Object
Converts this PatchScheduleRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): PatchScheduleRequest
Creates a new PatchScheduleRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IPatchScheduleRequest | Properties to set |
Returns
PatchScheduleRequest instance
decode
▸ decode(reader, length?): PatchScheduleRequest
Decodes a PatchScheduleRequest 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
PatchScheduleRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): PatchScheduleRequest
Decodes a PatchScheduleRequest message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
PatchScheduleRequest
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 PatchScheduleRequest message. Does not implicitly temporal.api.workflowservice.v1.PatchScheduleRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IPatchScheduleRequest | PatchScheduleRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified PatchScheduleRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.PatchScheduleRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IPatchScheduleRequest | PatchScheduleRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): PatchScheduleRequest
Creates a PatchScheduleRequest message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
PatchScheduleRequest
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for PatchScheduleRequest
Parameters
| Name | Type | Description |
|---|---|---|
typeUrlPrefix? | string | your custom typeUrlPrefix(default "type.googleapis.com") |
Returns
string
The default type url
toObject
▸ toObject(message, options?): Object
Creates a plain object from a PatchScheduleRequest message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | PatchScheduleRequest | PatchScheduleRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object