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

Class QueryPlanningContext

java.lang.Object

software.amazon.awssdk.services.lakeformation.model.QueryPlanningContext

All Implemented Interfaces:

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

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

A structure containing information about the query plan.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	QueryPlanningContext.Builder

Method Summary

Modifier and Type	Method	Description
static QueryPlanningContext.Builder	builder()
String	catalogId()	The ID of the Data Catalog where the partition in question resides.
String	databaseName()	The database containing the table.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasQueryParameters()	For responses, this returns true if the service returned a value for the QueryParameters property.
Instant	queryAsOfTime()	The time as of when to read the table contents.
Map<String,String>	queryParameters()	A map consisting of key-value pairs.
List<SdkField<?>>	sdkFields()
static Class<? extends QueryPlanningContext.Builder>	serializableBuilderClass()
QueryPlanningContext.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	transactionId()	The transaction ID at which to read the table contents.

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

catalogId

public final String catalogId()

The ID of the Data Catalog where the partition in question resides. If none is provided, the Amazon Web Services account ID is used by default.

Returns:

The ID of the Data Catalog where the partition in question resides. If none is provided, the Amazon Web Services account ID is used by default.

databaseName

public final String databaseName()

The database containing the table.

Returns:

The database containing the table.

queryAsOfTime

public final Instant queryAsOfTime()

The time as of when to read the table contents. If not set, the most recent transaction commit time will be used. Cannot be specified along with TransactionId.

Returns:

The time as of when to read the table contents. If not set, the most recent transaction commit time will be used. Cannot be specified along with TransactionId.

hasQueryParameters

public final boolean hasQueryParameters()

For responses, this returns true if the service returned a value for the QueryParameters 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.

queryParameters

public final Map<String,String> queryParameters()

A map consisting of key-value pairs.

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 hasQueryParameters() method.

Returns:

A map consisting of key-value pairs.

transactionId

public final String transactionId()

The transaction ID at which to read the table contents. If this transaction is not committed, the read will be treated as part of that transaction and will see its writes. If this transaction has aborted, an error will be returned. If not set, defaults to the most recent committed transaction. Cannot be specified along with QueryAsOfTime.

Returns:

The transaction ID at which to read the table contents. If this transaction is not committed, the read will be treated as part of that transaction and will see its writes. If this transaction has aborted, an error will be returned. If not set, defaults to the most recent committed transaction. Cannot be specified along with QueryAsOfTime.

toBuilder

public QueryPlanningContext.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<QueryPlanningContext.Builder,QueryPlanningContext>

builder

public static QueryPlanningContext.Builder builder()

serializableBuilderClass

public static Class<? extends QueryPlanningContext.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