Package software.amazon.awssdk.services.cleanrooms.model

Class ProtectedQueryS3OutputConfiguration

java.lang.Object

software.amazon.awssdk.services.cleanrooms.model.ProtectedQueryS3OutputConfiguration

All Implemented Interfaces:

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

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

Contains the configuration to write the query results to S3.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ProtectedQueryS3OutputConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
String	bucket()	The S3 bucket to unload the protected query results.
static ProtectedQueryS3OutputConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	keyPrefix()	The S3 prefix to unload the protected query results.
ResultFormat	resultFormat()	Intended file format of the result.
String	resultFormatAsString()	Intended file format of the result.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ProtectedQueryS3OutputConfiguration.Builder>	serializableBuilderClass()
Boolean	singleFileOutput()	Indicates whether files should be output as a single file (TRUE) or output as multiple files ( FALSE).
ProtectedQueryS3OutputConfiguration.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

resultFormat

public final ResultFormat resultFormat()

Intended file format of the result.

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

Returns:

Intended file format of the result.

See Also:

ResultFormat

resultFormatAsString

public final String resultFormatAsString()

Intended file format of the result.

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

Returns:

Intended file format of the result.

See Also:

ResultFormat

bucket

public final String bucket()

The S3 bucket to unload the protected query results.

Returns:

The S3 bucket to unload the protected query results.

keyPrefix

public final String keyPrefix()

The S3 prefix to unload the protected query results.

Returns:

The S3 prefix to unload the protected query results.

singleFileOutput

public final Boolean singleFileOutput()

Indicates whether files should be output as a single file (TRUE) or output as multiple files ( FALSE). This parameter is only supported for analyses with the Spark analytics engine.

Returns:

Indicates whether files should be output as a single file (TRUE) or output as multiple files (FALSE). This parameter is only supported for analyses with the Spark analytics engine.

toBuilder

public ProtectedQueryS3OutputConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ProtectedQueryS3OutputConfiguration.Builder,ProtectedQueryS3OutputConfiguration>

builder

public static ProtectedQueryS3OutputConfiguration.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo