Class QuerySessionContext
- All Implemented Interfaces:
Serializable,SdkPojo,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:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionAn opaque string-string map passed by the query engine.static QuerySessionContext.Builderbuilder()final StringAn identifier string for the consumer cluster.final booleanfinal booleanequalsBySdkFields(Object obj) final <T> Optional<T>getValueForField(String fieldName, Class<T> clazz) final booleanFor responses, this returns true if the service returned a value for the AdditionalContext property.final inthashCode()final StringA cryptographically generated query identifier generated by Glue or Lake Formation.final StringqueryId()A unique identifier generated by the query engine for the query.final InstantA timestamp provided by the query engine for when the query started.static Class<? extends QuerySessionContext.Builder>final StringtoString()Returns a string representation of this object.Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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
An identifier string for the consumer cluster.
- Returns:
- An identifier string for the consumer cluster.
-
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 theisEmpty()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
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
- Specified by:
toBuilderin interfaceToCopyableBuilder<QuerySessionContext.Builder,QuerySessionContext>
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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. -
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-