software.amazon.awssdk.services.s3.model

Class S3Location

java.lang.Object

software.amazon.awssdk.services.s3.model.S3Location

All Implemented Interfaces:

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

@Generated(value="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 and Description
static interface	S3Location.Builder

Method Summary

Modifier and Type	Method and 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() Returns true if the AccessControlList property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasUserMetadata() Returns true if the UserMetadata property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
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 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 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 Encryption encryption()

Returns the value of the Encryption property for this object.

Returns:

The value of the Encryption property for this object.

cannedACL

public 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 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 boolean hasAccessControlList()

Returns true if the AccessControlList property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

accessControlList

public 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.

You can use hasAccessControlList() to see if a value was sent in this field.

Returns:

A list of grants that control access to the staged results.

tagging

public 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 boolean hasUserMetadata()

Returns true if the UserMetadata property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

userMetadata

public 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.

You can use hasUserMetadata() to see if a value was sent in this field.

Returns:

A list of metadata to store with the restore results in S3.

storageClass

public 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 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 int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo