public final class Task extends GeneratedMessageV3 implements TaskOrBuilder
A task represents a user-visible job.
Protobuf type google.cloud.dataplex.v1.Task
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
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()
newBuilder()
public static Task.Builder newBuilder()
newBuilder(Task prototype)
public static Task.Builder newBuilder(Task prototype)
| Parameter |
|---|
| Name | Description |
prototype | Task
|
public static Task parseDelimitedFrom(InputStream input)
| Returns |
|---|
| Type | Description |
Task | |
public static Task parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Task | |
parseFrom(byte[] data)
public static Task parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
| Returns |
|---|
| Type | Description |
Task | |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Task parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Task | |
parseFrom(ByteString data)
public static Task parseFrom(ByteString data)
| Returns |
|---|
| Type | Description |
Task | |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Task parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Task | |
public static Task parseFrom(CodedInputStream input)
| Returns |
|---|
| Type | Description |
Task | |
public static Task parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Task | |
public static Task parseFrom(InputStream input)
| Returns |
|---|
| Type | Description |
Task | |
public static Task parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Task | |
parseFrom(ByteBuffer data)
public static Task parseFrom(ByteBuffer data)
| Returns |
|---|
| Type | Description |
Task | |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Task parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Task | |
parser()
public static Parser<Task> parser()
Methods
containsLabels(String key)
public boolean containsLabels(String key)
Optional. User-defined labels for the task.
map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
|---|
| Name | Description |
key | String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getConfigCase()
public Task.ConfigCase getConfigCase()
getCreateTime()
public Timestamp getCreateTime()
Output only. The time when the task was created.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| 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 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstanceForType()
public Task getDefaultInstanceForType()
| Returns |
|---|
| Type | Description |
Task | |
getDescription()
public String getDescription()
Optional. Description of the task.
string description = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
String | The description.
|
getDescriptionBytes()
public ByteString getDescriptionBytes()
Optional. Description of the task.
string description = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for description.
|
getDisplayName()
public String getDisplayName()
Optional. User friendly display name.
string display_name = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
String | The displayName.
|
getDisplayNameBytes()
public ByteString getDisplayNameBytes()
Optional. User friendly display name.
string display_name = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for displayName.
|
getExecutionSpec()
public Task.ExecutionSpec getExecutionSpec()
Required. Spec related to how a task is executed.
.google.cloud.dataplex.v1.Task.ExecutionSpec execution_spec = 101 [(.google.api.field_behavior) = REQUIRED];
getExecutionSpecOrBuilder()
public Task.ExecutionSpecOrBuilder getExecutionSpecOrBuilder()
Required. Spec related to how a task is executed.
.google.cloud.dataplex.v1.Task.ExecutionSpec execution_spec = 101 [(.google.api.field_behavior) = REQUIRED];
getExecutionStatus()
public Task.ExecutionStatus getExecutionStatus()
Output only. Status of the latest task executions.
.google.cloud.dataplex.v1.Task.ExecutionStatus execution_status = 201 [(.google.api.field_behavior) = OUTPUT_ONLY];
getExecutionStatusOrBuilder()
public Task.ExecutionStatusOrBuilder getExecutionStatusOrBuilder()
Output only. Status of the latest task executions.
.google.cloud.dataplex.v1.Task.ExecutionStatus execution_status = 201 [(.google.api.field_behavior) = OUTPUT_ONLY];
getLabels()
public Map<String,String> getLabels()
getLabelsCount()
public int getLabelsCount()
Optional. User-defined labels for the task.
map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
int | |
getLabelsMap()
public Map<String,String> getLabelsMap()
Optional. User-defined labels for the task.
map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)
Optional. User-defined labels for the task.
map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];
getLabelsOrThrow(String key)
public String getLabelsOrThrow(String key)
Optional. User-defined labels for the task.
map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
|---|
| Name | Description |
key | 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 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| 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 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Returns |
|---|
| Type | Description |
ByteString | The bytes for name.
|
getNotebook()
public Task.NotebookTaskConfig getNotebook()
Config related to running scheduled Notebooks.
.google.cloud.dataplex.v1.Task.NotebookTaskConfig notebook = 302;
getNotebookOrBuilder()
public Task.NotebookTaskConfigOrBuilder getNotebookOrBuilder()
Config related to running scheduled Notebooks.
.google.cloud.dataplex.v1.Task.NotebookTaskConfig notebook = 302;
getParserForType()
public Parser<Task> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getSpark()
public Task.SparkTaskConfig getSpark()
Config related to running custom Spark tasks.
.google.cloud.dataplex.v1.Task.SparkTaskConfig spark = 300;
getSparkOrBuilder()
public Task.SparkTaskConfigOrBuilder getSparkOrBuilder()
Config related to running custom Spark tasks.
.google.cloud.dataplex.v1.Task.SparkTaskConfig spark = 300;
getState()
Output only. Current state of the task.
.google.cloud.dataplex.v1.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
State | The state.
|
getStateValue()
public int getStateValue()
Output only. Current state of the task.
.google.cloud.dataplex.v1.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| 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.cloud.dataplex.v1.Task.TriggerSpec trigger_spec = 100 [(.google.api.field_behavior) = REQUIRED];
getTriggerSpecOrBuilder()
public Task.TriggerSpecOrBuilder getTriggerSpecOrBuilder()
Required. Spec related to how often and when a task should be triggered.
.google.cloud.dataplex.v1.Task.TriggerSpec trigger_spec = 100 [(.google.api.field_behavior) = REQUIRED];
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 [(.google.api.field_behavior) = OUTPUT_ONLY];
| 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 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for uid.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
getUpdateTime()
public Timestamp getUpdateTime()
Output only. The time when the task was last updated.
.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| 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 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasCreateTime()
public boolean hasCreateTime()
Output only. The time when the task was created.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
boolean | Whether the createTime field is set.
|
hasExecutionSpec()
public boolean hasExecutionSpec()
Required. Spec related to how a task is executed.
.google.cloud.dataplex.v1.Task.ExecutionSpec execution_spec = 101 [(.google.api.field_behavior) = REQUIRED];
| Returns |
|---|
| Type | Description |
boolean | Whether the executionSpec field is set.
|
hasExecutionStatus()
public boolean hasExecutionStatus()
Output only. Status of the latest task executions.
.google.cloud.dataplex.v1.Task.ExecutionStatus execution_status = 201 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
boolean | Whether the executionStatus field is set.
|
hasNotebook()
public boolean hasNotebook()
Config related to running scheduled Notebooks.
.google.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.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.cloud.dataplex.v1.Task.TriggerSpec trigger_spec = 100 [(.google.api.field_behavior) = REQUIRED];
| 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 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
boolean | Whether the updateTime field is set.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Task.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Task.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public Task.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
