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

Interface ListEntitiesRequest

All Superinterfaces:

AutoCloseable, ConnectorRequest

All Known Implementing Classes:

ImmutableListEntitiesRequest

@Value.Immutable
public interface ListEntitiesRequest
extends ConnectorRequest

Represents the input of a ListEntities operation.

Method Summary

Modifier and Type	Method and Description
ConnectorContext	connectorContext() Context contains the connector settings, credentials and APi version etc.
String	entitiesPath() Path/URI of entities.
default Long	maxResult() 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.

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

close

Method Detail

entitiesPath

@Nullable
String entitiesPath()

Path/URI of entities.

maxResult

@Nullable
 @Value.Default
default Long maxResult()

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.