Package flyteidl.event

Interface Event.TaskExecutionEventOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Event.TaskExecutionEvent, Event.TaskExecutionEvent.Builder
    Enclosing class:
    Event
    public static interface Event.TaskExecutionEventOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • hasTaskId

        boolean hasTaskId()
         ID of the task. In combination with the retryAttempt this will indicate
 the task execution uniquely for a given parent node execution.
        .flyteidl.core.Identifier task_id = 1;
        Returns:
        Whether the taskId field is set.

      • getTaskId

        IdentifierOuterClass.Identifier getTaskId()
         ID of the task. In combination with the retryAttempt this will indicate
 the task execution uniquely for a given parent node execution.
        .flyteidl.core.Identifier task_id = 1;
        Returns:
        The taskId.

      • getTaskIdOrBuilder

        IdentifierOuterClass.IdentifierOrBuilder getTaskIdOrBuilder()
         ID of the task. In combination with the retryAttempt this will indicate
 the task execution uniquely for a given parent node execution.
        .flyteidl.core.Identifier task_id = 1;

      • hasParentNodeExecutionId

        boolean hasParentNodeExecutionId()
         A task execution is always kicked off by a node execution, the event consumer
 will use the parent_id to relate the task to it's parent node execution
        .flyteidl.core.NodeExecutionIdentifier parent_node_execution_id = 2;
        Returns:
        Whether the parentNodeExecutionId field is set.

      • getParentNodeExecutionId

        IdentifierOuterClass.NodeExecutionIdentifier getParentNodeExecutionId()
         A task execution is always kicked off by a node execution, the event consumer
 will use the parent_id to relate the task to it's parent node execution
        .flyteidl.core.NodeExecutionIdentifier parent_node_execution_id = 2;
        Returns:
        The parentNodeExecutionId.

      • getParentNodeExecutionIdOrBuilder

        IdentifierOuterClass.NodeExecutionIdentifierOrBuilder getParentNodeExecutionIdOrBuilder()
         A task execution is always kicked off by a node execution, the event consumer
 will use the parent_id to relate the task to it's parent node execution
        .flyteidl.core.NodeExecutionIdentifier parent_node_execution_id = 2;

      • getRetryAttempt

        int getRetryAttempt()
         retry attempt number for this task, ie., 2 for the second attempt
        uint32 retry_attempt = 3;
        Returns:
        The retryAttempt.

      • getPhaseValue

        int getPhaseValue()
         Phase associated with the event
        .flyteidl.core.TaskExecution.Phase phase = 4;
        Returns:
        The enum numeric value on the wire for phase.

      • getPhase

        Execution.TaskExecution.Phase getPhase()
         Phase associated with the event
        .flyteidl.core.TaskExecution.Phase phase = 4;
        Returns:
        The phase.

      • getProducerId

        String getProducerId()
         id of the process that sent this event, mainly for trace debugging
        string producer_id = 5;
        Returns:
        The producerId.

      • getProducerIdBytes

        com.google.protobuf.ByteString getProducerIdBytes()
         id of the process that sent this event, mainly for trace debugging
        string producer_id = 5;
        Returns:
        The bytes for producerId.

      • getLogsList

        List<Execution.TaskLog> getLogsList()
         log information for the task execution
        repeated .flyteidl.core.TaskLog logs = 6;

      • getLogs

        Execution.TaskLog getLogs​(int index)
         log information for the task execution
        repeated .flyteidl.core.TaskLog logs = 6;

      • getLogsCount

        int getLogsCount()
         log information for the task execution
        repeated .flyteidl.core.TaskLog logs = 6;

      • getLogsOrBuilderList

        List<? extends Execution.TaskLogOrBuilder> getLogsOrBuilderList()
         log information for the task execution
        repeated .flyteidl.core.TaskLog logs = 6;

      • getLogsOrBuilder

        Execution.TaskLogOrBuilder getLogsOrBuilder​(int index)
         log information for the task execution
        repeated .flyteidl.core.TaskLog logs = 6;

      • hasOccurredAt

        boolean hasOccurredAt()
         This timestamp represents when the original event occurred, it is generated
 by the executor of the task.
        .google.protobuf.Timestamp occurred_at = 7;
        Returns:
        Whether the occurredAt field is set.

      • getOccurredAt

        com.google.protobuf.Timestamp getOccurredAt()
         This timestamp represents when the original event occurred, it is generated
 by the executor of the task.
        .google.protobuf.Timestamp occurred_at = 7;
        Returns:
        The occurredAt.

      • getOccurredAtOrBuilder

        com.google.protobuf.TimestampOrBuilder getOccurredAtOrBuilder()
         This timestamp represents when the original event occurred, it is generated
 by the executor of the task.
        .google.protobuf.Timestamp occurred_at = 7;

      • getInputUri

        String getInputUri()
         URI of the input file, it encodes all the information
 including Cloud source provider. ie., s3://...
        string input_uri = 8;
        Returns:
        The inputUri.

      • getInputUriBytes

        com.google.protobuf.ByteString getInputUriBytes()
         URI of the input file, it encodes all the information
 including Cloud source provider. ie., s3://...
        string input_uri = 8;
        Returns:
        The bytes for inputUri.

      • hasOutputUri

        boolean hasOutputUri()
         URI to the output of the execution, it will be in a format that encodes all the information
 including Cloud source provider. ie., s3://...
        string output_uri = 9;
        Returns:
        Whether the outputUri field is set.

      • getOutputUri

        String getOutputUri()
         URI to the output of the execution, it will be in a format that encodes all the information
 including Cloud source provider. ie., s3://...
        string output_uri = 9;
        Returns:
        The outputUri.

      • getOutputUriBytes

        com.google.protobuf.ByteString getOutputUriBytes()
         URI to the output of the execution, it will be in a format that encodes all the information
 including Cloud source provider. ie., s3://...
        string output_uri = 9;
        Returns:
        The bytes for outputUri.

      • hasError

        boolean hasError()
         Error information for the execution
        .flyteidl.core.ExecutionError error = 10;
        Returns:
        Whether the error field is set.

      • getError

        Execution.ExecutionError getError()
         Error information for the execution
        .flyteidl.core.ExecutionError error = 10;
        Returns:
        The error.

      • hasOutputData

        boolean hasOutputData()
         Raw output data produced by this task execution.
        .flyteidl.core.LiteralMap output_data = 17;
        Returns:
        Whether the outputData field is set.

      • getOutputData

        Literals.LiteralMap getOutputData()
         Raw output data produced by this task execution.
        .flyteidl.core.LiteralMap output_data = 17;
        Returns:
        The outputData.

      • getOutputDataOrBuilder

        Literals.LiteralMapOrBuilder getOutputDataOrBuilder()
         Raw output data produced by this task execution.
        .flyteidl.core.LiteralMap output_data = 17;

      • hasCustomInfo

        boolean hasCustomInfo()
         Custom data that the task plugin sends back. This is extensible to allow various plugins in the system.
        .google.protobuf.Struct custom_info = 11;
        Returns:
        Whether the customInfo field is set.

      • getCustomInfo

        com.google.protobuf.Struct getCustomInfo()
         Custom data that the task plugin sends back. This is extensible to allow various plugins in the system.
        .google.protobuf.Struct custom_info = 11;
        Returns:
        The customInfo.

      • getCustomInfoOrBuilder

        com.google.protobuf.StructOrBuilder getCustomInfoOrBuilder()
         Custom data that the task plugin sends back. This is extensible to allow various plugins in the system.
        .google.protobuf.Struct custom_info = 11;

      • getPhaseVersion

        int getPhaseVersion()
         Some phases, like RUNNING, can send multiple events with changed metadata (new logs, additional custom_info, etc)
 that should be recorded regardless of the lack of phase change.
 The version field should be incremented when metadata changes across the duration of an individual phase.
        uint32 phase_version = 12;
        Returns:
        The phaseVersion.

      • getReason

        String getReason()
         An optional explanation for the phase transition.
        string reason = 13;
        Returns:
        The reason.

      • getReasonBytes

        com.google.protobuf.ByteString getReasonBytes()
         An optional explanation for the phase transition.
        string reason = 13;
        Returns:
        The bytes for reason.

      • getTaskType

        String getTaskType()
         A predefined yet extensible Task type identifier. If the task definition is already registered in flyte admin
 this type will be identical, but not all task executions necessarily use pre-registered definitions and this
 type is useful to render the task in the UI, filter task executions, etc.
        string task_type = 14;
        Returns:
        The taskType.

      • getTaskTypeBytes

        com.google.protobuf.ByteString getTaskTypeBytes()
         A predefined yet extensible Task type identifier. If the task definition is already registered in flyte admin
 this type will be identical, but not all task executions necessarily use pre-registered definitions and this
 type is useful to render the task in the UI, filter task executions, etc.
        string task_type = 14;
        Returns:
        The bytes for taskType.

      • hasMetadata

        boolean hasMetadata()
         Metadata around how a task was executed.
        .flyteidl.event.TaskExecutionMetadata metadata = 16;
        Returns:
        Whether the metadata field is set.

      • getMetadata

        Event.TaskExecutionMetadata getMetadata()
         Metadata around how a task was executed.
        .flyteidl.event.TaskExecutionMetadata metadata = 16;
        Returns:
        The metadata.

      • getEventVersion

        int getEventVersion()
         The event version is used to indicate versioned changes in how data is reported using this
 proto message. For example, event_verison > 0 means that maps tasks report logs using the
 TaskExecutionMetadata ExternalResourceInfo fields for each subtask rather than the TaskLog
 in this message.
        int32 event_version = 18;
        Returns:
        The eventVersion.