S3Location (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.glacier.model.S3Location

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class S3Location
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Contains information about the location in Amazon S3 where the select job results are stored.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

S3Location()

Constructors
Constructor and Description
`S3Location()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`S3Location`	`addTaggingEntry(String key, String value)`
`S3Location`	`addUserMetadataEntry(String key, String value)`
`S3Location`	`clearTaggingEntries()` Removes all the entries added into Tagging.
`S3Location`	`clearUserMetadataEntries()` Removes all the entries added into UserMetadata.
`S3Location`	`clone()`
`boolean`	`equals(Object obj)`
`List<Grant>`	`getAccessControlList()` A list of grants that control access to the staged results.
`String`	`getBucketName()` The name of the bucket where the restore results are stored.
`String`	`getCannedACL()` The canned ACL to apply to the restore results.
`Encryption`	`getEncryption()` Contains information about the encryption used to store the job results in Amazon S3.
`String`	`getPrefix()` The prefix that is prepended to the restore results for this request.
`String`	`getStorageClass()` The storage class used to store the restore results.
`Map<String,String>`	`getTagging()` The tag-set that is applied to the restore results.
`Map<String,String>`	`getUserMetadata()` A map of metadata to store with the restore results in Amazon S3.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAccessControlList(Collection<Grant> accessControlList)` A list of grants that control access to the staged results.
`void`	`setBucketName(String bucketName)` The name of the bucket where the restore results are stored.
`void`	`setCannedACL(String cannedACL)` The canned ACL to apply to the restore results.
`void`	`setEncryption(Encryption encryption)` Contains information about the encryption used to store the job results in Amazon S3.
`void`	`setPrefix(String prefix)` The prefix that is prepended to the restore results for this request.
`void`	`setStorageClass(String storageClass)` The storage class used to store the restore results.
`void`	`setTagging(Map<String,String> tagging)` The tag-set that is applied to the restore results.
`void`	`setUserMetadata(Map<String,String> userMetadata)` A map of metadata to store with the restore results in Amazon S3.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`S3Location`	`withAccessControlList(Collection<Grant> accessControlList)` A list of grants that control access to the staged results.
`S3Location`	`withAccessControlList(Grant... accessControlList)` A list of grants that control access to the staged results.
`S3Location`	`withBucketName(String bucketName)` The name of the bucket where the restore results are stored.
`S3Location`	`withCannedACL(CannedACL cannedACL)` The canned ACL to apply to the restore results.
`S3Location`	`withCannedACL(String cannedACL)` The canned ACL to apply to the restore results.
`S3Location`	`withEncryption(Encryption encryption)` Contains information about the encryption used to store the job results in Amazon S3.
`S3Location`	`withPrefix(String prefix)` The prefix that is prepended to the restore results for this request.
`S3Location`	`withStorageClass(StorageClass storageClass)` The storage class used to store the restore results.
`S3Location`	`withStorageClass(String storageClass)` The storage class used to store the restore results.
`S3Location`	`withTagging(Map<String,String> tagging)` The tag-set that is applied to the restore results.
`S3Location`	`withUserMetadata(Map<String,String> userMetadata)` A map of metadata to store with the restore results in Amazon S3.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - S3Location
```
public S3Location()
```
- Method Detail
  - setBucketName
```
public void setBucketName(String bucketName)
```
    The name of the bucket where the restore results are stored.
    
    Parameters:
    
    bucketName - The name of the bucket where the restore results are stored.
  - getBucketName
```
public String getBucketName()
```
    The name of the bucket where the restore results are stored.
    
    Returns:
    
    The name of the bucket where the restore results are stored.
  - withBucketName
```
public S3Location withBucketName(String bucketName)
```
    The name of the bucket where the restore results are stored.
    
    Parameters:
    
    bucketName - The name of the bucket where the restore results are stored.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPrefix
```
public void setPrefix(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.
  - getPrefix
```
public String getPrefix()
```
    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.
  - withPrefix
```
public S3Location withPrefix(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.
  - setEncryption
```
public void setEncryption(Encryption encryption)
```
    Contains information about the encryption used to store the job results in Amazon S3.
    
    Parameters:
    
    encryption - Contains information about the encryption used to store the job results in Amazon S3.
  - getEncryption
```
public Encryption getEncryption()
```
    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.
  - withEncryption
```
public S3Location withEncryption(Encryption encryption)
```
    Contains information about the encryption used to store the job results in Amazon S3.
    
    Parameters:
    
    encryption - Contains information about the encryption used to store the job results in Amazon S3.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCannedACL
```
public void setCannedACL(String cannedACL)
```
    The canned ACL to apply to the restore results.
    
    Parameters:
    
    cannedACL - The canned ACL to apply to the restore results.
    
    See Also:
    
    CannedACL
  - getCannedACL
```
public String getCannedACL()
```
    The canned ACL to apply to the restore results.
    
    Returns:
    
    The canned ACL to apply to the restore results.
    
    See Also:
    
    CannedACL
  - withCannedACL
```
public S3Location withCannedACL(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:
    
    CannedACL
  - withCannedACL
```
public S3Location withCannedACL(CannedACL 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:
    
    CannedACL
  - getAccessControlList
```
public List<Grant> getAccessControlList()
```
    A list of grants that control access to the staged results.
    
    Returns:
    
    A list of grants that control access to the staged results.
  - setAccessControlList
```
public void setAccessControlList(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.
  - withAccessControlList
```
public S3Location withAccessControlList(Grant... accessControlList)
```
    A list of grants that control access to the staged results.
    
    NOTE: This method appends the values to the existing list (if any). Use setAccessControlList(java.util.Collection) or withAccessControlList(java.util.Collection) if you want to override the existing values.
    
    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.
  - withAccessControlList
```
public S3Location withAccessControlList(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.
  - getTagging
```
public Map<String,String> getTagging()
```
    The tag-set that is applied to the restore results.
    
    Returns:
    
    The tag-set that is applied to the restore results.
  - setTagging
```
public void setTagging(Map<String,String> tagging)
```
    The tag-set that is applied to the restore results.
    
    Parameters:
    
    tagging - The tag-set that is applied to the restore results.
  - withTagging
```
public S3Location withTagging(Map<String,String> 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.
  - addTaggingEntry
```
public S3Location addTaggingEntry(String key,
                                  String value)
```
  - clearTaggingEntries
```
public S3Location clearTaggingEntries()
```
    Removes all the entries added into Tagging.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getUserMetadata
```
public Map<String,String> getUserMetadata()
```
    A map of metadata to store with the restore results in Amazon S3.
    
    Returns:
    
    A map of metadata to store with the restore results in Amazon S3.
  - setUserMetadata
```
public void setUserMetadata(Map<String,String> userMetadata)
```
    A map of metadata to store with the restore results in Amazon S3.
    
    Parameters:
    
    userMetadata - A map of metadata to store with the restore results in Amazon S3.
  - withUserMetadata
```
public S3Location withUserMetadata(Map<String,String> userMetadata)
```
    A map of metadata to store with the restore results in Amazon S3.
    
    Parameters:
    
    userMetadata - A map of metadata to store with the restore results in Amazon S3.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addUserMetadataEntry
```
public S3Location addUserMetadataEntry(String key,
                                       String value)
```
  - clearUserMetadataEntries
```
public S3Location clearUserMetadataEntries()
```
    Removes all the entries added into UserMetadata.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStorageClass
```
public void setStorageClass(String storageClass)
```
    The storage class used to store the restore results.
    
    Parameters:
    
    storageClass - The storage class used to store the restore results.
    
    See Also:
    
    StorageClass
  - getStorageClass
```
public String getStorageClass()
```
    The storage class used to store the restore results.
    
    Returns:
    
    The storage class used to store the restore results.
    
    See Also:
    
    StorageClass
  - withStorageClass
```
public S3Location withStorageClass(String storageClass)
```
    The storage class used to store the restore results.
    
    Parameters:
    
    storageClass - The storage class used to store the restore results.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StorageClass
  - withStorageClass
```
public S3Location withStorageClass(StorageClass storageClass)
```
    The storage class used to store the restore results.
    
    Parameters:
    
    storageClass - The storage class used to store the restore results.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StorageClass
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public S3Location clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class S3Location

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

S3Location

Method Detail

setBucketName

getBucketName

withBucketName

setPrefix

getPrefix

withPrefix

setEncryption

getEncryption

withEncryption

setCannedACL

getCannedACL

withCannedACL

withCannedACL

getAccessControlList

setAccessControlList

withAccessControlList

withAccessControlList

getTagging

setTagging

withTagging

addTaggingEntry

clearTaggingEntries

getUserMetadata

setUserMetadata

withUserMetadata

addUserMetadataEntry

clearUserMetadataEntries

setStorageClass

getStorageClass

withStorageClass

withStorageClass

toString

equals

hashCode

clone

marshall