Class protos.google.dataflow.v1beta3.Job

Version 1.0.2

• 3.0.2 (latest)
• 2.1.2
• 2.0.1
• 1.2.0
• 1.1.0
• 1.0.2

Represents a Job.

Package

@google-cloud/dataflow!

Constructors

(constructor)(properties)

constructor(properties?: google.dataflow.v1beta3.IJob);

Constructs a new Job.

Parameter

Type	Name	Description
IJob	properties	Properties to set

Properties

clientRequestId

public clientRequestId: string;

Job clientRequestId.

Property Value

Type	Description
string

createdFromSnapshotId

public createdFromSnapshotId: string;

Job createdFromSnapshotId.

Property Value

Type	Description
string

createTime

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

Job createTime.

Property Value

Type	Description
(google.protobuf.ITimestamp|null)

currentState

public currentState: (google.dataflow.v1beta3.JobState|keyof typeof google.dataflow.v1beta3.JobState);

Job currentState.

Property Value

Type	Description
(google.dataflow.v1beta3.JobState|keyof typeof google.dataflow.v1beta3.JobState)

currentStateTime

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

Job currentStateTime.

Property Value

Type	Description
(google.protobuf.ITimestamp|null)

environment

public environment?: (google.dataflow.v1beta3.IEnvironment|null);

Job environment.

Property Value

Type	Description
(google.dataflow.v1beta3.IEnvironment|null)

executionInfo

public executionInfo?: (google.dataflow.v1beta3.IJobExecutionInfo|null);

Job executionInfo.

Property Value

Type	Description
(google.dataflow.v1beta3.IJobExecutionInfo|null)

id

public id: string;

Job id.

Property Value

Type	Description
string

jobMetadata

public jobMetadata?: (google.dataflow.v1beta3.IJobMetadata|null);

Job jobMetadata.

Property Value

Type	Description
(google.dataflow.v1beta3.IJobMetadata|null)

labels

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

Job labels.

Property Value

Type	Description
{ [k: string]: string }

location

public location: string;

Job location.

Property Value

Type	Description
string

name

public name: string;

Job name.

Property Value

Type	Description
string

pipelineDescription

public pipelineDescription?: (google.dataflow.v1beta3.IPipelineDescription|null);

Job pipelineDescription.

Property Value

Type	Description
(google.dataflow.v1beta3.IPipelineDescription|null)

projectId

public projectId: string;

Job projectId.

Property Value

Type	Description
string

replacedByJobId

public replacedByJobId: string;

Job replacedByJobId.

Property Value

Type	Description
string

replaceJobId

public replaceJobId: string;

Job replaceJobId.

Property Value

Type	Description
string

requestedState

public requestedState: (google.dataflow.v1beta3.JobState|keyof typeof google.dataflow.v1beta3.JobState);

Job requestedState.

Property Value

Type	Description
(google.dataflow.v1beta3.JobState|keyof typeof google.dataflow.v1beta3.JobState)

satisfiesPzs

public satisfiesPzs: boolean;

Job satisfiesPzs.

Property Value

Type	Description
boolean

stageStates

public stageStates: google.dataflow.v1beta3.IExecutionStageState[];

Job stageStates.

Property Value

Type	Description
google.dataflow.v1beta3.IExecutionStageState[]

startTime

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

Job startTime.

Property Value

Type	Description
(google.protobuf.ITimestamp|null)

steps

public steps: google.dataflow.v1beta3.IStep[];

Job steps.

Property Value

Type	Description
google.dataflow.v1beta3.IStep[]

stepsLocation

public stepsLocation: string;

Job stepsLocation.

Property Value

Type	Description
string

tempFiles

public tempFiles: string[];

Job tempFiles.

Property Value

Type	Description
string[]

transformNameMapping

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

Job transformNameMapping.

Property Value

Type	Description
{ [k: string]: string }

type

public type: (google.dataflow.v1beta3.JobType|keyof typeof google.dataflow.v1beta3.JobType);

Job type.

Property Value

Type	Description
(google.dataflow.v1beta3.JobType|keyof typeof google.dataflow.v1beta3.JobType)

Methods

create(properties)

public static create(properties?: google.dataflow.v1beta3.IJob): google.dataflow.v1beta3.Job;

Creates a new Job instance using the specified properties.

Parameter

Type	Name	Description
IJob	properties	Properties to set

Returns

Type	Description
google.dataflow.v1beta3.Job	Job instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.dataflow.v1beta3.Job;

Decodes a Job message from the specified reader or buffer.

Parameters

Type	Name	Description
($protobuf.Reader|Uint8Array)	reader	Reader or buffer to decode from
number	length	Message length if known beforehand

Returns

Type	Description
google.dataflow.v1beta3.Job	Job

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.dataflow.v1beta3.Job;

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

Parameter

Type	Name	Description
($protobuf.Reader|Uint8Array)	reader	Reader or buffer to decode from

Returns

Type	Description
google.dataflow.v1beta3.Job	Job

encode(message, writer)

public static encode(message: google.dataflow.v1beta3.IJob, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Job message. Does not implicitly messages.

Parameters

Type	Name	Description
IJob	message	Job message or plain object to encode
$protobuf.Writer	writer	Writer to encode to

Returns

Type	Description
$protobuf.Writer	Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.dataflow.v1beta3.IJob, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Type	Name	Description
IJob	message	Job message or plain object to encode
$protobuf.Writer	writer	Writer to encode to

Returns

Type	Description
$protobuf.Writer	Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.dataflow.v1beta3.Job;

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

Parameter

Type	Name	Description
{ [k: string]: any }	object	Plain object

Returns

Type	Description
google.dataflow.v1beta3.Job	Job

toJSON()

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

Converts this Job to JSON.

Returns

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

toObject(message, options)

public static toObject(message: google.dataflow.v1beta3.Job, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters

Type	Name	Description
google.dataflow.v1beta3.Job	message	Job
$protobuf.IConversionOptions	options	Conversion options

Returns

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

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a Job message.

Parameter

Type	Name	Description
{ [k: string]: any }	message	Plain object to verify

Returns

Type	Description
(string|null)	null if valid, otherwise the reason why it is not