Package flyteidl.core

Interface Tasks.TaskTemplateOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Tasks.TaskTemplate, Tasks.TaskTemplate.Builder
    Enclosing class:
    Tasks

    public static interface Tasks.TaskTemplateOrBuilder
    extends com.google.protobuf.MessageOrBuilder
    • Method Detail

      • hasId

        boolean hasId()
         Auto generated taskId by the system. Task Id uniquely identifies this task globally.
         
        .flyteidl.core.Identifier id = 1;
        Returns:
        Whether the id field is set.
      • getId

        IdentifierOuterClass.Identifier getId()
         Auto generated taskId by the system. Task Id uniquely identifies this task globally.
         
        .flyteidl.core.Identifier id = 1;
        Returns:
        The id.
      • getType

        String getType()
         A predefined yet extensible Task type identifier. This can be used to customize any of the components. If no
         extensions are provided in the system, Flyte will resolve this task to its TaskCategory and default the
         implementation registered for the TaskCategory.
         
        string type = 2;
        Returns:
        The type.
      • getTypeBytes

        com.google.protobuf.ByteString getTypeBytes()
         A predefined yet extensible Task type identifier. This can be used to customize any of the components. If no
         extensions are provided in the system, Flyte will resolve this task to its TaskCategory and default the
         implementation registered for the TaskCategory.
         
        string type = 2;
        Returns:
        The bytes for type.
      • hasMetadata

        boolean hasMetadata()
         Extra metadata about the task.
         
        .flyteidl.core.TaskMetadata metadata = 3;
        Returns:
        Whether the metadata field is set.
      • getMetadata

        Tasks.TaskMetadata getMetadata()
         Extra metadata about the task.
         
        .flyteidl.core.TaskMetadata metadata = 3;
        Returns:
        The metadata.
      • getMetadataOrBuilder

        Tasks.TaskMetadataOrBuilder getMetadataOrBuilder()
         Extra metadata about the task.
         
        .flyteidl.core.TaskMetadata metadata = 3;
      • hasInterface

        boolean hasInterface()
         A strongly typed interface for the task. This enables others to use this task within a workflow and guarantees
         compile-time validation of the workflow to avoid costly runtime failures.
         
        .flyteidl.core.TypedInterface interface = 4;
        Returns:
        Whether the interface field is set.
      • getInterface

        Interface.TypedInterface getInterface()
         A strongly typed interface for the task. This enables others to use this task within a workflow and guarantees
         compile-time validation of the workflow to avoid costly runtime failures.
         
        .flyteidl.core.TypedInterface interface = 4;
        Returns:
        The interface.
      • getInterfaceOrBuilder

        Interface.TypedInterfaceOrBuilder getInterfaceOrBuilder()
         A strongly typed interface for the task. This enables others to use this task within a workflow and guarantees
         compile-time validation of the workflow to avoid costly runtime failures.
         
        .flyteidl.core.TypedInterface interface = 4;
      • hasCustom

        boolean hasCustom()
         Custom data about the task. This is extensible to allow various plugins in the system.
         
        .google.protobuf.Struct custom = 5;
        Returns:
        Whether the custom field is set.
      • getCustom

        com.google.protobuf.Struct getCustom()
         Custom data about the task. This is extensible to allow various plugins in the system.
         
        .google.protobuf.Struct custom = 5;
        Returns:
        The custom.
      • getCustomOrBuilder

        com.google.protobuf.StructOrBuilder getCustomOrBuilder()
         Custom data about the task. This is extensible to allow various plugins in the system.
         
        .google.protobuf.Struct custom = 5;
      • hasContainer

        boolean hasContainer()
        .flyteidl.core.Container container = 6;
        Returns:
        Whether the container field is set.
      • getContainer

        Tasks.Container getContainer()
        .flyteidl.core.Container container = 6;
        Returns:
        The container.
      • hasK8SPod

        boolean hasK8SPod()
        .flyteidl.core.K8sPod k8s_pod = 17;
        Returns:
        Whether the k8sPod field is set.
      • getK8SPod

        Tasks.K8sPod getK8SPod()
        .flyteidl.core.K8sPod k8s_pod = 17;
        Returns:
        The k8sPod.
      • hasSql

        boolean hasSql()
        .flyteidl.core.Sql sql = 18;
        Returns:
        Whether the sql field is set.
      • getSql

        Tasks.Sql getSql()
        .flyteidl.core.Sql sql = 18;
        Returns:
        The sql.
      • getTaskTypeVersion

        int getTaskTypeVersion()
         This can be used to customize task handling at execution time for the same task type.
         
        int32 task_type_version = 7;
        Returns:
        The taskTypeVersion.
      • hasSecurityContext

        boolean hasSecurityContext()
         security_context encapsulates security attributes requested to run this task.
         
        .flyteidl.core.SecurityContext security_context = 8;
        Returns:
        Whether the securityContext field is set.
      • getSecurityContext

        Security.SecurityContext getSecurityContext()
         security_context encapsulates security attributes requested to run this task.
         
        .flyteidl.core.SecurityContext security_context = 8;
        Returns:
        The securityContext.
      • getSecurityContextOrBuilder

        Security.SecurityContextOrBuilder getSecurityContextOrBuilder()
         security_context encapsulates security attributes requested to run this task.
         
        .flyteidl.core.SecurityContext security_context = 8;
      • getConfigCount

        int getConfigCount()
         Metadata about the custom defined for this task. This is extensible to allow various plugins in the system
         to use as required.
         reserve the field numbers 1 through 15 for very frequently occurring message elements
         
        map<string, string> config = 16;
      • containsConfig

        boolean containsConfig​(String key)
         Metadata about the custom defined for this task. This is extensible to allow various plugins in the system
         to use as required.
         reserve the field numbers 1 through 15 for very frequently occurring message elements
         
        map<string, string> config = 16;
      • getConfigMap

        Map<String,​String> getConfigMap()
         Metadata about the custom defined for this task. This is extensible to allow various plugins in the system
         to use as required.
         reserve the field numbers 1 through 15 for very frequently occurring message elements
         
        map<string, string> config = 16;
      • getConfigOrDefault

        String getConfigOrDefault​(String key,
                                  String defaultValue)
         Metadata about the custom defined for this task. This is extensible to allow various plugins in the system
         to use as required.
         reserve the field numbers 1 through 15 for very frequently occurring message elements
         
        map<string, string> config = 16;
      • getConfigOrThrow

        String getConfigOrThrow​(String key)
         Metadata about the custom defined for this task. This is extensible to allow various plugins in the system
         to use as required.
         reserve the field numbers 1 through 15 for very frequently occurring message elements
         
        map<string, string> config = 16;