Constructor
new Task(propertiesopt)
Constructs a new Task.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.tasks.v2.ITask |
<optional> |
Properties to set |
- Implements:
-
- ITask
Members
appEngineHttpRequest
Task appEngineHttpRequest.
createTime
Task createTime.
dispatchCount
Task dispatchCount.
dispatchDeadline
Task dispatchDeadline.
firstAttempt
Task firstAttempt.
httpRequest
Task httpRequest.
lastAttempt
Task lastAttempt.
messageType
Task messageType.
name
Task name.
responseCount
Task responseCount.
scheduleTime
Task scheduleTime.
view
Task view.
View
View enum.
Properties:
| Name | Type | Description |
|---|---|---|
VIEW_UNSPECIFIED |
number |
VIEW_UNSPECIFIED value |
BASIC |
number |
BASIC value |
FULL |
number |
FULL value |
Methods
toJSON() → {Object.<string, *>}
Converts this Task to JSON.
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
JSON object |
(static) create(propertiesopt) → {google.cloud.tasks.v2.Task}
Creates a new Task instance using the specified properties.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.tasks.v2.ITask |
<optional> |
Properties to set |
Returns:
| Type | Description |
|---|---|
| google.cloud.tasks.v2.Task |
Task instance |
(static) decode(reader, lengthopt) → {google.cloud.tasks.v2.Task}
Decodes a Task message from the specified reader or buffer.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
reader |
$protobuf.Reader | Uint8Array |
Reader or buffer to decode from |
|
length |
number |
<optional> |
Message length if known beforehand |
Returns:
| Type | Description |
|---|---|
| google.cloud.tasks.v2.Task |
Task |
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
(static) decodeDelimited(reader) → {google.cloud.tasks.v2.Task}
Decodes a Task message from the specified reader or buffer, length delimited.
Parameters:
| Name | Type | Description |
|---|---|---|
reader |
$protobuf.Reader | Uint8Array |
Reader or buffer to decode from |
Returns:
| Type | Description |
|---|---|
| google.cloud.tasks.v2.Task |
Task |
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
(static) encode(message, writeropt) → {$protobuf.Writer}
Encodes the specified Task message. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.tasks.v2.ITask |
Task message or plain object to encode |
|
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
Returns:
| Type | Description |
|---|---|
| $protobuf.Writer |
Writer |
(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}
Encodes the specified Task message, length delimited. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.tasks.v2.ITask |
Task message or plain object to encode |
|
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
Returns:
| Type | Description |
|---|---|
| $protobuf.Writer |
Writer |
(static) fromObject(object) → {google.cloud.tasks.v2.Task}
Creates a Task message from a plain object. Also converts values to their respective internal types.
Parameters:
| Name | Type | Description |
|---|---|---|
object |
Object.<string, *> |
Plain object |
Returns:
| Type | Description |
|---|---|
| google.cloud.tasks.v2.Task |
Task |
(static) getTypeUrl(typeUrlPrefixopt) → {string}
Gets the default type url for Task
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
typeUrlPrefix |
string |
<optional> |
your custom typeUrlPrefix(default "type.googleapis.com") |
Returns:
| Type | Description |
|---|---|
| string |
The default type url |
(static) toObject(message, optionsopt) → {Object.<string, *>}
Creates a plain object from a Task message. Also converts values to other types if specified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.tasks.v2.Task |
Task |
|
options |
$protobuf.IConversionOptions |
<optional> |
Conversion options |
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
Plain object |
(static) verify(message) → {string|null}
Verifies a Task message.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Object.<string, *> |
Plain object to verify |
Returns:
| Type | Description |
|---|---|
| string | null |
|