Class S3Location
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<S3Location.Builder,
S3Location>
Contains information about the location in Amazon S3 where the select job results are stored.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionA list of grants that control access to the staged results.final String
The name of the Amazon S3 bucket where the job results are stored.static S3Location.Builder
builder()
final CannedACL
The canned access control list (ACL) to apply to the job results.final String
The canned access control list (ACL) to apply to the job results.final Encryption
Contains information about the encryption used to store the job results in Amazon S3.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the AccessControlList property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Tagging property.final boolean
For responses, this returns true if the service returned a value for the UserMetadata property.final String
prefix()
The prefix that is prepended to the results for this request.static Class
<? extends S3Location.Builder> final StorageClass
The storage class used to store the job results.final String
The storage class used to store the job results.tagging()
The tag-set that is applied to the job results.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.A map of metadata to store with the job results in Amazon S3.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
bucketName
The name of the Amazon S3 bucket where the job results are stored.
- Returns:
- The name of the Amazon S3 bucket where the job results are stored.
-
prefix
The prefix that is prepended to the results for this request.
- Returns:
- The prefix that is prepended to the results for this request.
-
encryption
Contains information about the encryption used to store the job results in Amazon S3.
- Returns:
- Contains information about the encryption used to store the job results in Amazon S3.
-
cannedACL
The canned access control list (ACL) to apply to the job results.
If the service returns an enum value that is not available in the current SDK version,
cannedACL
will returnCannedACL.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcannedACLAsString()
.- Returns:
- The canned access control list (ACL) to apply to the job results.
- See Also:
-
cannedACLAsString
The canned access control list (ACL) to apply to the job results.
If the service returns an enum value that is not available in the current SDK version,
cannedACL
will returnCannedACL.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcannedACLAsString()
.- Returns:
- The canned access control list (ACL) to apply to the job results.
- See Also:
-
hasAccessControlList
public final boolean hasAccessControlList()For responses, this returns true if the service returned a value for the AccessControlList property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
accessControlList
A list of grants that control access to the staged results.
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
hasAccessControlList()
method.- Returns:
- A list of grants that control access to the staged results.
-
hasTagging
public final boolean hasTagging()For responses, this returns true if the service returned a value for the Tagging property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
tagging
The tag-set that is applied to the job results.
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
hasTagging()
method.- Returns:
- The tag-set that is applied to the job results.
-
hasUserMetadata
public final boolean hasUserMetadata()For responses, this returns true if the service returned a value for the UserMetadata property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
userMetadata
A map of metadata to store with the job results in Amazon S3.
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
hasUserMetadata()
method.- Returns:
- A map of metadata to store with the job results in Amazon S3.
-
storageClass
The storage class used to store the job results.
If the service returns an enum value that is not available in the current SDK version,
storageClass
will returnStorageClass.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstorageClassAsString()
.- Returns:
- The storage class used to store the job results.
- See Also:
-
storageClassAsString
The storage class used to store the job results.
If the service returns an enum value that is not available in the current SDK version,
storageClass
will returnStorageClass.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstorageClassAsString()
.- Returns:
- The storage class used to store the job results.
- See Also:
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<S3Location.Builder,
S3Location> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-