Represents a StageSummary.
Package
@google-cloud/dataflowConstructors
(constructor)(properties)
constructor(properties?: google.dataflow.v1beta3.IStageSummary);
Constructs a new StageSummary.
Parameter | |
---|---|
Name | Description |
properties |
IStageSummary
Properties to set |
Properties
endTime
public endTime?: (google.protobuf.ITimestamp|null);
StageSummary endTime.
metrics
public metrics: google.dataflow.v1beta3.IMetricUpdate[];
StageSummary metrics.
progress
public progress?: (google.dataflow.v1beta3.IProgressTimeseries|null);
StageSummary progress.
stageId
public stageId: string;
StageSummary stageId.
startTime
public startTime?: (google.protobuf.ITimestamp|null);
StageSummary startTime.
state
public state: (google.dataflow.v1beta3.ExecutionState|keyof typeof google.dataflow.v1beta3.ExecutionState);
StageSummary state.
Methods
create(properties)
public static create(properties?: google.dataflow.v1beta3.IStageSummary): google.dataflow.v1beta3.StageSummary;
Creates a new StageSummary instance using the specified properties.
Parameter | |
---|---|
Name | Description |
properties |
IStageSummary
Properties to set |
Returns | |
---|---|
Type | Description |
StageSummary | StageSummary instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.dataflow.v1beta3.StageSummary;
Decodes a StageSummary message from the specified reader or buffer.
Parameters | |
---|---|
Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
Returns | |
---|---|
Type | Description |
StageSummary | StageSummary |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.dataflow.v1beta3.StageSummary;
Decodes a StageSummary message from the specified reader or buffer, length delimited.
Parameter | |
---|---|
Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
Returns | |
---|---|
Type | Description |
StageSummary | StageSummary |
encode(message, writer)
public static encode(message: google.dataflow.v1beta3.IStageSummary, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified StageSummary message. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IStageSummary
StageSummary 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.IStageSummary, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified StageSummary message, length delimited. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IStageSummary
StageSummary 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.StageSummary;
Creates a StageSummary 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 |
StageSummary | StageSummary |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;
Gets the default type url for StageSummary
Parameter | |
---|---|
Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
Returns | |
---|---|
Type | Description |
string | The default type url |
toJSON()
public toJSON(): { [k: string]: any };
Converts this StageSummary to JSON.
Returns | |
---|---|
Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.dataflow.v1beta3.StageSummary, options?: $protobuf.IConversionOptions): { [k: string]: any };
Creates a plain object from a StageSummary message. Also converts values to other types if specified.
Parameters | |
---|---|
Name | Description |
message |
StageSummary
StageSummary |
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 StageSummary message.
Parameter | |
---|---|
Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
Returns | |
---|---|
Type | Description |
(string|null) |
|