FieldDefinition
Defines a field in an entity schema for REST connector data sources, specifying the field name and data type.
Contents
- FieldDataType
-
The data type of the field.
Type: String
Valid Values:
INT | SMALLINT | BIGINT | FLOAT | LONG | DATE | BOOLEAN | MAP | ARRAY | STRING | TIMESTAMP | DECIMAL | BYTE | SHORT | DOUBLE | STRUCT | BINARY | UNIONRequired: Yes
- Name
-
The name of the field in the entity schema.
Type: String
Required: Yes
- FilterOverrides
-
Per-field overrides for filter behavior, allowing customization of how filters are applied to this specific field.
Type: FilterOverrides object
Required: No
- IsNullable
-
Indicates whether this field can contain null values.
Type: Boolean
Required: No
- IsOrderable
-
Indicates whether this field can be used for ordering results.
Type: Boolean
Required: No
- IsPartitionable
-
Indicates whether this field can be used for partitioning queries to the data source.
Type: Boolean
Required: No
- IsQueryable
-
Indicates whether this field can be used in filter predicates when querying data.
Type: Boolean
Required: No
- ResponseDateFormat
-
The format pattern for parsing date values from API responses. Required when the API uses a non-ISO-8601 format. Accepts Java
DateTimeFormatterpatterns (for example,EEE, d MMM yyyy HH:mm:ss Z),EPOCH_SECONDSfor Unix epoch seconds, orEPOCH_MILLISfor Unix epoch milliseconds.Type: String
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: