caikit.interfaces.common.data_model.stream_sources
==================================================

.. py:module:: caikit.interfaces.common.data_model.stream_sources

.. autoapi-nested-parse::

   This file contains interfaces required to generate DataStreamSource[T] classes



Classes
-------

.. autoapisummary::

   caikit.interfaces.common.data_model.stream_sources.FileReference
   caikit.interfaces.common.data_model.stream_sources.ListOfFileReferences
   caikit.interfaces.common.data_model.stream_sources.Directory
   caikit.interfaces.common.data_model.stream_sources.S3Base
   caikit.interfaces.common.data_model.stream_sources.S3Files
   caikit.interfaces.common.data_model.stream_sources.S3Path


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

.. py:class:: FileReference

   Bases: :py:obj:`caikit.core.data_model.DataObjectBase`


   A DataObject is a data model class that is backed by a @dataclass.

   Data model classes that use the @dataobject decorator must derive from this
   base class.


   .. py:attribute:: filename
      :type:  py_to_proto.dataclass_to_proto.Annotated[str, FieldNumber(1)]


.. py:class:: ListOfFileReferences

   Bases: :py:obj:`caikit.core.data_model.DataObjectBase`


   A DataObject is a data model class that is backed by a @dataclass.

   Data model classes that use the @dataobject decorator must derive from this
   base class.


   .. py:attribute:: files
      :type:  py_to_proto.dataclass_to_proto.Annotated[List[str], FieldNumber(1)]


.. py:class:: Directory

   Bases: :py:obj:`caikit.core.data_model.DataObjectBase`


   A DataObject is a data model class that is backed by a @dataclass.

   Data model classes that use the @dataobject decorator must derive from this
   base class.


   .. py:attribute:: dirname
      :type:  py_to_proto.dataclass_to_proto.Annotated[str, FieldNumber(1)]


   .. py:attribute:: extension
      :type:  py_to_proto.dataclass_to_proto.Annotated[str, FieldNumber(2)]


.. py:class:: S3Base

   Bases: :py:obj:`caikit.core.data_model.DataObjectBase`


   A DataObject is a data model class that is backed by a @dataclass.

   Data model classes that use the @dataobject decorator must derive from this
   base class.


   .. py:attribute:: endpoint
      :type:  py_to_proto.dataclass_to_proto.Annotated[str, FieldNumber(2)]


   .. py:attribute:: region
      :type:  py_to_proto.dataclass_to_proto.Annotated[str, FieldNumber(3)]


   .. py:attribute:: bucket
      :type:  py_to_proto.dataclass_to_proto.Annotated[str, FieldNumber(4)]


   .. py:attribute:: accessKey
      :type:  py_to_proto.dataclass_to_proto.Annotated[str, FieldNumber(5)]


   .. py:attribute:: secretKey
      :type:  py_to_proto.dataclass_to_proto.Annotated[str, FieldNumber(6)]


   .. py:attribute:: IAM_id
      :type:  py_to_proto.dataclass_to_proto.Annotated[str, FieldNumber(7)]


   .. py:attribute:: IAM_api_key
      :type:  py_to_proto.dataclass_to_proto.Annotated[str, FieldNumber(8)]


.. py:class:: S3Files

   Bases: :py:obj:`S3Base`


   A DataObject is a data model class that is backed by a @dataclass.

   Data model classes that use the @dataobject decorator must derive from this
   base class.


   .. py:attribute:: files
      :type:  py_to_proto.dataclass_to_proto.Annotated[List[str], FieldNumber(1)]


.. py:class:: S3Path

   Bases: :py:obj:`S3Base`


   A DataObject is a data model class that is backed by a @dataclass.

   Data model classes that use the @dataobject decorator must derive from this
   base class.


   .. py:attribute:: path
      :type:  py_to_proto.dataclass_to_proto.Annotated[str, FieldNumber(1)]