Package flyteidl.event

Class Event.TaskExecutionEvent.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Event.TaskExecutionEventOrBuilder, java.lang.Cloneable
    Enclosing class:
    Event.TaskExecutionEvent
    public static final class Event.TaskExecutionEvent.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Event.TaskExecutionEvent.Builder>
implements Event.TaskExecutionEventOrBuilder
     Plugin specific execution event information. For tasks like Python, Hive, Spark, DynamicJob.
    Protobuf type flyteidl.event.TaskExecutionEvent

    • Method Detail

      • 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.Builder<Event.TaskExecutionEvent.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Event.TaskExecutionEvent.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • setField

        public Event.TaskExecutionEvent.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                 java.lang.Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<Event.TaskExecutionEvent.Builder>

      • setRepeatedField

        public Event.TaskExecutionEvent.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                         int index,
                                                         java.lang.Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Event.TaskExecutionEvent.Builder>

      • addRepeatedField

        public Event.TaskExecutionEvent.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                         java.lang.Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Event.TaskExecutionEvent.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Event.TaskExecutionEvent.Builder>

      • mergeFrom

        public Event.TaskExecutionEvent.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws java.io.IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Event.TaskExecutionEvent.Builder>
        Throws:
        java.io.IOException

      • 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.

      • clearTaskId

        public Event.TaskExecutionEvent.Builder clearTaskId()
         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;

      • getTaskIdBuilder

        public IdentifierOuterClass.Identifier.Builder getTaskIdBuilder()
         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

        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.

      • clearParentNodeExecutionId

        public Event.TaskExecutionEvent.Builder clearParentNodeExecutionId()
         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;

      • getParentNodeExecutionIdBuilder

        public IdentifierOuterClass.NodeExecutionIdentifier.Builder getParentNodeExecutionIdBuilder()
         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

        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.

      • setRetryAttempt

        public Event.TaskExecutionEvent.Builder setRetryAttempt​(int value)
         retry attempt number for this task, ie., 2 for the second attempt
        uint32 retry_attempt = 3;
        Parameters:
        value - The retryAttempt to set.
        Returns:
        This builder for chaining.

      • clearRetryAttempt

        public Event.TaskExecutionEvent.Builder clearRetryAttempt()
         retry attempt number for this task, ie., 2 for the second attempt
        uint32 retry_attempt = 3;
        Returns:
        This builder for chaining.

      • 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.

      • setPhaseValue

        public Event.TaskExecutionEvent.Builder setPhaseValue​(int value)
         Phase associated with the event
        .flyteidl.core.TaskExecution.Phase phase = 4;
        Parameters:
        value - The enum numeric value on the wire for phase to set.
        Returns:
        This builder for chaining.

      • clearPhase

        public Event.TaskExecutionEvent.Builder clearPhase()
         Phase associated with the event
        .flyteidl.core.TaskExecution.Phase phase = 4;
        Returns:
        This builder for chaining.

      • getProducerId

        public java.lang.String getProducerId()
         id of the process that sent this event, mainly for trace debugging
        string producer_id = 5;
        Specified by:
        getProducerId in interface Event.TaskExecutionEventOrBuilder
        Returns:
        The producerId.

      • 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.

      • setProducerId

        public Event.TaskExecutionEvent.Builder setProducerId​(java.lang.String value)
         id of the process that sent this event, mainly for trace debugging
        string producer_id = 5;
        Parameters:
        value - The producerId to set.
        Returns:
        This builder for chaining.

      • clearProducerId

        public Event.TaskExecutionEvent.Builder clearProducerId()
         id of the process that sent this event, mainly for trace debugging
        string producer_id = 5;
        Returns:
        This builder for chaining.

      • setProducerIdBytes

        public Event.TaskExecutionEvent.Builder setProducerIdBytes​(com.google.protobuf.ByteString value)
         id of the process that sent this event, mainly for trace debugging
        string producer_id = 5;
        Parameters:
        value - The bytes for producerId to set.
        Returns:
        This builder for chaining.

      • removeLogs

        public Event.TaskExecutionEvent.Builder removeLogs​(int index)
         log information for the task execution
        repeated .flyteidl.core.TaskLog logs = 6;

      • getLogsBuilder

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

      • addLogsBuilder

        public Execution.TaskLog.Builder addLogsBuilder()
         log information for the task execution
        repeated .flyteidl.core.TaskLog logs = 6;

      • addLogsBuilder

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

      • getLogsBuilderList

        public java.util.List<Execution.TaskLog.Builder> getLogsBuilderList()
         log information for the task execution
        repeated .flyteidl.core.TaskLog logs = 6;

      • 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.

      • setOccurredAt

        public Event.TaskExecutionEvent.Builder setOccurredAt​(com.google.protobuf.Timestamp value)
         This timestamp represents when the original event occurred, it is generated
 by the executor of the task.
        .google.protobuf.Timestamp occurred_at = 7;

      • setOccurredAt

        public Event.TaskExecutionEvent.Builder setOccurredAt​(com.google.protobuf.Timestamp.Builder builderForValue)
         This timestamp represents when the original event occurred, it is generated
 by the executor of the task.
        .google.protobuf.Timestamp occurred_at = 7;

      • mergeOccurredAt

        public Event.TaskExecutionEvent.Builder mergeOccurredAt​(com.google.protobuf.Timestamp value)
         This timestamp represents when the original event occurred, it is generated
 by the executor of the task.
        .google.protobuf.Timestamp occurred_at = 7;

      • clearOccurredAt

        public Event.TaskExecutionEvent.Builder clearOccurredAt()
         This timestamp represents when the original event occurred, it is generated
 by the executor of the task.
        .google.protobuf.Timestamp occurred_at = 7;

      • getOccurredAtBuilder

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

      • 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 java.lang.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.

      • setInputUri

        public Event.TaskExecutionEvent.Builder setInputUri​(java.lang.String value)
         URI of the input file, it encodes all the information
 including Cloud source provider. ie., s3://...
        string input_uri = 8;
        Parameters:
        value - The inputUri to set.
        Returns:
        This builder for chaining.

      • clearInputUri

        public Event.TaskExecutionEvent.Builder clearInputUri()
         URI of the input file, it encodes all the information
 including Cloud source provider. ie., s3://...
        string input_uri = 8;
        Returns:
        This builder for chaining.

      • setInputUriBytes

        public Event.TaskExecutionEvent.Builder setInputUriBytes​(com.google.protobuf.ByteString value)
         URI of the input file, it encodes all the information
 including Cloud source provider. ie., s3://...
        string input_uri = 8;
        Parameters:
        value - The bytes for inputUri to set.
        Returns:
        This builder for chaining.

      • getOutputUri

        public java.lang.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.

      • setOutputUri

        public Event.TaskExecutionEvent.Builder setOutputUri​(java.lang.String value)
         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;
        Parameters:
        value - The outputUri to set.
        Returns:
        This builder for chaining.

      • clearOutputUri

        public Event.TaskExecutionEvent.Builder clearOutputUri()
         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:
        This builder for chaining.

      • setOutputUriBytes

        public Event.TaskExecutionEvent.Builder setOutputUriBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for outputUri to set.
        Returns:
        This builder for chaining.

      • 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.

      • 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.

      • setCustomInfo

        public Event.TaskExecutionEvent.Builder setCustomInfo​(com.google.protobuf.Struct value)
         Custom data that the task plugin sends back. This is extensible to allow various plugins in the system.
        .google.protobuf.Struct custom_info = 11;

      • setCustomInfo

        public Event.TaskExecutionEvent.Builder setCustomInfo​(com.google.protobuf.Struct.Builder builderForValue)
         Custom data that the task plugin sends back. This is extensible to allow various plugins in the system.
        .google.protobuf.Struct custom_info = 11;

      • mergeCustomInfo

        public Event.TaskExecutionEvent.Builder mergeCustomInfo​(com.google.protobuf.Struct value)
         Custom data that the task plugin sends back. This is extensible to allow various plugins in the system.
        .google.protobuf.Struct custom_info = 11;

      • clearCustomInfo

        public Event.TaskExecutionEvent.Builder clearCustomInfo()
         Custom data that the task plugin sends back. This is extensible to allow various plugins in the system.
        .google.protobuf.Struct custom_info = 11;

      • getCustomInfoBuilder

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

      • 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.

      • setPhaseVersion

        public Event.TaskExecutionEvent.Builder setPhaseVersion​(int value)
         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;
        Parameters:
        value - The phaseVersion to set.
        Returns:
        This builder for chaining.

      • clearPhaseVersion

        public Event.TaskExecutionEvent.Builder clearPhaseVersion()
         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:
        This builder for chaining.

      • 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.

      • clearMetadata

        public Event.TaskExecutionEvent.Builder clearMetadata()
         Metadata around how a task was executed.
        .flyteidl.event.TaskExecutionMetadata metadata = 16;

      • getMetadataBuilder

        public Event.TaskExecutionMetadata.Builder getMetadataBuilder()
         Metadata around how a task was executed.
        .flyteidl.event.TaskExecutionMetadata metadata = 16;

      • setUnknownFields

        public final Event.TaskExecutionEvent.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Event.TaskExecutionEvent.Builder>

      • mergeUnknownFields

        public final Event.TaskExecutionEvent.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Event.TaskExecutionEvent.Builder>