ProxyLensQuery (Lens 2.6.1 API)

java.lang.Object
- org.apache.lens.api.ToYAMLString
- - org.apache.lens.api.query.LensQuery
  - - org.apache.lens.client.model.ProxyLensQuery

All Implemented Interfaces:

org.jvnet.jaxb2_commons.lang.ToString
```
public class ProxyLensQuery
extends LensQuery
```
This class can be used to create Proxy Lens Query objects. The Proxy objects support lazy initialization of members of this class given a query handle and LensStatement.
In most cases the query handle information should suffice which is available locally, and only in a few cases like LensClient.LensClientResultSetWithStats, extra information needs to be fetched from Lens Server.
Note:This class if not meant to be instantiated by lens apps (using lens-client to interact with lens server) directly

Nested Class Summary
- Nested classes/interfaces inherited from class org.apache.lens.api.ToYAMLString
  ToYAMLString.FieldNameAndValue

Constructor Summary

Constructors
Constructor and Description

ProxyLensQuery(LensStatement statement, QueryHandle queryHandle)

Constructors
Constructor and Description
`ProxyLensQuery(LensStatement statement, QueryHandle queryHandle)`

Method Summary

Methods
Modifier and Type	Method and Description
`long`	`getClosedTime()` The the query close time when the query is purged by the server and no more operations are pending for it.
`long`	`getDriverFinishTime()` The the query execution end time on driver.
`String`	`getDriverOpHandle()` The operation handle associated with the driver, if any.
`String`	`getDriverQuery()` The driver query.
`long`	`getDriverStartTime()` The query execution start time on driver.
`Integer`	`getErrorCode()`
`String`	`getErrorMessage()`
`long`	`getFinishTime()` The query finish time on server.
`long`	`getLaunchTime()` The query launch time.
`Priority`	`getPriority()` The priority of the query.
`LensConf`	`getQueryConf()` The query conf that was used for executing this query.
`QueryHandle`	`getQueryHandle()` The query handle that represents this query uniquely
`String`	`getQueryHandleString()`
`String`	`getQueryName()` The query name, if any.
`String`	`getResultSetPath()` The result set path for this query if the query output was persisted by the server.
`String`	`getSelectedDriverName()` Name of the driver which executed the query (Example: hive/testDriver, jdbc/prodDriver etc)
`QueryStatus`	`getStatus()` The status of this query.
`long`	`getSubmissionTime()` The submission time.
`String`	`getSubmittedUser()` The user who submitted the query.
`String`	`getUserQuery()` The the query submitted by the user
`boolean`	`isPersistent()` Is true if query's result would be persisted by server.

Methods inherited from class org.apache.lens.api.query.LensQuery
equals, hashCode

Methods inherited from class org.apache.lens.api.ToYAMLString
append, appendFields, fromXMLString, getFieldsToAppend, toString, toXMLString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ProxyLensQuery
```
public ProxyLensQuery(LensStatement statement,
              QueryHandle queryHandle)
```
- Method Detail
  - getQueryHandle
```
public QueryHandle getQueryHandle()
```
    Description copied from class: LensQuery
    
    The query handle that represents this query uniquely
    
    Overrides:
    
    getQueryHandle in class LensQuery
  - getSubmittedUser
```
public String getSubmittedUser()
```
    Description copied from class: LensQuery
    
    The user who submitted the query.
    
    Overrides:
    
    getSubmittedUser in class LensQuery
  - getUserQuery
```
public String getUserQuery()
```
    Description copied from class: LensQuery
    
    The the query submitted by the user
    
    Overrides:
    
    getUserQuery in class LensQuery
  - getPriority
```
public Priority getPriority()
```
    Description copied from class: LensQuery
    
    The priority of the query.
    
    Overrides:
    
    getPriority in class LensQuery
  - isPersistent
```
public boolean isPersistent()
```
    Description copied from class: LensQuery
    
    Is true if query's result would be persisted by server.
    
    Overrides:
    
    isPersistent in class LensQuery
  - getSelectedDriverName
```
public String getSelectedDriverName()
```
    Description copied from class: LensQuery
    
    Name of the driver which executed the query (Example: hive/testDriver, jdbc/prodDriver etc)
    
    Overrides:
    
    getSelectedDriverName in class LensQuery
  - getDriverQuery
```
public String getDriverQuery()
```
    Description copied from class: LensQuery
    
    The driver query. It is the final query (derived form user query) that was submitted by the driver for execution.
    
    Overrides:
    
    getDriverQuery in class LensQuery
  - getStatus
```
public QueryStatus getStatus()
```
    Description copied from class: LensQuery
    
    The status of this query. Note: QueryStatus.getStatus() method can be used to get the QueryStatus.Status enum that defines the current state of the query. Also other utility methods are available to check the status of the query like QueryStatus.queued(), QueryStatus.successful(), QueryStatus.finished(), QueryStatus.failed() and QueryStatus.running()
    
    Overrides:
    
    getStatus in class LensQuery
  - getResultSetPath
```
public String getResultSetPath()
```
    Description copied from class: LensQuery
    
    The result set path for this query if the query output was persisted by the server.
    
    Overrides:
    
    getResultSetPath in class LensQuery
  - getDriverOpHandle
```
public String getDriverOpHandle()
```
    Description copied from class: LensQuery
    
    The operation handle associated with the driver, if any.
    
    Overrides:
    
    getDriverOpHandle in class LensQuery
  - getQueryConf
```
public LensConf getQueryConf()
```
    Description copied from class: LensQuery
    
    The query conf that was used for executing this query.
    
    Overrides:
    
    getQueryConf in class LensQuery
  - getSubmissionTime
```
public long getSubmissionTime()
```
    Description copied from class: LensQuery
    
    The submission time.
    
    Overrides:
    
    getSubmissionTime in class LensQuery
  - getLaunchTime
```
public long getLaunchTime()
```
    Description copied from class: LensQuery
    
    The query launch time. This will be submission time + time spent by query waiting in the queue
    
    Overrides:
    
    getLaunchTime in class LensQuery
  - getDriverStartTime
```
public long getDriverStartTime()
```
    Description copied from class: LensQuery
    
    The query execution start time on driver. This will >= launch time.
    
    Overrides:
    
    getDriverStartTime in class LensQuery
  - getDriverFinishTime
```
public long getDriverFinishTime()
```
    Description copied from class: LensQuery
    
    The the query execution end time on driver.
    
    Overrides:
    
    getDriverFinishTime in class LensQuery
  - getFinishTime
```
public long getFinishTime()
```
    Description copied from class: LensQuery
    
    The query finish time on server. This will be driver finish time + any extra time spent by server (like formatting the result)
    
    Overrides:
    
    getFinishTime in class LensQuery
  - getClosedTime
```
public long getClosedTime()
```
    Description copied from class: LensQuery
    
    The the query close time when the query is purged by the server and no more operations are pending for it. Note: not supported as of now.
    
    Overrides:
    
    getClosedTime in class LensQuery
  - getQueryName
```
public String getQueryName()
```
    Description copied from class: LensQuery
    
    The query name, if any.
    
    Overrides:
    
    getQueryName in class LensQuery
  - getErrorCode
```
public Integer getErrorCode()
```
    Overrides:
    
    getErrorCode in class LensQuery
    
    Returns:
    error code in case of query failures
  - getErrorMessage
```
public String getErrorMessage()
```
    Overrides:
    
    getErrorMessage in class LensQuery
    
    Returns:
    error message in case of query failures
  - getQueryHandleString
```
public String getQueryHandleString()
```
    Overrides:
    
    getQueryHandleString in class LensQuery
    
    Returns:
    the query handle string

Class ProxyLensQuery

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.lens.api.ToYAMLString

Constructor Summary

Method Summary

Methods inherited from class org.apache.lens.api.query.LensQuery

Methods inherited from class org.apache.lens.api.ToYAMLString

Methods inherited from class java.lang.Object

Constructor Detail

ProxyLensQuery

Method Detail

getQueryHandle

getSubmittedUser

getUserQuery

getPriority

isPersistent

getSelectedDriverName

getDriverQuery

getStatus

getResultSetPath

getDriverOpHandle

getQueryConf

getSubmissionTime

getLaunchTime

getDriverStartTime

getDriverFinishTime

getFinishTime

getClosedTime

getQueryName

getErrorCode

getErrorMessage

getQueryHandleString