alluxio.s3

Class TaggingData

java.lang.Object

alluxio.s3.TaggingData

public class TaggingData
extends Object

Parsed version of the S3 tagging XML. Used by the following S3 API actions: - GetBucketTagging, GetObjectTagging, PutBucketTagging, PutObjectTagging

Constructor Summary

Constructors

Constructor and Description
TaggingData() Default constructor for jackson.
TaggingData(alluxio.s3.TaggingData.TagSet tagSet) Create a new TaggingData.

Method Summary

Modifier and Type	Method and Description
TaggingData	addTags(Map<String,String> tagMap) Merges the contents of the provided tag map with the existing tags.
TaggingData	clear() Removes all tags contained in this object.
static TaggingData	deserialize(byte[] bytes) Deserialize the XML (bytes).
Map<String,String>	getTagMap() Returns the Map object containing the contents of the TagSet.
static com.google.protobuf.ByteString	serialize(TaggingData tagData) Serializes the object as an XML (bytes).
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TaggingData

public TaggingData()

Default constructor for jackson.

TaggingData

public TaggingData(@Nullable
                   alluxio.s3.TaggingData.TagSet tagSet)

Create a new TaggingData.

Parameters:

tagSet - the user metadata tags

Method Detail

deserialize

public static TaggingData deserialize(byte[] bytes)
                               throws IOException

Deserialize the XML (bytes).

Parameters:

bytes - byte array of the Java-serialized object

Returns:

a deserialized TaggingData object

Throws:

IOException

serialize

public static com.google.protobuf.ByteString serialize(TaggingData tagData)
                                                throws com.fasterxml.jackson.core.JsonProcessingException

Serializes the object as an XML (bytes).

Parameters:

tagData - the TaggingData object to serialize

Returns:

the ByteString serialization of this object

Throws:

com.fasterxml.jackson.core.JsonProcessingException

toString

public String toString()

Overrides:

toString in class Object

getTagMap

public Map<String,String> getTagMap()

Returns the Map object containing the contents of the TagSet. Useful for parsing or iterating over tag data.

Returns:

a Map object containing the tags

addTags

public TaggingData addTags(Map<String,String> tagMap)
                    throws IllegalArgumentException

Merges the contents of the provided tag map with the existing tags. Overwrites any duplicate tags.

Parameters:

tagMap - a collection of Tags represented by key-value pairs

Returns:

a reference to this object

Throws:

IllegalArgumentException

clear

public TaggingData clear()

Removes all tags contained in this object.

Returns:

a reference to this object