Package software.amazon.awssdk.services.athena.model

Class QueryResultsS3AccessGrantsConfiguration

java.lang.Object

software.amazon.awssdk.services.athena.model.QueryResultsS3AccessGrantsConfiguration

All Implemented Interfaces:

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

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

Specifies whether Amazon S3 access grants are enabled for query results.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	QueryResultsS3AccessGrantsConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
AuthenticationType	authenticationType()	The authentication type used for Amazon S3 access grants.
String	authenticationTypeAsString()	The authentication type used for Amazon S3 access grants.
static QueryResultsS3AccessGrantsConfiguration.Builder	builder()
Boolean	createUserLevelPrefix()	When enabled, appends the user ID as an Amazon S3 path prefix to the query result output location.
Boolean	enableS3AccessGrants()	Specifies whether Amazon S3 access grants are enabled for query results.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends QueryResultsS3AccessGrantsConfiguration.Builder>	serializableBuilderClass()
QueryResultsS3AccessGrantsConfiguration.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

enableS3AccessGrants

public final Boolean enableS3AccessGrants()

Specifies whether Amazon S3 access grants are enabled for query results.

Returns:

Specifies whether Amazon S3 access grants are enabled for query results.

createUserLevelPrefix

public final Boolean createUserLevelPrefix()

When enabled, appends the user ID as an Amazon S3 path prefix to the query result output location.

Returns:

When enabled, appends the user ID as an Amazon S3 path prefix to the query result output location.

authenticationType

public final AuthenticationType authenticationType()

The authentication type used for Amazon S3 access grants. Currently, only DIRECTORY_IDENTITY is supported.

If the service returns an enum value that is not available in the current SDK version, authenticationType will return AuthenticationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authenticationTypeAsString().

Returns:

The authentication type used for Amazon S3 access grants. Currently, only DIRECTORY_IDENTITY is supported.

See Also:

AuthenticationType

authenticationTypeAsString

public final String authenticationTypeAsString()

The authentication type used for Amazon S3 access grants. Currently, only DIRECTORY_IDENTITY is supported.

If the service returns an enum value that is not available in the current SDK version, authenticationType will return AuthenticationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authenticationTypeAsString().

Returns:

The authentication type used for Amazon S3 access grants. Currently, only DIRECTORY_IDENTITY is supported.

See Also:

AuthenticationType

toBuilder

public QueryResultsS3AccessGrantsConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<QueryResultsS3AccessGrantsConfiguration.Builder,QueryResultsS3AccessGrantsConfiguration>

builder

public static QueryResultsS3AccessGrantsConfiguration.Builder builder()

serializableBuilderClass

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