Class protos.google.cloud.dataproc.v1.OrderedJob (4.5.0)

Represents an OrderedJob.

Package

Constructors

(constructor)(properties)

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

Constructs a new OrderedJob.

Parameter
Name	Description
`properties`	`IOrderedJob` Properties to set

Properties

hadoopJob

public hadoopJob?: (google.cloud.dataproc.v1.IHadoopJob|null);

OrderedJob hadoopJob.

hiveJob

public hiveJob?: (google.cloud.dataproc.v1.IHiveJob|null);

OrderedJob hiveJob.

jobType

public jobType?: ("hadoopJob"|"sparkJob"|"pysparkJob"|"hiveJob"|"pigJob"|"sparkRJob"|"sparkSqlJob"|"prestoJob");

OrderedJob jobType.

labels

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

OrderedJob labels.

pigJob

public pigJob?: (google.cloud.dataproc.v1.IPigJob|null);

OrderedJob pigJob.

prerequisiteStepIds

public prerequisiteStepIds: string[];

OrderedJob prerequisiteStepIds.

prestoJob

public prestoJob?: (google.cloud.dataproc.v1.IPrestoJob|null);

OrderedJob prestoJob.

pysparkJob

public pysparkJob?: (google.cloud.dataproc.v1.IPySparkJob|null);

OrderedJob pysparkJob.

scheduling

public scheduling?: (google.cloud.dataproc.v1.IJobScheduling|null);

OrderedJob scheduling.

sparkJob

public sparkJob?: (google.cloud.dataproc.v1.ISparkJob|null);

OrderedJob sparkJob.

sparkRJob

public sparkRJob?: (google.cloud.dataproc.v1.ISparkRJob|null);

OrderedJob sparkRJob.

sparkSqlJob

public sparkSqlJob?: (google.cloud.dataproc.v1.ISparkSqlJob|null);

OrderedJob sparkSqlJob.

stepId

public stepId: string;

OrderedJob stepId.

Methods

create(properties)

public static create(properties?: google.cloud.dataproc.v1.IOrderedJob): google.cloud.dataproc.v1.OrderedJob;

Creates a new OrderedJob instance using the specified properties.

Parameter
Name	Description
`properties`	`IOrderedJob` Properties to set

Returns
Type	Description
`google.cloud.dataproc.v1.OrderedJob`	OrderedJob instance

decode(reader, length)

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

Decodes an OrderedJob 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.OrderedJob`	OrderedJob

decodeDelimited(reader)

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

Decodes an OrderedJob 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.OrderedJob`	OrderedJob

encode(message, writer)

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

Encodes the specified OrderedJob message. Does not implicitly messages.

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

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

Parameters
Name	Description
`message`	`IOrderedJob` OrderedJob 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.OrderedJob;

Creates an OrderedJob 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.OrderedJob`	OrderedJob

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for OrderedJob

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 OrderedJob to JSON.

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

toObject(message, options)

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

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

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