org.apache.hadoop.fs.s3a.commit.files

Class SuccessData

java.lang.Object

org.apache.hadoop.fs.s3a.commit.files.PersistentCommitData

org.apache.hadoop.fs.s3a.commit.files.SuccessData

All Implemented Interfaces:

Serializable

@InterfaceAudience.Private
 @InterfaceStability.Unstable
public class SuccessData
extends PersistentCommitData

Summary data saved into a _SUCCESS marker file. This provides an easy way to determine which committer was used to commit work.

1. File length == 0: classic FileOutputCommitter.
2. Loadable as SuccessData: A s3guard committer with name in in committer field.
3. Not loadable? Something else.

This is an unstable structure intended for diagnostics and testing. Applications reading this data should use/check the name field to differentiate from any other JSON-based manifest and to identify changes in the output format.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME Name to include in persisted data, so as to differentiate from any other manifests: "org.apache.hadoop.fs.s3a.commit.files.SuccessData/1".

Fields inherited from class org.apache.hadoop.fs.s3a.commit.files.PersistentCommitData

VERSION

Constructor Summary

Constructors

Constructor and Description
SuccessData()

Method Summary

Modifier and Type	Method and Description
void	addDiagnostic(String key, String value) Add a diagnostics entry.
String	dumpDiagnostics(String prefix, String middle, String suffix) Dump the diagnostics (if any) to a string.
String	dumpMetrics(String prefix, String middle, String suffix) Dump the metrics (if any) to a string.
String	getCommitter()
String	getDate()
String	getDescription()
Map<String,String>	getDiagnostics()
List<String>	getFilenames()
String	getHostname()
Map<String,Long>	getMetrics()
String	getName()
long	getTimestamp()
protected static String	joinMap(Map<String,?> map, String prefix, String middle, String suffix) Join any map of string to value into a string, sorting the keys first.
static SuccessData	load(org.apache.hadoop.fs.FileSystem fs, org.apache.hadoop.fs.Path path) Load an instance from a file, then validate it.
void	save(org.apache.hadoop.fs.FileSystem fs, org.apache.hadoop.fs.Path path, boolean overwrite) Save to a hadoop filesystem.
void	setCommitter(String committer)
void	setDate(String date)
void	setDescription(String description)
void	setDiagnostics(Map<String,String> diagnostics)
void	setFilenames(List<String> filenames)
void	setHostname(String hostname)
void	setMetrics(Map<String,Long> metrics)
void	setName(String name)
void	setTimestamp(long timestamp)
byte[]	toBytes() Serialize to JSON and then to a byte array, after performing a preflight validation of the data to be saved.
String	toString()
void	validate() Validate the data: those fields which must be non empty, must be set.

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

Name to include in persisted data, so as to differentiate from any other manifests: "org.apache.hadoop.fs.s3a.commit.files.SuccessData/1".

See Also:

Constant Field Values

Constructor Detail

SuccessData

public SuccessData()

Method Detail

validate

public void validate()
              throws ValidationFailure

Description copied from class: PersistentCommitData

Validate the data: those fields which must be non empty, must be set.

Specified by:

validate in class PersistentCommitData

Throws:

ValidationFailure - if the data is invalid

toBytes

public byte[] toBytes()
               throws IOException

Description copied from class: PersistentCommitData

Serialize to JSON and then to a byte array, after performing a preflight validation of the data to be saved.

Specified by:

toBytes in class PersistentCommitData

Returns:

the data in a persistable form.

Throws:

IOException - serialization problem or validation failure.

save

public void save(org.apache.hadoop.fs.FileSystem fs,
                 org.apache.hadoop.fs.Path path,
                 boolean overwrite)
          throws IOException

Description copied from class: PersistentCommitData

Save to a hadoop filesystem.

Specified by:

save in class PersistentCommitData

Parameters:

fs - filesystem

path - path

overwrite - should any existing file be overwritten

Throws:

IOException - IO exception

toString

public String toString()

Overrides:

toString in class Object

dumpMetrics

public String dumpMetrics(String prefix,
                          String middle,
                          String suffix)

Dump the metrics (if any) to a string. The metrics are sorted for ease of viewing.

Parameters:

prefix - prefix before every entry

middle - string between key and value

suffix - suffix to each entry

Returns:

the dumped string

dumpDiagnostics

public String dumpDiagnostics(String prefix,
                              String middle,
                              String suffix)

Dump the diagnostics (if any) to a string.

Parameters:

prefix - prefix before every entry

middle - string between key and value

suffix - suffix to each entry

Returns:

the dumped string

joinMap

protected static String joinMap(Map<String,?> map,
                                String prefix,
                                String middle,
                                String suffix)

Join any map of string to value into a string, sorting the keys first.

Parameters:

map - map to join

prefix - prefix before every entry

middle - string between key and value

suffix - suffix to each entry

Returns:

a string for reporting.

load

public static SuccessData load(org.apache.hadoop.fs.FileSystem fs,
                               org.apache.hadoop.fs.Path path)
                        throws IOException

Load an instance from a file, then validate it.

Parameters:

fs - filesystem

path - path

Returns:

the loaded instance

Throws:

IOException - IO failure

ValidationFailure - if the data is invalid

getName

public String getName()

setName

public void setName(String name)

getTimestamp

public long getTimestamp()

Returns:

timestamp of creation.

setTimestamp

public void setTimestamp(long timestamp)

getDate

public String getDate()

Returns:

timestamp as date; no expectation of parseability.

setDate

public void setDate(String date)

getHostname

public String getHostname()

Returns:

host which created the file (implicitly: committed the work).

setHostname

public void setHostname(String hostname)

getCommitter

public String getCommitter()

Returns:

committer name.

setCommitter

public void setCommitter(String committer)

getDescription

public String getDescription()

Returns:

any description text.

setDescription

public void setDescription(String description)

getMetrics

public Map<String,Long> getMetrics()

Returns:

any metrics.

setMetrics

public void setMetrics(Map<String,Long> metrics)

getFilenames

public List<String> getFilenames()

Returns:

a list of filenames in the commit.

setFilenames

public void setFilenames(List<String> filenames)

getDiagnostics

public Map<String,String> getDiagnostics()

setDiagnostics

public void setDiagnostics(Map<String,String> diagnostics)

addDiagnostic

public void addDiagnostic(String key,
                          String value)

Add a diagnostics entry.

Parameters:

key - name

value - value