Class protos.google.cloud.dataproc.v1.WorkflowTemplate (2.5.0)

Represents a WorkflowTemplate.

Package

@google-cloud/dataproc!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.dataproc.v1.IWorkflowTemplate);

Constructs a new WorkflowTemplate.

Parameter

Name	Description
properties	`IWorkflowTemplate` Properties to set

Properties

createTime

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

WorkflowTemplate createTime.

Property Value

Type	Description
(google.protobuf.ITimestamp\|null)

dagTimeout

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

WorkflowTemplate dagTimeout.

Property Value

Type	Description
(google.protobuf.IDuration\|null)

id

public id: string;

WorkflowTemplate id.

Property Value

Type	Description
string

jobs

public jobs: google.cloud.dataproc.v1.IOrderedJob[];

WorkflowTemplate jobs.

Property Value

Type	Description
google.cloud.dataproc.v1.IOrderedJob[]

labels

public labels: { [k: string]: string };

WorkflowTemplate labels.

Property Value

Type	Description
{ [k: string]: string }

name

public name: string;

WorkflowTemplate name.

Property Value

Type	Description
string

parameters

public parameters: google.cloud.dataproc.v1.ITemplateParameter[];

WorkflowTemplate parameters.

Property Value

Type	Description
google.cloud.dataproc.v1.ITemplateParameter[]

placement

public placement?: (google.cloud.dataproc.v1.IWorkflowTemplatePlacement|null);

WorkflowTemplate placement.

Property Value

Type	Description
(google.cloud.dataproc.v1.IWorkflowTemplatePlacement\|null)

updateTime

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

WorkflowTemplate updateTime.

Property Value

Type	Description
(google.protobuf.ITimestamp\|null)

version

public version: number;

WorkflowTemplate version.

Property Value

Type	Description
number

Methods

create(properties)

public static create(properties?: google.cloud.dataproc.v1.IWorkflowTemplate): google.cloud.dataproc.v1.WorkflowTemplate;

Creates a new WorkflowTemplate instance using the specified properties.

Parameter

Name	Description
properties	`IWorkflowTemplate` Properties to set

Returns

Type	Description
google.cloud.dataproc.v1.WorkflowTemplate	WorkflowTemplate instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.dataproc.v1.WorkflowTemplate;

Decodes a WorkflowTemplate 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.dataproc.v1.WorkflowTemplate	WorkflowTemplate

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.dataproc.v1.WorkflowTemplate;

Decodes a WorkflowTemplate 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.dataproc.v1.WorkflowTemplate	WorkflowTemplate

encode(message, writer)

public static encode(message: google.cloud.dataproc.v1.IWorkflowTemplate, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified WorkflowTemplate message. Does not implicitly messages.

Parameters

Name	Description
message	`IWorkflowTemplate` WorkflowTemplate 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.dataproc.v1.IWorkflowTemplate, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`IWorkflowTemplate` WorkflowTemplate 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.dataproc.v1.WorkflowTemplate;

Creates a WorkflowTemplate 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.dataproc.v1.WorkflowTemplate	WorkflowTemplate

toJSON()

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

Converts this WorkflowTemplate to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

Name	Description
message	`google.cloud.dataproc.v1.WorkflowTemplate` WorkflowTemplate
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 WorkflowTemplate 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