Package com.google.cloud.dataplex.v1
Interface TaskOrBuilder
-
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
Task,Task.Builder
public interface TaskOrBuilder extends com.google.protobuf.MessageOrBuilder
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description booleancontainsLabels(String key)Optional.Task.ConfigCasegetConfigCase()com.google.protobuf.TimestampgetCreateTime()Output only.com.google.protobuf.TimestampOrBuildergetCreateTimeOrBuilder()Output only.StringgetDescription()Optional.com.google.protobuf.ByteStringgetDescriptionBytes()Optional.StringgetDisplayName()Optional.com.google.protobuf.ByteStringgetDisplayNameBytes()Optional.Task.ExecutionSpecgetExecutionSpec()Required.Task.ExecutionSpecOrBuildergetExecutionSpecOrBuilder()Required.Task.ExecutionStatusgetExecutionStatus()Output only.Task.ExecutionStatusOrBuildergetExecutionStatusOrBuilder()Output only.Map<String,String>getLabels()Deprecated.intgetLabelsCount()Optional.Map<String,String>getLabelsMap()Optional.StringgetLabelsOrDefault(String key, String defaultValue)Optional.StringgetLabelsOrThrow(String key)Optional.StringgetName()Output only.com.google.protobuf.ByteStringgetNameBytes()Output only.Task.NotebookTaskConfiggetNotebook()Config related to running scheduled Notebooks.Task.NotebookTaskConfigOrBuildergetNotebookOrBuilder()Config related to running scheduled Notebooks.Task.SparkTaskConfiggetSpark()Config related to running custom Spark tasks.Task.SparkTaskConfigOrBuildergetSparkOrBuilder()Config related to running custom Spark tasks.StategetState()Output only.intgetStateValue()Output only.Task.TriggerSpecgetTriggerSpec()Required.Task.TriggerSpecOrBuildergetTriggerSpecOrBuilder()Required.StringgetUid()Output only.com.google.protobuf.ByteStringgetUidBytes()Output only.com.google.protobuf.TimestampgetUpdateTime()Output only.com.google.protobuf.TimestampOrBuildergetUpdateTimeOrBuilder()Output only.booleanhasCreateTime()Output only.booleanhasExecutionSpec()Required.booleanhasExecutionStatus()Output only.booleanhasNotebook()Config related to running scheduled Notebooks.booleanhasSpark()Config related to running custom Spark tasks.booleanhasTriggerSpec()Required.booleanhasUpdateTime()Output only.-
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
-
-
-
Method Detail
-
getName
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:
- The name.
-
getNameBytes
com.google.protobuf.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:
- The bytes for name.
-
getUid
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:
- The uid.
-
getUidBytes
com.google.protobuf.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:
- The bytes for uid.
-
hasCreateTime
boolean hasCreateTime()
Output only. The time when the task was created.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- Whether the createTime field is set.
-
getCreateTime
com.google.protobuf.Timestamp getCreateTime()
Output only. The time when the task was created.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The createTime.
-
getCreateTimeOrBuilder
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The time when the task was created.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
-
hasUpdateTime
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:
- Whether the updateTime field is set.
-
getUpdateTime
com.google.protobuf.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:
- The updateTime.
-
getUpdateTimeOrBuilder
com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. The time when the task was last updated.
.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
-
getDescription
String getDescription()
Optional. Description of the task.
string description = 5 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- The description.
-
getDescriptionBytes
com.google.protobuf.ByteString getDescriptionBytes()
Optional. Description of the task.
string description = 5 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- The bytes for description.
-
getDisplayName
String getDisplayName()
Optional. User friendly display name.
string display_name = 6 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- The displayName.
-
getDisplayNameBytes
com.google.protobuf.ByteString getDisplayNameBytes()
Optional. User friendly display name.
string display_name = 6 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- The bytes for displayName.
-
getStateValue
int getStateValue()
Output only. Current state of the task.
.google.cloud.dataplex.v1.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The enum numeric value on the wire for state.
-
getState
State getState()
Output only. Current state of the task.
.google.cloud.dataplex.v1.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The state.
-
getLabelsCount
int getLabelsCount()
Optional. User-defined labels for the task.
map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];
-
containsLabels
boolean containsLabels(String key)
Optional. User-defined labels for the task.
map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];
-
getLabels
@Deprecated Map<String,String> getLabels()
Deprecated.UsegetLabelsMap()instead.
-
getLabelsMap
Map<String,String> getLabelsMap()
Optional. User-defined labels for the task.
map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];
-
getLabelsOrDefault
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 getLabelsOrThrow(String key)
Optional. User-defined labels for the task.
map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];
-
hasTriggerSpec
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:
- Whether the triggerSpec field is set.
-
getTriggerSpec
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:
- The triggerSpec.
-
getTriggerSpecOrBuilder
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];
-
hasExecutionSpec
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:
- Whether the executionSpec field is set.
-
getExecutionSpec
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:
- The executionSpec.
-
getExecutionSpecOrBuilder
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];
-
hasExecutionStatus
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:
- Whether the executionStatus field is set.
-
getExecutionStatus
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:
- The executionStatus.
-
getExecutionStatusOrBuilder
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];
-
hasSpark
boolean hasSpark()
Config related to running custom Spark tasks.
.google.cloud.dataplex.v1.Task.SparkTaskConfig spark = 300;- Returns:
- Whether the spark field is set.
-
getSpark
Task.SparkTaskConfig getSpark()
Config related to running custom Spark tasks.
.google.cloud.dataplex.v1.Task.SparkTaskConfig spark = 300;- Returns:
- The spark.
-
getSparkOrBuilder
Task.SparkTaskConfigOrBuilder getSparkOrBuilder()
Config related to running custom Spark tasks.
.google.cloud.dataplex.v1.Task.SparkTaskConfig spark = 300;
-
hasNotebook
boolean hasNotebook()
Config related to running scheduled Notebooks.
.google.cloud.dataplex.v1.Task.NotebookTaskConfig notebook = 302;- Returns:
- Whether the notebook field is set.
-
getNotebook
Task.NotebookTaskConfig getNotebook()
Config related to running scheduled Notebooks.
.google.cloud.dataplex.v1.Task.NotebookTaskConfig notebook = 302;- Returns:
- The notebook.
-
getNotebookOrBuilder
Task.NotebookTaskConfigOrBuilder getNotebookOrBuilder()
Config related to running scheduled Notebooks.
.google.cloud.dataplex.v1.Task.NotebookTaskConfig notebook = 302;
-
getConfigCase
Task.ConfigCase getConfigCase()
-
-