cbelasticsearch

Class IndexBuilder

lucee.Component
    extended by cbelasticsearch.IndexBuilder

Elasticsearch Index Builder Object

Class Attributes:
  • license : Apache v2.0
  •  
  • package : cbElasticsearch.models
  •  
  • synchronized : false
  •  
  • accessors : true
  •  
  • persistent : false
  •  
  • author : Jon Clausen
  •  
    Property Summary
    type property default serializable required
    any aliases


    • access = public
    • returntype = any
    true false
    any indexName


    • access = public
    • returntype = any
    true false
    any mappings


    • access = public
    • returntype = any
    true false
    any settings


    • access = public
    • returntype = any
    true false
    any type


    • access = public
    • returntype = any
    true false
    Method Summary
    any delete()
         Deletes the index named in the configured builder.
    string getAliases()
    Client getClient()
         Client provider.
    Config getConfig()
         Config provider.
    struct getDSL()
    string getIndexName()
    string getJSON()
    cbelasticsearch.MappingBuilder getMappingBuilder()
         MappingBuilder provider.
    string getMappings()
    string getSettings()
    string getType()
    IndexBuilder new([string name], [any properties], [struct settings])
    any onDIComplete()
    any reset()
    any save()
         Persists the document to Elasticsearch.
    any setAliases(any aliases)
    any setIndexName(any indexName)
    any setMappings(any mappings)
    any setSettings(any settings)
    any setType(any type)
     
    Methods inherited from class lucee.Component
    None

    Property Detail

    aliases

    property any aliases

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    indexName

    property any indexName

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    mappings

    property any mappings

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    settings

    property any settings

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    type

    property any type

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    Method Detail

    delete

    public any delete()

    Deletes the index named in the configured builder


    getAliases

    public string getAliases()


    getClient

    public Client getClient()

    Client provider


    getConfig

    public Config getConfig()

    Config provider


    getDSL

    public struct getDSL()


    getIndexName

    public string getIndexName()


    getJSON

    public string getJSON()


    getMappingBuilder

    public cbelasticsearch.MappingBuilder getMappingBuilder()

    MappingBuilder provider


    getMappings

    public string getMappings()


    getSettings

    public string getSettings()


    getType

    public string getType()


    new

    public IndexBuilder new([string name], [any properties], [struct settings])

    Parameters:
    name
    properties
    settings

    onDIComplete

    public any onDIComplete()


    reset

    public any reset()


    save

    public any save()

    Persists the document to Elasticsearch


    setAliases

    public any setAliases(any aliases)

    Parameters:
    aliases

    setIndexName

    public any setIndexName(any indexName)

    Parameters:
    indexName

    setMappings

    public any setMappings(any mappings)

    Parameters:
    mappings

    setSettings

    public any setSettings(any settings)

    Parameters:
    settings

    setType

    public any setType(any type)

    Parameters:
    type