WorkflowMetadata

google.cloud.dataproc.v1. WorkflowMetadata

Represents a WorkflowMetadata.

Constructor

new WorkflowMetadata(propertiesopt)

Constructs a new WorkflowMetadata.

Parameters:
Name Type Attributes Description
properties google.cloud.dataproc.v1.IWorkflowMetadata <optional>

Properties to set

Implements:
  • IWorkflowMetadata

Members

State

State enum.

Properties:
Name Type Description
UNKNOWN number

UNKNOWN value

PENDING number

PENDING value

RUNNING number

RUNNING value

DONE number

DONE value

clusterName

WorkflowMetadata clusterName.

clusterUuid

WorkflowMetadata clusterUuid.

createCluster

WorkflowMetadata createCluster.

dagEndTime

WorkflowMetadata dagEndTime.

dagStartTime

WorkflowMetadata dagStartTime.

dagTimeout

WorkflowMetadata dagTimeout.

deleteCluster

WorkflowMetadata deleteCluster.

endTime

WorkflowMetadata endTime.

graph

WorkflowMetadata graph.

parameters

WorkflowMetadata parameters.

startTime

WorkflowMetadata startTime.

state

WorkflowMetadata state.

template

WorkflowMetadata template.

version

WorkflowMetadata version.

Methods

(static) create(propertiesopt) → {google.cloud.dataproc.v1.WorkflowMetadata}

Creates a new WorkflowMetadata instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.dataproc.v1.IWorkflowMetadata <optional>

Properties to set

Returns:
Type Description
google.cloud.dataproc.v1.WorkflowMetadata

WorkflowMetadata instance

(static) decode(reader, lengthopt) → {google.cloud.dataproc.v1.WorkflowMetadata}

Decodes a WorkflowMetadata message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

length number <optional>

Message length if known beforehand

Returns:
Type Description
google.cloud.dataproc.v1.WorkflowMetadata

WorkflowMetadata

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.cloud.dataproc.v1.WorkflowMetadata}

Decodes a WorkflowMetadata message from the specified reader or buffer, length delimited.

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

Returns:
Type Description
google.cloud.dataproc.v1.WorkflowMetadata

WorkflowMetadata

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified WorkflowMetadata message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.dataproc.v1.IWorkflowMetadata

WorkflowMetadata message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

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

Parameters:
Name Type Attributes Description
message google.cloud.dataproc.v1.IWorkflowMetadata

WorkflowMetadata message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.cloud.dataproc.v1.WorkflowMetadata}

Creates a WorkflowMetadata message from a plain object. Also converts values to their respective internal types.

Parameters:
Name Type Description
object Object.<string, *>

Plain object

Returns:
Type Description
google.cloud.dataproc.v1.WorkflowMetadata

WorkflowMetadata

(static) toObject(message, optionsopt) → {Object.<string, *>}

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

Parameters:
Name Type Attributes Description
message google.cloud.dataproc.v1.WorkflowMetadata

WorkflowMetadata

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies a WorkflowMetadata message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not

toJSON() → {Object.<string, *>}

Converts this WorkflowMetadata to JSON.

Returns:
Type Description
Object.<string, *>

JSON object