Google Git
Sign in
apache / hadoop-site / 952d547359cafef280f0a0324055741b2ed55be1 / . / content / docs / r3.3.1 / api / org / apache / hadoop / maven / plugin / protoc / package-summary.html
blob: 2d81cc175974eb7429da5141b47f841479867abe [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_292) on Tue Jun 15 06:00:58 GMT 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>org.apache.hadoop.maven.plugin.protoc (Apache Hadoop Main 3.3.1 API)</title>
<meta name="date" content="2021-06-15">
<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="org.apache.hadoop.maven.plugin.protoc (Apache Hadoop Main 3.3.1 API)";
}
}
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>
<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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.html">Use</a></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/hadoop/maven/plugin/paralleltests/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../org/apache/hadoop/maven/plugin/resourcegz/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/hadoop/maven/plugin/protoc/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.hadoop.maven.plugin.protoc</h1>
<div class="docSummary">
<div class="block">Plugins to generate Java files based on protocol buffers with the protoc
command.</div>
</div>
<p>See:&nbsp;<a href="#package.description">Description</a></p>
</div>
<div class="contentContainer"><a name="package.description">
<!-- -->
</a>
<h2 title="Package org.apache.hadoop.maven.plugin.protoc Description">Package org.apache.hadoop.maven.plugin.protoc Description</h2>
<div class="block"><p>Plugins to generate Java files based on protocol buffers with the protoc
command.
<p>For generated files intended for primary build artifacts use like:
<pre>
&lt;plugins&gt;
... SNIP ...
&lt;plugin&gt;
&lt;groupId&gt;org.apache.hadoop&lt;/groupId&gt;
&lt;artifactId&gt;hadoop-maven-plugins&lt;/artifactId&gt;
&lt;executions&gt;
... SNIP ...
&lt;execution&gt;
&lt;id&gt;compile-protoc&lt;/id&gt;
&lt;goals&gt;
&lt;goal&gt;protoc&lt;/goal&gt;
&lt;/goals&gt;
&lt;configuration&gt;
&lt;protocVersion&gt;${protobuf.version}&lt;/protocVersion&gt;
&lt;protocCommand&gt;${protoc.path}&lt;/protocCommand&gt;
&lt;imports&gt;
&lt;param&gt;${basedir}/src/main/proto&lt;/param&gt;
&lt;/imports&gt;
&lt;source&gt;
&lt;directory&gt;${basedir}/src/main/proto&lt;/directory&gt;
&lt;includes&gt;
&lt;include&gt;HAServiceProtocol.proto&lt;/include&gt;
... SNIP ...
&lt;include&gt;RefreshCallQueueProtocol.proto&lt;/include&gt;
&lt;include&gt;GenericRefreshProtocol.proto&lt;/include&gt;
&lt;/includes&gt;
&lt;/source&gt;
&lt;/configuration&gt;
&lt;/execution&gt;
... SNIP ...
&lt;/executions&gt;
... SNIP ...
&lt;/plugin&gt;
&lt;/plugins&gt;
</pre>
For generated files intended only for test, use like:
<pre>
&lt;plugins&gt;
... SNIP ...
&lt;plugin&gt;
&lt;groupId&gt;org.apache.hadoop&lt;/groupId&gt;
&lt;artifactId&gt;hadoop-maven-plugins&lt;/artifactId&gt;
&lt;executions&gt;
... SNIP ...
&lt;execution&gt;
&lt;id&gt;compile-test-protoc&lt;/id&gt;
&lt;goals&gt;
&lt;goal&gt;test-protoc&lt;/goal&gt;
&lt;/goals&gt;
&lt;configuration&gt;
&lt;protocVersion&gt;${protobuf.version}&lt;/protocVersion&gt;
&lt;protocCommand&gt;${protoc.path}&lt;/protocCommand&gt;
&lt;imports&gt;
&lt;param&gt;${basedir}/src/test/proto&lt;/param&gt;
&lt;/imports&gt;
&lt;source&gt;
&lt;directory&gt;${basedir}/src/test/proto&lt;/directory&gt;
&lt;includes&gt;
&lt;include&gt;test.proto&lt;/include&gt;
&lt;include&gt;test_rpc_service.proto&lt;/include&gt;
&lt;/includes&gt;
&lt;/source&gt;
&lt;/configuration&gt;
&lt;/execution&gt;
... SNIP ...
&lt;/executions&gt;
... SNIP ...
&lt;/plugin&gt;
&lt;/plugins&gt;
</pre></div>
</div>
<!-- ======= 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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.html">Use</a></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/hadoop/maven/plugin/paralleltests/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../org/apache/hadoop/maven/plugin/resourcegz/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/hadoop/maven/plugin/protoc/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2021 <a href="https://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>