Interface Entity.Builder

All Superinterfaces:
Buildable, CopyableBuilder<Entity.Builder,Entity>, SdkBuilder<Entity.Builder,Entity>, SdkPojo
Enclosing class:
Entity
@Mutable @NotThreadSafe public static interface Entity.Builder extends SdkPojo, CopyableBuilder<Entity.Builder,Entity>

  • Method Details

    • entityName

      Entity.Builder entityName(String entityName)

      The name of the entity.

      Parameters:
      entityName - The name of the entity.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • label

      Entity.Builder label(String label)

      Label used for the entity.

      Parameters:
      label - Label used for the entity.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • isParentEntity

      Entity.Builder isParentEntity(Boolean isParentEntity)

      A Boolean value which helps to determine whether there are sub objects that can be listed.

      Parameters:
      isParentEntity - A Boolean value which helps to determine whether there are sub objects that can be listed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      Entity.Builder description(String description)

      A description of the entity.

      Parameters:
      description - A description of the entity.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • category

      Entity.Builder category(String category)

      The type of entities that are present in the response. This value depends on the source connection. For example this is SObjects for Salesforce and databases or schemas or tables for sources like Amazon Redshift.

      Parameters:
      category - The type of entities that are present in the response. This value depends on the source connection. For example this is SObjects for Salesforce and databases or schemas or tables for sources like Amazon Redshift.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customProperties

      Entity.Builder customProperties(Map<String,String> customProperties)

      An optional map of keys which may be returned for an entity by a connector.

      Parameters:
      customProperties - An optional map of keys which may be returned for an entity by a connector.
      Returns:
      Returns a reference to this object so that method calls can be chained together.