Package software.amazon.awssdk.services.s3.model

Interface S3Location.Builder

All Superinterfaces:

Buildable, CopyableBuilder<S3Location.Builder,S3Location>, SdkBuilder<S3Location.Builder,S3Location>, SdkPojo

Enclosing class:

S3Location

@Mutable
@NotThreadSafe
public static interface S3Location.Builder
extends SdkPojo, CopyableBuilder<S3Location.Builder,S3Location>

Method Summary

Modifier and Type	Method	Description
S3Location.Builder	accessControlList(Collection<Grant> accessControlList)	A list of grants that control access to the staged results.
S3Location.Builder	accessControlList(Consumer<Grant.Builder>... accessControlList)	A list of grants that control access to the staged results.
S3Location.Builder	accessControlList(Grant... accessControlList)	A list of grants that control access to the staged results.
S3Location.Builder	bucketName(String bucketName)	The name of the bucket where the restore results will be placed.
S3Location.Builder	cannedACL(String cannedACL)	The canned ACL to apply to the restore results.
S3Location.Builder	cannedACL(ObjectCannedACL cannedACL)	The canned ACL to apply to the restore results.
default S3Location.Builder	encryption(Consumer<Encryption.Builder> encryption)	Sets the value of the Encryption property for this object.
S3Location.Builder	encryption(Encryption encryption)	Sets the value of the Encryption property for this object.
S3Location.Builder	prefix(String prefix)	The prefix that is prepended to the restore results for this request.
S3Location.Builder	storageClass(String storageClass)	The class of storage used to store the restore results.
S3Location.Builder	storageClass(StorageClass storageClass)	The class of storage used to store the restore results.
default S3Location.Builder	tagging(Consumer<Tagging.Builder> tagging)	The tag-set that is applied to the restore results.
S3Location.Builder	tagging(Tagging tagging)	The tag-set that is applied to the restore results.
S3Location.Builder	userMetadata(Collection<MetadataEntry> userMetadata)	A list of metadata to store with the restore results in S3.
S3Location.Builder	userMetadata(Consumer<MetadataEntry.Builder>... userMetadata)	A list of metadata to store with the restore results in S3.
S3Location.Builder	userMetadata(MetadataEntry... userMetadata)	A list of metadata to store with the restore results in S3.

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

bucketName

S3Location.Builder bucketName(String bucketName)

The name of the bucket where the restore results will be placed.

Parameters:

bucketName - The name of the bucket where the restore results will be placed.

Returns:

Returns a reference to this object so that method calls can be chained together.

prefix

S3Location.Builder prefix(String prefix)

The prefix that is prepended to the restore results for this request.

Parameters:

prefix - The prefix that is prepended to the restore results for this request.

Returns:

Returns a reference to this object so that method calls can be chained together.

encryption

S3Location.Builder encryption(Encryption encryption)

Sets the value of the Encryption property for this object.

Parameters:

encryption - The new value for the Encryption property for this object.

Returns:

Returns a reference to this object so that method calls can be chained together.

encryption

default S3Location.Builder encryption(Consumer<Encryption.Builder> encryption)

Sets the value of the Encryption property for this object. This is a convenience method that creates an instance of the Encryption.Builder avoiding the need to create one manually via Encryption.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to encryption(Encryption).

Parameters:

encryption - a consumer that will call methods on Encryption.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

encryption(Encryption)

cannedACL

S3Location.Builder cannedACL(String cannedACL)

The canned ACL to apply to the restore results.

Parameters:

cannedACL - The canned ACL to apply to the restore results.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ObjectCannedACL, ObjectCannedACL

cannedACL

S3Location.Builder cannedACL(ObjectCannedACL cannedACL)

The canned ACL to apply to the restore results.

Parameters:

cannedACL - The canned ACL to apply to the restore results.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ObjectCannedACL, ObjectCannedACL

accessControlList

S3Location.Builder accessControlList(Collection<Grant> accessControlList)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

accessControlList

S3Location.Builder accessControlList(Grant... accessControlList)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

accessControlList

S3Location.Builder accessControlList(Consumer<Grant.Builder>... accessControlList)

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

This is a convenience method that creates an instance of the Grant.Builder avoiding the need to create one manually via Grant.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #accessControlList(List).

Parameters:

accessControlList - a consumer that will call methods on Grant.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#accessControlList(java.util.Collection)

tagging

S3Location.Builder tagging(Tagging tagging)

The tag-set that is applied to the restore results.

Parameters:

tagging - The tag-set that is applied to the restore results.

Returns:

Returns a reference to this object so that method calls can be chained together.

tagging

default S3Location.Builder tagging(Consumer<Tagging.Builder> tagging)

The tag-set that is applied to the restore results.

This is a convenience method that creates an instance of the Tagging.Builder avoiding the need to create one manually via Tagging.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tagging(Tagging).

Parameters:

tagging - a consumer that will call methods on Tagging.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

tagging(Tagging)

userMetadata

S3Location.Builder userMetadata(Collection<MetadataEntry> userMetadata)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

userMetadata

S3Location.Builder userMetadata(MetadataEntry... userMetadata)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

userMetadata

S3Location.Builder userMetadata(Consumer<MetadataEntry.Builder>... userMetadata)

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

This is a convenience method that creates an instance of the MetadataEntry.Builder avoiding the need to create one manually via MetadataEntry.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #userMetadata(List).

Parameters:

userMetadata - a consumer that will call methods on MetadataEntry.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#userMetadata(java.util.Collection)

storageClass

S3Location.Builder storageClass(String storageClass)

The class of storage used to store the restore results.

Parameters:

storageClass - The class of storage used to store the restore results.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

StorageClass, StorageClass

storageClass

S3Location.Builder storageClass(StorageClass storageClass)

The class of storage used to store the restore results.

Parameters:

storageClass - The class of storage used to store the restore results.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

StorageClass, StorageClass