com.amazonaws.appflow.custom.connector.model.metadata

Interface FieldDefinition

All Known Implementing Classes:

ImmutableFieldDefinition

@Value.Immutable
public interface FieldDefinition

Describes the data model of a field. For example, for an account entity, the fields would be account name, account ID, and so on.

Method Summary

Modifier and Type	Method and Description
FieldConstraints	constraints() Constraints applicable to this field like length, value etc.
Map<String,String>	customProperties() Custom properties defined for this field.
FieldDataType	dataType() DataType of this field.
default String	dataTypeLabel() Application specific description of the dataType, so that AppFlow user can be presented with the same information in the public API for exposing connector specific metadata
String	defaultValue() Default value of the field.
String	description() Description of this field.
String	fieldName() The unique identifier of the connector field.
default List<ConnectorOperator>	filterOperators() Filter Operators applicable for this field.
Boolean	isDeprecated() Specifies if this field is deprecated.
Boolean	isPrimaryKey() Specifies if it can be used as a primary key.
String	label() Label for this field.
ReadOperationProperty	readProperties() The properties that can be applied to a field when the connector is being used as a SOURCE.
WriteOperationProperty	writeProperties() The properties applied to a field when the connector is being used as a destination.

Method Detail

fieldName

String fieldName()

The unique identifier of the connector field.

dataType

FieldDataType dataType()

DataType of this field.

dataTypeLabel

@Value.Default
default String dataTypeLabel()

Application specific description of the dataType, so that AppFlow user can be presented with the same information in the public API for exposing connector specific metadata

label

@Nullable
String label()

Label for this field.

description

@Nullable
String description()

Description of this field.

isPrimaryKey

@Nullable
Boolean isPrimaryKey()

Specifies if it can be used as a primary key.

defaultValue

@Nullable
String defaultValue()

Default value of the field.

isDeprecated

@Nullable
Boolean isDeprecated()

Specifies if this field is deprecated.

constraints

@Nullable
FieldConstraints constraints()

Constraints applicable to this field like length, value etc.

readProperties

@Nullable
ReadOperationProperty readProperties()

The properties that can be applied to a field when the connector is being used as a SOURCE.

writeProperties

@Nullable
WriteOperationProperty writeProperties()

The properties applied to a field when the connector is being used as a destination.

filterOperators

@Value.Default
default List<ConnectorOperator> filterOperators()

Filter Operators applicable for this field. This method can be overridden by the connector developers for specific use cases. For example if they wish to disallow certain operators for specific data types, that can be modified by overriding this method.

customProperties

@Nullable
Map<String,String> customProperties()

Custom properties defined for this field.