com.amazonaws.appflow.custom.connector.model.write

Interface WriteDataRequest

All Superinterfaces:

AutoCloseable, ConnectorRequest

All Known Implementing Classes:

ImmutableWriteDataRequest

@Value.Immutable
public interface WriteDataRequest
extends ConnectorRequest

Represents the input of a WriteData operation.

Method Summary

Modifier and Type	Method and Description
Boolean	allOrNone() Specifies that the WRITE operation must fail immediately after encountering the first instance of failure when writing a batch of records to the Application.
ConnectorContext	connectorContext() Context contains the connector settings, credentials and API version etc.
String	entityIdentifier() Unique identifier for the entity.
List<String>	idFieldNames() Primary keys of the entity.
WriteOperationType	operation() Write operation type needs to be called.
List<String>	records() List of JSON serialized string of the entity record as per the entity metadata.

Methods inherited from interface com.amazonaws.appflow.custom.connector.model.ConnectorRequest

close

Method Detail

entityIdentifier

String entityIdentifier()

Unique identifier for the entity. Can be entityId/ entityName / entityPath+name / entityUrl etc.

operation

WriteOperationType operation()

Write operation type needs to be called.

idFieldNames

@Nullable
List<String> idFieldNames()

Primary keys of the entity. Used for DELETE/ UPDATE/ UPSERT operations.

records

@Nullable
List<String> records()

List of JSON serialized string of the entity record as per the entity metadata.

allOrNone

@Nullable
Boolean allOrNone()

Specifies that the WRITE operation must fail immediately after encountering the first instance of failure when writing a batch of records to the Application. Alternatively, if the application supports the allOrNone behavior the connector can pass on the flag to the application.

connectorContext

ConnectorContext connectorContext()

Context contains the connector settings, credentials and API version etc.