Task

google.cloud.tasks.v2. Task

Represents a Task.

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

(static) View :number

View enum.

Properties:
Name Type Description
VIEW_UNSPECIFIED number

VIEW_UNSPECIFIED value

BASIC number

BASIC value

FULL number

FULL value

appEngineHttpRequest :google.cloud.tasks.v2.IAppEngineHttpRequest|null|undefined

Task appEngineHttpRequest.

createTime :google.protobuf.ITimestamp|null|undefined

Task createTime.

dispatchCount :number

Task dispatchCount.

dispatchDeadline :google.protobuf.IDuration|null|undefined

Task dispatchDeadline.

firstAttempt :google.cloud.tasks.v2.IAttempt|null|undefined

Task firstAttempt.

httpRequest :google.cloud.tasks.v2.IHttpRequest|null|undefined

Task httpRequest.

lastAttempt :google.cloud.tasks.v2.IAttempt|null|undefined

Task lastAttempt.

messageType :"appEngineHttpRequest"|"httpRequest"|undefined

Task messageType.

name :string

Task name.

responseCount :number

Task responseCount.

scheduleTime :google.protobuf.ITimestamp|null|undefined

Task scheduleTime.

view :google.cloud.tasks.v2.Task.View

Task view.

Methods

(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

(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

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

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

(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

(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

(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

(static) verify(message) → {string|null}

Verifies a Task message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

toJSON() → {Object.<string, *>}

Converts this Task to JSON.