WorkflowTemplate

google.cloud.dataproc.v1. WorkflowTemplate

Represents a WorkflowTemplate.

Constructor

new WorkflowTemplate(propertiesopt)

Constructs a new WorkflowTemplate.

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

Properties to set

Implements:
  • IWorkflowTemplate

Members

createTime

WorkflowTemplate createTime.

dagTimeout

WorkflowTemplate dagTimeout.

id

WorkflowTemplate id.

jobs

WorkflowTemplate jobs.

labels

WorkflowTemplate labels.

name

WorkflowTemplate name.

parameters

WorkflowTemplate parameters.

placement

WorkflowTemplate placement.

updateTime

WorkflowTemplate updateTime.

version

WorkflowTemplate version.

Methods

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

Converts this WorkflowTemplate to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

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

Creates a new WorkflowTemplate instance using the specified properties.

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

Properties to set

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

WorkflowTemplate instance

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

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

WorkflowTemplate

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.WorkflowTemplate}

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

WorkflowTemplate

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 WorkflowTemplate message. Does not implicitly verify messages.

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

WorkflowTemplate 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 WorkflowTemplate message, length delimited. Does not implicitly verify messages.

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

WorkflowTemplate 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.WorkflowTemplate}

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

WorkflowTemplate

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for WorkflowTemplate

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

your custom typeUrlPrefix(default "type.googleapis.com")

Returns:
Type Description
string

The default type url

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

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

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

WorkflowTemplate

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

Verifies a WorkflowTemplate 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