Package software.amazon.awssdk.services.snowball.model

Class S3Resource

java.lang.Object

software.amazon.awssdk.services.snowball.model.S3Resource

All Implemented Interfaces:

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

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

Each S3Resource object represents an Amazon S3 bucket that your transferred data will be exported from or imported into. For export jobs, this object can have an optional KeyRange value. The length of the range is defined at job creation, and has either an inclusive BeginMarker, an inclusive EndMarker, or both. Ranges are UTF-8 binary sorted.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	S3Resource.Builder

Method Summary

Modifier and Type	Method	Description
String	bucketArn()	The Amazon Resource Name (ARN) of an Amazon S3 bucket.
static S3Resource.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTargetOnDeviceServices()	For responses, this returns true if the service returned a value for the TargetOnDeviceServices property.
KeyRange	keyRange()	For export jobs, you can provide an optional KeyRange within a specific Amazon S3 bucket.
List<SdkField<?>>	sdkFields()
static Class<? extends S3Resource.Builder>	serializableBuilderClass()
List<TargetOnDeviceService>	targetOnDeviceServices()	Specifies the service or services on the Snow Family device that your transferred data will be exported from or imported into.
S3Resource.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

bucketArn

public final String bucketArn()

The Amazon Resource Name (ARN) of an Amazon S3 bucket.

Returns:

The Amazon Resource Name (ARN) of an Amazon S3 bucket.

keyRange

public final KeyRange keyRange()

For export jobs, you can provide an optional KeyRange within a specific Amazon S3 bucket. The length of the range is defined at job creation, and has either an inclusive BeginMarker, an inclusive EndMarker, or both. Ranges are UTF-8 binary sorted.

Returns:

For export jobs, you can provide an optional KeyRange within a specific Amazon S3 bucket. The length of the range is defined at job creation, and has either an inclusive BeginMarker, an inclusive EndMarker, or both. Ranges are UTF-8 binary sorted.

hasTargetOnDeviceServices

public final boolean hasTargetOnDeviceServices()

For responses, this returns true if the service returned a value for the TargetOnDeviceServices 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.

targetOnDeviceServices

public final List<TargetOnDeviceService> targetOnDeviceServices()

Specifies the service or services on the Snow Family device that your transferred data will be exported from or imported into. Amazon Web Services Snow Family supports Amazon S3 and NFS (Network File System).

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 hasTargetOnDeviceServices() method.

Returns:

Specifies the service or services on the Snow Family device that your transferred data will be exported from or imported into. Amazon Web Services Snow Family supports Amazon S3 and NFS (Network File System).

toBuilder

public S3Resource.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<S3Resource.Builder,S3Resource>

builder

public static S3Resource.Builder builder()

serializableBuilderClass

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