Package com.atlan.api

Class QueriesEndpoint

java.lang.Object

com.atlan.api.AbstractEndpoint

com.atlan.api.HekaEndpoint

com.atlan.api.QueriesEndpoint

public class QueriesEndpoint
extends HekaEndpoint

API endpoints for running 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
QueriesEndpoint(AtlanClient client)

Method Summary

Modifier and Type	Method	Description
QueryResponse	stream(QueryRequest request)	Runs the provided query and returns its results.
QueryResponse	stream(QueryRequest request, RequestOptions options)	Runs the provided query and returns its results.

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

QueriesEndpoint

public QueriesEndpoint(AtlanClient client)

Method Details

stream

public QueryResponse stream(QueryRequest request)
                     throws AtlanException

Runs the provided query and returns its results.

Parameters:

request - query to run

Returns:

results of the query

Throws:

AtlanException - on any issues with API communication

stream

public QueryResponse stream(QueryRequest request,
 RequestOptions options)
                     throws AtlanException

Runs the provided query and returns its results.

Parameters:

request - query to run

options - to override default client settings

Returns:

results of the query

Throws:

AtlanException - on any issues with API communication