Package flyteidl.event

Class Event.TaskExecutionEvent

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Event.TaskExecutionEventOrBuilder, Serializable
    Enclosing class:
    Event
    public static final class Event.TaskExecutionEvent
extends com.google.protobuf.GeneratedMessageV3
implements Event.TaskExecutionEventOrBuilder
     Plugin specific execution event information. For tasks like Python, Hive, Spark, DynamicJob.
    Protobuf type flyteidl.event.TaskExecutionEvent
    See Also:
    Serialized Form

    • Constructor Detail

      • TaskExecutionEvent

        private TaskExecutionEvent​(com.google.protobuf.GeneratedMessageV3.Builder<?> builder)

      • TaskExecutionEvent

        private TaskExecutionEvent()

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • hasTaskId

        public 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;
        Specified by:
        hasTaskId in interface Event.TaskExecutionEventOrBuilder
        Returns:
        Whether the taskId field is set.

      • hasParentNodeExecutionId

        public 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;
        Specified by:
        hasParentNodeExecutionId in interface Event.TaskExecutionEventOrBuilder
        Returns:
        Whether the parentNodeExecutionId field is set.

      • getRetryAttempt

        public int getRetryAttempt()
         retry attempt number for this task, ie., 2 for the second attempt
        uint32 retry_attempt = 3;
        Specified by:
        getRetryAttempt in interface Event.TaskExecutionEventOrBuilder
        Returns:
        The retryAttempt.

      • getPhaseValue

        public int getPhaseValue()
         Phase associated with the event
        .flyteidl.core.TaskExecution.Phase phase = 4;
        Specified by:
        getPhaseValue in interface Event.TaskExecutionEventOrBuilder
        Returns:
        The enum numeric value on the wire for phase.

      • getProducerIdBytes

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

      • hasOccurredAt

        public 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;
        Specified by:
        hasOccurredAt in interface Event.TaskExecutionEventOrBuilder
        Returns:
        Whether the occurredAt field is set.

      • getOccurredAt

        public 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;
        Specified by:
        getOccurredAt in interface Event.TaskExecutionEventOrBuilder
        Returns:
        The occurredAt.

      • getOccurredAtOrBuilder

        public 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;
        Specified by:
        getOccurredAtOrBuilder in interface Event.TaskExecutionEventOrBuilder

      • getInputUri

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

      • getInputUriBytes

        public 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;
        Specified by:
        getInputUriBytes in interface Event.TaskExecutionEventOrBuilder
        Returns:
        The bytes for inputUri.

      • hasOutputUri

        public 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;
        Specified by:
        hasOutputUri in interface Event.TaskExecutionEventOrBuilder
        Returns:
        Whether the outputUri field is set.

      • getOutputUri

        public 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;
        Specified by:
        getOutputUri in interface Event.TaskExecutionEventOrBuilder
        Returns:
        The outputUri.

      • getOutputUriBytes

        public 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;
        Specified by:
        getOutputUriBytes in interface Event.TaskExecutionEventOrBuilder
        Returns:
        The bytes for outputUri.

      • hasError

        public boolean hasError()
         Error information for the execution
        .flyteidl.core.ExecutionError error = 10;
        Specified by:
        hasError in interface Event.TaskExecutionEventOrBuilder
        Returns:
        Whether the error field is set.

      • hasOutputData

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

      • hasCustomInfo

        public 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;
        Specified by:
        hasCustomInfo in interface Event.TaskExecutionEventOrBuilder
        Returns:
        Whether the customInfo field is set.

      • getCustomInfo

        public 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;
        Specified by:
        getCustomInfo in interface Event.TaskExecutionEventOrBuilder
        Returns:
        The customInfo.

      • getCustomInfoOrBuilder

        public 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;
        Specified by:
        getCustomInfoOrBuilder in interface Event.TaskExecutionEventOrBuilder

      • getPhaseVersion

        public 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;
        Specified by:
        getPhaseVersion in interface Event.TaskExecutionEventOrBuilder
        Returns:
        The phaseVersion.

      • getReasonBytes

        public com.google.protobuf.ByteString getReasonBytes()
         An optional explanation for the phase transition.
        string reason = 13;
        Specified by:
        getReasonBytes in interface Event.TaskExecutionEventOrBuilder
        Returns:
        The bytes for reason.

      • getTaskType

        public 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;
        Specified by:
        getTaskType in interface Event.TaskExecutionEventOrBuilder
        Returns:
        The taskType.

      • getTaskTypeBytes

        public 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;
        Specified by:
        getTaskTypeBytes in interface Event.TaskExecutionEventOrBuilder
        Returns:
        The bytes for taskType.

      • hasMetadata

        public boolean hasMetadata()
         Metadata around how a task was executed.
        .flyteidl.event.TaskExecutionMetadata metadata = 16;
        Specified by:
        hasMetadata in interface Event.TaskExecutionEventOrBuilder
        Returns:
        Whether the metadata field is set.

      • getEventVersion

        public 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;
        Specified by:
        getEventVersion in interface Event.TaskExecutionEventOrBuilder
        Returns:
        The eventVersion.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static Event.TaskExecutionEvent parseFrom​(ByteBuffer data)
                                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Event.TaskExecutionEvent parseFrom​(ByteBuffer data,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Event.TaskExecutionEvent parseFrom​(com.google.protobuf.ByteString data)
                                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Event.TaskExecutionEvent parseFrom​(com.google.protobuf.ByteString data,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Event.TaskExecutionEvent parseFrom​(byte[] data)
                                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Event.TaskExecutionEvent parseFrom​(byte[] data,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • newBuilderForType

        public Event.TaskExecutionEvent.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public Event.TaskExecutionEvent.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected Event.TaskExecutionEvent.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<Event.TaskExecutionEvent> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public Event.TaskExecutionEvent getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder