blob: 92952c1ef9b39d654802c241fbbed3d32a03c45f [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.7.0_131) on Wed Mar 29 10:23:58 UTC 2017 -->
<title>Protos.CommandInfo.URIOrBuilder</title>
<meta name="date" content="2017-03-29">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Protos.CommandInfo.URIOrBuilder";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../org/apache/mesos/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="../../../org/apache/mesos/Protos.CommandInfo.URI.Builder.html" title="class in org.apache.mesos"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/apache/mesos/Protos.CommandInfoOrBuilder.html" title="interface in org.apache.mesos"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/apache/mesos/Protos.CommandInfo.URIOrBuilder.html" target="_top">Frames</a></li>
<li><a href="Protos.CommandInfo.URIOrBuilder.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All 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>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&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">org.apache.mesos</div>
<h2 title="Interface Protos.CommandInfo.URIOrBuilder" class="title">Interface Protos.CommandInfo.URIOrBuilder</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../org/apache/mesos/Protos.CommandInfo.URI.html" title="class in org.apache.mesos">Protos.CommandInfo.URI</a>, <a href="../../../org/apache/mesos/Protos.CommandInfo.URI.Builder.html" title="class in org.apache.mesos">Protos.CommandInfo.URI.Builder</a></dd>
</dl>
<dl>
<dt>Enclosing class:</dt>
<dd><a href="../../../org/apache/mesos/Protos.CommandInfo.html" title="class in org.apache.mesos">Protos.CommandInfo</a></dd>
</dl>
<hr>
<br>
<pre>public static interface <span class="strong">Protos.CommandInfo.URIOrBuilder</span></pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/mesos/Protos.CommandInfo.URIOrBuilder.html#getCache()">getCache</a></strong>()</code>
<div class="block"><code>optional bool cache = 4;</code></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/mesos/Protos.CommandInfo.URIOrBuilder.html#getExecutable()">getExecutable</a></strong>()</code>
<div class="block"><code>optional bool executable = 2;</code></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/mesos/Protos.CommandInfo.URIOrBuilder.html#getExtract()">getExtract</a></strong>()</code>
<div class="block"><code>optional bool extract = 3 [default = true];</code></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/mesos/Protos.CommandInfo.URIOrBuilder.html#getOutputFile()">getOutputFile</a></strong>()</code>
<div class="block"><code>optional string output_file = 5;</code></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>com.google.protobuf.ByteString</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/mesos/Protos.CommandInfo.URIOrBuilder.html#getOutputFileBytes()">getOutputFileBytes</a></strong>()</code>
<div class="block"><code>optional string output_file = 5;</code></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/mesos/Protos.CommandInfo.URIOrBuilder.html#getValue()">getValue</a></strong>()</code>
<div class="block"><code>required string value = 1;</code></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>com.google.protobuf.ByteString</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/mesos/Protos.CommandInfo.URIOrBuilder.html#getValueBytes()">getValueBytes</a></strong>()</code>
<div class="block"><code>required string value = 1;</code></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/mesos/Protos.CommandInfo.URIOrBuilder.html#hasCache()">hasCache</a></strong>()</code>
<div class="block"><code>optional bool cache = 4;</code></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/mesos/Protos.CommandInfo.URIOrBuilder.html#hasExecutable()">hasExecutable</a></strong>()</code>
<div class="block"><code>optional bool executable = 2;</code></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/mesos/Protos.CommandInfo.URIOrBuilder.html#hasExtract()">hasExtract</a></strong>()</code>
<div class="block"><code>optional bool extract = 3 [default = true];</code></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/mesos/Protos.CommandInfo.URIOrBuilder.html#hasOutputFile()">hasOutputFile</a></strong>()</code>
<div class="block"><code>optional string output_file = 5;</code></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/mesos/Protos.CommandInfo.URIOrBuilder.html#hasValue()">hasValue</a></strong>()</code>
<div class="block"><code>required string value = 1;</code></div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="hasValue()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasValue</h4>
<pre>boolean&nbsp;hasValue()</pre>
<div class="block"><code>required string value = 1;</code></div>
</li>
</ul>
<a name="getValue()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValue</h4>
<pre>java.lang.String&nbsp;getValue()</pre>
<div class="block"><code>required string value = 1;</code></div>
</li>
</ul>
<a name="getValueBytes()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValueBytes</h4>
<pre>com.google.protobuf.ByteString&nbsp;getValueBytes()</pre>
<div class="block"><code>required string value = 1;</code></div>
</li>
</ul>
<a name="hasExecutable()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasExecutable</h4>
<pre>boolean&nbsp;hasExecutable()</pre>
<div class="block"><code>optional bool executable = 2;</code></div>
</li>
</ul>
<a name="getExecutable()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExecutable</h4>
<pre>boolean&nbsp;getExecutable()</pre>
<div class="block"><code>optional bool executable = 2;</code></div>
</li>
</ul>
<a name="hasExtract()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasExtract</h4>
<pre>boolean&nbsp;hasExtract()</pre>
<div class="block"><code>optional bool extract = 3 [default = true];</code>
<pre>
In case the fetched file is recognized as an archive, extract
its contents into the sandbox. Note that a cached archive is
not copied from the cache to the sandbox in case extraction
originates from an archive in the cache.
</pre></div>
</li>
</ul>
<a name="getExtract()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExtract</h4>
<pre>boolean&nbsp;getExtract()</pre>
<div class="block"><code>optional bool extract = 3 [default = true];</code>
<pre>
In case the fetched file is recognized as an archive, extract
its contents into the sandbox. Note that a cached archive is
not copied from the cache to the sandbox in case extraction
originates from an archive in the cache.
</pre></div>
</li>
</ul>
<a name="hasCache()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasCache</h4>
<pre>boolean&nbsp;hasCache()</pre>
<div class="block"><code>optional bool cache = 4;</code>
<pre>
If this field is "true", the fetcher cache will be used. If not,
fetching bypasses the cache and downloads directly into the
sandbox directory, no matter whether a suitable cache file is
available or not. The former directs the fetcher to download to
the file cache, then copy from there to the sandbox. Subsequent
fetch attempts with the same URI will omit downloading and copy
from the cache as long as the file is resident there. Cache files
may get evicted at any time, which then leads to renewed
downloading. See also "docs/fetcher.md" and
"docs/fetcher-cache-internals.md".
</pre></div>
</li>
</ul>
<a name="getCache()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCache</h4>
<pre>boolean&nbsp;getCache()</pre>
<div class="block"><code>optional bool cache = 4;</code>
<pre>
If this field is "true", the fetcher cache will be used. If not,
fetching bypasses the cache and downloads directly into the
sandbox directory, no matter whether a suitable cache file is
available or not. The former directs the fetcher to download to
the file cache, then copy from there to the sandbox. Subsequent
fetch attempts with the same URI will omit downloading and copy
from the cache as long as the file is resident there. Cache files
may get evicted at any time, which then leads to renewed
downloading. See also "docs/fetcher.md" and
"docs/fetcher-cache-internals.md".
</pre></div>
</li>
</ul>
<a name="hasOutputFile()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasOutputFile</h4>
<pre>boolean&nbsp;hasOutputFile()</pre>
<div class="block"><code>optional string output_file = 5;</code>
<pre>
The fetcher's default behavior is to use the URI string's basename to
name the local copy. If this field is provided, the local copy will be
named with its value instead. If there is a directory component (which
must be a relative path), the local copy will be stored in that
subdirectory inside the sandbox.
</pre></div>
</li>
</ul>
<a name="getOutputFile()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOutputFile</h4>
<pre>java.lang.String&nbsp;getOutputFile()</pre>
<div class="block"><code>optional string output_file = 5;</code>
<pre>
The fetcher's default behavior is to use the URI string's basename to
name the local copy. If this field is provided, the local copy will be
named with its value instead. If there is a directory component (which
must be a relative path), the local copy will be stored in that
subdirectory inside the sandbox.
</pre></div>
</li>
</ul>
<a name="getOutputFileBytes()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getOutputFileBytes</h4>
<pre>com.google.protobuf.ByteString&nbsp;getOutputFileBytes()</pre>
<div class="block"><code>optional string output_file = 5;</code>
<pre>
The fetcher's default behavior is to use the URI string's basename to
name the local copy. If this field is provided, the local copy will be
named with its value instead. If there is a directory component (which
must be a relative path), the local copy will be stored in that
subdirectory inside the sandbox.
</pre></div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../org/apache/mesos/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="../../../org/apache/mesos/Protos.CommandInfo.URI.Builder.html" title="class in org.apache.mesos"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/apache/mesos/Protos.CommandInfoOrBuilder.html" title="interface in org.apache.mesos"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/apache/mesos/Protos.CommandInfo.URIOrBuilder.html" target="_top">Frames</a></li>
<li><a href="Protos.CommandInfo.URIOrBuilder.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All 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>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&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>