blob: 770a225a0d4750182727978853f123123431611b [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:30:18 UTC 2017 -->
<title>Protos.NetworkInfo.IPAddressOrBuilder</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.NetworkInfo.IPAddressOrBuilder";
}
}
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.NetworkInfo.IPAddress.Builder.html" title="class in org.apache.mesos"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/apache/mesos/Protos.NetworkInfo.PortMapping.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.NetworkInfo.IPAddressOrBuilder.html" target="_top">Frames</a></li>
<li><a href="Protos.NetworkInfo.IPAddressOrBuilder.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.NetworkInfo.IPAddressOrBuilder" class="title">Interface Protos.NetworkInfo.IPAddressOrBuilder</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.NetworkInfo.IPAddress.html" title="class in org.apache.mesos">Protos.NetworkInfo.IPAddress</a>, <a href="../../../org/apache/mesos/Protos.NetworkInfo.IPAddress.Builder.html" title="class in org.apache.mesos">Protos.NetworkInfo.IPAddress.Builder</a></dd>
</dl>
<dl>
<dt>Enclosing class:</dt>
<dd><a href="../../../org/apache/mesos/Protos.NetworkInfo.html" title="class in org.apache.mesos">Protos.NetworkInfo</a></dd>
</dl>
<hr>
<br>
<pre>public static interface <span class="strong">Protos.NetworkInfo.IPAddressOrBuilder</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.NetworkInfo.IPAddressOrBuilder.html#getIpAddress()">getIpAddress</a></strong>()</code>
<div class="block"><code>optional string ip_address = 2;</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.NetworkInfo.IPAddressOrBuilder.html#getIpAddressBytes()">getIpAddressBytes</a></strong>()</code>
<div class="block"><code>optional string ip_address = 2;</code></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../org/apache/mesos/Protos.NetworkInfo.Protocol.html" title="enum in org.apache.mesos">Protos.NetworkInfo.Protocol</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/mesos/Protos.NetworkInfo.IPAddressOrBuilder.html#getProtocol()">getProtocol</a></strong>()</code>
<div class="block"><code>optional .mesos.NetworkInfo.Protocol protocol = 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.NetworkInfo.IPAddressOrBuilder.html#hasIpAddress()">hasIpAddress</a></strong>()</code>
<div class="block"><code>optional string ip_address = 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.NetworkInfo.IPAddressOrBuilder.html#hasProtocol()">hasProtocol</a></strong>()</code>
<div class="block"><code>optional .mesos.NetworkInfo.Protocol protocol = 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="hasProtocol()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasProtocol</h4>
<pre>boolean&nbsp;hasProtocol()</pre>
<div class="block"><code>optional .mesos.NetworkInfo.Protocol protocol = 1;</code>
<pre>
Specify IP address requirement. Set protocol to the desired value to
request the network isolator on the Agent to assign an IP address to the
container being launched. If a specific IP address is specified in
ip_address, this field should not be set.
</pre></div>
</li>
</ul>
<a name="getProtocol()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProtocol</h4>
<pre><a href="../../../org/apache/mesos/Protos.NetworkInfo.Protocol.html" title="enum in org.apache.mesos">Protos.NetworkInfo.Protocol</a>&nbsp;getProtocol()</pre>
<div class="block"><code>optional .mesos.NetworkInfo.Protocol protocol = 1;</code>
<pre>
Specify IP address requirement. Set protocol to the desired value to
request the network isolator on the Agent to assign an IP address to the
container being launched. If a specific IP address is specified in
ip_address, this field should not be set.
</pre></div>
</li>
</ul>
<a name="hasIpAddress()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasIpAddress</h4>
<pre>boolean&nbsp;hasIpAddress()</pre>
<div class="block"><code>optional string ip_address = 2;</code>
<pre>
Statically assigned IP provided by the Framework. This IP will be
assigned to the container by the network isolator module on the Agent.
This field should not be used with the protocol field above.
If an explicit address is requested but is unavailable, the network
isolator should fail the task.
</pre></div>
</li>
</ul>
<a name="getIpAddress()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIpAddress</h4>
<pre>java.lang.String&nbsp;getIpAddress()</pre>
<div class="block"><code>optional string ip_address = 2;</code>
<pre>
Statically assigned IP provided by the Framework. This IP will be
assigned to the container by the network isolator module on the Agent.
This field should not be used with the protocol field above.
If an explicit address is requested but is unavailable, the network
isolator should fail the task.
</pre></div>
</li>
</ul>
<a name="getIpAddressBytes()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getIpAddressBytes</h4>
<pre>com.google.protobuf.ByteString&nbsp;getIpAddressBytes()</pre>
<div class="block"><code>optional string ip_address = 2;</code>
<pre>
Statically assigned IP provided by the Framework. This IP will be
assigned to the container by the network isolator module on the Agent.
This field should not be used with the protocol field above.
If an explicit address is requested but is unavailable, the network
isolator should fail the task.
</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.NetworkInfo.IPAddress.Builder.html" title="class in org.apache.mesos"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/apache/mesos/Protos.NetworkInfo.PortMapping.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.NetworkInfo.IPAddressOrBuilder.html" target="_top">Frames</a></li>
<li><a href="Protos.NetworkInfo.IPAddressOrBuilder.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>