Field
The Field object has information about the different properties associated with a field in the connector.
Contents
- CustomProperties
-
Optional map of keys which may be returned.
Type: String to string map
Required: No
- Description
-
A description of the field.
Type: String
Required: No
- FieldName
-
A unique identifier for the field.
Type: String
Required: No
- FieldType
-
The type of data in the field.
Type: String
Valid Values:
INT | SMALLINT | BIGINT | FLOAT | LONG | DATE | BOOLEAN | MAP | ARRAY | STRING | TIMESTAMP | DECIMAL | BYTE | SHORT | DOUBLE | STRUCTRequired: No
- IsCreateable
-
Indicates whether this field can be created as part of a destination write.
Type: Boolean
Required: No
- IsDefaultOnCreate
-
Indicates whether this field is populated automatically when the object is created, such as a created at timestamp.
Type: Boolean
Required: No
- IsFilterable
-
Indicates whether this field can used in a filter clause (
WHEREclause) of a SQL statement when querying data.Type: Boolean
Required: No
- IsNullable
-
Indicates whether this field can be nullable or not.
Type: Boolean
Required: No
- IsPartitionable
-
Indicates whether a given field can be used in partitioning the query made to SaaS.
Type: Boolean
Required: No
- IsPrimaryKey
-
Indicates whether this field can used as a primary key for the given entity.
Type: Boolean
Required: No
- IsRetrievable
-
Indicates whether this field can be added in Select clause of SQL query or whether it is retrievable or not.
Type: Boolean
Required: No
- IsUpdateable
-
Indicates whether this field can be updated as part of a destination write.
Type: Boolean
Required: No
- IsUpsertable
-
Indicates whether this field can be upserted as part of a destination write.
Type: Boolean
Required: No
- Label
-
A readable label used for the field.
Type: String
Required: No
- NativeDataType
-
The data type returned by the SaaS API, such as “picklist” or “textarea” from Salesforce.
Type: String
Required: No
- ParentField
-
A parent field name for a nested field.
Type: String
Required: No
- SupportedFilterOperators
-
Indicates the support filter operators for this field.
Type: Array of strings
Valid Values:
LESS_THAN | GREATER_THAN | BETWEEN | EQUAL_TO | NOT_EQUAL_TO | GREATER_THAN_OR_EQUAL_TO | LESS_THAN_OR_EQUAL_TO | CONTAINS | ORDER_BYRequired: No
- SupportedValues
-
A list of supported values for the field.
Type: Array of strings
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
