Class protos.google.cloud.tasks.v2beta3.Task (2.5.0)

Represents a Task.

Package

@google-cloud/tasks

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.tasks.v2beta3.ITask);

Constructs a new Task.

Parameter
Name Description
properties ITask

Properties to set

Properties

appEngineHttpRequest

public appEngineHttpRequest?: (google.cloud.tasks.v2beta3.IAppEngineHttpRequest|null);

Task appEngineHttpRequest.

createTime

public createTime?: (google.protobuf.ITimestamp|null);

Task createTime.

dispatchCount

public dispatchCount: number;

Task dispatchCount.

dispatchDeadline

public dispatchDeadline?: (google.protobuf.IDuration|null);

Task dispatchDeadline.

firstAttempt

public firstAttempt?: (google.cloud.tasks.v2beta3.IAttempt|null);

Task firstAttempt.

httpRequest

public httpRequest?: (google.cloud.tasks.v2beta3.IHttpRequest|null);

Task httpRequest.

lastAttempt

public lastAttempt?: (google.cloud.tasks.v2beta3.IAttempt|null);

Task lastAttempt.

name

public name: string;

Task name.

payloadType

public payloadType?: ("appEngineHttpRequest"|"httpRequest"|"pullMessage");

Task payloadType.

pullMessage

public pullMessage?: (google.cloud.tasks.v2beta3.IPullMessage|null);

Task pullMessage.

responseCount

public responseCount: number;

Task responseCount.

scheduleTime

public scheduleTime?: (google.protobuf.ITimestamp|null);

Task scheduleTime.

view

public view: (google.cloud.tasks.v2beta3.Task.View|keyof typeof google.cloud.tasks.v2beta3.Task.View);

Task view.

Methods

create(properties)

public static create(properties?: google.cloud.tasks.v2beta3.ITask): google.cloud.tasks.v2beta3.Task;

Creates a new Task instance using the specified properties.

Parameter
Name Description
properties ITask

Properties to set
Returns
Type Description
google.cloud.tasks.v2beta3.Task

Task instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.tasks.v2beta3.Task;

Decodes a Task message from the specified reader or buffer.

Parameters
Name Description
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from
length number

Message length if known beforehand
Returns
Type Description
google.cloud.tasks.v2beta3.Task

Task

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.tasks.v2beta3.Task;

Decodes a Task message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from
Returns
Type Description
google.cloud.tasks.v2beta3.Task

Task

encode(message, writer)

public static encode(message: google.cloud.tasks.v2beta3.ITask, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Task message. Does not implicitly messages.

Parameters
Name Description
message ITask

Task message or plain object to encode
writer $protobuf.Writer

Writer to encode to
Returns
Type Description
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.tasks.v2beta3.ITask, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Task message, length delimited. Does not implicitly messages.

Parameters
Name Description
message ITask

Task message or plain object to encode
writer $protobuf.Writer

Writer to encode to
Returns
Type Description
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.tasks.v2beta3.Task;

Creates a Task message from a plain object. Also converts values to their respective internal types.

Parameter
Name Description
object { [k: string]: any }

Plain object
Returns
Type Description
google.cloud.tasks.v2beta3.Task

Task

toJSON()

public toJSON(): { [k: string]: any };

Converts this Task to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.tasks.v2beta3.Task, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a Task message. Also converts values to other types if specified.

Parameters
Name Description
message google.cloud.tasks.v2beta3.Task

Task
options $protobuf.IConversionOptions

Conversion options
Returns
Type Description
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a Task message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify
Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not