Class Task (0.15.0) 

public final class Task extends GeneratedMessageV3 implements TaskOrBuilder

A task represents a user-visible job.

Protobuf type google.events.cloud.dataplex.v1.Task

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Task

Implements

TaskOrBuilder

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

EXECUTION_SPEC_FIELD_NUMBER

public static final int EXECUTION_SPEC_FIELD_NUMBER
Field Value
Type Description
int

EXECUTION_STATUS_FIELD_NUMBER

public static final int EXECUTION_STATUS_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

NOTEBOOK_FIELD_NUMBER

public static final int NOTEBOOK_FIELD_NUMBER
Field Value
Type Description
int

SPARK_FIELD_NUMBER

public static final int SPARK_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

TRIGGER_SPEC_FIELD_NUMBER

public static final int TRIGGER_SPEC_FIELD_NUMBER
Field Value
Type Description
int

UID_FIELD_NUMBER

public static final int UID_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Task getDefaultInstance()
Returns
Type Description
Task

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Task.Builder newBuilder()
Returns
Type Description
Task.Builder

newBuilder(Task prototype)

public static Task.Builder newBuilder(Task prototype)
Parameter
Name Description
prototype Task
Returns
Type Description
Task.Builder

parseDelimitedFrom(InputStream input)

public static Task parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Task
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Task parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Task
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Task parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Task
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Task parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Task
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Task parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Task
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Task parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Task
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Task parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Task
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Task parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Task
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Task parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Task
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Task parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Task
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Task parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Task
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Task parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Task
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Task> parser()
Returns
Type Description
Parser<Task>

Methods

containsLabels(String key)

public boolean containsLabels(String key)

Optional. User-defined labels for the task.

map<string, string> labels = 8;

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getConfigCase()

public Task.ConfigCase getConfigCase()
Returns
Type Description
Task.ConfigCase

getCreateTime()

public Timestamp getCreateTime()

Output only. The time when the task was created.

.google.protobuf.Timestamp create_time = 3;

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The time when the task was created.

.google.protobuf.Timestamp create_time = 3;

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Task getDefaultInstanceForType()
Returns
Type Description
Task

getDescription()

public String getDescription()

Optional. Description of the task.

string description = 5;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. Description of the task.

string description = 5;

Returns
Type Description
ByteString

The bytes for description.

getDisplayName()

public String getDisplayName()

Optional. User friendly display name.

string display_name = 6;

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Optional. User friendly display name.

string display_name = 6;

Returns
Type Description
ByteString

The bytes for displayName.

getExecutionSpec()

public Task.ExecutionSpec getExecutionSpec()

Required. Spec related to how a task is executed.

.google.events.cloud.dataplex.v1.Task.ExecutionSpec execution_spec = 101;

Returns
Type Description
Task.ExecutionSpec

The executionSpec.

getExecutionSpecOrBuilder()

public Task.ExecutionSpecOrBuilder getExecutionSpecOrBuilder()

Required. Spec related to how a task is executed.

.google.events.cloud.dataplex.v1.Task.ExecutionSpec execution_spec = 101;

Returns
Type Description
Task.ExecutionSpecOrBuilder

getExecutionStatus()

public Task.ExecutionStatus getExecutionStatus()

Output only. Status of the latest task executions.

.google.events.cloud.dataplex.v1.Task.ExecutionStatus execution_status = 201;

Returns
Type Description
Task.ExecutionStatus

The executionStatus.

getExecutionStatusOrBuilder()

public Task.ExecutionStatusOrBuilder getExecutionStatusOrBuilder()

Output only. Status of the latest task executions.

.google.events.cloud.dataplex.v1.Task.ExecutionStatus execution_status = 201;

Returns
Type Description
Task.ExecutionStatusOrBuilder

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Optional. User-defined labels for the task.

map<string, string> labels = 8;

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Optional. User-defined labels for the task.

map<string, string> labels = 8;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Optional. User-defined labels for the task.

map<string, string> labels = 8;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Optional. User-defined labels for the task.

map<string, string> labels = 8;

Parameter
Name Description
key String
Returns
Type Description
String

getName()

public String getName()

Output only. The relative resource name of the task, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/ tasks/{task_id}.

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. The relative resource name of the task, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/ tasks/{task_id}.

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getNotebook()

public Task.NotebookTaskConfig getNotebook()

Config related to running scheduled Notebooks.

.google.events.cloud.dataplex.v1.Task.NotebookTaskConfig notebook = 302;

Returns
Type Description
Task.NotebookTaskConfig

The notebook.

getNotebookOrBuilder()

public Task.NotebookTaskConfigOrBuilder getNotebookOrBuilder()

Config related to running scheduled Notebooks.

.google.events.cloud.dataplex.v1.Task.NotebookTaskConfig notebook = 302;

Returns
Type Description
Task.NotebookTaskConfigOrBuilder

getParserForType()

public Parser<Task> getParserForType()
Returns
Type Description
Parser<Task>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSpark()

public Task.SparkTaskConfig getSpark()

Config related to running custom Spark tasks.

.google.events.cloud.dataplex.v1.Task.SparkTaskConfig spark = 300;

Returns
Type Description
Task.SparkTaskConfig

The spark.

getSparkOrBuilder()

public Task.SparkTaskConfigOrBuilder getSparkOrBuilder()

Config related to running custom Spark tasks.

.google.events.cloud.dataplex.v1.Task.SparkTaskConfig spark = 300;

Returns
Type Description
Task.SparkTaskConfigOrBuilder

getState()

public State getState()

Output only. Current state of the task.

.google.events.cloud.dataplex.v1.State state = 7;

Returns
Type Description
State

The state.

getStateValue()

public int getStateValue()

Output only. Current state of the task.

.google.events.cloud.dataplex.v1.State state = 7;

Returns
Type Description
int

The enum numeric value on the wire for state.

getTriggerSpec()

public Task.TriggerSpec getTriggerSpec()

Required. Spec related to how often and when a task should be triggered.

.google.events.cloud.dataplex.v1.Task.TriggerSpec trigger_spec = 100;

Returns
Type Description
Task.TriggerSpec

The triggerSpec.

getTriggerSpecOrBuilder()

public Task.TriggerSpecOrBuilder getTriggerSpecOrBuilder()

Required. Spec related to how often and when a task should be triggered.

.google.events.cloud.dataplex.v1.Task.TriggerSpec trigger_spec = 100;

Returns
Type Description
Task.TriggerSpecOrBuilder

getUid()

public String getUid()

Output only. System generated globally unique ID for the task. This ID will be different if the task is deleted and re-created with the same name.

string uid = 2;

Returns
Type Description
String

The uid.

getUidBytes()

public ByteString getUidBytes()

Output only. System generated globally unique ID for the task. This ID will be different if the task is deleted and re-created with the same name.

string uid = 2;

Returns
Type Description
ByteString

The bytes for uid.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
Type Description
UnknownFieldSet
Overrides

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The time when the task was last updated.

.google.protobuf.Timestamp update_time = 4;

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The time when the task was last updated.

.google.protobuf.Timestamp update_time = 4;

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. The time when the task was created.

.google.protobuf.Timestamp create_time = 3;

Returns
Type Description
boolean

Whether the createTime field is set.

hasExecutionSpec()

public boolean hasExecutionSpec()

Required. Spec related to how a task is executed.

.google.events.cloud.dataplex.v1.Task.ExecutionSpec execution_spec = 101;

Returns
Type Description
boolean

Whether the executionSpec field is set.

hasExecutionStatus()

public boolean hasExecutionStatus()

Output only. Status of the latest task executions.

.google.events.cloud.dataplex.v1.Task.ExecutionStatus execution_status = 201;

Returns
Type Description
boolean

Whether the executionStatus field is set.

hasNotebook()

public boolean hasNotebook()

Config related to running scheduled Notebooks.

.google.events.cloud.dataplex.v1.Task.NotebookTaskConfig notebook = 302;

Returns
Type Description
boolean

Whether the notebook field is set.

hasSpark()

public boolean hasSpark()

Config related to running custom Spark tasks.

.google.events.cloud.dataplex.v1.Task.SparkTaskConfig spark = 300;

Returns
Type Description
boolean

Whether the spark field is set.

hasTriggerSpec()

public boolean hasTriggerSpec()

Required. Spec related to how often and when a task should be triggered.

.google.events.cloud.dataplex.v1.Task.TriggerSpec trigger_spec = 100;

Returns
Type Description
boolean

Whether the triggerSpec field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The time when the task was last updated.

.google.protobuf.Timestamp update_time = 4;

Returns
Type Description
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
Name Description
number int
Returns
Type Description
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Task.Builder newBuilderForType()
Returns
Type Description
Task.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Task.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Task.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Task.Builder toBuilder()
Returns
Type Description
Task.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException