Class: PinnedOverride

v1.VersioningOverride.PinnedOverride

Represents a PinnedOverride.

Implements

• IPinnedOverride

Constructors

constructor

• new PinnedOverride(properties?): PinnedOverride

Constructs a new PinnedOverride.

Parameters

Name	Type	Description
properties?	IPinnedOverride	Properties to set

Returns

PinnedOverride

Properties

behavior

• behavior: PinnedOverrideBehavior

Defaults to PINNED_OVERRIDE_BEHAVIOR_UNSPECIFIED. See PinnedOverrideBehavior for details.

Implementation of

IPinnedOverride.behavior

---

version

• Optional version: null | IWorkerDeploymentVersion

Specifies the Worker Deployment Version to pin this workflow to. Required if the target workflow is not already pinned to a version.

If omitted and the target workflow is already pinned, the effective pinned version will be the existing pinned version.

If omitted and the target workflow is not pinned, the override request will be rejected with a PreconditionFailed error.

Implementation of

IPinnedOverride.version

Methods

toJSON

▸ toJSON(): Object

Converts this PinnedOverride to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): PinnedOverride

Creates a new PinnedOverride instance using the specified properties.

Parameters

Name	Type	Description
properties?	IPinnedOverride	Properties to set

Returns

PinnedOverride

PinnedOverride instance

---

decode

▸ decode(reader, length?): PinnedOverride

Decodes a PinnedOverride 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

PinnedOverride

PinnedOverride

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): PinnedOverride

Decodes a PinnedOverride message from the specified reader or buffer, length delimited.

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from

Returns

PinnedOverride

PinnedOverride

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 PinnedOverride message. Does not implicitly temporal.api.workflow.v1.VersioningOverride.PinnedOverride.verify|verify messages.

Parameters

Name	Type	Description
message	IPinnedOverride	PinnedOverride message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

Encodes the specified PinnedOverride message, length delimited. Does not implicitly temporal.api.workflow.v1.VersioningOverride.PinnedOverride.verify|verify messages.

Parameters

Name	Type	Description
message	IPinnedOverride	PinnedOverride message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): PinnedOverride

Creates a PinnedOverride message from a plain object. Also converts values to their respective internal types.

Parameters

Name	Type	Description
object	Object	Plain object

Returns

PinnedOverride

PinnedOverride

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for PinnedOverride

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 PinnedOverride message. Also converts values to other types if specified.

Parameters

Name	Type	Description
message	PinnedOverride	PinnedOverride
options?	IConversionOptions	Conversion options

Returns

Object

Plain object