Package com.atlan.net

Class ApiEventStreamResource

java.lang.Object

com.atlan.model.core.AtlanObject

com.atlan.net.ApiEventStreamResource

All Implemented Interfaces:

AtlanEventStreamResponseInterface, Serializable

Direct Known Subclasses:

QueryResponse

public abstract class ApiEventStreamResource
extends AtlanObject
implements AtlanEventStreamResponseInterface

Base class for all event-stream response objects.

See Also:

• Serialized Form

Nested Class Summary

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
ApiEventStreamResource()

Method Summary

Modifier and Type	Method	Description
AtlanEventStreamResponse	getLastResponse()
static <T extends ApiEventStreamResource> T	request(AtlanClient client, ApiResource.RequestMethod method, String url, AtlanObject payload, Class<T> clazz, RequestOptions options)	Pass-through to the request-handling method after confirming that the provided payload is non-null.
static <T extends ApiEventStreamResource> T	request(AtlanClient client, ApiResource.RequestMethod method, String url, String body, Class<T> clazz, RequestOptions options)	Pass-through the request to the request-handling method.
void	setLastResponse(AtlanEventStreamResponse response)
String	toString()

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

canEqual, equals, getRawJsonObject, hashCode, setRawJsonObject, toJson

Methods inherited from class java.lang.Object

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

Constructor Details

ApiEventStreamResource

public ApiEventStreamResource()

Method Details

getLastResponse

public AtlanEventStreamResponse getLastResponse()

Specified by:

getLastResponse in interface AtlanEventStreamResponseInterface

setLastResponse

public void setLastResponse(AtlanEventStreamResponse response)

Specified by:

setLastResponse in interface AtlanEventStreamResponseInterface

request

public static <T extends ApiEventStreamResource> T request(AtlanClient client,
 ApiResource.RequestMethod method,
 String url,
 AtlanObject payload,
 Class<T> clazz,
 RequestOptions options)
                                                    throws AtlanException

Pass-through to the request-handling method after confirming that the provided payload is non-null.

Type Parameters:

T - the type of the response

Parameters:

client - connectivity to Atlan

method - for the request

url - of the request

payload - to send in the request

clazz - defining the expected response type

options - for sending the request (or null to use global defaults)

Returns:

the response

Throws:

AtlanException - on any API interaction problem

request

public static <T extends ApiEventStreamResource> T request(AtlanClient client,
 ApiResource.RequestMethod method,
 String url,
 String body,
 Class<T> clazz,
 RequestOptions options)
                                                    throws AtlanException

Pass-through the request to the request-handling method. This method wraps debug-level logging lines around the request to show precisely what was constructed and sent to Atlan. What was returned in the response is explicitly not logged to avoid any sensitive information possibly being logged.

Type Parameters:

T - the type of the response

Parameters:

client - connectivity to Atlan

method - for the request

url - of the request

body - to send in the request, if any (to not send any use an empty string)

clazz - defining the expected response type

options - for sending the request (or null to use global defaults)

Returns:

the response

Throws:

AtlanException - on any API interaction problem

toString

public String toString()

Description copied from class: AtlanObject

Overrides:

toString in class AtlanObject