scaffold.flyte.launcher_conf
============================

.. py:module:: scaffold.flyte.launcher_conf


Classes
-------

.. autoapisummary::

   scaffold.flyte.launcher_conf.ExecutionEnvironmentEnum
   scaffold.flyte.launcher_conf.FlyteDockerImageConf
   scaffold.flyte.launcher_conf.FlyteDomainEnum
   scaffold.flyte.launcher_conf.FlyteNotificationConf
   scaffold.flyte.launcher_conf.FlyteNotificationEnum
   scaffold.flyte.launcher_conf.FlyteWorkflowConf
   scaffold.flyte.launcher_conf.FlyteWorkflowExecutionPhaseEnum
   scaffold.flyte.launcher_conf.WorkflowExecutionPhase


Module Contents
---------------

.. py:class:: ExecutionEnvironmentEnum

   Bases: :py:obj:`str`, :py:obj:`enum.Enum`


   str(object='') -> str
   str(bytes_or_buffer[, encoding[, errors]]) -> str

   Create a new string object from the given object. If encoding or
   errors is specified, then the object must expose a data buffer
   that will be decoded using the given encoding and error handler.
   Otherwise, returns the result of object.__str__() (if defined)
   or repr(object).
   encoding defaults to sys.getdefaultencoding().
   errors defaults to 'strict'.

   Initialize self.  See help(type(self)) for accurate signature.


   .. py:attribute:: local
      :value: 'local'



   .. py:attribute:: remote
      :value: 'remote'



.. py:class:: FlyteDockerImageConf

   .. py:attribute:: base_image
      :type:  str


   .. py:attribute:: base_image_version
      :type:  Optional[str]


   .. py:attribute:: buildargs
      :type:  dict


   .. py:attribute:: docker_context
      :type:  str
      :value: '.'



   .. py:attribute:: docker_kwargs
      :type:  dict


   .. py:attribute:: dockerfile_path
      :type:  str
      :value: 'infrastructure/docker/Dockerfile'



   .. py:attribute:: flyte_image_name
      :type:  str
      :value: 'default'



   .. py:attribute:: secrets
      :type:  Optional[List[str]]
      :value: None



   .. py:attribute:: target_image
      :type:  str


   .. py:attribute:: target_image_version
      :type:  Optional[str]
      :value: 'latest'



.. py:class:: FlyteDomainEnum

   Bases: :py:obj:`str`, :py:obj:`enum.Enum`


   str(object='') -> str
   str(bytes_or_buffer[, encoding[, errors]]) -> str

   Create a new string object from the given object. If encoding or
   errors is specified, then the object must expose a data buffer
   that will be decoded using the given encoding and error handler.
   Otherwise, returns the result of object.__str__() (if defined)
   or repr(object).
   encoding defaults to sys.getdefaultencoding().
   errors defaults to 'strict'.

   Initialize self.  See help(type(self)) for accurate signature.


   .. py:attribute:: development
      :value: 'development'



   .. py:attribute:: production
      :value: 'production'



   .. py:attribute:: staging
      :value: 'staging'



.. py:class:: FlyteNotificationConf

   .. py:attribute:: phases
      :type:  List[FlyteWorkflowExecutionPhaseEnum]
      :value: []



   .. py:attribute:: recipients
      :type:  List[str]
      :value: []



   .. py:attribute:: type
      :type:  FlyteNotificationEnum


.. py:class:: FlyteNotificationEnum

   Bases: :py:obj:`str`, :py:obj:`enum.Enum`


   str(object='') -> str
   str(bytes_or_buffer[, encoding[, errors]]) -> str

   Create a new string object from the given object. If encoding or
   errors is specified, then the object must expose a data buffer
   that will be decoded using the given encoding and error handler.
   Otherwise, returns the result of object.__str__() (if defined)
   or repr(object).
   encoding defaults to sys.getdefaultencoding().
   errors defaults to 'strict'.

   Initialize self.  See help(type(self)) for accurate signature.


   .. py:attribute:: email
      :value: 'email'



   .. py:attribute:: slack
      :value: 'slack'



.. py:class:: FlyteWorkflowConf

   .. py:attribute:: cron_schedule
      :type:  Optional[str]
      :value: None



   .. py:attribute:: default_image
      :type:  FlyteDockerImageConf


   .. py:attribute:: domain
      :type:  FlyteDomainEnum


   .. py:attribute:: extra_images
      :type:  List[FlyteDockerImageConf]
      :value: []



   .. py:attribute:: ignore
      :type:  str
      :value: '.flyteignore'



   .. py:attribute:: project
      :type:  str
      :value: 'default'



   .. py:attribute:: version
      :type:  Optional[str]
      :value: None



.. py:class:: FlyteWorkflowExecutionPhaseEnum

   Bases: :py:obj:`str`, :py:obj:`enum.Enum`


   str(object='') -> str
   str(bytes_or_buffer[, encoding[, errors]]) -> str

   Create a new string object from the given object. If encoding or
   errors is specified, then the object must expose a data buffer
   that will be decoded using the given encoding and error handler.
   Otherwise, returns the result of object.__str__() (if defined)
   or repr(object).
   encoding defaults to sys.getdefaultencoding().
   errors defaults to 'strict'.

   Initialize self.  See help(type(self)) for accurate signature.


   .. py:attribute:: ABORTED


   .. py:attribute:: ABORTING


   .. py:attribute:: FAILED


   .. py:attribute:: FAILING


   .. py:attribute:: QUEUED


   .. py:attribute:: RUNNING


   .. py:attribute:: SUCCEEDED


   .. py:attribute:: SUCCEEDING


   .. py:attribute:: TIMED_OUT


   .. py:attribute:: UNDEFINED


.. py:class:: WorkflowExecutionPhase

   .. py:attribute:: ABORTED
      :value: 7



   .. py:attribute:: ABORTING
      :value: 9



   .. py:attribute:: FAILED
      :value: 6



   .. py:attribute:: FAILING
      :value: 5



   .. py:attribute:: QUEUED
      :value: 1



   .. py:attribute:: RUNNING
      :value: 2



   .. py:attribute:: SUCCEEDED
      :value: 4



   .. py:attribute:: SUCCEEDING
      :value: 3



   .. py:attribute:: TIMED_OUT
      :value: 8



   .. py:attribute:: UNDEFINED
      :value: 0