com.google.cloud.aiplatform.v1

Interface PipelineTaskDetailOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

PipelineTaskDetail, PipelineTaskDetail.Builder

public interface PipelineTaskDetailOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsInputs(String key) Output only.
boolean	containsOutputs(String key) Output only.
com.google.protobuf.Timestamp	getCreateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getCreateTimeOrBuilder() Output only.
com.google.protobuf.Timestamp	getEndTime() Output only.
com.google.protobuf.TimestampOrBuilder	getEndTimeOrBuilder() Output only.
com.google.rpc.Status	getError() Output only.
com.google.rpc.StatusOrBuilder	getErrorOrBuilder() Output only.
Execution	getExecution() Output only.
ExecutionOrBuilder	getExecutionOrBuilder() Output only.
PipelineTaskExecutorDetail	getExecutorDetail() Output only.
PipelineTaskExecutorDetailOrBuilder	getExecutorDetailOrBuilder() Output only.
Map<String,PipelineTaskDetail.ArtifactList>	getInputs() Deprecated.
int	getInputsCount() Output only.
Map<String,PipelineTaskDetail.ArtifactList>	getInputsMap() Output only.
PipelineTaskDetail.ArtifactList	getInputsOrDefault(String key, PipelineTaskDetail.ArtifactList defaultValue) Output only.
PipelineTaskDetail.ArtifactList	getInputsOrThrow(String key) Output only.
Map<String,PipelineTaskDetail.ArtifactList>	getOutputs() Deprecated.
int	getOutputsCount() Output only.
Map<String,PipelineTaskDetail.ArtifactList>	getOutputsMap() Output only.
PipelineTaskDetail.ArtifactList	getOutputsOrDefault(String key, PipelineTaskDetail.ArtifactList defaultValue) Output only.
PipelineTaskDetail.ArtifactList	getOutputsOrThrow(String key) Output only.
long	getParentTaskId() Output only.
PipelineTaskDetail.PipelineTaskStatus	getPipelineTaskStatus(int index) Output only.
int	getPipelineTaskStatusCount() Output only.
List<PipelineTaskDetail.PipelineTaskStatus>	getPipelineTaskStatusList() Output only.
PipelineTaskDetail.PipelineTaskStatusOrBuilder	getPipelineTaskStatusOrBuilder(int index) Output only.
List<? extends PipelineTaskDetail.PipelineTaskStatusOrBuilder>	getPipelineTaskStatusOrBuilderList() Output only.
com.google.protobuf.Timestamp	getStartTime() Output only.
com.google.protobuf.TimestampOrBuilder	getStartTimeOrBuilder() Output only.
PipelineTaskDetail.State	getState() Output only.
int	getStateValue() Output only.
long	getTaskId() Output only.
String	getTaskName() Output only.
com.google.protobuf.ByteString	getTaskNameBytes() Output only.
String	getTaskUniqueName() Output only.
com.google.protobuf.ByteString	getTaskUniqueNameBytes() Output only.
boolean	hasCreateTime() Output only.
boolean	hasEndTime() Output only.
boolean	hasError() Output only.
boolean	hasExecution() Output only.
boolean	hasExecutorDetail() Output only.
boolean	hasStartTime() Output only.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getTaskId

long getTaskId()

 Output only. The system generated ID of the task.
 

int64 task_id = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The taskId.

getParentTaskId

long getParentTaskId()

 Output only. The id of the parent task if the task is within a component
 scope. Empty if the task is at the root level.
 

int64 parent_task_id = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The parentTaskId.

getTaskName

String getTaskName()

 Output only. The user specified name of the task that is defined in
 [pipeline_spec][google.cloud.aiplatform.v1.PipelineJob.pipeline_spec].
 

string task_name = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The taskName.

getTaskNameBytes

com.google.protobuf.ByteString getTaskNameBytes()

 Output only. The user specified name of the task that is defined in
 [pipeline_spec][google.cloud.aiplatform.v1.PipelineJob.pipeline_spec].
 

string task_name = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The bytes for taskName.

hasCreateTime

boolean hasCreateTime()

 Output only. Task create time.
 

.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. Task create time.
 

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

Returns:

The createTime.

getCreateTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()

 Output only. Task create time.
 

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

hasStartTime

boolean hasStartTime()

 Output only. Task start time.
 

.google.protobuf.Timestamp start_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the startTime field is set.

getStartTime

com.google.protobuf.Timestamp getStartTime()

 Output only. Task start time.
 

.google.protobuf.Timestamp start_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The startTime.

getStartTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()

 Output only. Task start time.
 

.google.protobuf.Timestamp start_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

hasEndTime

boolean hasEndTime()

 Output only. Task end time.
 

.google.protobuf.Timestamp end_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the endTime field is set.

getEndTime

com.google.protobuf.Timestamp getEndTime()

 Output only. Task end time.
 

.google.protobuf.Timestamp end_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The endTime.

getEndTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder()

 Output only. Task end time.
 

.google.protobuf.Timestamp end_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

hasExecutorDetail

boolean hasExecutorDetail()

 Output only. The detailed execution info.
 

.google.cloud.aiplatform.v1.PipelineTaskExecutorDetail executor_detail = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the executorDetail field is set.

getExecutorDetail

PipelineTaskExecutorDetail getExecutorDetail()

 Output only. The detailed execution info.
 

.google.cloud.aiplatform.v1.PipelineTaskExecutorDetail executor_detail = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The executorDetail.

getExecutorDetailOrBuilder

PipelineTaskExecutorDetailOrBuilder getExecutorDetailOrBuilder()

 Output only. The detailed execution info.
 

.google.cloud.aiplatform.v1.PipelineTaskExecutorDetail executor_detail = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

getStateValue

int getStateValue()

 Output only. State of the task.
 

.google.cloud.aiplatform.v1.PipelineTaskDetail.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The enum numeric value on the wire for state.

getState

PipelineTaskDetail.State getState()

 Output only. State of the task.
 

.google.cloud.aiplatform.v1.PipelineTaskDetail.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The state.

hasExecution

boolean hasExecution()

 Output only. The execution metadata of the task.
 

.google.cloud.aiplatform.v1.Execution execution = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the execution field is set.

getExecution

Execution getExecution()

 Output only. The execution metadata of the task.
 

.google.cloud.aiplatform.v1.Execution execution = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The execution.

getExecutionOrBuilder

ExecutionOrBuilder getExecutionOrBuilder()

 Output only. The execution metadata of the task.
 

.google.cloud.aiplatform.v1.Execution execution = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

hasError

boolean hasError()

 Output only. The error that occurred during task execution.
 Only populated when the task's state is FAILED or CANCELLED.
 

.google.rpc.Status error = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the error field is set.

getError

com.google.rpc.Status getError()

 Output only. The error that occurred during task execution.
 Only populated when the task's state is FAILED or CANCELLED.
 

.google.rpc.Status error = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The error.

getErrorOrBuilder

com.google.rpc.StatusOrBuilder getErrorOrBuilder()

 Output only. The error that occurred during task execution.
 Only populated when the task's state is FAILED or CANCELLED.
 

.google.rpc.Status error = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

getPipelineTaskStatusList

List<PipelineTaskDetail.PipelineTaskStatus> getPipelineTaskStatusList()

 Output only. A list of task status. This field keeps a record of task
 status evolving over time.
 

repeated .google.cloud.aiplatform.v1.PipelineTaskDetail.PipelineTaskStatus pipeline_task_status = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

getPipelineTaskStatus

PipelineTaskDetail.PipelineTaskStatus getPipelineTaskStatus(int index)

 Output only. A list of task status. This field keeps a record of task
 status evolving over time.
 

repeated .google.cloud.aiplatform.v1.PipelineTaskDetail.PipelineTaskStatus pipeline_task_status = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

getPipelineTaskStatusCount

int getPipelineTaskStatusCount()

 Output only. A list of task status. This field keeps a record of task
 status evolving over time.
 

repeated .google.cloud.aiplatform.v1.PipelineTaskDetail.PipelineTaskStatus pipeline_task_status = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

getPipelineTaskStatusOrBuilderList

List<? extends PipelineTaskDetail.PipelineTaskStatusOrBuilder> getPipelineTaskStatusOrBuilderList()

 Output only. A list of task status. This field keeps a record of task
 status evolving over time.
 

repeated .google.cloud.aiplatform.v1.PipelineTaskDetail.PipelineTaskStatus pipeline_task_status = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

getPipelineTaskStatusOrBuilder

PipelineTaskDetail.PipelineTaskStatusOrBuilder getPipelineTaskStatusOrBuilder(int index)

 Output only. A list of task status. This field keeps a record of task
 status evolving over time.
 

repeated .google.cloud.aiplatform.v1.PipelineTaskDetail.PipelineTaskStatus pipeline_task_status = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

getInputsCount

int getInputsCount()

 Output only. The runtime input artifacts of the task.
 

map<string, .google.cloud.aiplatform.v1.PipelineTaskDetail.ArtifactList> inputs = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

containsInputs

boolean containsInputs(String key)

 Output only. The runtime input artifacts of the task.
 

map<string, .google.cloud.aiplatform.v1.PipelineTaskDetail.ArtifactList> inputs = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

getInputs

@Deprecated
Map<String,PipelineTaskDetail.ArtifactList> getInputs()

Deprecated.

Use getInputsMap() instead.

getInputsMap

Map<String,PipelineTaskDetail.ArtifactList> getInputsMap()

 Output only. The runtime input artifacts of the task.
 

map<string, .google.cloud.aiplatform.v1.PipelineTaskDetail.ArtifactList> inputs = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

getInputsOrDefault

PipelineTaskDetail.ArtifactList getInputsOrDefault(String key,
                                                   PipelineTaskDetail.ArtifactList defaultValue)

 Output only. The runtime input artifacts of the task.
 

map<string, .google.cloud.aiplatform.v1.PipelineTaskDetail.ArtifactList> inputs = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

getInputsOrThrow

PipelineTaskDetail.ArtifactList getInputsOrThrow(String key)

 Output only. The runtime input artifacts of the task.
 

map<string, .google.cloud.aiplatform.v1.PipelineTaskDetail.ArtifactList> inputs = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

getOutputsCount

int getOutputsCount()

 Output only. The runtime output artifacts of the task.
 

map<string, .google.cloud.aiplatform.v1.PipelineTaskDetail.ArtifactList> outputs = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

containsOutputs

boolean containsOutputs(String key)

 Output only. The runtime output artifacts of the task.
 

map<string, .google.cloud.aiplatform.v1.PipelineTaskDetail.ArtifactList> outputs = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

getOutputs

@Deprecated
Map<String,PipelineTaskDetail.ArtifactList> getOutputs()

Deprecated.

Use getOutputsMap() instead.

getOutputsMap

Map<String,PipelineTaskDetail.ArtifactList> getOutputsMap()

 Output only. The runtime output artifacts of the task.
 

map<string, .google.cloud.aiplatform.v1.PipelineTaskDetail.ArtifactList> outputs = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

getOutputsOrDefault

PipelineTaskDetail.ArtifactList getOutputsOrDefault(String key,
                                                    PipelineTaskDetail.ArtifactList defaultValue)

 Output only. The runtime output artifacts of the task.
 

map<string, .google.cloud.aiplatform.v1.PipelineTaskDetail.ArtifactList> outputs = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

getOutputsOrThrow

PipelineTaskDetail.ArtifactList getOutputsOrThrow(String key)

 Output only. The runtime output artifacts of the task.
 

map<string, .google.cloud.aiplatform.v1.PipelineTaskDetail.ArtifactList> outputs = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

getTaskUniqueName

String getTaskUniqueName()

 Output only. The unique name of a task.
 This field is used by rerun pipeline job.
 Console UI and Vertex AI SDK will support triggering pipeline job reruns.
 The name is constructed by concatenating all the parent tasks name with
 the task name. For example, if a task named "child_task" has a parent task
 named "parent_task_1" and parent task 1 has a parent task named
 "parent_task_2", the task unique name will be
 "parent_task_2.parent_task_1.child_task".
 

string task_unique_name = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The taskUniqueName.

getTaskUniqueNameBytes

com.google.protobuf.ByteString getTaskUniqueNameBytes()

 Output only. The unique name of a task.
 This field is used by rerun pipeline job.
 Console UI and Vertex AI SDK will support triggering pipeline job reruns.
 The name is constructed by concatenating all the parent tasks name with
 the task name. For example, if a task named "child_task" has a parent task
 named "parent_task_1" and parent task 1 has a parent task named
 "parent_task_2", the task unique name will be
 "parent_task_2.parent_task_1.child_task".
 

string task_unique_name = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The bytes for taskUniqueName.