software.amazon.awssdk.services.glacier.model

Class S3Location

java.lang.Object

software.amazon.awssdk.services.glacier.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>

Contains information about the location in Amazon S3 where the select job results are stored.

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 Amazon S3 bucket where the job results are stored.
static S3Location.Builder	builder()
CannedACL	cannedACL() The canned access control list (ACL) to apply to the job results.
String	cannedACLAsString() The canned access control list (ACL) to apply to the job results.
Encryption	encryption() Contains information about the encryption used to store the job results in Amazon S3.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	prefix() The prefix that is prepended to the results for this request.
List<SdkField<?>>	sdkFields()
static Class<? extends S3Location.Builder>	serializableBuilderClass()
StorageClass	storageClass() The storage class used to store the job results.
String	storageClassAsString() The storage class used to store the job results.
Map<String,String>	tagging() The tag-set that is applied to the job results.
S3Location.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
Map<String,String>	userMetadata() A map of metadata to store with the job results in Amazon S3.

Methods inherited from class java.lang.Object

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 Amazon S3 bucket where the job results are stored.

Returns:

The name of the Amazon S3 bucket where the job results are stored.

prefix

public String prefix()

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

Returns:

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

encryption

public Encryption encryption()

Contains information about the encryption used to store the job results in Amazon S3.

Returns:

Contains information about the encryption used to store the job results in Amazon S3.

cannedACL

public CannedACL cannedACL()

The canned access control list (ACL) to apply to the job results.

If the service returns an enum value that is not available in the current SDK version, cannedACL will return CannedACL.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from cannedACLAsString().

Returns:

The canned access control list (ACL) to apply to the job results.

See Also:

CannedACL

cannedACLAsString

public String cannedACLAsString()

The canned access control list (ACL) to apply to the job results.

If the service returns an enum value that is not available in the current SDK version, cannedACL will return CannedACL.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from cannedACLAsString().

Returns:

The canned access control list (ACL) to apply to the job results.

See Also:

CannedACL

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.

Returns:

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

tagging

public Map<String,String> tagging()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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

userMetadata

public Map<String,String> userMetadata()

A map of metadata to store with the job results in Amazon S3.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

A map of metadata to store with the job results in Amazon S3.

storageClass

public StorageClass storageClass()

The storage class used to store the job 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 storage class used to store the job results.

See Also:

StorageClass

storageClassAsString

public String storageClassAsString()

The storage class used to store the job 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 storage class used to store the job results.

See Also:

StorageClass

toBuilder

public S3Location.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<S3Location.Builder,S3Location>

Returns:

a builder for type T

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

toString

public String toString()

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

Returns:

List of SdkField in this POJO. May be empty list but should never be null.