.. raw:: html

    <script type="module" src="../_static/js/object_tab_linker.js"> </script>
    <script type="module" src="../_static/js/query_example_selector.js"> </script>

FieldMetadata
=============

.. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

    Descriptor of the field in the GraphQL schema.



.. tab-set::
    .. tab-item:: Fields
        
        .. div::
            :name: ``enum_values``
        

        ``enum_values`` | List[:doc:`/scalars/String`] 




        
        .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

            A list of possible values for a field. Empty list indicates that field accepts arbitrary value.

        

        
        .. div::
            :name: ``min_length_value``
        
        ``min_length_value`` | Integer 



        
        .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

            Indicates minimum length of the string field value.

        

        
        .. div::
            :name: ``max_length_value``
        
        ``max_length_value`` | Integer 



        
        .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

            Indicates maximum length of the string field value.

        

        
        .. div::
            :name: ``default_value``
        
        ``default_value`` | String 



        
        .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

            Returns default value for the field. If there is no default value, returns None.

        

        
        .. div::
            :name: ``regex_value``
        
        ``regex_value`` | String 



        
        .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

            Indicates if field's value is validated by regex and returns the regex pattern. None indicates no regex validation.

        

        
        .. div::
            :name: ``field_name``
        
        ``field_name`` | String 



        
        .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

            Name of the GraphQL schema field name (self-reference to provided argument).

        

        
        .. div::
            :name: ``is_required``
        
        ``is_required`` | :doc:`/scalars/Boolean` 



        
        .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

            Indicates if field is required and has to be provided by user during creation.

        

        
        .. div::
            :name: ``is_read_only``
        
        ``is_read_only`` | :doc:`/scalars/Boolean` 



        
        .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

            Indicates if field is read-only and cannot be changed.

        

        
        .. div::
            :name: ``is_nullable``
        
        ``is_nullable`` | :doc:`/scalars/Boolean` 



        
        .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

            Indicates if field value can be set as null.

        

        
        .. div::
            :name: ``is_type_of``
        
        ``is_type_of`` | String 



        
        .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

            Returns the type of the field. Example: String, Integer, List, ContainerImage, FreshnessGrades, etc.

        

        
        .. div::
            :name: ``description_value``
        
        ``description_value`` | String 



        
        .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

            Returns the description of the field.

        

        
        .. div::
            :name: ``is_compressed``
        
        ``is_compressed`` | :doc:`/scalars/Boolean` 



        
        .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

            Indicates if field value is compressed at rest.

        

        
        .. div::
            :name: ``subfields``
        

        ``subfields`` | List[:doc:`/scalars/String`] 




        
        .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

            A list of subfields for the current field referencing nested Type or list of top level fields of the top level Type (if field_name arg for query is not provided or is empty string). None indicates no subfields - root field.

        

        
        .. div::
            :name: ``min_items_value``
        
        ``min_items_value`` | Integer 



        
        .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

            List specific field. Indicates minimum number of items in the list.

        

        
        .. div::
            :name: ``max_items_value``
        
        ``max_items_value`` | Integer 



        
        .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

            List specific field. Indicates maximum number of items in the list.

        

        
        .. div::
            :name: ``has_list_items_of_type``
        
        ``has_list_items_of_type`` | String 



        
        .. div:: sd-font-weight-light sd-fs-6 sd-font-italic sd-text-muted

            The items field represent the value of field's items status.

        

        

    


    .. tab-item:: Indexes

        
            Index management is not enabled on this collection.