public final class Task extends GeneratedMessageV3 implements TaskOrBuilder
A task represents a user-visible job.
Protobuf type google.cloud.dataplex.v1.Task
Static Fields
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
Field Value
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
Field Value
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
EXECUTION_SPEC_FIELD_NUMBER
public static final int EXECUTION_SPEC_FIELD_NUMBER
Field Value
EXECUTION_STATUS_FIELD_NUMBER
public static final int EXECUTION_STATUS_FIELD_NUMBER
Field Value
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
SPARK_FIELD_NUMBER
public static final int SPARK_FIELD_NUMBER
Field Value
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
Field Value
TRIGGER_SPEC_FIELD_NUMBER
public static final int TRIGGER_SPEC_FIELD_NUMBER
Field Value
UID_FIELD_NUMBER
public static final int UID_FIELD_NUMBER
Field Value
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Task getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static Task.Builder newBuilder()
Returns
newBuilder(Task prototype)
public static Task.Builder newBuilder(Task prototype)
Parameter
| Name | Description |
| prototype | Task
|
Returns
public static Task parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Task parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Task parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Task parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Task parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Task parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Task parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Task parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Task parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Task parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Task parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Task parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Task> parser()
Returns
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];
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getConfigCase()
public Task.ConfigCase getConfigCase()
Returns
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];
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
getDescription()
public String getDescription()
Optional. Description of the task.
string description = 5 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| String | The description.
|
getDescriptionBytes()
public ByteString getDescriptionBytes()
Optional. Description of the task.
string description = 5 [(.google.api.field_behavior) = OPTIONAL];
| 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];
| Type | Description |
| String | The displayName.
|
getDisplayNameBytes()
public ByteString getDisplayNameBytes()
Optional. User friendly display name.
string display_name = 6 [(.google.api.field_behavior) = OPTIONAL];
| 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()
Returns
getLabelsCount()
public int getLabelsCount()
Optional. User-defined labels for the task.
map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];
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];
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) = { ... }
| 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) = { ... }
getParserForType()
public Parser<Task> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
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];
| 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];
| 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];
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];
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
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];
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];
| 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];
| 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];
| Type | Description |
| boolean | Whether the executionStatus field is set.
|
hasSpark()
public boolean hasSpark()
Config related to running custom Spark tasks.
.google.cloud.dataplex.v1.Task.SparkTaskConfig spark = 300;
| 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];
| 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];
| Type | Description |
| boolean | Whether the updateTime field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public Task.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Task.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public Task.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
