com.amazonaws.appflow.custom.connector.model.retreive

Interface RetrieveDataRequest

All Superinterfaces:

AutoCloseable, ConnectorRequest

All Known Implementing Classes:

ImmutableRetrieveDataRequest

@Value.Immutable
public interface RetrieveDataRequest
extends ConnectorRequest

Represents the input of a RetrieveData operation.

Method Summary

Modifier and Type	Method and Description
ConnectorContext	connectorContext() Context contains the connector settings, credentials and APi version etc.
String	entityIdentifier() Unique identifier for the entity.
String	idFieldName() Field name which will be used as part of where statement to retrieve the data.
List<String>	ids() List of values for idFieldName.
List<String>	selectedFieldNames() Field values to retrieve.

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.

selectedFieldNames

@Nullable
List<String> selectedFieldNames()

Field values to retrieve. If null, it will provide all the fields for the entity.

idFieldName

@Nullable
String idFieldName()

Field name which will be used as part of where statement to retrieve the data. Can be primary or any other column name.

ids

@Nullable
List<String> ids()

List of values for idFieldName.

connectorContext

ConnectorContext connectorContext()

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