Package software.amazon.awssdk.services.lakeformation.model

Class QuerySessionContext

java.lang.Object

software.amazon.awssdk.services.lakeformation.model.QuerySessionContext

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<QuerySessionContext.Builder,QuerySessionContext>

@Generated("software.amazon.awssdk:codegen")
public final class QuerySessionContext
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<QuerySessionContext.Builder,QuerySessionContext>

A structure used as a protocol between query engines and Lake Formation or Glue. Contains both a Lake Formation generated authorization identifier and information from the request's authorization context.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	QuerySessionContext.Builder

Method Summary

Modifier and Type	Method	Description
Map<String,String>	additionalContext()	An opaque string-string map passed by the query engine.
static QuerySessionContext.Builder	builder()
String	clusterId()	An identifier string for the consumer cluster.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAdditionalContext()	For responses, this returns true if the service returned a value for the AdditionalContext property.
int	hashCode()
String	queryAuthorizationId()	A cryptographically generated query identifier generated by Glue or Lake Formation.
String	queryId()	A unique identifier generated by the query engine for the query.
Instant	queryStartTime()	A timestamp provided by the query engine for when the query started.
List<SdkField<?>>	sdkFields()
static Class<? extends QuerySessionContext.Builder>	serializableBuilderClass()
QuerySessionContext.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

queryId

public final String queryId()

A unique identifier generated by the query engine for the query.

Returns:

A unique identifier generated by the query engine for the query.

queryStartTime

public final Instant queryStartTime()

A timestamp provided by the query engine for when the query started.

Returns:

A timestamp provided by the query engine for when the query started.

clusterId

public final String clusterId()

An identifier string for the consumer cluster.

Returns:

An identifier string for the consumer cluster.

queryAuthorizationId

public final String queryAuthorizationId()

A cryptographically generated query identifier generated by Glue or Lake Formation.

Returns:

A cryptographically generated query identifier generated by Glue or Lake Formation.

hasAdditionalContext

public final boolean hasAdditionalContext()

For responses, this returns true if the service returned a value for the AdditionalContext property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

additionalContext

public final Map<String,String> additionalContext()

An opaque string-string map passed by the query engine.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAdditionalContext() method.

Returns:

An opaque string-string map passed by the query engine.

toBuilder

public QuerySessionContext.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<QuerySessionContext.Builder,QuerySessionContext>

builder

public static QuerySessionContext.Builder builder()

serializableBuilderClass

public static Class<? extends QuerySessionContext.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo