Skip to main content

Class: CommitBuildId

This command is intended to be used to complete the rollout of a Build ID and cleanup unnecessary rules possibly created during a gradual rollout. Specifically, this command will make the following changes atomically:

  1. Adds an assignment rule (with full ramp) for the target Build ID at the end of the list.
  2. Removes all previously added assignment rules to the given target Build ID (if any).
  3. Removes any fully-ramped assignment rule for other Build IDs.

Properties​

force​

force: boolean

To prevent committing invalid Build IDs, we reject the request if no pollers has been seen recently for this Build ID. Use the force option to disable this validation.

targetBuildId​

targetBuildId: string

CommitBuildId targetBuildId.

Methods​

toJSON()​

toJSON(): object

Converts this CommitBuildId to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): CommitBuildId & $Properties

Creates a new CommitBuildId instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

CommitBuildId & $Properties

CommitBuildId instance

Call Signature​

static create(properties?): CommitBuildId

Creates a new CommitBuildId instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

CommitBuildId

CommitBuildId instance

decode()​

static decode(reader, length?): CommitBuildId & $Properties

Decodes a CommitBuildId message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message length if known beforehand

Returns​

CommitBuildId & $Properties

CommitBuildId

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): CommitBuildId & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

CommitBuildId & $Properties

CommitBuildId

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

Encodes the specified CommitBuildId message. Does not implicitly temporal.api.workflowservice.v1.UpdateWorkerVersioningRulesRequest.CommitBuildId.verify|verify messages.

Parameters​

message​

$Properties

CommitBuildId message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified CommitBuildId message, length delimited. Does not implicitly temporal.api.workflowservice.v1.UpdateWorkerVersioningRulesRequest.CommitBuildId.verify|verify messages.

Parameters​

message​

$Properties

CommitBuildId message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): CommitBuildId

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

Parameters​

object​

Plain object

Returns​

CommitBuildId

CommitBuildId

toObject()​

static toObject(message, options?): object

Creates a plain object from a CommitBuildId message. Also converts values to other types if specified.

Parameters​

message​

CommitBuildId

CommitBuildId

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object