Package flyteidl.core

Class Tasks.Container

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Tasks.ContainerOrBuilder, java.io.Serializable
    Enclosing class:
    Tasks
    public static final class Tasks.Container
extends com.google.protobuf.GeneratedMessageV3
implements Tasks.ContainerOrBuilder
    Protobuf type flyteidl.core.Container
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Tasks.Container.Builder
      Protobuf type flyteidl.core.Container

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,​BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,​BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Method Detail

      • newInstance

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

      • getImage

        public java.lang.String getImage()
         Container image url. Eg: docker/redis:latest
        string image = 1;
        Specified by:
        getImage in interface Tasks.ContainerOrBuilder
        Returns:
        The image.

      • getImageBytes

        public com.google.protobuf.ByteString getImageBytes()
         Container image url. Eg: docker/redis:latest
        string image = 1;
        Specified by:
        getImageBytes in interface Tasks.ContainerOrBuilder
        Returns:
        The bytes for image.

      • getCommandList

        public com.google.protobuf.ProtocolStringList getCommandList()
         Command to be executed, if not provided, the default entrypoint in the container image will be used.
        repeated string command = 2;
        Specified by:
        getCommandList in interface Tasks.ContainerOrBuilder
        Returns:
        A list containing the command.

      • getCommandCount

        public int getCommandCount()
         Command to be executed, if not provided, the default entrypoint in the container image will be used.
        repeated string command = 2;
        Specified by:
        getCommandCount in interface Tasks.ContainerOrBuilder
        Returns:
        The count of command.

      • getCommand

        public java.lang.String getCommand​(int index)
         Command to be executed, if not provided, the default entrypoint in the container image will be used.
        repeated string command = 2;
        Specified by:
        getCommand in interface Tasks.ContainerOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The command at the given index.

      • getCommandBytes

        public com.google.protobuf.ByteString getCommandBytes​(int index)
         Command to be executed, if not provided, the default entrypoint in the container image will be used.
        repeated string command = 2;
        Specified by:
        getCommandBytes in interface Tasks.ContainerOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the command at the given index.

      • getArgsList

        public com.google.protobuf.ProtocolStringList getArgsList()
         These will default to Flyte given paths. If provided, the system will not append known paths. If the task still
 needs flyte's inputs and outputs path, add $(FLYTE_INPUT_FILE), $(FLYTE_OUTPUT_FILE) wherever makes sense and the
 system will populate these before executing the container.
        repeated string args = 3;
        Specified by:
        getArgsList in interface Tasks.ContainerOrBuilder
        Returns:
        A list containing the args.

      • getArgsCount

        public int getArgsCount()
         These will default to Flyte given paths. If provided, the system will not append known paths. If the task still
 needs flyte's inputs and outputs path, add $(FLYTE_INPUT_FILE), $(FLYTE_OUTPUT_FILE) wherever makes sense and the
 system will populate these before executing the container.
        repeated string args = 3;
        Specified by:
        getArgsCount in interface Tasks.ContainerOrBuilder
        Returns:
        The count of args.

      • getArgs

        public java.lang.String getArgs​(int index)
         These will default to Flyte given paths. If provided, the system will not append known paths. If the task still
 needs flyte's inputs and outputs path, add $(FLYTE_INPUT_FILE), $(FLYTE_OUTPUT_FILE) wherever makes sense and the
 system will populate these before executing the container.
        repeated string args = 3;
        Specified by:
        getArgs in interface Tasks.ContainerOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The args at the given index.

      • getArgsBytes

        public com.google.protobuf.ByteString getArgsBytes​(int index)
         These will default to Flyte given paths. If provided, the system will not append known paths. If the task still
 needs flyte's inputs and outputs path, add $(FLYTE_INPUT_FILE), $(FLYTE_OUTPUT_FILE) wherever makes sense and the
 system will populate these before executing the container.
        repeated string args = 3;
        Specified by:
        getArgsBytes in interface Tasks.ContainerOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the args at the given index.

      • hasResources

        public boolean hasResources()
         Container resources requirement as specified by the container engine.
        .flyteidl.core.Resources resources = 4;
        Specified by:
        hasResources in interface Tasks.ContainerOrBuilder
        Returns:
        Whether the resources field is set.

      • getResources

        public Tasks.Resources getResources()
         Container resources requirement as specified by the container engine.
        .flyteidl.core.Resources resources = 4;
        Specified by:
        getResources in interface Tasks.ContainerOrBuilder
        Returns:
        The resources.

      • getEnvCount

        public int getEnvCount()
         Environment variables will be set as the container is starting up.
        repeated .flyteidl.core.KeyValuePair env = 5;
        Specified by:
        getEnvCount in interface Tasks.ContainerOrBuilder

      • getConfigList

        public java.util.List<Literals.KeyValuePair> getConfigList()
         Allows extra configs to be available for the container.
 TODO: elaborate on how configs will become available.
        repeated .flyteidl.core.KeyValuePair config = 6;
        Specified by:
        getConfigList in interface Tasks.ContainerOrBuilder

      • getConfigCount

        public int getConfigCount()
         Allows extra configs to be available for the container.
 TODO: elaborate on how configs will become available.
        repeated .flyteidl.core.KeyValuePair config = 6;
        Specified by:
        getConfigCount in interface Tasks.ContainerOrBuilder

      • getConfig

        public Literals.KeyValuePair getConfig​(int index)
         Allows extra configs to be available for the container.
 TODO: elaborate on how configs will become available.
        repeated .flyteidl.core.KeyValuePair config = 6;
        Specified by:
        getConfig in interface Tasks.ContainerOrBuilder

      • getPortsList

        public java.util.List<Tasks.ContainerPort> getPortsList()
         Ports to open in the container. This feature is not supported by all execution engines. (e.g. supported on K8s but
 not supported on AWS Batch)
 Only K8s
        repeated .flyteidl.core.ContainerPort ports = 7;
        Specified by:
        getPortsList in interface Tasks.ContainerOrBuilder

      • getPortsOrBuilderList

        public java.util.List<? extends Tasks.ContainerPortOrBuilder> getPortsOrBuilderList()
         Ports to open in the container. This feature is not supported by all execution engines. (e.g. supported on K8s but
 not supported on AWS Batch)
 Only K8s
        repeated .flyteidl.core.ContainerPort ports = 7;
        Specified by:
        getPortsOrBuilderList in interface Tasks.ContainerOrBuilder

      • getPortsCount

        public int getPortsCount()
         Ports to open in the container. This feature is not supported by all execution engines. (e.g. supported on K8s but
 not supported on AWS Batch)
 Only K8s
        repeated .flyteidl.core.ContainerPort ports = 7;
        Specified by:
        getPortsCount in interface Tasks.ContainerOrBuilder

      • getPorts

        public Tasks.ContainerPort getPorts​(int index)
         Ports to open in the container. This feature is not supported by all execution engines. (e.g. supported on K8s but
 not supported on AWS Batch)
 Only K8s
        repeated .flyteidl.core.ContainerPort ports = 7;
        Specified by:
        getPorts in interface Tasks.ContainerOrBuilder

      • getPortsOrBuilder

        public Tasks.ContainerPortOrBuilder getPortsOrBuilder​(int index)
         Ports to open in the container. This feature is not supported by all execution engines. (e.g. supported on K8s but
 not supported on AWS Batch)
 Only K8s
        repeated .flyteidl.core.ContainerPort ports = 7;
        Specified by:
        getPortsOrBuilder in interface Tasks.ContainerOrBuilder

      • hasDataConfig

        public boolean hasDataConfig()
         BETA: Optional configuration for DataLoading. If not specified, then default values are used.
 This makes it possible to to run a completely portable container, that uses inputs and outputs
 only from the local file-system and without having any reference to flyteidl. This is supported only on K8s at the moment.
 If data loading is enabled, then data will be mounted in accompanying directories specified in the DataLoadingConfig. If the directories
 are not specified, inputs will be mounted onto and outputs will be uploaded from a pre-determined file-system path. Refer to the documentation
 to understand the default paths.
 Only K8s
        .flyteidl.core.DataLoadingConfig data_config = 9;
        Specified by:
        hasDataConfig in interface Tasks.ContainerOrBuilder
        Returns:
        Whether the dataConfig field is set.

      • getDataConfig

        public Tasks.DataLoadingConfig getDataConfig()
         BETA: Optional configuration for DataLoading. If not specified, then default values are used.
 This makes it possible to to run a completely portable container, that uses inputs and outputs
 only from the local file-system and without having any reference to flyteidl. This is supported only on K8s at the moment.
 If data loading is enabled, then data will be mounted in accompanying directories specified in the DataLoadingConfig. If the directories
 are not specified, inputs will be mounted onto and outputs will be uploaded from a pre-determined file-system path. Refer to the documentation
 to understand the default paths.
 Only K8s
        .flyteidl.core.DataLoadingConfig data_config = 9;
        Specified by:
        getDataConfig in interface Tasks.ContainerOrBuilder
        Returns:
        The dataConfig.

      • getDataConfigOrBuilder

        public Tasks.DataLoadingConfigOrBuilder getDataConfigOrBuilder()
         BETA: Optional configuration for DataLoading. If not specified, then default values are used.
 This makes it possible to to run a completely portable container, that uses inputs and outputs
 only from the local file-system and without having any reference to flyteidl. This is supported only on K8s at the moment.
 If data loading is enabled, then data will be mounted in accompanying directories specified in the DataLoadingConfig. If the directories
 are not specified, inputs will be mounted onto and outputs will be uploaded from a pre-determined file-system path. Refer to the documentation
 to understand the default paths.
 Only K8s
        .flyteidl.core.DataLoadingConfig data_config = 9;
        Specified by:
        getDataConfigOrBuilder in interface Tasks.ContainerOrBuilder

      • 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 java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        java.io.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​(java.lang.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 Tasks.Container parseFrom​(java.nio.ByteBuffer data)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Tasks.Container parseFrom​(java.nio.ByteBuffer data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

        public static Tasks.Container parseFrom​(java.io.InputStream input)
                                 throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static Tasks.Container parseFrom​(java.io.InputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static Tasks.Container parseDelimitedFrom​(java.io.InputStream input)
                                          throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static Tasks.Container parseDelimitedFrom​(java.io.InputStream input,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static Tasks.Container parseFrom​(com.google.protobuf.CodedInputStream input)
                                 throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static Tasks.Container parseFrom​(com.google.protobuf.CodedInputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws java.io.IOException
        Throws:
        java.io.IOException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • parser

        public static com.google.protobuf.Parser<Tasks.Container> parser()

      • getParserForType

        public com.google.protobuf.Parser<Tasks.Container> 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 Tasks.Container getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder