Class: AddNewCompatibleVersion
v1.UpdateWorkerBuildIdCompatibilityRequest.AddNewCompatibleVersion
Represents an AddNewCompatibleVersion.
Implements
Constructors
constructor
• new AddNewCompatibleVersion(properties?): AddNewCompatibleVersion
Constructs a new AddNewCompatibleVersion.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IAddNewCompatibleVersion | Properties to set |
Returns
Properties
existingCompatibleBuildId
• existingCompatibleBuildId: string
A build id which must already exist in the version sets known by the task queue. The new id will be stored in the set containing this id, marking it as compatible with the versions within.
Implementation of
IAddNewCompatibleVersion.existingCompatibleBuildId
makeSetDefault
• makeSetDefault: boolean
When set, establishes the compatible set being targeted as the overall default for the queue. If a different set was the current default, the targeted set will replace it as the new default.
Implementation of
IAddNewCompatibleVersion.makeSetDefault
newBuildId
• newBuildId: string
A new id to be added to an existing compatible set.
Implementation of
IAddNewCompatibleVersion.newBuildId
Methods
toJSON
▸ toJSON(): Object
Converts this AddNewCompatibleVersion to JSON.
Returns
Object
JSON object
create
▸ create(properties?): AddNewCompatibleVersion
Creates a new AddNewCompatibleVersion instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IAddNewCompatibleVersion | Properties to set |
Returns
AddNewCompatibleVersion instance
decode
▸ decode(reader, length?): AddNewCompatibleVersion
Decodes an AddNewCompatibleVersion 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
AddNewCompatibleVersion
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): AddNewCompatibleVersion
Decodes an AddNewCompatibleVersion message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
AddNewCompatibleVersion
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 AddNewCompatibleVersion message. Does not implicitly temporal.api.workflowservice.v1.UpdateWorkerBuildIdCompatibilityRequest.AddNewCompatibleVersion.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IAddNewCompatibleVersion | AddNewCompatibleVersion message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified AddNewCompatibleVersion message, length delimited. Does not implicitly temporal.api.workflowservice.v1.UpdateWorkerBuildIdCompatibilityRequest.AddNewCompatibleVersion.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IAddNewCompatibleVersion | AddNewCompatibleVersion message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): AddNewCompatibleVersion
Creates an AddNewCompatibleVersion message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
AddNewCompatibleVersion
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for AddNewCompatibleVersion
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 an AddNewCompatibleVersion message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | AddNewCompatibleVersion | AddNewCompatibleVersion |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object