Package com.atlan.api

Class QueryParserEndpoint

java.lang.Object

com.atlan.api.AbstractEndpoint

com.atlan.api.HekaEndpoint

com.atlan.api.QueryParserEndpoint

public class QueryParserEndpoint
extends HekaEndpoint

API endpoints for parsing SQL queries.

Nested Class Summary

Nested classes/interfaces inherited from class com.atlan.api.AbstractEndpoint

AbstractEndpoint.RawResponse

Field Summary

Fields inherited from class com.atlan.api.AbstractEndpoint

client

Constructor Summary

Constructors

Constructor	Description
QueryParserEndpoint(AtlanClient client)

Method Summary

Modifier and Type	Method	Description
ParsedQuery	parse(QueryParserRequest request)	Parses the provided query to describe its component parts.
ParsedQuery	parse(QueryParserRequest request, RequestOptions options)	Parses the provided query to describe its component parts.

Methods inherited from class com.atlan.api.HekaEndpoint

getBaseUrl

Methods inherited from class com.atlan.api.AbstractEndpoint

getBaseUrl

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

QueryParserEndpoint

public QueryParserEndpoint(AtlanClient client)

Method Details

parse

public ParsedQuery parse(QueryParserRequest request)
                  throws AtlanException

Parses the provided query to describe its component parts.

Parameters:

request - query to parse and configuration options

Returns:

parsed explanation of the query

Throws:

AtlanException - on any issues with API communication

parse

public ParsedQuery parse(QueryParserRequest request,
 RequestOptions options)
                  throws AtlanException

Parses the provided query to describe its component parts.

Parameters:

request - query to parse and configuration options

options - to override default client settings

Returns:

parsed explanation of the query

Throws:

AtlanException - on any issues with API communication