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

Interface WriteOperationProperty

All Known Implementing Classes:

ImmutableWriteOperationProperty

@Value.Immutable
public interface WriteOperationProperty

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

Method Summary

Modifier and Type	Method and Description
Boolean	isCreatable() Specifies if the destination field can be created by the current user.
Boolean	isDefaultedOnCreate() Specifies if default value will be used by application while creating records if not provided.
Boolean	isNullable() Specifies if the destination field can have a null value.
Boolean	isUpdatable() Specifies whether the field can be updated during an UPDATE or UPSERT write operation.
Boolean	isUpsertable() Specifies if the flow run can either insert new rows in the destination field if they do not already exist, or update them if they do.
List<WriteOperationType>	supportedWriteOperations() A list of supported write operations.

Method Detail

isCreatable

@Nullable
Boolean isCreatable()

Specifies if the destination field can be created by the current user.

isUpdatable

@Nullable
Boolean isUpdatable()

Specifies whether the field can be updated during an UPDATE or UPSERT write operation.

isNullable

@Nullable
Boolean isNullable()

Specifies if the destination field can have a null value.

isUpsertable

@Nullable
Boolean isUpsertable()

Specifies if the flow run can either insert new rows in the destination field if they do not already exist, or update them if they do.

isDefaultedOnCreate

@Nullable
Boolean isDefaultedOnCreate()

Specifies if default value will be used by application while creating records if not provided.

supportedWriteOperations

@Nullable
List<WriteOperationType> supportedWriteOperations()

A list of supported write operations. For each write operation listed, this field can be used in idFieldNames when that write operation is present as a destination option.