Represents a Task.
Package
@google-cloud/dataplexConstructors
(constructor)(properties)
constructor(properties?: google.cloud.dataplex.v1.ITask);Constructs a new Task.
| Parameter | |
|---|---|
| Name | Description |
properties |
ITask
Properties to set |
Properties
config
public config?: ("spark"|"notebook");Task config.
createTime
public createTime?: (google.protobuf.ITimestamp|null);Task createTime.
description
public description: string;Task description.
displayName
public displayName: string;Task displayName.
executionSpec
public executionSpec?: (google.cloud.dataplex.v1.Task.IExecutionSpec|null);Task executionSpec.
executionStatus
public executionStatus?: (google.cloud.dataplex.v1.Task.IExecutionStatus|null);Task executionStatus.
labels
public labels: { [k: string]: string };Task labels.
name
public name: string;Task name.
notebook
public notebook?: (google.cloud.dataplex.v1.Task.INotebookTaskConfig|null);Task notebook.
spark
public spark?: (google.cloud.dataplex.v1.Task.ISparkTaskConfig|null);Task spark.
state
public state: (google.cloud.dataplex.v1.State|keyof typeof google.cloud.dataplex.v1.State);Task state.
triggerSpec
public triggerSpec?: (google.cloud.dataplex.v1.Task.ITriggerSpec|null);Task triggerSpec.
uid
public uid: string;Task uid.
updateTime
public updateTime?: (google.protobuf.ITimestamp|null);Task updateTime.
Methods
create(properties)
public static create(properties?: google.cloud.dataplex.v1.ITask): google.cloud.dataplex.v1.Task;Creates a new Task instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
ITask
Properties to set |
| Returns | |
|---|---|
| Type | Description |
Task | Task instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.dataplex.v1.Task;Decodes a Task 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 |
Task | Task |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.dataplex.v1.Task;Decodes a Task message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
Task | Task |
encode(message, writer)
public static encode(message: google.cloud.dataplex.v1.ITask, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Task message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ITask
Task 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.dataplex.v1.ITask, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Task message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ITask
Task 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.dataplex.v1.Task;Creates a Task 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 |
Task | Task |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Task
| 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 Task to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.dataplex.v1.Task, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a Task message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
Task
Task |
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 Task message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|