cbelasticsearch

Class Task

lucee.Component
    extended by cbelasticsearch.Task

Elasticsearch Task 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 action


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


    • access = public
    • returntype = any
    true false
    boolean completed


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


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


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


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


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


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


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


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


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


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


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


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


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


    • access = public
    • returntype = any
    true false
    Method Summary
    string getAction()
    string getCancellable()
    Client getClient()
         Client provider.
    string getCompleted()
    string getDescription()
    string getHeaders()
    string getId()
    any getIdentifier()
    string getNode()
    string getParent_task_id()
    any getParentTask()
    string getRequests_per_second()
    string getResponse()
    string getRunning_time_in_nanos()
    string getRunningTime()
    string getStart_time_in_millis()
    string getStartTime()
    string getStatus()
    string getType()
    boolean isChildTask()
    boolean isComplete([boolean refresh='true'], [numeric delay='0'])
         Returns the complete status of the task after a refresh.
    any populate([struct properties])
    any refresh()
    any setAction(any action)
    any setCancellable(any cancellable)
    any setCompleted(boolean completed)
    any setDescription(any description)
    any setHeaders(any headers)
    any setId(any id)
    any setNode(any node)
    any setParent_task_id(any parent_task_id)
    any setRequests_per_second(any requests_per_second)
    any setResponse(any response)
    any setRunning_time_in_nanos(any running_time_in_nanos)
    any setRunningTime(any runningTime)
    any setStart_time_in_millis(any start_time_in_millis)
    any setStartTime(any startTime)
    any setStatus(any status)
    any setType(any type)
     
    Methods inherited from class lucee.Component
    None

    Property Detail

    action

    property any action

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

    cancellable

    property any cancellable

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

    completed

    property boolean completed = [false]

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

    description

    property any description

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

    headers

    property any headers

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

    id

    property any id

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

    node

    property any node

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

    parent_task_id

    property any parent_task_id

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

    requests_per_second

    property any requests_per_second

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

    response

    property any response

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

    running_time_in_nanos

    property any running_time_in_nanos

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

    runningTime

    property any runningTime

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

    start_time_in_millis

    property any start_time_in_millis

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

    startTime

    property any startTime

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

    status

    property any status

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

    type

    property any type

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

    Method Detail

    getAction

    public string getAction()


    getCancellable

    public string getCancellable()


    getClient

    public Client getClient()

    Client provider


    getCompleted

    public string getCompleted()


    getDescription

    public string getDescription()


    getHeaders

    public string getHeaders()


    getId

    public string getId()


    getIdentifier

    public any getIdentifier()


    getNode

    public string getNode()


    getParent_task_id

    public string getParent_task_id()


    getParentTask

    public any getParentTask()


    getRequests_per_second

    public string getRequests_per_second()


    getResponse

    public string getResponse()


    getRunning_time_in_nanos

    public string getRunning_time_in_nanos()


    getRunningTime

    public string getRunningTime()


    getStart_time_in_millis

    public string getStart_time_in_millis()


    getStartTime

    public string getStartTime()


    getStatus

    public string getStatus()


    getType

    public string getType()


    isChildTask

    public boolean isChildTask()


    isComplete

    public boolean isComplete([boolean refresh='true'], [numeric delay='0'])

    Returns the complete status of the task after a refresh

    Parameters:
    refresh - boolean Whether to refresh the task
    delay - numeric The delay time in milliseconds - useful to slow down a while() loop

    populate

    public any populate([struct properties])

    Parameters:
    properties

    refresh

    public any refresh()


    setAction

    public any setAction(any action)

    Parameters:
    action

    setCancellable

    public any setCancellable(any cancellable)

    Parameters:
    cancellable

    setCompleted

    public any setCompleted(boolean completed)

    Parameters:
    completed

    setDescription

    public any setDescription(any description)

    Parameters:
    description

    setHeaders

    public any setHeaders(any headers)

    Parameters:
    headers

    setId

    public any setId(any id)

    Parameters:
    id

    setNode

    public any setNode(any node)

    Parameters:
    node

    setParent_task_id

    public any setParent_task_id(any parent_task_id)

    Parameters:
    parent_task_id

    setRequests_per_second

    public any setRequests_per_second(any requests_per_second)

    Parameters:
    requests_per_second

    setResponse

    public any setResponse(any response)

    Parameters:
    response

    setRunning_time_in_nanos

    public any setRunning_time_in_nanos(any running_time_in_nanos)

    Parameters:
    running_time_in_nanos

    setRunningTime

    public any setRunningTime(any runningTime)

    Parameters:
    runningTime

    setStart_time_in_millis

    public any setStart_time_in_millis(any start_time_in_millis)

    Parameters:
    start_time_in_millis

    setStartTime

    public any setStartTime(any startTime)

    Parameters:
    startTime

    setStatus

    public any setStatus(any status)

    Parameters:
    status

    setType

    public any setType(any type)

    Parameters:
    type