java.lang.Object
- software.amazon.awssdk.services.s3.model.S3Location

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<S3Location.Builder,S3Location>
```
@Generated("software.amazon.awssdk:codegen")
public final class S3Location
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<S3Location.Builder,S3Location>
```
Describes an Amazon S3 location that will receive the results of the restore request.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface S3Location.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`List<Grant>`	`accessControlList()`	A list of grants that control access to the staged results.
`String`	`bucketName()`	The name of the bucket where the restore results will be placed.
`static S3Location.Builder`	`builder()`
`ObjectCannedACL`	`cannedACL()`	The canned ACL to apply to the restore results.
`String`	`cannedACLAsString()`	The canned ACL to apply to the restore results.
`Encryption`	`encryption()`	Returns the value of the Encryption property for this object.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAccessControlList()`	For responses, this returns true if the service returned a value for the AccessControlList property.
`int`	`hashCode()`
`boolean`	`hasUserMetadata()`	For responses, this returns true if the service returned a value for the UserMetadata property.
`String`	`prefix()`	The prefix that is prepended to the restore results for this request.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends S3Location.Builder>`	`serializableBuilderClass()`
`StorageClass`	`storageClass()`	The class of storage used to store the restore results.
`String`	`storageClassAsString()`	The class of storage used to store the restore results.
`Tagging`	`tagging()`	The tag-set that is applied to the restore results.
`S3Location.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`List<MetadataEntry>`	`userMetadata()`	A list of metadata to store with the restore results in S3.

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
  - bucketName
```
public final String bucketName()
```
    The name of the bucket where the restore results will be placed.
    
    Returns:
    
    The name of the bucket where the restore results will be placed.
  - prefix
```
public final String prefix()
```
    The prefix that is prepended to the restore results for this request.
    
    Returns:
    
    The prefix that is prepended to the restore results for this request.
  - encryption
```
public final Encryption encryption()
```
    Returns the value of the Encryption property for this object.
    
    Returns:
    
    The value of the Encryption property for this object.
  - cannedACL
```
public final ObjectCannedACL cannedACL()
```
    The canned ACL to apply to the restore results.
    
    If the service returns an enum value that is not available in the current SDK version, cannedACL will return ObjectCannedACL.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from cannedACLAsString().
    
    Returns:
    
    The canned ACL to apply to the restore results.
    
    See Also:
    
    ObjectCannedACL
  - cannedACLAsString
```
public final String cannedACLAsString()
```
    The canned ACL to apply to the restore results.
    
    If the service returns an enum value that is not available in the current SDK version, cannedACL will return ObjectCannedACL.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from cannedACLAsString().
    
    Returns:
    
    The canned ACL to apply to the restore results.
    
    See Also:
    
    ObjectCannedACL
  - 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 the isEmpty() 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
```
public final List<Grant> 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.
  - tagging
```
public final Tagging tagging()
```
    The tag-set that is applied to the restore results.
    
    Returns:
    
    The tag-set that is applied to the restore 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 the isEmpty() 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
```
public final List<MetadataEntry> userMetadata()
```
    A list of metadata to store with the restore results in 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 list of metadata to store with the restore results in S3.
  - storageClass
```
public final StorageClass storageClass()
```
    The class of storage used to store the restore results.
    
    If the service returns an enum value that is not available in the current SDK version, storageClass will return StorageClass.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from storageClassAsString().
    
    Returns:
    
    The class of storage used to store the restore results.
    
    See Also:
    
    StorageClass
  - storageClassAsString
```
public final String storageClassAsString()
```
    The class of storage used to store the restore results.
    
    If the service returns an enum value that is not available in the current SDK version, storageClass will return StorageClass.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from storageClassAsString().
    
    Returns:
    
    The class of storage used to store the restore results.
    
    See Also:
    
    StorageClass
  - toBuilder
```
public S3Location.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<S3Location.Builder,S3Location>
  - builder
```
public static S3Location.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends S3Location.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

Class S3Location

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

bucketName

prefix

encryption

cannedACL

cannedACLAsString

hasAccessControlList

accessControlList

tagging

hasUserMetadata

userMetadata

storageClass

storageClassAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields