Class: SetPatchMarker
coresdk.workflow_commands.SetPatchMarker
A request to set/check if a certain patch is present or not
Implements
Constructors
constructor
• new SetPatchMarker(properties?): SetPatchMarker
Constructs a new SetPatchMarker.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | ISetPatchMarker | Properties to set |
Returns
Properties
deprecated
• deprecated: boolean
Can be set to true to indicate that branches using this change are being removed, and all future worker deployments will only have the "with change" code in them.
Implementation of
patchId
• patchId: string
A user-chosen identifier for this patch. If the same identifier is used in multiple places in the code, those places are considered to be versioned as one unit. IE: The check call will return the same result for all of them
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this SetPatchMarker to JSON.
Returns
Object
JSON object
create
▸ create(properties?): SetPatchMarker
Creates a new SetPatchMarker instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | ISetPatchMarker | Properties to set |
Returns
SetPatchMarker instance
decode
▸ decode(reader, length?): SetPatchMarker
Decodes a SetPatchMarker 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
SetPatchMarker
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): SetPatchMarker
Decodes a SetPatchMarker message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
SetPatchMarker
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 SetPatchMarker message. Does not implicitly coresdk.workflow_commands.SetPatchMarker.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | ISetPatchMarker | SetPatchMarker message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified SetPatchMarker message, length delimited. Does not implicitly coresdk.workflow_commands.SetPatchMarker.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | ISetPatchMarker | SetPatchMarker message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): SetPatchMarker
Creates a SetPatchMarker message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
SetPatchMarker
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for SetPatchMarker
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 SetPatchMarker message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | SetPatchMarker | SetPatchMarker |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object