Class ResultConfiguration
- java.lang.Object
-
- software.amazon.awssdk.services.athena.model.ResultConfiguration
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<ResultConfiguration.Builder,ResultConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class ResultConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ResultConfiguration.Builder,ResultConfiguration>
The location in Amazon S3 where query and calculation results are stored and the encryption option, if any, used for query and calculation results. These are known as "client-side settings". If workgroup settings override client-side settings, then the query uses the workgroup settings.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceResultConfiguration.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description AclConfigurationaclConfiguration()Indicates that an Amazon S3 canned ACL should be set to control ownership of stored query results.static ResultConfiguration.Builderbuilder()EncryptionConfigurationencryptionConfiguration()If query and calculation results are encrypted in Amazon S3, indicates the encryption option used (for example,SSE_KMSorCSE_KMS) and key information.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)StringexpectedBucketOwner()The Amazon Web Services account ID that you expect to be the owner of the Amazon S3 bucket specified by ResultConfiguration$OutputLocation.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()StringoutputLocation()The location in Amazon S3 where your query and calculation results are stored, such ass3://path/to/query/bucket/.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends ResultConfiguration.Builder>serializableBuilderClass()ResultConfiguration.BuildertoBuilder()StringtoString()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
-
outputLocation
public final String outputLocation()
The location in Amazon S3 where your query and calculation results are stored, such as
s3://path/to/query/bucket/. To run the query, you must specify the query results location using one of the ways: either for individual queries using either this setting (client-side), or in the workgroup, using WorkGroupConfiguration. If none of them is set, Athena issues an error that no output location is provided. If workgroup settings override client-side settings, then the query uses the settings specified for the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.- Returns:
- The location in Amazon S3 where your query and calculation results are stored, such as
s3://path/to/query/bucket/. To run the query, you must specify the query results location using one of the ways: either for individual queries using either this setting (client-side), or in the workgroup, using WorkGroupConfiguration. If none of them is set, Athena issues an error that no output location is provided. If workgroup settings override client-side settings, then the query uses the settings specified for the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.
-
encryptionConfiguration
public final EncryptionConfiguration encryptionConfiguration()
If query and calculation results are encrypted in Amazon S3, indicates the encryption option used (for example,
SSE_KMSorCSE_KMS) and key information. This is a client-side setting. If workgroup settings override client-side settings, then the query uses the encryption configuration that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings.- Returns:
- If query and calculation results are encrypted in Amazon S3, indicates the encryption option used (for
example,
SSE_KMSorCSE_KMS) and key information. This is a client-side setting. If workgroup settings override client-side settings, then the query uses the encryption configuration that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings.
-
expectedBucketOwner
public final String expectedBucketOwner()
The Amazon Web Services account ID that you expect to be the owner of the Amazon S3 bucket specified by ResultConfiguration$OutputLocation. If set, Athena uses the value for
ExpectedBucketOwnerwhen it makes Amazon S3 calls to your specified output location. If theExpectedBucketOwnerAmazon Web Services account ID does not match the actual owner of the Amazon S3 bucket, the call fails with a permissions error.This is a client-side setting. If workgroup settings override client-side settings, then the query uses the
ExpectedBucketOwnersetting that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings.- Returns:
- The Amazon Web Services account ID that you expect to be the owner of the Amazon S3 bucket specified by
ResultConfiguration$OutputLocation. If set, Athena uses the value for
ExpectedBucketOwnerwhen it makes Amazon S3 calls to your specified output location. If theExpectedBucketOwnerAmazon Web Services account ID does not match the actual owner of the Amazon S3 bucket, the call fails with a permissions error.This is a client-side setting. If workgroup settings override client-side settings, then the query uses the
ExpectedBucketOwnersetting that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings.
-
aclConfiguration
public final AclConfiguration aclConfiguration()
Indicates that an Amazon S3 canned ACL should be set to control ownership of stored query results. Currently the only supported canned ACL is
BUCKET_OWNER_FULL_CONTROL. This is a client-side setting. If workgroup settings override client-side settings, then the query uses the ACL configuration that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. For more information, see WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings.- Returns:
- Indicates that an Amazon S3 canned ACL should be set to control ownership of stored query results.
Currently the only supported canned ACL is
BUCKET_OWNER_FULL_CONTROL. This is a client-side setting. If workgroup settings override client-side settings, then the query uses the ACL configuration that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. For more information, see WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings.
-
toBuilder
public ResultConfiguration.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<ResultConfiguration.Builder,ResultConfiguration>
-
builder
public static ResultConfiguration.Builder builder()
-
serializableBuilderClass
public static Class<? extends ResultConfiguration.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-