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

Interface Entity

All Known Implementing Classes:

ImmutableEntity

@Value.Immutable
public interface Entity

Represents the entity structure.

Method Summary

Modifier and Type	Method and Description
Map<String,String>	customProperties() Entity Specific custom properties.
String	description() Description of the entity.
String	entityIdentifier() Unique identifier for the entity.
boolean	hasNestedEntities() Specifies whether the connector entity is a parent or a category and has more entities nested underneath it.
default boolean	isWritable() Specifies if the connector entity is writable
String	label() Label of the entity.

Method Detail

entityIdentifier

String entityIdentifier()

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

hasNestedEntities

boolean hasNestedEntities()

Specifies whether the connector entity is a parent or a category and has more entities nested underneath it.

isWritable

@Value.Default
default boolean isWritable()

Specifies if the connector entity is writable

label

@Nullable
String label()

Label of the entity.

description

@Nullable
String description()

Description of the entity.

customProperties

@Nullable
Map<String,String> customProperties()

Entity Specific custom properties.