Interface TaskOrBuilder (1.38.0)

Version 1.38.0

• 1.57.0 (latest)
• 1.56.0
• 1.55.0
• 1.54.0
• 1.53.0
• 1.52.0
• 1.51.0
• 1.50.0
• 1.49.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.0
• 1.9.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.2
• 1.0.1
• 0.2.2

public interface TaskOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract 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

Returns
Type	Description
boolean

getConfigCase()

public abstract Task.ConfigCase getConfigCase()

Returns
Type	Description
Task.ConfigCase

getCreateTime()

public abstract 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 abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The time when the task was created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TimestampOrBuilder

getDescription()

public abstract String getDescription()

Optional. Description of the task.

string description = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The description.

getDescriptionBytes()

public abstract 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 abstract String getDisplayName()

Optional. User friendly display name.

string display_name = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The displayName.

getDisplayNameBytes()

public abstract 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 abstract 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];

Returns
Type	Description
Task.ExecutionSpec	The executionSpec.

getExecutionSpecOrBuilder()

public abstract 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];

Returns
Type	Description
Task.ExecutionSpecOrBuilder

getExecutionStatus()

public abstract 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];

Returns
Type	Description
Task.ExecutionStatus	The executionStatus.

getExecutionStatusOrBuilder()

public abstract 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];

Returns
Type	Description
Task.ExecutionStatusOrBuilder

getLabels() (deprecated)

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
Map<String,String>

getLabelsCount()

public abstract 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 abstract Map<String,String> getLabelsMap()

Optional. User-defined labels for the task.

map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

Optional. User-defined labels for the task.

map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getLabelsOrThrow(String key)

public abstract 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

Returns
Type	Description
String

getName()

public abstract 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 abstract 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 abstract Task.NotebookTaskConfig getNotebook()

Config related to running scheduled Notebooks.

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

Returns
Type	Description
Task.NotebookTaskConfig	The notebook.

getNotebookOrBuilder()

public abstract Task.NotebookTaskConfigOrBuilder getNotebookOrBuilder()

Config related to running scheduled Notebooks.

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

Returns
Type	Description
Task.NotebookTaskConfigOrBuilder

getSpark()

public abstract Task.SparkTaskConfig getSpark()

Config related to running custom Spark tasks.

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

Returns
Type	Description
Task.SparkTaskConfig	The spark.

getSparkOrBuilder()

public abstract Task.SparkTaskConfigOrBuilder getSparkOrBuilder()

Config related to running custom Spark tasks.

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

Returns
Type	Description
Task.SparkTaskConfigOrBuilder

getState()

public abstract State 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 abstract 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 abstract 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];

Returns
Type	Description
Task.TriggerSpec	The triggerSpec.

getTriggerSpecOrBuilder()

public abstract 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];

Returns
Type	Description
Task.TriggerSpecOrBuilder

getUid()

public abstract 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 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The uid.

getUidBytes()

public abstract 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.

getUpdateTime()

public abstract 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 abstract TimestampOrBuilder getUpdateTimeOrBuilder()

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
TimestampOrBuilder

hasCreateTime()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.