blob: 9f746488777e9aabee879ec1cbede45a63c7bd2a [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 Fri Mar 10 00:29:31 UTC 2017 -->
<title>Protos.CommandInfoOrBuilder</title>
<meta name="date" content="2017-03-10">
<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.CommandInfoOrBuilder";
}
}
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.URIOrBuilder.html" title="interface in org.apache.mesos"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/apache/mesos/Protos.ContainerID.html" title="class 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.CommandInfoOrBuilder.html" target="_top">Frames</a></li>
<li><a href="Protos.CommandInfoOrBuilder.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.CommandInfoOrBuilder" class="title">Interface Protos.CommandInfoOrBuilder</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.html" title="class in org.apache.mesos">Protos.CommandInfo</a>, <a href="../../../org/apache/mesos/Protos.CommandInfo.Builder.html" title="class in org.apache.mesos">Protos.CommandInfo.Builder</a></dd>
</dl>
<dl>
<dt>Enclosing class:</dt>
<dd><a href="../../../org/apache/mesos/Protos.html" title="class in org.apache.mesos">Protos</a></dd>
</dl>
<hr>
<br>
<pre>public static interface <span class="strong">Protos.CommandInfoOrBuilder</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>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/mesos/Protos.CommandInfoOrBuilder.html#getArguments(int)">getArguments</a></strong>(int&nbsp;index)</code>
<div class="block"><code>repeated string arguments = 7;</code></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>com.google.protobuf.ByteString</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/mesos/Protos.CommandInfoOrBuilder.html#getArgumentsBytes(int)">getArgumentsBytes</a></strong>(int&nbsp;index)</code>
<div class="block"><code>repeated string arguments = 7;</code></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/mesos/Protos.CommandInfoOrBuilder.html#getArgumentsCount()">getArgumentsCount</a></strong>()</code>
<div class="block"><code>repeated string arguments = 7;</code></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>com.google.protobuf.ProtocolStringList</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/mesos/Protos.CommandInfoOrBuilder.html#getArgumentsList()">getArgumentsList</a></strong>()</code>
<div class="block"><code>repeated string arguments = 7;</code></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../org/apache/mesos/Protos.Environment.html" title="class in org.apache.mesos">Protos.Environment</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/mesos/Protos.CommandInfoOrBuilder.html#getEnvironment()">getEnvironment</a></strong>()</code>
<div class="block"><code>optional .mesos.Environment environment = 2;</code></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../org/apache/mesos/Protos.EnvironmentOrBuilder.html" title="interface in org.apache.mesos">Protos.EnvironmentOrBuilder</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/mesos/Protos.CommandInfoOrBuilder.html#getEnvironmentOrBuilder()">getEnvironmentOrBuilder</a></strong>()</code>
<div class="block"><code>optional .mesos.Environment environment = 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.CommandInfoOrBuilder.html#getShell()">getShell</a></strong>()</code>
<div class="block"><code>optional bool shell = 6 [default = true];</code></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../org/apache/mesos/Protos.CommandInfo.URI.html" title="class in org.apache.mesos">Protos.CommandInfo.URI</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/mesos/Protos.CommandInfoOrBuilder.html#getUris(int)">getUris</a></strong>(int&nbsp;index)</code>
<div class="block"><code>repeated .mesos.CommandInfo.URI uris = 1;</code></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/mesos/Protos.CommandInfoOrBuilder.html#getUrisCount()">getUrisCount</a></strong>()</code>
<div class="block"><code>repeated .mesos.CommandInfo.URI uris = 1;</code></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../../../org/apache/mesos/Protos.CommandInfo.URI.html" title="class in org.apache.mesos">Protos.CommandInfo.URI</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/mesos/Protos.CommandInfoOrBuilder.html#getUrisList()">getUrisList</a></strong>()</code>
<div class="block"><code>repeated .mesos.CommandInfo.URI uris = 1;</code></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../org/apache/mesos/Protos.CommandInfo.URIOrBuilder.html" title="interface in org.apache.mesos">Protos.CommandInfo.URIOrBuilder</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/mesos/Protos.CommandInfoOrBuilder.html#getUrisOrBuilder(int)">getUrisOrBuilder</a></strong>(int&nbsp;index)</code>
<div class="block"><code>repeated .mesos.CommandInfo.URI uris = 1;</code></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.List&lt;? extends <a href="../../../org/apache/mesos/Protos.CommandInfo.URIOrBuilder.html" title="interface in org.apache.mesos">Protos.CommandInfo.URIOrBuilder</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/mesos/Protos.CommandInfoOrBuilder.html#getUrisOrBuilderList()">getUrisOrBuilderList</a></strong>()</code>
<div class="block"><code>repeated .mesos.CommandInfo.URI uris = 1;</code></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/mesos/Protos.CommandInfoOrBuilder.html#getUser()">getUser</a></strong>()</code>
<div class="block"><code>optional string user = 5;</code></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>com.google.protobuf.ByteString</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/mesos/Protos.CommandInfoOrBuilder.html#getUserBytes()">getUserBytes</a></strong>()</code>
<div class="block"><code>optional string user = 5;</code></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/mesos/Protos.CommandInfoOrBuilder.html#getValue()">getValue</a></strong>()</code>
<div class="block"><code>optional string value = 3;</code></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>com.google.protobuf.ByteString</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/mesos/Protos.CommandInfoOrBuilder.html#getValueBytes()">getValueBytes</a></strong>()</code>
<div class="block"><code>optional string value = 3;</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.CommandInfoOrBuilder.html#hasEnvironment()">hasEnvironment</a></strong>()</code>
<div class="block"><code>optional .mesos.Environment environment = 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.CommandInfoOrBuilder.html#hasShell()">hasShell</a></strong>()</code>
<div class="block"><code>optional bool shell = 6 [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.CommandInfoOrBuilder.html#hasUser()">hasUser</a></strong>()</code>
<div class="block"><code>optional string user = 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.CommandInfoOrBuilder.html#hasValue()">hasValue</a></strong>()</code>
<div class="block"><code>optional string value = 3;</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="getUrisList()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUrisList</h4>
<pre>java.util.List&lt;<a href="../../../org/apache/mesos/Protos.CommandInfo.URI.html" title="class in org.apache.mesos">Protos.CommandInfo.URI</a>&gt;&nbsp;getUrisList()</pre>
<div class="block"><code>repeated .mesos.CommandInfo.URI uris = 1;</code></div>
</li>
</ul>
<a name="getUris(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUris</h4>
<pre><a href="../../../org/apache/mesos/Protos.CommandInfo.URI.html" title="class in org.apache.mesos">Protos.CommandInfo.URI</a>&nbsp;getUris(int&nbsp;index)</pre>
<div class="block"><code>repeated .mesos.CommandInfo.URI uris = 1;</code></div>
</li>
</ul>
<a name="getUrisCount()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUrisCount</h4>
<pre>int&nbsp;getUrisCount()</pre>
<div class="block"><code>repeated .mesos.CommandInfo.URI uris = 1;</code></div>
</li>
</ul>
<a name="getUrisOrBuilderList()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUrisOrBuilderList</h4>
<pre>java.util.List&lt;? extends <a href="../../../org/apache/mesos/Protos.CommandInfo.URIOrBuilder.html" title="interface in org.apache.mesos">Protos.CommandInfo.URIOrBuilder</a>&gt;&nbsp;getUrisOrBuilderList()</pre>
<div class="block"><code>repeated .mesos.CommandInfo.URI uris = 1;</code></div>
</li>
</ul>
<a name="getUrisOrBuilder(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUrisOrBuilder</h4>
<pre><a href="../../../org/apache/mesos/Protos.CommandInfo.URIOrBuilder.html" title="interface in org.apache.mesos">Protos.CommandInfo.URIOrBuilder</a>&nbsp;getUrisOrBuilder(int&nbsp;index)</pre>
<div class="block"><code>repeated .mesos.CommandInfo.URI uris = 1;</code></div>
</li>
</ul>
<a name="hasEnvironment()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasEnvironment</h4>
<pre>boolean&nbsp;hasEnvironment()</pre>
<div class="block"><code>optional .mesos.Environment environment = 2;</code></div>
</li>
</ul>
<a name="getEnvironment()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEnvironment</h4>
<pre><a href="../../../org/apache/mesos/Protos.Environment.html" title="class in org.apache.mesos">Protos.Environment</a>&nbsp;getEnvironment()</pre>
<div class="block"><code>optional .mesos.Environment environment = 2;</code></div>
</li>
</ul>
<a name="getEnvironmentOrBuilder()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEnvironmentOrBuilder</h4>
<pre><a href="../../../org/apache/mesos/Protos.EnvironmentOrBuilder.html" title="interface in org.apache.mesos">Protos.EnvironmentOrBuilder</a>&nbsp;getEnvironmentOrBuilder()</pre>
<div class="block"><code>optional .mesos.Environment environment = 2;</code></div>
</li>
</ul>
<a name="hasShell()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasShell</h4>
<pre>boolean&nbsp;hasShell()</pre>
<div class="block"><code>optional bool shell = 6 [default = true];</code>
<pre>
There are two ways to specify the command:
1) If 'shell == true', the command will be launched via shell
(i.e., /bin/sh -c 'value'). The 'value' specified will be
treated as the shell command. The 'arguments' will be ignored.
2) If 'shell == false', the command will be launched by passing
arguments to an executable. The 'value' specified will be
treated as the filename of the executable. The 'arguments'
will be treated as the arguments to the executable. This is
similar to how POSIX exec families launch processes (i.e.,
execlp(value, arguments(0), arguments(1), ...)).
NOTE: The field 'value' is changed from 'required' to 'optional'
in 0.20.0. It will only cause issues if a new framework is
connecting to an old master.
</pre></div>
</li>
</ul>
<a name="getShell()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getShell</h4>
<pre>boolean&nbsp;getShell()</pre>
<div class="block"><code>optional bool shell = 6 [default = true];</code>
<pre>
There are two ways to specify the command:
1) If 'shell == true', the command will be launched via shell
(i.e., /bin/sh -c 'value'). The 'value' specified will be
treated as the shell command. The 'arguments' will be ignored.
2) If 'shell == false', the command will be launched by passing
arguments to an executable. The 'value' specified will be
treated as the filename of the executable. The 'arguments'
will be treated as the arguments to the executable. This is
similar to how POSIX exec families launch processes (i.e.,
execlp(value, arguments(0), arguments(1), ...)).
NOTE: The field 'value' is changed from 'required' to 'optional'
in 0.20.0. It will only cause issues if a new framework is
connecting to an old master.
</pre></div>
</li>
</ul>
<a name="hasValue()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasValue</h4>
<pre>boolean&nbsp;hasValue()</pre>
<div class="block"><code>optional string value = 3;</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>optional string value = 3;</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>optional string value = 3;</code></div>
</li>
</ul>
<a name="getArgumentsList()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getArgumentsList</h4>
<pre>com.google.protobuf.ProtocolStringList&nbsp;getArgumentsList()</pre>
<div class="block"><code>repeated string arguments = 7;</code></div>
</li>
</ul>
<a name="getArgumentsCount()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getArgumentsCount</h4>
<pre>int&nbsp;getArgumentsCount()</pre>
<div class="block"><code>repeated string arguments = 7;</code></div>
</li>
</ul>
<a name="getArguments(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getArguments</h4>
<pre>java.lang.String&nbsp;getArguments(int&nbsp;index)</pre>
<div class="block"><code>repeated string arguments = 7;</code></div>
</li>
</ul>
<a name="getArgumentsBytes(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getArgumentsBytes</h4>
<pre>com.google.protobuf.ByteString&nbsp;getArgumentsBytes(int&nbsp;index)</pre>
<div class="block"><code>repeated string arguments = 7;</code></div>
</li>
</ul>
<a name="hasUser()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasUser</h4>
<pre>boolean&nbsp;hasUser()</pre>
<div class="block"><code>optional string user = 5;</code>
<pre>
Enables executor and tasks to run as a specific user. If the user
field is present both in FrameworkInfo and here, the CommandInfo
user value takes precedence.
</pre></div>
</li>
</ul>
<a name="getUser()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUser</h4>
<pre>java.lang.String&nbsp;getUser()</pre>
<div class="block"><code>optional string user = 5;</code>
<pre>
Enables executor and tasks to run as a specific user. If the user
field is present both in FrameworkInfo and here, the CommandInfo
user value takes precedence.
</pre></div>
</li>
</ul>
<a name="getUserBytes()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getUserBytes</h4>
<pre>com.google.protobuf.ByteString&nbsp;getUserBytes()</pre>
<div class="block"><code>optional string user = 5;</code>
<pre>
Enables executor and tasks to run as a specific user. If the user
field is present both in FrameworkInfo and here, the CommandInfo
user value takes precedence.
</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.URIOrBuilder.html" title="interface in org.apache.mesos"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/apache/mesos/Protos.ContainerID.html" title="class 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.CommandInfoOrBuilder.html" target="_top">Frames</a></li>
<li><a href="Protos.CommandInfoOrBuilder.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>