Package software.amazon.awssdk.services.transfer.model

Class S3InputFileLocation

java.lang.Object

software.amazon.awssdk.services.transfer.model.S3InputFileLocation

All Implemented Interfaces:

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

@Generated("software.amazon.awssdk:codegen")
public final class S3InputFileLocation
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<S3InputFileLocation.Builder,S3InputFileLocation>

Specifies the customer input Amazon S3 file location. If it is used inside copyStepDetails.DestinationFileLocation, it should be the S3 copy destination.

You need to provide the bucket and key. The key can represent either a path or a file. This is determined by whether or not you end the key value with the forward slash (/) character. If the final character is "/", then your file is copied to the folder, and its name does not change. If, rather, the final character is alphanumeric, your uploaded file is renamed to the path value. In this case, if a file with that name already exists, it is overwritten.

For example, if your path is shared-files/bob/, your uploaded files are copied to the shared-files/bob/, folder. If your path is shared-files/today, each uploaded file is copied to the shared-files folder and named today: each upload overwrites the previous version of the bob file.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	S3InputFileLocation.Builder

Method Summary

Modifier and Type	Method	Description
String	bucket()	Specifies the S3 bucket for the customer input file.
static S3InputFileLocation.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	key()	The name assigned to the file when it was created in Amazon S3.
List<SdkField<?>>	sdkFields()
static Class<? extends S3InputFileLocation.Builder>	serializableBuilderClass()
S3InputFileLocation.Builder	toBuilder()
String	toString()	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

bucket

public final String bucket()

Specifies the S3 bucket for the customer input file.

Returns:

Specifies the S3 bucket for the customer input file.

key

public final String key()

The name assigned to the file when it was created in Amazon S3. You use the object key to retrieve the object.

Returns:

The name assigned to the file when it was created in Amazon S3. You use the object key to retrieve the object.

toBuilder

public S3InputFileLocation.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<S3InputFileLocation.Builder,S3InputFileLocation>

builder

public static S3InputFileLocation.Builder builder()

serializableBuilderClass

public static Class<? extends S3InputFileLocation.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