com.amazonaws.appflow.custom.connector.model.query

Interface QueryDataRequest

All Superinterfaces:

AutoCloseable, ConnectorRequest

All Known Implementing Classes:

ImmutableQueryDataRequest

@Value.Immutable
public interface QueryDataRequest
extends ConnectorRequest

Represents the input of a QueryData 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	filterExpression() Filter expression string similar to the WHERE clause in SQL.
default Long	maxResults() Maximum number of records needs to be returned as part of single call.
String	nextToken() The pagination token - next page should start from this token value.
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.

filterExpression

@Nullable
String filterExpression()

Filter expression string similar to the WHERE clause in SQL.

maxResults

@Value.Default
default Long maxResults()

Maximum number of records needs to be returned as part of single call. Default value is 1000.

nextToken

@Nullable
String nextToken()

The pagination token - next page should start from this token value.

connectorContext

ConnectorContext connectorContext()

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