Class protos.google.cloud.dataproc.v1beta2.OrderedJob (2.5.0)

Represents an OrderedJob.

Package

@google-cloud/dataproc!

Constructors

(constructor)(properties)

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

Constructs a new OrderedJob.

Parameter

Name	Description
properties	`IOrderedJob` Properties to set

Properties

hadoopJob

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

OrderedJob hadoopJob.

Property Value

Type	Description
(google.cloud.dataproc.v1beta2.IHadoopJob\|null)

hiveJob

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

OrderedJob hiveJob.

Property Value

Type	Description
(google.cloud.dataproc.v1beta2.IHiveJob\|null)

jobType

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

OrderedJob jobType.

Property Value

Type	Description
("hadoopJob"\|"sparkJob"\|"pysparkJob"\|"hiveJob"\|"pigJob"\|"sparkRJob"\|"sparkSqlJob"\|"prestoJob")

labels

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

OrderedJob labels.

Property Value

Type	Description
{ [k: string]: string }

pigJob

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

OrderedJob pigJob.

Property Value

Type	Description
(google.cloud.dataproc.v1beta2.IPigJob\|null)

prerequisiteStepIds

public prerequisiteStepIds: string[];

OrderedJob prerequisiteStepIds.

Property Value

Type	Description
string[]

prestoJob

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

OrderedJob prestoJob.

Property Value

Type	Description
(google.cloud.dataproc.v1beta2.IPrestoJob\|null)

pysparkJob

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

OrderedJob pysparkJob.

Property Value

Type	Description
(google.cloud.dataproc.v1beta2.IPySparkJob\|null)

scheduling

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

OrderedJob scheduling.

Property Value

Type	Description
(google.cloud.dataproc.v1beta2.IJobScheduling\|null)

sparkJob

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

OrderedJob sparkJob.

Property Value

Type	Description
(google.cloud.dataproc.v1beta2.ISparkJob\|null)

sparkRJob

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

OrderedJob sparkRJob.

Property Value

Type	Description
(google.cloud.dataproc.v1beta2.ISparkRJob\|null)

sparkSqlJob

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

OrderedJob sparkSqlJob.

Property Value

Type	Description
(google.cloud.dataproc.v1beta2.ISparkSqlJob\|null)

stepId

public stepId: string;

OrderedJob stepId.

Property Value

Type	Description
string

Methods

create(properties)

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

Creates a new OrderedJob instance using the specified properties.

Parameter

Name	Description
properties	`IOrderedJob` Properties to set

Returns

Type	Description
google.cloud.dataproc.v1beta2.OrderedJob	OrderedJob instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.dataproc.v1beta2.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.v1beta2.OrderedJob	OrderedJob

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.dataproc.v1beta2.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.v1beta2.OrderedJob	OrderedJob

encode(message, writer)

public static encode(message: google.cloud.dataproc.v1beta2.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.v1beta2.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.v1beta2.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.v1beta2.OrderedJob	OrderedJob

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.v1beta2.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.v1beta2.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