Package com.atlan.model.admin

Class QueryResponse

java.lang.Object

com.atlan.model.core.AtlanObject

com.atlan.net.ApiEventStreamResource

com.atlan.model.admin.QueryResponse

All Implemented Interfaces:

AtlanEventStreamResponseInterface, Serializable

public class QueryResponse
extends ApiEventStreamResource

Response containing the details of a parsed SQL query.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	QueryResponse.AssetDetails	Details about an asset that was queried, in case of errors.
static final class	QueryResponse.ColumnDetails	Details about the columns that were returned from a query that was run.
static final class	QueryResponse.ColumnType	Details about the type of column that was returned from a query that was run.
static final class	QueryResponse.QueryDetails	Details about a query that was run.

Nested classes/interfaces inherited from class com.atlan.model.core.AtlanObject

AtlanObject.AtlanObjectBuilder<C extends AtlanObject,B extends AtlanObject.AtlanObjectBuilder<C,B>>

Field Summary

Fields inherited from class com.atlan.model.core.AtlanObject

rawJsonObject

Constructor Summary

Constructors

Constructor	Description
QueryResponse(String requestId, String errorName, String errorMessage, String errorCode, String queryId, List<List<String>> rows, List<QueryResponse.ColumnDetails> columns, QueryResponse.QueryDetails details)	All-args constructor needed by Jackson to deserialize individual events.
QueryResponse(List<QueryResponse> events)	Create a single consolidated response from multiple events related to the same query.

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
List<QueryResponse.ColumnDetails>	getColumns()	Columns that are present in each row of the results.
QueryResponse.QueryDetails	getDetails()	Details about the query.
String	getErrorCode()	Unique code for the error, if there was any error.
String	getErrorMessage()	Explanation of the error, if there was any error.
String	getErrorName()	Unique name for the error, if there was any error.
String	getQueryId()	Unique identifier (GUID) for the specific run of the query.
String	getRequestId()	Unique identifier for the request, if there was any error.
List<List<String>>	getRows()	Results of the query.
int	hashCode()
String	toString()

Methods inherited from class com.atlan.net.ApiEventStreamResource

getLastResponse, request, request, setLastResponse

Methods inherited from class com.atlan.model.core.AtlanObject

getRawJsonObject, setRawJsonObject, toJson

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

QueryResponse

public QueryResponse(List<QueryResponse> events)

Create a single consolidated response from multiple events related to the same query. (All ApiEventStreamResource objects must have a List constructor like this, as it is used as part of the response deserialization process, via reflection.)

Parameters:

events - detailing the streamed results of a query

QueryResponse

public QueryResponse(String requestId,
 String errorName,
 String errorMessage,
 String errorCode,
 String queryId,
 List<List<String>> rows,
 List<QueryResponse.ColumnDetails> columns,
 QueryResponse.QueryDetails details)

All-args constructor needed by Jackson to deserialize individual events. (Used by Jackson as part of the response deserialization process.)

Parameters:

requestId - see requestId

errorName - see errorName

errorMessage - see errorMessage

errorCode - see errorCode

queryId - see queryId

rows - see rows

columns - see columns

details - see details

Method Details

getRequestId

public String getRequestId()

Unique identifier for the request, if there was any error.

getErrorName

public String getErrorName()

Unique name for the error, if there was any error.

getErrorMessage

public String getErrorMessage()

Explanation of the error, if there was any error.

getErrorCode

public String getErrorCode()

Unique code for the error, if there was any error.

getQueryId

public String getQueryId()

Unique identifier (GUID) for the specific run of the query.

getRows

public List<List<String>> getRows()

Results of the query. Each element is of the outer list is a single row, while each inner list gives the column values for that row (in order).

getColumns

public List<QueryResponse.ColumnDetails> getColumns()

Columns that are present in each row of the results. The order of the elements of this list will match the order of the inner list of values for the rows.

getDetails

public QueryResponse.QueryDetails getDetails()

Details about the query.

equals

public boolean equals(Object o)

Overrides:

equals in class AtlanObject

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class AtlanObject

hashCode

public int hashCode()

Overrides:

hashCode in class AtlanObject

toString

public String toString()

Description copied from class: AtlanObject

Overrides:

toString in class ApiEventStreamResource