Class: TaskQueueVersionSelection
taskqueue.v1.TaskQueueVersionSelection
Used for specifying versions the caller is interested in.
Implements
Constructors
constructor
• new TaskQueueVersionSelection(properties?): TaskQueueVersionSelection
Constructs a new TaskQueueVersionSelection.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | ITaskQueueVersionSelection | Properties to set |
Returns
Properties
allActive
• allActive: boolean
Include all active versions. A version is considered active if, in the last few minutes, it has had new tasks or polls, or it has been the subject of certain task queue API calls.
Implementation of
ITaskQueueVersionSelection.allActive
buildIds
• buildIds: string[]
Include specific Build IDs.
Implementation of
ITaskQueueVersionSelection.buildIds
unversioned
• unversioned: boolean
Include the unversioned queue.
Implementation of
ITaskQueueVersionSelection.unversioned
Methods
toJSON
▸ toJSON(): Object
Converts this TaskQueueVersionSelection to JSON.
Returns
Object
JSON object
create
▸ create(properties?): TaskQueueVersionSelection
Creates a new TaskQueueVersionSelection instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | ITaskQueueVersionSelection | Properties to set |
Returns
TaskQueueVersionSelection instance
decode
▸ decode(reader, length?): TaskQueueVersionSelection
Decodes a TaskQueueVersionSelection 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
TaskQueueVersionSelection
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): TaskQueueVersionSelection
Decodes a TaskQueueVersionSelection message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
TaskQueueVersionSelection
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 TaskQueueVersionSelection message. Does not implicitly temporal.api.taskqueue.v1.TaskQueueVersionSelection.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | ITaskQueueVersionSelection | TaskQueueVersionSelection message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified TaskQueueVersionSelection message, length delimited. Does not implicitly temporal.api.taskqueue.v1.TaskQueueVersionSelection.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | ITaskQueueVersionSelection | TaskQueueVersionSelection message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): TaskQueueVersionSelection
Creates a TaskQueueVersionSelection message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
TaskQueueVersionSelection
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for TaskQueueVersionSelection
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 TaskQueueVersionSelection message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | TaskQueueVersionSelection | TaskQueueVersionSelection |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object