Class PipelineTaskDetail (3.4.1)

public final class PipelineTaskDetail extends GeneratedMessageV3 implements PipelineTaskDetailOrBuilder

The runtime detail of a task execution.

Protobuf type google.cloud.aiplatform.v1.PipelineTaskDetail

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

END_TIME_FIELD_NUMBER

public static final int END_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

ERROR_FIELD_NUMBER

public static final int ERROR_FIELD_NUMBER
Field Value
TypeDescription
int

EXECUTION_FIELD_NUMBER

public static final int EXECUTION_FIELD_NUMBER
Field Value
TypeDescription
int

EXECUTOR_DETAIL_FIELD_NUMBER

public static final int EXECUTOR_DETAIL_FIELD_NUMBER
Field Value
TypeDescription
int

INPUTS_FIELD_NUMBER

public static final int INPUTS_FIELD_NUMBER
Field Value
TypeDescription
int

OUTPUTS_FIELD_NUMBER

public static final int OUTPUTS_FIELD_NUMBER
Field Value
TypeDescription
int

PARENT_TASK_ID_FIELD_NUMBER

public static final int PARENT_TASK_ID_FIELD_NUMBER
Field Value
TypeDescription
int

PIPELINE_TASK_STATUS_FIELD_NUMBER

public static final int PIPELINE_TASK_STATUS_FIELD_NUMBER
Field Value
TypeDescription
int

START_TIME_FIELD_NUMBER

public static final int START_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
TypeDescription
int

TASK_ID_FIELD_NUMBER

public static final int TASK_ID_FIELD_NUMBER
Field Value
TypeDescription
int

TASK_NAME_FIELD_NUMBER

public static final int TASK_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static PipelineTaskDetail getDefaultInstance()
Returns
TypeDescription
PipelineTaskDetail

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static PipelineTaskDetail.Builder newBuilder()
Returns
TypeDescription
PipelineTaskDetail.Builder

newBuilder(PipelineTaskDetail prototype)

public static PipelineTaskDetail.Builder newBuilder(PipelineTaskDetail prototype)
Parameter
NameDescription
prototypePipelineTaskDetail
Returns
TypeDescription
PipelineTaskDetail.Builder

parseDelimitedFrom(InputStream input)

public static PipelineTaskDetail parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
PipelineTaskDetail
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PipelineTaskDetail parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PipelineTaskDetail
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static PipelineTaskDetail parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
PipelineTaskDetail
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PipelineTaskDetail parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PipelineTaskDetail
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PipelineTaskDetail parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
PipelineTaskDetail
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PipelineTaskDetail parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PipelineTaskDetail
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PipelineTaskDetail parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
PipelineTaskDetail
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PipelineTaskDetail parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PipelineTaskDetail
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static PipelineTaskDetail parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
PipelineTaskDetail
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PipelineTaskDetail parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PipelineTaskDetail
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static PipelineTaskDetail parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
PipelineTaskDetail
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PipelineTaskDetail parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PipelineTaskDetail
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<PipelineTaskDetail> parser()
Returns
TypeDescription
Parser<PipelineTaskDetail>

Methods

containsInputs(String key)

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

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

containsOutputs(String key)

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

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getCreateTime()

public Timestamp getCreateTime()

Output only. Task create time.

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

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Task create time.

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

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public PipelineTaskDetail getDefaultInstanceForType()
Returns
TypeDescription
PipelineTaskDetail

getEndTime()

public Timestamp getEndTime()

Output only. Task end time.

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

Returns
TypeDescription
Timestamp

The endTime.

getEndTimeOrBuilder()

public TimestampOrBuilder getEndTimeOrBuilder()

Output only. Task end time.

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

Returns
TypeDescription
TimestampOrBuilder

getError()

public 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
TypeDescription
com.google.rpc.Status

The error.

getErrorOrBuilder()

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

Returns
TypeDescription
com.google.rpc.StatusOrBuilder

getExecution()

public Execution getExecution()

Output only. The execution metadata of the task.

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

Returns
TypeDescription
Execution

The execution.

getExecutionOrBuilder()

public ExecutionOrBuilder getExecutionOrBuilder()

Output only. The execution metadata of the task.

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

Returns
TypeDescription
ExecutionOrBuilder

getExecutorDetail()

public PipelineTaskExecutorDetail getExecutorDetail()

Output only. The detailed execution info.

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

Returns
TypeDescription
PipelineTaskExecutorDetail

The executorDetail.

getExecutorDetailOrBuilder()

public PipelineTaskExecutorDetailOrBuilder getExecutorDetailOrBuilder()

Output only. The detailed execution info.

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

Returns
TypeDescription
PipelineTaskExecutorDetailOrBuilder

getInputs()

public Map<String,PipelineTaskDetail.ArtifactList> getInputs()

Use #getInputsMap() instead.

Returns
TypeDescription
Map<String,ArtifactList>

getInputsCount()

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

Returns
TypeDescription
int

getInputsMap()

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

Returns
TypeDescription
Map<String,ArtifactList>

getInputsOrDefault(String key, PipelineTaskDetail.ArtifactList defaultValue)

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

Parameters
NameDescription
keyString
defaultValuePipelineTaskDetail.ArtifactList
Returns
TypeDescription
PipelineTaskDetail.ArtifactList

getInputsOrThrow(String key)

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

Parameter
NameDescription
keyString
Returns
TypeDescription
PipelineTaskDetail.ArtifactList

getOutputs()

public Map<String,PipelineTaskDetail.ArtifactList> getOutputs()

Use #getOutputsMap() instead.

Returns
TypeDescription
Map<String,ArtifactList>

getOutputsCount()

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

Returns
TypeDescription
int

getOutputsMap()

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

Returns
TypeDescription
Map<String,ArtifactList>

getOutputsOrDefault(String key, PipelineTaskDetail.ArtifactList defaultValue)

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

Parameters
NameDescription
keyString
defaultValuePipelineTaskDetail.ArtifactList
Returns
TypeDescription
PipelineTaskDetail.ArtifactList

getOutputsOrThrow(String key)

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

Parameter
NameDescription
keyString
Returns
TypeDescription
PipelineTaskDetail.ArtifactList

getParentTaskId()

public 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
TypeDescription
long

The parentTaskId.

getParserForType()

public Parser<PipelineTaskDetail> getParserForType()
Returns
TypeDescription
Parser<PipelineTaskDetail>
Overrides

getPipelineTaskStatus(int index)

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

Parameter
NameDescription
indexint
Returns
TypeDescription
PipelineTaskDetail.PipelineTaskStatus

getPipelineTaskStatusCount()

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

Returns
TypeDescription
int

getPipelineTaskStatusList()

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

Returns
TypeDescription
List<PipelineTaskStatus>

getPipelineTaskStatusOrBuilder(int index)

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

Parameter
NameDescription
indexint
Returns
TypeDescription
PipelineTaskDetail.PipelineTaskStatusOrBuilder

getPipelineTaskStatusOrBuilderList()

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

Returns
TypeDescription
List<? extends com.google.cloud.aiplatform.v1.PipelineTaskDetail.PipelineTaskStatusOrBuilder>

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getStartTime()

public Timestamp getStartTime()

Output only. Task start time.

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

Returns
TypeDescription
Timestamp

The startTime.

getStartTimeOrBuilder()

public TimestampOrBuilder getStartTimeOrBuilder()

Output only. Task start time.

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

Returns
TypeDescription
TimestampOrBuilder

getState()

public PipelineTaskDetail.State getState()

Output only. State of the task.

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

Returns
TypeDescription
PipelineTaskDetail.State

The state.

getStateValue()

public int getStateValue()

Output only. State of the task.

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

Returns
TypeDescription
int

The enum numeric value on the wire for state.

getTaskId()

public long getTaskId()

Output only. The system generated ID of the task.

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

Returns
TypeDescription
long

The taskId.

getTaskName()

public String getTaskName()

Output only. The user specified name of the task that is defined in [PipelineJob.spec][].

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

Returns
TypeDescription
String

The taskName.

getTaskNameBytes()

public ByteString getTaskNameBytes()

Output only. The user specified name of the task that is defined in [PipelineJob.spec][].

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

Returns
TypeDescription
ByteString

The bytes for taskName.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasCreateTime()

public boolean hasCreateTime()

Output only. Task create time.

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

Returns
TypeDescription
boolean

Whether the createTime field is set.

hasEndTime()

public boolean hasEndTime()

Output only. Task end time.

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

Returns
TypeDescription
boolean

Whether the endTime field is set.

hasError()

public 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
TypeDescription
boolean

Whether the error field is set.

hasExecution()

public boolean hasExecution()

Output only. The execution metadata of the task.

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

Returns
TypeDescription
boolean

Whether the execution field is set.

hasExecutorDetail()

public boolean hasExecutorDetail()

Output only. The detailed execution info.

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

Returns
TypeDescription
boolean

Whether the executorDetail field is set.

hasStartTime()

public boolean hasStartTime()

Output only. Task start time.

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

Returns
TypeDescription
boolean

Whether the startTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public PipelineTaskDetail.Builder newBuilderForType()
Returns
TypeDescription
PipelineTaskDetail.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PipelineTaskDetail.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
PipelineTaskDetail.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public PipelineTaskDetail.Builder toBuilder()
Returns
TypeDescription
PipelineTaskDetail.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException