Class ResultConfigurationUpdates
- java.lang.Object
-
- software.amazon.awssdk.services.athena.model.ResultConfigurationUpdates
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<ResultConfigurationUpdates.Builder,ResultConfigurationUpdates>
@Generated("software.amazon.awssdk:codegen") public final class ResultConfigurationUpdates extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ResultConfigurationUpdates.Builder,ResultConfigurationUpdates>
The information about the updates in the query results, such as output location and encryption configuration for the query results.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceResultConfigurationUpdates.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description AclConfigurationaclConfiguration()The ACL configuration for the query results.static ResultConfigurationUpdates.Builderbuilder()EncryptionConfigurationencryptionConfiguration()The encryption configuration for query and calculation results.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/.BooleanremoveAclConfiguration()If set totrue, indicates that the previously-specified ACL configuration for queries in this workgroup should be ignored and set to null.BooleanremoveEncryptionConfiguration()If set to "true", indicates that the previously-specified encryption configuration (also known as the client-side setting) for queries in this workgroup should be ignored and set to null.BooleanremoveExpectedBucketOwner()If set to "true", removes the Amazon Web Services account ID previously specified for ResultConfiguration$ExpectedBucketOwner.BooleanremoveOutputLocation()If set to "true", indicates that the previously-specified query results location (also known as a client-side setting) for queries in this workgroup should be ignored and set to null.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends ResultConfigurationUpdates.Builder>serializableBuilderClass()ResultConfigurationUpdates.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/. If workgroup settings override client-side settings, then the query uses the location for the query results and the encryption configuration that are specified for the workgroup. The "workgroup settings override" is specified inEnforceWorkGroupConfiguration(true/false) in theWorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.- Returns:
- The location in Amazon S3 where your query and calculation results are stored, such as
s3://path/to/query/bucket/. If workgroup settings override client-side settings, then the query uses the location for the query results and the encryption configuration that are specified for the workgroup. The "workgroup settings override" is specified inEnforceWorkGroupConfiguration(true/false) in theWorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.
-
removeOutputLocation
public final Boolean removeOutputLocation()
If set to "true", indicates that the previously-specified query results location (also known as a client-side setting) for queries in this workgroup should be ignored and set to null. If set to "false" or not set, and a value is present in the
OutputLocationinResultConfigurationUpdates(the client-side setting), theOutputLocationin the workgroup'sResultConfigurationwill be updated with the new value. For more information, see Workgroup Settings Override Client-Side Settings.- Returns:
- If set to "true", indicates that the previously-specified query results location (also known as a
client-side setting) for queries in this workgroup should be ignored and set to null. If set to "false"
or not set, and a value is present in the
OutputLocationinResultConfigurationUpdates(the client-side setting), theOutputLocationin the workgroup'sResultConfigurationwill be updated with the new value. For more information, see Workgroup Settings Override Client-Side Settings.
-
encryptionConfiguration
public final EncryptionConfiguration encryptionConfiguration()
The encryption configuration for query and calculation results.
- Returns:
- The encryption configuration for query and calculation results.
-
removeEncryptionConfiguration
public final Boolean removeEncryptionConfiguration()
If set to "true", indicates that the previously-specified encryption configuration (also known as the client-side setting) for queries in this workgroup should be ignored and set to null. If set to "false" or not set, and a value is present in the
EncryptionConfigurationinResultConfigurationUpdates(the client-side setting), theEncryptionConfigurationin the workgroup'sResultConfigurationwill be updated with the new value. For more information, see Workgroup Settings Override Client-Side Settings.- Returns:
- If set to "true", indicates that the previously-specified encryption configuration (also known as the
client-side setting) for queries in this workgroup should be ignored and set to null. If set to "false"
or not set, and a value is present in the
EncryptionConfigurationinResultConfigurationUpdates(the client-side setting), theEncryptionConfigurationin the workgroup'sResultConfigurationwill be updated with the new value. For more information, see 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.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.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.
-
removeExpectedBucketOwner
public final Boolean removeExpectedBucketOwner()
If set to "true", removes the Amazon Web Services account ID previously specified for ResultConfiguration$ExpectedBucketOwner. If set to "false" or not set, and a value is present in the
ExpectedBucketOwnerinResultConfigurationUpdates(the client-side setting), theExpectedBucketOwnerin the workgroup'sResultConfigurationis updated with the new value. For more information, see Workgroup Settings Override Client-Side Settings.- Returns:
- If set to "true", removes the Amazon Web Services account ID previously specified for
ResultConfiguration$ExpectedBucketOwner. If set to "false" or not set, and a value is present in
the
ExpectedBucketOwnerinResultConfigurationUpdates(the client-side setting), theExpectedBucketOwnerin the workgroup'sResultConfigurationis updated with the new value. For more information, see Workgroup Settings Override Client-Side Settings.
-
aclConfiguration
public final AclConfiguration aclConfiguration()
The ACL configuration for the query results.
- Returns:
- The ACL configuration for the query results.
-
removeAclConfiguration
public final Boolean removeAclConfiguration()
If set to
true, indicates that the previously-specified ACL configuration for queries in this workgroup should be ignored and set to null. If set tofalseor not set, and a value is present in theAclConfigurationofResultConfigurationUpdates, theAclConfigurationin the workgroup'sResultConfigurationis updated with the new value. For more information, see Workgroup Settings Override Client-Side Settings.- Returns:
- If set to
true, indicates that the previously-specified ACL configuration for queries in this workgroup should be ignored and set to null. If set tofalseor not set, and a value is present in theAclConfigurationofResultConfigurationUpdates, theAclConfigurationin the workgroup'sResultConfigurationis updated with the new value. For more information, see Workgroup Settings Override Client-Side Settings.
-
toBuilder
public ResultConfigurationUpdates.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<ResultConfigurationUpdates.Builder,ResultConfigurationUpdates>
-
builder
public static ResultConfigurationUpdates.Builder builder()
-
serializableBuilderClass
public static Class<? extends ResultConfigurationUpdates.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
-
-