blob: 5cecb12c58bf0b212c660ed6c1fd73e42297107d [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_40) on Thu Jul 20 13:18:49 PDT 2017 -->
<title>CopyableFile (gobblin-data-management 0.11.0 API)</title>
<meta name="date" content="2017-07-20">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CopyableFile (gobblin-data-management 0.11.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":41,"i1":10,"i2":9,"i3":10,"i4":10,"i5":9,"i6":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../gobblin/data/management/copy/CopyableDatasetMetadata.html" title="class in gobblin.data.management.copy"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../gobblin/data/management/copy/CopyableFile.Builder.html" title="class in gobblin.data.management.copy"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?gobblin/data/management/copy/CopyableFile.html" target="_top">Frames</a></li>
<li><a href="CopyableFile.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.gobblin.data.management.copy.CopyEntity">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">gobblin.data.management.copy</div>
<h2 title="Class CopyableFile" class="title">Class CopyableFile</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../gobblin/data/management/copy/CopyEntity.html" title="class in gobblin.data.management.copy">gobblin.data.management.copy.CopyEntity</a></li>
<li>
<ul class="inheritance">
<li>gobblin.data.management.copy.CopyableFile</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../gobblin/data/management/partition/File.html" title="interface in gobblin.data.management.partition">File</a>, <a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-utility/gobblin/util/guid/HasGuid.html?is-external=true" title="class or interface in gobblin.util.guid">HasGuid</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">CopyableFile</span>
extends <a href="../../../../gobblin/data/management/copy/CopyEntity.html" title="class in gobblin.data.management.copy">CopyEntity</a>
implements <a href="../../../../gobblin/data/management/partition/File.html" title="interface in gobblin.data.management.partition">File</a></pre>
<div class="block">Abstraction for a file to copy from <a href="../../../../gobblin/data/management/copy/CopyableFile.html#origin"><code>origin</code></a> to <a href="../../../../gobblin/data/management/copy/CopyableFile.html#destination"><code>destination</code></a>. <a href="../../../../gobblin/data/management/copy/CopyableFile.html" title="class in gobblin.data.management.copy"><code>CopyableFile</code></a>s should be
created using a <a href="../../../../gobblin/data/management/copy/CopyableFile.Builder.html" title="class in gobblin.data.management.copy"><code>CopyableFile.Builder</code></a> obtained with the method <a href="../../../../gobblin/data/management/copy/CopyableFile.html#builder-org.apache.hadoop.fs.FileSystem-org.apache.hadoop.fs.FileStatus-org.apache.hadoop.fs.Path-gobblin.data.management.copy.CopyConfiguration-"><code>builder(org.apache.hadoop.fs.FileSystem, org.apache.hadoop.fs.FileStatus, org.apache.hadoop.fs.Path, gobblin.data.management.copy.CopyConfiguration)</code></a>.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../gobblin/data/management/copy/CopyableFile.Builder.html" title="class in gobblin.data.management.copy">CopyableFile.Builder</a></span></code>
<div class="block">Builder for creating <a href="../../../../gobblin/data/management/copy/CopyableFile.html" title="class in gobblin.data.management.copy"><code>CopyableFile</code></a>s.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.gobblin.data.management.copy.CopyEntity">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class&nbsp;gobblin.data.management.copy.<a href="../../../../gobblin/data/management/copy/CopyEntity.html" title="class in gobblin.data.management.copy">CopyEntity</a></h3>
<code><a href="../../../../gobblin/data/management/copy/CopyEntity.DatasetAndPartition.html" title="class in gobblin.data.management.copy">CopyEntity.DatasetAndPartition</a></code></li>
</ul>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.gobblin.data.management.copy.CopyEntity">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;gobblin.data.management.copy.<a href="../../../../gobblin/data/management/copy/CopyEntity.html" title="class in gobblin.data.management.copy">CopyEntity</a></h3>
<code><a href="../../../../gobblin/data/management/copy/CopyEntity.html#GSON">GSON</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../gobblin/data/management/copy/CopyableFile.html#CopyableFile-org.apache.hadoop.fs.FileStatus-org.apache.hadoop.fs.Path-gobblin.data.management.copy.OwnerAndPermission-java.util.List-byte:A-gobblin.data.management.copy.PreserveAttributes-java.lang.String-long-long-java.util.Map-">CopyableFile</a></span>(<a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/FileStatus.html?is-external=true" title="class or interface in org.apache.hadoop.fs">FileStatus</a>&nbsp;origin,
<a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/Path.html?is-external=true" title="class or interface in org.apache.hadoop.fs">Path</a>&nbsp;destination,
<a href="../../../../gobblin/data/management/copy/OwnerAndPermission.html" title="class in gobblin.data.management.copy">OwnerAndPermission</a>&nbsp;destinationOwnerAndPermission,
<a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../gobblin/data/management/copy/OwnerAndPermission.html" title="class in gobblin.data.management.copy">OwnerAndPermission</a>&gt;&nbsp;ancestorsOwnerAndPermission,
byte[]&nbsp;checksum,
<a href="../../../../gobblin/data/management/copy/PreserveAttributes.html" title="class in gobblin.data.management.copy">PreserveAttributes</a>&nbsp;preserve,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;fileSet,
long&nbsp;originTimestamp,
long&nbsp;upstreamTimestamp,
<a href="https://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;additionalMetadata)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static <a href="../../../../gobblin/data/management/copy/CopyableFile.Builder.html" title="class in gobblin.data.management.copy">CopyableFile.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../gobblin/data/management/copy/CopyableFile.html#builder-org.apache.hadoop.fs.FileSystem-org.apache.hadoop.fs.FileStatus-org.apache.hadoop.fs.Path-gobblin.data.management.copy.CopyConfiguration-">builder</a></span>(<a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/FileSystem.html?is-external=true" title="class or interface in org.apache.hadoop.fs">FileSystem</a>&nbsp;originFs,
<a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/FileStatus.html?is-external=true" title="class or interface in org.apache.hadoop.fs">FileStatus</a>&nbsp;origin,
<a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/Path.html?is-external=true" title="class or interface in org.apache.hadoop.fs">Path</a>&nbsp;datasetRoot,
<a href="../../../../gobblin/data/management/copy/CopyConfiguration.html" title="class in gobblin.data.management.copy">CopyConfiguration</a>&nbsp;copyConfiguration)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">use <a href="../../../../gobblin/data/management/copy/CopyableFile.html#fromOriginAndDestination-org.apache.hadoop.fs.FileSystem-org.apache.hadoop.fs.FileStatus-org.apache.hadoop.fs.Path-gobblin.data.management.copy.CopyConfiguration-"><code>fromOriginAndDestination(org.apache.hadoop.fs.FileSystem, org.apache.hadoop.fs.FileStatus, org.apache.hadoop.fs.Path, gobblin.data.management.copy.CopyConfiguration)</code></a>. This method was changed to remove reliance on dataset root
which is not standard of all datasets. The old functionality on inferring destinations cannot be
achieved without dataset root and common dataset root, so this is an approximation. Copyable datasets
should compute file destinations themselves.</span></div>
</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../gobblin/data/management/copy/CopyableFile.html#explain--">explain</a></span>()</code>
<div class="block">Used for simulate runs.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static <a href="../../../../gobblin/data/management/copy/CopyableFile.Builder.html" title="class in gobblin.data.management.copy">CopyableFile.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../gobblin/data/management/copy/CopyableFile.html#fromOriginAndDestination-org.apache.hadoop.fs.FileSystem-org.apache.hadoop.fs.FileStatus-org.apache.hadoop.fs.Path-gobblin.data.management.copy.CopyConfiguration-">fromOriginAndDestination</a></span>(<a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/FileSystem.html?is-external=true" title="class or interface in org.apache.hadoop.fs">FileSystem</a>&nbsp;originFs,
<a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/FileStatus.html?is-external=true" title="class or interface in org.apache.hadoop.fs">FileStatus</a>&nbsp;origin,
<a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/Path.html?is-external=true" title="class or interface in org.apache.hadoop.fs">Path</a>&nbsp;destination,
<a href="../../../../gobblin/data/management/copy/CopyConfiguration.html" title="class in gobblin.data.management.copy">CopyConfiguration</a>&nbsp;copyConfiguration)</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/FileStatus.html?is-external=true" title="class or interface in org.apache.hadoop.fs">FileStatus</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../gobblin/data/management/copy/CopyableFile.html#getFileStatus--">getFileStatus</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-utility/gobblin/util/guid/Guid.html?is-external=true" title="class or interface in gobblin.util.guid">Guid</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../gobblin/data/management/copy/CopyableFile.html#guid--">guid</a></span>()</code>
<div class="block">Generates a replicable guid to uniquely identify the origin of this <a href="../../../../gobblin/data/management/copy/CopyableFile.html" title="class in gobblin.data.management.copy"><code>CopyableFile</code></a>.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../gobblin/data/management/copy/OwnerAndPermission.html" title="class in gobblin.data.management.copy">OwnerAndPermission</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../gobblin/data/management/copy/CopyableFile.html#resolveReplicatedOwnerAndPermission-org.apache.hadoop.fs.FileSystem-org.apache.hadoop.fs.Path-gobblin.data.management.copy.CopyConfiguration-">resolveReplicatedOwnerAndPermission</a></span>(<a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/FileSystem.html?is-external=true" title="class or interface in org.apache.hadoop.fs">FileSystem</a>&nbsp;fs,
<a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/Path.html?is-external=true" title="class or interface in org.apache.hadoop.fs">Path</a>&nbsp;path,
<a href="../../../../gobblin/data/management/copy/CopyConfiguration.html" title="class in gobblin.data.management.copy">CopyConfiguration</a>&nbsp;copyConfiguration)</code>
<div class="block">Computes the correct <a href="../../../../gobblin/data/management/copy/OwnerAndPermission.html" title="class in gobblin.data.management.copy"><code>OwnerAndPermission</code></a> obtained from replicating source owner and permissions and applying
the <a href="../../../../gobblin/data/management/copy/PreserveAttributes.html" title="class in gobblin.data.management.copy"><code>PreserveAttributes</code></a> rules in copyConfiguration.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../gobblin/data/management/copy/OwnerAndPermission.html" title="class in gobblin.data.management.copy">OwnerAndPermission</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../gobblin/data/management/copy/CopyableFile.html#resolveReplicatedOwnerAndPermissionsRecursively-org.apache.hadoop.fs.FileSystem-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.Path-gobblin.data.management.copy.CopyConfiguration-">resolveReplicatedOwnerAndPermissionsRecursively</a></span>(<a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/FileSystem.html?is-external=true" title="class or interface in org.apache.hadoop.fs">FileSystem</a>&nbsp;sourceFs,
<a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/Path.html?is-external=true" title="class or interface in org.apache.hadoop.fs">Path</a>&nbsp;fromPath,
<a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/Path.html?is-external=true" title="class or interface in org.apache.hadoop.fs">Path</a>&nbsp;toPath,
<a href="../../../../gobblin/data/management/copy/CopyConfiguration.html" title="class in gobblin.data.management.copy">CopyConfiguration</a>&nbsp;copyConfiguration)</code>
<div class="block">Compute the correct <a href="../../../../gobblin/data/management/copy/OwnerAndPermission.html" title="class in gobblin.data.management.copy"><code>OwnerAndPermission</code></a> obtained from replicating source owner and permissions and applying
the <a href="../../../../gobblin/data/management/copy/PreserveAttributes.html" title="class in gobblin.data.management.copy"><code>PreserveAttributes</code></a> rules for fromPath and every ancestor up to but excluding toPath.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.gobblin.data.management.copy.CopyEntity">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;gobblin.data.management.copy.<a href="../../../../gobblin/data/management/copy/CopyEntity.html" title="class in gobblin.data.management.copy">CopyEntity</a></h3>
<code><a href="../../../../gobblin/data/management/copy/CopyEntity.html#deserialize-java.lang.String-">deserialize</a>, <a href="../../../../gobblin/data/management/copy/CopyEntity.html#deserializeList-java.lang.String-">deserializeList</a>, <a href="../../../../gobblin/data/management/copy/CopyEntity.html#getDatasetAndPartition-gobblin.data.management.copy.CopyableDatasetMetadata-">getDatasetAndPartition</a>, <a href="../../../../gobblin/data/management/copy/CopyEntity.html#serialize-gobblin.data.management.copy.CopyEntity-">serialize</a>, <a href="../../../../gobblin/data/management/copy/CopyEntity.html#serializeList-java.util.List-">serializeList</a>, <a href="../../../../gobblin/data/management/copy/CopyEntity.html#toString--">toString</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="CopyableFile-org.apache.hadoop.fs.FileStatus-org.apache.hadoop.fs.Path-gobblin.data.management.copy.OwnerAndPermission-java.util.List-byte:A-gobblin.data.management.copy.PreserveAttributes-java.lang.String-long-long-java.util.Map-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>CopyableFile</h4>
<pre>public&nbsp;CopyableFile(<a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/FileStatus.html?is-external=true" title="class or interface in org.apache.hadoop.fs">FileStatus</a>&nbsp;origin,
<a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/Path.html?is-external=true" title="class or interface in org.apache.hadoop.fs">Path</a>&nbsp;destination,
<a href="../../../../gobblin/data/management/copy/OwnerAndPermission.html" title="class in gobblin.data.management.copy">OwnerAndPermission</a>&nbsp;destinationOwnerAndPermission,
<a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../gobblin/data/management/copy/OwnerAndPermission.html" title="class in gobblin.data.management.copy">OwnerAndPermission</a>&gt;&nbsp;ancestorsOwnerAndPermission,
byte[]&nbsp;checksum,
<a href="../../../../gobblin/data/management/copy/PreserveAttributes.html" title="class in gobblin.data.management.copy">PreserveAttributes</a>&nbsp;preserve,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;fileSet,
long&nbsp;originTimestamp,
long&nbsp;upstreamTimestamp,
<a href="https://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;additionalMetadata)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="builder-org.apache.hadoop.fs.FileSystem-org.apache.hadoop.fs.FileStatus-org.apache.hadoop.fs.Path-gobblin.data.management.copy.CopyConfiguration-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>builder</h4>
<pre><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public static&nbsp;<a href="../../../../gobblin/data/management/copy/CopyableFile.Builder.html" title="class in gobblin.data.management.copy">CopyableFile.Builder</a>&nbsp;builder(<a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/FileSystem.html?is-external=true" title="class or interface in org.apache.hadoop.fs">FileSystem</a>&nbsp;originFs,
<a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/FileStatus.html?is-external=true" title="class or interface in org.apache.hadoop.fs">FileStatus</a>&nbsp;origin,
<a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/Path.html?is-external=true" title="class or interface in org.apache.hadoop.fs">Path</a>&nbsp;datasetRoot,
<a href="../../../../gobblin/data/management/copy/CopyConfiguration.html" title="class in gobblin.data.management.copy">CopyConfiguration</a>&nbsp;copyConfiguration)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">use <a href="../../../../gobblin/data/management/copy/CopyableFile.html#fromOriginAndDestination-org.apache.hadoop.fs.FileSystem-org.apache.hadoop.fs.FileStatus-org.apache.hadoop.fs.Path-gobblin.data.management.copy.CopyConfiguration-"><code>fromOriginAndDestination(org.apache.hadoop.fs.FileSystem, org.apache.hadoop.fs.FileStatus, org.apache.hadoop.fs.Path, gobblin.data.management.copy.CopyConfiguration)</code></a>. This method was changed to remove reliance on dataset root
which is not standard of all datasets. The old functionality on inferring destinations cannot be
achieved without dataset root and common dataset root, so this is an approximation. Copyable datasets
should compute file destinations themselves.</span></div>
<div class="block">Get a <a href="../../../../gobblin/data/management/copy/CopyableFile.Builder.html" title="class in gobblin.data.management.copy"><code>CopyableFile.Builder</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>originFs</code> - <a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/FileSystem.html?is-external=true" title="class or interface in org.apache.hadoop.fs"><code>FileSystem</code></a> where original file exists.</dd>
<dd><code>origin</code> - <a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/FileStatus.html?is-external=true" title="class or interface in org.apache.hadoop.fs"><code>FileStatus</code></a> of the original file.</dd>
<dd><code>datasetRoot</code> - Value of <code>CopyableDataset#datasetRoot</code> of the dataset creating this <a href="../../../../gobblin/data/management/copy/CopyableFile.html" title="class in gobblin.data.management.copy"><code>CopyableFile</code></a>.</dd>
<dd><code>copyConfiguration</code> - <a href="../../../../gobblin/data/management/copy/CopyConfiguration.html" title="class in gobblin.data.management.copy"><code>CopyConfiguration</code></a> for the copy job.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <a href="../../../../gobblin/data/management/copy/CopyableFile.Builder.html" title="class in gobblin.data.management.copy"><code>CopyableFile.Builder</code></a>.</dd>
</dl>
</li>
</ul>
<a name="fromOriginAndDestination-org.apache.hadoop.fs.FileSystem-org.apache.hadoop.fs.FileStatus-org.apache.hadoop.fs.Path-gobblin.data.management.copy.CopyConfiguration-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fromOriginAndDestination</h4>
<pre>public static&nbsp;<a href="../../../../gobblin/data/management/copy/CopyableFile.Builder.html" title="class in gobblin.data.management.copy">CopyableFile.Builder</a>&nbsp;fromOriginAndDestination(<a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/FileSystem.html?is-external=true" title="class or interface in org.apache.hadoop.fs">FileSystem</a>&nbsp;originFs,
<a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/FileStatus.html?is-external=true" title="class or interface in org.apache.hadoop.fs">FileStatus</a>&nbsp;origin,
<a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/Path.html?is-external=true" title="class or interface in org.apache.hadoop.fs">Path</a>&nbsp;destination,
<a href="../../../../gobblin/data/management/copy/CopyConfiguration.html" title="class in gobblin.data.management.copy">CopyConfiguration</a>&nbsp;copyConfiguration)</pre>
</li>
</ul>
<a name="resolveReplicatedOwnerAndPermission-org.apache.hadoop.fs.FileSystem-org.apache.hadoop.fs.Path-gobblin.data.management.copy.CopyConfiguration-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resolveReplicatedOwnerAndPermission</h4>
<pre>public static&nbsp;<a href="../../../../gobblin/data/management/copy/OwnerAndPermission.html" title="class in gobblin.data.management.copy">OwnerAndPermission</a>&nbsp;resolveReplicatedOwnerAndPermission(<a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/FileSystem.html?is-external=true" title="class or interface in org.apache.hadoop.fs">FileSystem</a>&nbsp;fs,
<a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/Path.html?is-external=true" title="class or interface in org.apache.hadoop.fs">Path</a>&nbsp;path,
<a href="../../../../gobblin/data/management/copy/CopyConfiguration.html" title="class in gobblin.data.management.copy">CopyConfiguration</a>&nbsp;copyConfiguration)
throws <a href="https://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Computes the correct <a href="../../../../gobblin/data/management/copy/OwnerAndPermission.html" title="class in gobblin.data.management.copy"><code>OwnerAndPermission</code></a> obtained from replicating source owner and permissions and applying
the <a href="../../../../gobblin/data/management/copy/PreserveAttributes.html" title="class in gobblin.data.management.copy"><code>PreserveAttributes</code></a> rules in copyConfiguration.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="resolveReplicatedOwnerAndPermissionsRecursively-org.apache.hadoop.fs.FileSystem-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.Path-gobblin.data.management.copy.CopyConfiguration-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resolveReplicatedOwnerAndPermissionsRecursively</h4>
<pre>public static&nbsp;<a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../gobblin/data/management/copy/OwnerAndPermission.html" title="class in gobblin.data.management.copy">OwnerAndPermission</a>&gt;&nbsp;resolveReplicatedOwnerAndPermissionsRecursively(<a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/FileSystem.html?is-external=true" title="class or interface in org.apache.hadoop.fs">FileSystem</a>&nbsp;sourceFs,
<a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/Path.html?is-external=true" title="class or interface in org.apache.hadoop.fs">Path</a>&nbsp;fromPath,
<a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/Path.html?is-external=true" title="class or interface in org.apache.hadoop.fs">Path</a>&nbsp;toPath,
<a href="../../../../gobblin/data/management/copy/CopyConfiguration.html" title="class in gobblin.data.management.copy">CopyConfiguration</a>&nbsp;copyConfiguration)
throws <a href="https://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Compute the correct <a href="../../../../gobblin/data/management/copy/OwnerAndPermission.html" title="class in gobblin.data.management.copy"><code>OwnerAndPermission</code></a> obtained from replicating source owner and permissions and applying
the <a href="../../../../gobblin/data/management/copy/PreserveAttributes.html" title="class in gobblin.data.management.copy"><code>PreserveAttributes</code></a> rules for fromPath and every ancestor up to but excluding toPath.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A list of the computed <a href="../../../../gobblin/data/management/copy/OwnerAndPermission.html" title="class in gobblin.data.management.copy"><code>OwnerAndPermission</code></a>s starting from fromPath, up to but excluding toPath.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if toPath is not an ancestor of fromPath.</dd>
</dl>
</li>
</ul>
<a name="getFileStatus--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFileStatus</h4>
<pre>public&nbsp;<a href="http://hadoop.apache.org/docs/r2.3.0/api/org/apache/hadoop/fs/FileStatus.html?is-external=true" title="class or interface in org.apache.hadoop.fs">FileStatus</a>&nbsp;getFileStatus()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../gobblin/data/management/partition/File.html#getFileStatus--">getFileStatus</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../gobblin/data/management/partition/File.html" title="interface in gobblin.data.management.partition">File</a></code></dd>
</dl>
</li>
</ul>
<a name="guid--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>guid</h4>
<pre>public&nbsp;<a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-utility/gobblin/util/guid/Guid.html?is-external=true" title="class or interface in gobblin.util.guid">Guid</a>&nbsp;guid()
throws <a href="https://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Generates a replicable guid to uniquely identify the origin of this <a href="../../../../gobblin/data/management/copy/CopyableFile.html" title="class in gobblin.data.management.copy"><code>CopyableFile</code></a>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-utility/gobblin/util/guid/HasGuid.html?is-external=true#guid--" title="class or interface in gobblin.util.guid">guid</a></code>&nbsp;in interface&nbsp;<code><a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-utility/gobblin/util/guid/HasGuid.html?is-external=true" title="class or interface in gobblin.util.guid">HasGuid</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../gobblin/data/management/copy/CopyEntity.html#guid--">guid</a></code>&nbsp;in class&nbsp;<code><a href="../../../../gobblin/data/management/copy/CopyEntity.html" title="class in gobblin.data.management.copy">CopyEntity</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a guid uniquely identifying the origin file.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="explain--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>explain</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;explain()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../gobblin/data/management/copy/CopyEntity.html#explain--">CopyEntity</a></code></span></div>
<div class="block">Used for simulate runs. Should explain what this copy entity will do.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../gobblin/data/management/copy/CopyEntity.html#explain--">explain</a></code>&nbsp;in class&nbsp;<code><a href="../../../../gobblin/data/management/copy/CopyEntity.html" title="class in gobblin.data.management.copy">CopyEntity</a></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../gobblin/data/management/copy/CopyableDatasetMetadata.html" title="class in gobblin.data.management.copy"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../gobblin/data/management/copy/CopyableFile.Builder.html" title="class in gobblin.data.management.copy"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?gobblin/data/management/copy/CopyableFile.html" target="_top">Frames</a></li>
<li><a href="CopyableFile.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.gobblin.data.management.copy.CopyEntity">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>