Class: CommitBuildId
v1.UpdateWorkerVersioningRulesRequest.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:
- Adds an assignment rule (with full ramp) for the target Build ID at the end of the list.
- Removes all previously added assignment rules to the given target Build ID (if any).
- Removes any fully-ramped assignment rule for other Build IDs.
Implements
Constructors
constructor
• new CommitBuildId(properties?): CommitBuildId
Constructs a new CommitBuildId.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | ICommitBuildId | Properties to set |
Returns
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.
Implementation of
targetBuildId
• targetBuildId: string
CommitBuildId targetBuildId.
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this CommitBuildId to JSON.
Returns
Object
JSON object
create
▸ create(properties?): CommitBuildId
Creates a new CommitBuildId instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | ICommitBuildId | Properties to set |
Returns
CommitBuildId instance
decode
▸ decode(reader, length?): CommitBuildId
Decodes a CommitBuildId 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
CommitBuildId
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): CommitBuildId
Decodes a CommitBuildId message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
CommitBuildId
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 CommitBuildId message. Does not implicitly temporal.api.workflowservice.v1.UpdateWorkerVersioningRulesRequest.CommitBuildId.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | ICommitBuildId | CommitBuildId message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified CommitBuildId message, length delimited. Does not implicitly temporal.api.workflowservice.v1.UpdateWorkerVersioningRulesRequest.CommitBuildId.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | ICommitBuildId | CommitBuildId message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): CommitBuildId
Creates a CommitBuildId message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
CommitBuildId
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for CommitBuildId
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 CommitBuildId message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | CommitBuildId | CommitBuildId |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object