Class protos.google.dataflow.v1beta3.WorkItemDetails (1.2.0)

Version 1.2.0

• 3.0.2 (latest)
• 2.1.2
• 2.0.1
• 1.2.0
• 1.1.0
• 1.0.2

Represents a WorkItemDetails.

Package

@google-cloud/dataflow

Constructors

(constructor)(properties)

constructor(properties?: google.dataflow.v1beta3.IWorkItemDetails);

Constructs a new WorkItemDetails.

Parameter

Name	Description
properties	IWorkItemDetails Properties to set

Properties

attemptId

public attemptId: string;

WorkItemDetails attemptId.

endTime

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

WorkItemDetails endTime.

metrics

public metrics: google.dataflow.v1beta3.IMetricUpdate[];

WorkItemDetails metrics.

progress

public progress?: (google.dataflow.v1beta3.IProgressTimeseries|null);

WorkItemDetails progress.

startTime

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

WorkItemDetails startTime.

state

public state: (google.dataflow.v1beta3.ExecutionState|keyof typeof google.dataflow.v1beta3.ExecutionState);

WorkItemDetails state.

taskId

public taskId: string;

WorkItemDetails taskId.

Methods

create(properties)

public static create(properties?: google.dataflow.v1beta3.IWorkItemDetails): google.dataflow.v1beta3.WorkItemDetails;

Creates a new WorkItemDetails instance using the specified properties.

Parameter

Name	Description
properties	IWorkItemDetails Properties to set

Returns

Type	Description
google.dataflow.v1beta3.WorkItemDetails	WorkItemDetails instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.dataflow.v1beta3.WorkItemDetails;

Decodes a WorkItemDetails 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.dataflow.v1beta3.WorkItemDetails	WorkItemDetails

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.dataflow.v1beta3.WorkItemDetails;

Decodes a WorkItemDetails 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.dataflow.v1beta3.WorkItemDetails	WorkItemDetails

encode(message, writer)

public static encode(message: google.dataflow.v1beta3.IWorkItemDetails, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified WorkItemDetails message. Does not implicitly messages.

Parameters

Name	Description
message	IWorkItemDetails WorkItemDetails 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.dataflow.v1beta3.IWorkItemDetails, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	IWorkItemDetails WorkItemDetails 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.dataflow.v1beta3.WorkItemDetails;

Creates a WorkItemDetails 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.dataflow.v1beta3.WorkItemDetails	WorkItemDetails

toJSON()

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

Converts this WorkItemDetails to JSON.

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

public static toObject(message: google.dataflow.v1beta3.WorkItemDetails, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters

Name	Description
message	google.dataflow.v1beta3.WorkItemDetails WorkItemDetails
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 WorkItemDetails 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