Represents a Job.
Package
@google-cloud/dataflowConstructors
(constructor)(properties)
constructor(properties?: google.dataflow.v1beta3.IJob);Constructs a new Job.
| Parameter | |
|---|---|
| Name | Description |
properties |
IJob
Properties to set |
Properties
clientRequestId
public clientRequestId: string;Job clientRequestId.
createdFromSnapshotId
public createdFromSnapshotId: string;Job createdFromSnapshotId.
createTime
public createTime?: (google.protobuf.ITimestamp|null);Job createTime.
currentState
public currentState: (google.dataflow.v1beta3.JobState|keyof typeof google.dataflow.v1beta3.JobState);Job currentState.
currentStateTime
public currentStateTime?: (google.protobuf.ITimestamp|null);Job currentStateTime.
environment
public environment?: (google.dataflow.v1beta3.IEnvironment|null);Job environment.
executionInfo
public executionInfo?: (google.dataflow.v1beta3.IJobExecutionInfo|null);Job executionInfo.
id
public id: string;Job id.
jobMetadata
public jobMetadata?: (google.dataflow.v1beta3.IJobMetadata|null);Job jobMetadata.
labels
public labels: { [k: string]: string };Job labels.
location
public location: string;Job location.
name
public name: string;Job name.
pipelineDescription
public pipelineDescription?: (google.dataflow.v1beta3.IPipelineDescription|null);Job pipelineDescription.
projectId
public projectId: string;Job projectId.
replacedByJobId
public replacedByJobId: string;Job replacedByJobId.
replaceJobId
public replaceJobId: string;Job replaceJobId.
requestedState
public requestedState: (google.dataflow.v1beta3.JobState|keyof typeof google.dataflow.v1beta3.JobState);Job requestedState.
satisfiesPzs
public satisfiesPzs: boolean;Job satisfiesPzs.
stageStates
public stageStates: google.dataflow.v1beta3.IExecutionStageState[];Job stageStates.
startTime
public startTime?: (google.protobuf.ITimestamp|null);Job startTime.
steps
public steps: google.dataflow.v1beta3.IStep[];Job steps.
stepsLocation
public stepsLocation: string;Job stepsLocation.
tempFiles
public tempFiles: string[];Job tempFiles.
transformNameMapping
public transformNameMapping: { [k: string]: string };Job transformNameMapping.
type
public type: (google.dataflow.v1beta3.JobType|keyof typeof google.dataflow.v1beta3.JobType);Job type.
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 | |
|---|---|
| Name | Description |
properties |
IJob
Properties to set |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
message |
IJob
Job 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.dataflow.v1beta3.IJob, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Job message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IJob
Job 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.dataflow.v1beta3.Job;Creates a Job 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 |
Job | Job |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Job
| 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 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 | |
|---|---|
| Name | Description |
message |
Job
Job |
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 a Job message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|