Package flyteidl.core

Interface Tasks.ContainerOrBuilder

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

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

      • getImage

        java.lang.String getImage()
         Container image url. Eg: docker/redis:latest
         
        string image = 1;
        Returns:
        The image.
      • getImageBytes

        com.google.protobuf.ByteString getImageBytes()
         Container image url. Eg: docker/redis:latest
         
        string image = 1;
        Returns:
        The bytes for image.
      • getCommandList

        java.util.List<java.lang.String> getCommandList()
         Command to be executed, if not provided, the default entrypoint in the container image will be used.
         
        repeated string command = 2;
        Returns:
        A list containing the command.
      • getCommandCount

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

        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;
        Parameters:
        index - The index of the element to return.
        Returns:
        The command at the given index.
      • getCommandBytes

        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;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the command at the given index.
      • getArgsList

        java.util.List<java.lang.String> 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;
        Returns:
        A list containing the args.
      • getArgsCount

        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;
        Returns:
        The count of args.
      • getArgs

        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;
        Parameters:
        index - The index of the element to return.
        Returns:
        The args at the given index.
      • getArgsBytes

        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;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the args at the given index.
      • hasResources

        boolean hasResources()
         Container resources requirement as specified by the container engine.
         
        .flyteidl.core.Resources resources = 4;
        Returns:
        Whether the resources field is set.
      • getResources

        Tasks.Resources getResources()
         Container resources requirement as specified by the container engine.
         
        .flyteidl.core.Resources resources = 4;
        Returns:
        The resources.
      • getResourcesOrBuilder

        Tasks.ResourcesOrBuilder getResourcesOrBuilder()
         Container resources requirement as specified by the container engine.
         
        .flyteidl.core.Resources resources = 4;
      • getEnvList

        java.util.List<Literals.KeyValuePair> getEnvList()
         Environment variables will be set as the container is starting up.
         
        repeated .flyteidl.core.KeyValuePair env = 5;
      • getEnv

        Literals.KeyValuePair getEnv​(int index)
         Environment variables will be set as the container is starting up.
         
        repeated .flyteidl.core.KeyValuePair env = 5;
      • getEnvCount

        int getEnvCount()
         Environment variables will be set as the container is starting up.
         
        repeated .flyteidl.core.KeyValuePair env = 5;
      • getEnvOrBuilderList

        java.util.List<? extends Literals.KeyValuePairOrBuilder> getEnvOrBuilderList()
         Environment variables will be set as the container is starting up.
         
        repeated .flyteidl.core.KeyValuePair env = 5;
      • getEnvOrBuilder

        Literals.KeyValuePairOrBuilder getEnvOrBuilder​(int index)
         Environment variables will be set as the container is starting up.
         
        repeated .flyteidl.core.KeyValuePair env = 5;
      • getConfigList

        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;
      • getConfig

        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;
      • getConfigCount

        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;
      • getConfigOrBuilderList

        java.util.List<? extends Literals.KeyValuePairOrBuilder> getConfigOrBuilderList()
         Allows extra configs to be available for the container.
         TODO: elaborate on how configs will become available.
         
        repeated .flyteidl.core.KeyValuePair config = 6;
      • getConfigOrBuilder

        Literals.KeyValuePairOrBuilder getConfigOrBuilder​(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;
      • getPortsList

        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)
         
        repeated .flyteidl.core.ContainerPort ports = 7;
      • getPorts

        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)
         
        repeated .flyteidl.core.ContainerPort ports = 7;
      • getPortsCount

        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)
         
        repeated .flyteidl.core.ContainerPort ports = 7;
      • getPortsOrBuilderList

        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)
         
        repeated .flyteidl.core.ContainerPort ports = 7;
      • getPortsOrBuilder

        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)
         
        repeated .flyteidl.core.ContainerPort ports = 7;