blob: 4199edf6a2918a18f74de8c628f9c761c5535e83 [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:24:06 UTC 2017 -->
<title>Protos.Environment.VariableOrBuilder</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.Environment.VariableOrBuilder";
}
}
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.Environment.Variable.Type.html" title="enum in org.apache.mesos"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/apache/mesos/Protos.EnvironmentOrBuilder.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.Environment.VariableOrBuilder.html" target="_top">Frames</a></li>
<li><a href="Protos.Environment.VariableOrBuilder.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.Environment.VariableOrBuilder" class="title">Interface Protos.Environment.VariableOrBuilder</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.Environment.Variable.html" title="class in org.apache.mesos">Protos.Environment.Variable</a>, <a href="../../../org/apache/mesos/Protos.Environment.Variable.Builder.html" title="class in org.apache.mesos">Protos.Environment.Variable.Builder</a></dd>
</dl>
<dl>
<dt>Enclosing class:</dt>
<dd><a href="../../../org/apache/mesos/Protos.Environment.html" title="class in org.apache.mesos">Protos.Environment</a></dd>
</dl>
<hr>
<br>
<pre>public static interface <span class="strong">Protos.Environment.VariableOrBuilder</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.Environment.VariableOrBuilder.html#getName()">getName</a></strong>()</code>
<div class="block"><code>required string name = 1;</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.Environment.VariableOrBuilder.html#getNameBytes()">getNameBytes</a></strong>()</code>
<div class="block"><code>required string name = 1;</code></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../org/apache/mesos/Protos.Secret.html" title="class in org.apache.mesos">Protos.Secret</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/mesos/Protos.Environment.VariableOrBuilder.html#getSecret()">getSecret</a></strong>()</code>
<div class="block"><code>optional .mesos.Secret secret = 4;</code></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../org/apache/mesos/Protos.SecretOrBuilder.html" title="interface in org.apache.mesos">Protos.SecretOrBuilder</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/mesos/Protos.Environment.VariableOrBuilder.html#getSecretOrBuilder()">getSecretOrBuilder</a></strong>()</code>
<div class="block"><code>optional .mesos.Secret secret = 4;</code></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../org/apache/mesos/Protos.Environment.Variable.Type.html" title="enum in org.apache.mesos">Protos.Environment.Variable.Type</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/mesos/Protos.Environment.VariableOrBuilder.html#getType()">getType</a></strong>()</code>
<div class="block"><code>optional .mesos.Environment.Variable.Type type = 3 [default = VALUE];</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.Environment.VariableOrBuilder.html#getValue()">getValue</a></strong>()</code>
<div class="block"><code>optional string value = 2;</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.Environment.VariableOrBuilder.html#getValueBytes()">getValueBytes</a></strong>()</code>
<div class="block"><code>optional string value = 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.Environment.VariableOrBuilder.html#hasName()">hasName</a></strong>()</code>
<div class="block"><code>required string name = 1;</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.Environment.VariableOrBuilder.html#hasSecret()">hasSecret</a></strong>()</code>
<div class="block"><code>optional .mesos.Secret secret = 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.Environment.VariableOrBuilder.html#hasType()">hasType</a></strong>()</code>
<div class="block"><code>optional .mesos.Environment.Variable.Type type = 3 [default = VALUE];</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.Environment.VariableOrBuilder.html#hasValue()">hasValue</a></strong>()</code>
<div class="block"><code>optional string value = 2;</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="hasName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasName</h4>
<pre>boolean&nbsp;hasName()</pre>
<div class="block"><code>required string name = 1;</code></div>
</li>
</ul>
<a name="getName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre>java.lang.String&nbsp;getName()</pre>
<div class="block"><code>required string name = 1;</code></div>
</li>
</ul>
<a name="getNameBytes()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNameBytes</h4>
<pre>com.google.protobuf.ByteString&nbsp;getNameBytes()</pre>
<div class="block"><code>required string name = 1;</code></div>
</li>
</ul>
<a name="hasType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasType</h4>
<pre>boolean&nbsp;hasType()</pre>
<div class="block"><code>optional .mesos.Environment.Variable.Type type = 3 [default = VALUE];</code>
<pre>
In Mesos 1.2, the `Environment.variables.value` message was made
optional. The default type for `Environment.variables.type` is now VALUE,
which requires `value` to be set, maintaining backward compatibility.
TODO(greggomann): The default can be removed in Mesos 2.1 (MESOS-7134).
</pre></div>
</li>
</ul>
<a name="getType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getType</h4>
<pre><a href="../../../org/apache/mesos/Protos.Environment.Variable.Type.html" title="enum in org.apache.mesos">Protos.Environment.Variable.Type</a>&nbsp;getType()</pre>
<div class="block"><code>optional .mesos.Environment.Variable.Type type = 3 [default = VALUE];</code>
<pre>
In Mesos 1.2, the `Environment.variables.value` message was made
optional. The default type for `Environment.variables.type` is now VALUE,
which requires `value` to be set, maintaining backward compatibility.
TODO(greggomann): The default can be removed in Mesos 2.1 (MESOS-7134).
</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 = 2;</code>
<pre>
Only one of `value` and `secret` must be set.
</pre></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 = 2;</code>
<pre>
Only one of `value` and `secret` must be set.
</pre></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 = 2;</code>
<pre>
Only one of `value` and `secret` must be set.
</pre></div>
</li>
</ul>
<a name="hasSecret()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasSecret</h4>
<pre>boolean&nbsp;hasSecret()</pre>
<div class="block"><code>optional .mesos.Secret secret = 4;</code></div>
</li>
</ul>
<a name="getSecret()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSecret</h4>
<pre><a href="../../../org/apache/mesos/Protos.Secret.html" title="class in org.apache.mesos">Protos.Secret</a>&nbsp;getSecret()</pre>
<div class="block"><code>optional .mesos.Secret secret = 4;</code></div>
</li>
</ul>
<a name="getSecretOrBuilder()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getSecretOrBuilder</h4>
<pre><a href="../../../org/apache/mesos/Protos.SecretOrBuilder.html" title="interface in org.apache.mesos">Protos.SecretOrBuilder</a>&nbsp;getSecretOrBuilder()</pre>
<div class="block"><code>optional .mesos.Secret secret = 4;</code></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.Environment.Variable.Type.html" title="enum in org.apache.mesos"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/apache/mesos/Protos.EnvironmentOrBuilder.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.Environment.VariableOrBuilder.html" target="_top">Frames</a></li>
<li><a href="Protos.Environment.VariableOrBuilder.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>