Class: BuildIdReachability
taskqueue.v1.BuildIdReachability
Reachability of tasks for a worker by build id, in one or more task queues.
Implements
Constructors
constructor
• new BuildIdReachability(properties?): BuildIdReachability
Constructs a new BuildIdReachability.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IBuildIdReachability | Properties to set |
Returns
Properties
buildId
• buildId: string
A build id or empty if unversioned.
Implementation of
taskQueueReachability
• taskQueueReachability: ITaskQueueReachability[]
Reachability per task queue.
Implementation of
IBuildIdReachability.taskQueueReachability
Methods
toJSON
▸ toJSON(): Object
Converts this BuildIdReachability to JSON.
Returns
Object
JSON object
create
▸ create(properties?): BuildIdReachability
Creates a new BuildIdReachability instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IBuildIdReachability | Properties to set |
Returns
BuildIdReachability instance
decode
▸ decode(reader, length?): BuildIdReachability
Decodes a BuildIdReachability 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
BuildIdReachability
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): BuildIdReachability
Decodes a BuildIdReachability message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
BuildIdReachability
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 BuildIdReachability message. Does not implicitly temporal.api.taskqueue.v1.BuildIdReachability.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IBuildIdReachability | BuildIdReachability message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified BuildIdReachability message, length delimited. Does not implicitly temporal.api.taskqueue.v1.BuildIdReachability.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IBuildIdReachability | BuildIdReachability message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): BuildIdReachability
Creates a BuildIdReachability message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
BuildIdReachability
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for BuildIdReachability
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 BuildIdReachability message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | BuildIdReachability | BuildIdReachability |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object