FieldMetadata#
Descriptor of the field in the GraphQL schema.
enum_values | List[String]
A list of possible values for a field. Empty list indicates that field accepts arbitrary value.
min_length_value | Integer
Indicates minimum length of the string field value.
max_length_value | Integer
Indicates maximum length of the string field value.
default_value | String
Returns default value for the field. If there is no default value, returns None.
regex_value | String
Indicates if field’s value is validated by regex and returns the regex pattern. None indicates no regex validation.
field_name | String
Name of the GraphQL schema field name (self-reference to provided argument).
is_required | Boolean
Indicates if field is required and has to be provided by user during creation.
is_read_only | Boolean
Indicates if field is read-only and cannot be changed.
is_nullable | Boolean
Indicates if field value can be set as null.
is_type_of | String
Returns the type of the field. Example: String, Integer, List, ContainerImage, FreshnessGrades, etc.
description_value | String
Returns the description of the field.
is_compressed | Boolean
Indicates if field value is compressed at rest.
subfields | List[String]
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.
min_items_value | Integer
List specific field. Indicates minimum number of items in the list.
max_items_value | Integer
List specific field. Indicates maximum number of items in the list.
has_list_items_of_type | String
The items field represent the value of field’s items status.
Index management is not enabled on this collection.