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

Represents a WorkflowMetadata.

Package

@google-cloud/dataproc!

Constructors

(constructor)(properties)

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

Constructs a new WorkflowMetadata.

Parameter

Name	Description
properties	`IWorkflowMetadata` Properties to set

Properties

clusterName

public clusterName: string;

WorkflowMetadata clusterName.

Property Value

Type	Description
string

clusterUuid

public clusterUuid: string;

WorkflowMetadata clusterUuid.

Property Value

Type	Description
string

createCluster

public createCluster?: (google.cloud.dataproc.v1.IClusterOperation|null);

WorkflowMetadata createCluster.

Property Value

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

dagEndTime

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

WorkflowMetadata dagEndTime.

Property Value

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

dagStartTime

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

WorkflowMetadata dagStartTime.

Property Value

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

dagTimeout

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

WorkflowMetadata dagTimeout.

Property Value

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

deleteCluster

public deleteCluster?: (google.cloud.dataproc.v1.IClusterOperation|null);

WorkflowMetadata deleteCluster.

Property Value

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

endTime

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

WorkflowMetadata endTime.

Property Value

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

graph

public graph?: (google.cloud.dataproc.v1.IWorkflowGraph|null);

WorkflowMetadata graph.

Property Value

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

parameters

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

WorkflowMetadata parameters.

Property Value

Type	Description
{ [k: string]: string }

startTime

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

WorkflowMetadata startTime.

Property Value

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

state

public state: (google.cloud.dataproc.v1.WorkflowMetadata.State|keyof typeof google.cloud.dataproc.v1.WorkflowMetadata.State);

WorkflowMetadata state.

Property Value

Type	Description
(google.cloud.dataproc.v1.WorkflowMetadata.State\|keyof typeof google.cloud.dataproc.v1.WorkflowMetadata.State)

template

public template: string;

WorkflowMetadata template.

Property Value

Type	Description
string

version

public version: number;

WorkflowMetadata version.

Property Value

Type	Description
number

Methods

create(properties)

public static create(properties?: google.cloud.dataproc.v1.IWorkflowMetadata): google.cloud.dataproc.v1.WorkflowMetadata;

Creates a new WorkflowMetadata instance using the specified properties.

Parameter

Name	Description
properties	`IWorkflowMetadata` Properties to set

Returns

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

decode(reader, length)

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

Decodes a WorkflowMetadata 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.WorkflowMetadata	WorkflowMetadata

decodeDelimited(reader)

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

Decodes a WorkflowMetadata 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.WorkflowMetadata	WorkflowMetadata

encode(message, writer)

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

Encodes the specified WorkflowMetadata message. Does not implicitly messages.

Parameters

Name	Description
message	`IWorkflowMetadata` WorkflowMetadata 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.IWorkflowMetadata, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`IWorkflowMetadata` WorkflowMetadata 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.WorkflowMetadata;

Creates a WorkflowMetadata 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.WorkflowMetadata	WorkflowMetadata

toJSON()

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

Converts this WorkflowMetadata to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

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