Represents a WorkItemDetails.
Package
@google-cloud/dataflow!Constructors
(constructor)(properties)
constructor(properties?: google.dataflow.v1beta3.IWorkItemDetails);Constructs a new WorkItemDetails.
| Type | Name | Description |
|---|---|---|
| IWorkItemDetails | properties |
Properties to set |
Properties
attemptId
public attemptId: string;WorkItemDetails attemptId.
| Type | Description |
|---|---|
| string |
endTime
public endTime?: (google.protobuf.ITimestamp|null);WorkItemDetails endTime.
| Type | Description |
|---|---|
| (google.protobuf.ITimestamp|null) |
metrics
public metrics: google.dataflow.v1beta3.IMetricUpdate[];WorkItemDetails metrics.
| Type | Description |
|---|---|
| google.dataflow.v1beta3.IMetricUpdate[] |
progress
public progress?: (google.dataflow.v1beta3.IProgressTimeseries|null);WorkItemDetails progress.
| Type | Description |
|---|---|
| (google.dataflow.v1beta3.IProgressTimeseries|null) |
startTime
public startTime?: (google.protobuf.ITimestamp|null);WorkItemDetails startTime.
| Type | Description |
|---|---|
| (google.protobuf.ITimestamp|null) |
state
public state: (google.dataflow.v1beta3.ExecutionState|keyof typeof google.dataflow.v1beta3.ExecutionState);WorkItemDetails state.
| Type | Description |
|---|---|
| (google.dataflow.v1beta3.ExecutionState|keyof typeof google.dataflow.v1beta3.ExecutionState) |
taskId
public taskId: string;WorkItemDetails taskId.
| Type | Description |
|---|---|
| string |
Methods
create(properties)
public static create(properties?: google.dataflow.v1beta3.IWorkItemDetails): google.dataflow.v1beta3.WorkItemDetails;Creates a new WorkItemDetails instance using the specified properties.
| Type | Name | Description |
|---|---|---|
| IWorkItemDetails | properties |
Properties to set |
| 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.
| Type | Name | Description |
|---|---|---|
| ($protobuf.Reader|Uint8Array) | reader |
Reader or buffer to decode from |
| number | length |
Message length if known beforehand |
| 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.
| Type | Name | Description |
|---|---|---|
| ($protobuf.Reader|Uint8Array) | reader |
Reader or buffer to decode from |
| 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.
| Type | Name | Description |
|---|---|---|
| IWorkItemDetails | message |
WorkItemDetails message or plain object to encode |
| $protobuf.Writer | writer |
Writer to encode to |
| 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.
| Type | Name | Description |
|---|---|---|
| IWorkItemDetails | message |
WorkItemDetails message or plain object to encode |
| $protobuf.Writer | writer |
Writer to encode to |
| 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.
| Type | Name | Description |
|---|---|---|
| { [k: string]: any } | object |
Plain object |
| Type | Description |
|---|---|
| google.dataflow.v1beta3.WorkItemDetails | WorkItemDetails |
toJSON()
public toJSON(): { [k: string]: any };Converts this WorkItemDetails to JSON.
| 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.
| Type | Name | Description |
|---|---|---|
| google.dataflow.v1beta3.WorkItemDetails | message |
WorkItemDetails |
| $protobuf.IConversionOptions | options |
Conversion options |
| Type | Description |
|---|---|
| { [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a WorkItemDetails message.
| Type | Name | Description |
|---|---|---|
| { [k: string]: any } | message |
Plain object to verify |
| Type | Description |
|---|---|
| (string|null) |
|