Represents a PipelineDescription.
Package
@google-cloud/dataflowConstructors
(constructor)(properties)
constructor(properties?: google.dataflow.v1beta3.IPipelineDescription);
Constructs a new PipelineDescription.
Parameter | |
---|---|
Name | Description |
properties |
IPipelineDescription
Properties to set |
Properties
displayData
public displayData: google.dataflow.v1beta3.IDisplayData[];
PipelineDescription displayData.
executionPipelineStage
public executionPipelineStage: google.dataflow.v1beta3.IExecutionStageSummary[];
PipelineDescription executionPipelineStage.
originalPipelineTransform
public originalPipelineTransform: google.dataflow.v1beta3.ITransformSummary[];
PipelineDescription originalPipelineTransform.
Methods
create(properties)
public static create(properties?: google.dataflow.v1beta3.IPipelineDescription): google.dataflow.v1beta3.PipelineDescription;
Creates a new PipelineDescription instance using the specified properties.
Parameter | |
---|---|
Name | Description |
properties |
IPipelineDescription
Properties to set |
Returns | |
---|---|
Type | Description |
PipelineDescription | PipelineDescription instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.dataflow.v1beta3.PipelineDescription;
Decodes a PipelineDescription 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 |
PipelineDescription | PipelineDescription |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.dataflow.v1beta3.PipelineDescription;
Decodes a PipelineDescription message from the specified reader or buffer, length delimited.
Parameter | |
---|---|
Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
Returns | |
---|---|
Type | Description |
PipelineDescription | PipelineDescription |
encode(message, writer)
public static encode(message: google.dataflow.v1beta3.IPipelineDescription, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified PipelineDescription message. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IPipelineDescription
PipelineDescription 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.IPipelineDescription, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified PipelineDescription message, length delimited. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IPipelineDescription
PipelineDescription 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.PipelineDescription;
Creates a PipelineDescription 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 |
PipelineDescription | PipelineDescription |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;
Gets the default type url for PipelineDescription
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 PipelineDescription to JSON.
Returns | |
---|---|
Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.dataflow.v1beta3.PipelineDescription, options?: $protobuf.IConversionOptions): { [k: string]: any };
Creates a plain object from a PipelineDescription message. Also converts values to other types if specified.
Parameters | |
---|---|
Name | Description |
message |
PipelineDescription
PipelineDescription |
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 PipelineDescription message.
Parameter | |
---|---|
Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
Returns | |
---|---|
Type | Description |
(string|null) |
|