javadoc/javadoc/org/apache/beam/sdk/extensions/protobuf/ProtoSchemaTranslator.html - beam-site - Git at Google

 <!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_181-google-v7) on Mon Jan 27 16:42:30 PST 2020 -->
 <title>ProtoSchemaTranslator (Apache Beam 2.20.0-SNAPSHOT)</title>
 <meta name="date" content="2020-01-27">
 <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="ProtoSchemaTranslator (Apache Beam 2.20.0-SNAPSHOT)";
         }
     }
     catch(err) {
     }
 //-->
 var methods = {"i0":9,"i1":9,"i2":9};
 var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]};
 var altColor = "altColor";
 var rowColor = "rowColor";
 var tableTab = "tableTab";
 var activeTableTab = "activeTableTab";
 </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><a href="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/beam/sdk/extensions/protobuf/ProtoSchemaLogicalTypes.UInt64.html" title="class in org.apache.beam.sdk.extensions.protobuf"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li>Next&nbsp;Class</li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../../../index.html?org/apache/beam/sdk/extensions/protobuf/ProtoSchemaTranslator.html" target="_top">Frames</a></li>
 <li><a href="ProtoSchemaTranslator.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>
 <div>
 <ul class="subNavList">
 <li>Summary:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
 <li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
 <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method.summary">Method</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
 <li><a href="#constructor.detail">Constr</a>&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.beam.sdk.extensions.protobuf</div>
 <h2 title="Class ProtoSchemaTranslator" class="title">Class ProtoSchemaTranslator</h2>
 </div>
 <div class="contentContainer">
 <ul class="inheritance">
 <li>java.lang.Object</li>
 <li>
 <ul class="inheritance">
 <li>org.apache.beam.sdk.extensions.protobuf.ProtoSchemaTranslator</li>
 </ul>
 </li>
 </ul>
 <div class="description">
 <ul class="blockList">
 <li class="blockList">
 <hr>
 <br>
 <pre><a href="../../../../../../org/apache/beam/sdk/annotations/Experimental.html" title="annotation in org.apache.beam.sdk.annotations">@Experimental</a>(<a href="../../../../../../org/apache/beam/sdk/annotations/Experimental.html#value--">value</a>=<a href="../../../../../../org/apache/beam/sdk/annotations/Experimental.Kind.html#SCHEMAS">SCHEMAS</a>)
 public class <span class="typeNameLabel">ProtoSchemaTranslator</span>
 extends java.lang.Object</pre>
 <div class="block">This class provides utilities for inferring a Beam schema from a protocol buffer.

  <p>The following proto primitive types map to the following Beam types:

  <ul>
    <li>INT32 maps to FieldType.INT32
    <li>INT64 maps to FieldType.INT64
    <li>FLOAT maps to FieldType.FLOAT
    <li>DOUBLE maps to FieldType.DOUBLE
    <li>BOOL maps to FieldType.BOOLEAN
    <li>STRING maps to FieldType.STRING
    <li>BYTES maps to FieldType.BYTES
  </ul>

  <p>The following proto numeric types do not have have native Beam primitive types. LogicalType
  objects were created to represent these types. Normal numeric types are used as the base type of
  each of these logical types, so SQL queries should work as normal.

  <ul>
    <li>UINT32 maps to FieldType.logicalType(new ProtoSchemaLogicalTypes.UInt32()))
    <li>SINT32 maps to FieldType.logicalType(new ProtoSchemaLogicalTypes.SInt32()))
    <li>FIXED32 maps to FieldType.logicalType(new ProtoSchemaLogicalTypes.Fixed32()))
    <li>SFIXED32 maps to FieldType.logicalType(new ProtoSchemaLogicalTypes.SFixed32()))
    <li>UINT64 maps to FieldType.logicalType(new ProtoSchemaLogicalTypes.UInt64()))
    <li>SINT64 maps to FieldType.logicalType(new ProtoSchemaLogicalTypes.SInt64()))
    <li>FIXED64 maps to FieldType.logicalType(new ProtoSchemaLogicalTypes.Fixed64()))
    <li>SFIXED64 maps to FieldType.logicalType(new ProtoSchemaLogicalTypes.SFixed64()))
  </ul>

  <p>Protobuf maps are mapped to Beam FieldType.MAP types. Protobuf repeated fields are mapped to
  Beam FieldType.ARRAY types.

  <p>Beam schemas include the EnumerationType logical type to represent enumerations, and protobuf
  enumerations are translated to this logical type. The base representation type for this logical
  type is an INT32.

  <p>Beam schemas include the OneOfType logical type to represent unions, and protobuf oneOfs are
  translated to this logical type. The base representation type for this logical type is a subrow
  containing an optional field for each oneof option.

  <p>google.com.protobuf.Timestamp messages cannot be translated to FieldType.DATETIME types, as
  the proto type represents nanonseconds and Beam's native type does not currently support that. a
  new TimestampNanos logical type has been introduced to allow representing nanosecond timestamp,
  as well as a DurationNanos logical type to represent google.com.protobuf.Duration types.

  <p>Protobuf wrapper classes are translated to nullable types, as follows.

  <ul>
    <li>google.protobuf.Int32Value maps to a nullable FieldType.INT32
    <li>google.protobuf.Int64Value maps to a nullable FieldType.INT64
    <li>google.protobuf.UInt32Value maps to a nullable FieldType.logicalType(new UInt32())
    <li>google.protobuf.UInt64Value maps to a nullable Field.logicalType(new UInt64())
    <li>google.protobuf.FloatValue maps to a nullable FieldType.FLOAT
    <li>google.protobuf.DoubleValue maps to a nullable FieldType.DOUBLE
    <li>google.protobuf.BoolValue maps to a nullable FieldType.BOOLEAN
    <li>google.protobuf.StringValue maps to a nullable FieldType.STRING
    <li>google.protobuf.BytesValue maps to a nullable FieldType.BYTES
  </ul></div>
 </li>
 </ul>
 </div>
 <div class="summary">
 <ul class="blockList">
 <li class="blockList">
 <!-- =========== FIELD SUMMARY =========== -->
 <ul class="blockList">
 <li class="blockList"><a name="field.summary">
 <!--   -->
 </a>
 <h3>Field Summary</h3>
 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
 <caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
 <tr>
 <th class="colFirst" scope="col">Modifier and Type</th>
 <th class="colLast" scope="col">Field and Description</th>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>static java.lang.String</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/protobuf/ProtoSchemaTranslator.html#PROTO_NUMBER_METADATA_TAG">PROTO_NUMBER_METADATA_TAG</a></span></code>
 <div class="block">This METADATA tag is used to store the field number of a proto tag.</div>
 </td>
 </tr>
 </table>
 </li>
 </ul>
 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 <ul class="blockList">
 <li class="blockList"><a name="constructor.summary">
 <!--   -->
 </a>
 <h3>Constructor Summary</h3>
 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
 <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
 <tr>
 <th class="colOne" scope="col">Constructor and Description</th>
 </tr>
 <tr class="altColor">
 <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/protobuf/ProtoSchemaTranslator.html#ProtoSchemaTranslator--">ProtoSchemaTranslator</a></span>()</code>&nbsp;</td>
 </tr>
 </table>
 </li>
 </ul>
 <!-- ========== METHOD SUMMARY =========== -->
 <ul class="blockList">
 <li class="blockList"><a name="method.summary">
 <!--   -->
 </a>
 <h3>Method Summary</h3>
 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
 <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
 <tr>
 <th class="colFirst" scope="col">Modifier and Type</th>
 <th class="colLast" scope="col">Method and Description</th>
 </tr>
 <tr id="i0" class="altColor">
 <td class="colFirst"><code>static int</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/protobuf/ProtoSchemaTranslator.html#getFieldNumber-org.apache.beam.sdk.schemas.Schema.FieldType-">getFieldNumber</a></span>(<a href="../../../../../../org/apache/beam/sdk/schemas/Schema.FieldType.html" title="class in org.apache.beam.sdk.schemas">Schema.FieldType</a>&nbsp;fieldType)</code>
 <div class="block">Return the proto field number for a type.</div>
 </td>
 </tr>
 <tr id="i1" class="rowColor">
 <td class="colFirst"><code>static <a href="../../../../../../org/apache/beam/sdk/schemas/Schema.html" title="class in org.apache.beam.sdk.schemas">Schema</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/protobuf/ProtoSchemaTranslator.html#getSchema-java.lang.Class-">getSchema</a></span>(java.lang.Class&lt;? extends <a href="https://static.javadoc.io/com.google.protobuf/protobuf-java/3.11.1/com/google/protobuf/Message.html?is-external=true" title="class or interface in com.google.protobuf">Message</a>&gt;&nbsp;clazz)</code>
 <div class="block">Return a Beam scheam representing a proto class.</div>
 </td>
 </tr>
 <tr id="i2" class="altColor">
 <td class="colFirst"><code>static <a href="../../../../../../org/apache/beam/sdk/schemas/Schema.FieldType.html" title="class in org.apache.beam.sdk.schemas">Schema.FieldType</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/protobuf/ProtoSchemaTranslator.html#withFieldNumber-org.apache.beam.sdk.schemas.Schema.FieldType-int-">withFieldNumber</a></span>(<a href="../../../../../../org/apache/beam/sdk/schemas/Schema.FieldType.html" title="class in org.apache.beam.sdk.schemas">Schema.FieldType</a>&nbsp;fieldType,
                int&nbsp;index)</code>
 <div class="block">Attach a proto field number to a type.</div>
 </td>
 </tr>
 </table>
 <ul class="blockList">
 <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
 <!--   -->
 </a>
 <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
 <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
 </ul>
 </li>
 </ul>
 </li>
 </ul>
 </div>
 <div class="details">
 <ul class="blockList">
 <li class="blockList">
 <!-- ============ FIELD DETAIL =========== -->
 <ul class="blockList">
 <li class="blockList"><a name="field.detail">
 <!--   -->
 </a>
 <h3>Field Detail</h3>
 <a name="PROTO_NUMBER_METADATA_TAG">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>PROTO_NUMBER_METADATA_TAG</h4>
 <pre>public static final&nbsp;java.lang.String PROTO_NUMBER_METADATA_TAG</pre>
 <div class="block">This METADATA tag is used to store the field number of a proto tag.</div>
 <dl>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="../../../../../../constant-values.html#org.apache.beam.sdk.extensions.protobuf.ProtoSchemaTranslator.PROTO_NUMBER_METADATA_TAG">Constant Field Values</a></dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 <ul class="blockList">
 <li class="blockList"><a name="constructor.detail">
 <!--   -->
 </a>
 <h3>Constructor Detail</h3>
 <a name="ProtoSchemaTranslator--">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>ProtoSchemaTranslator</h4>
 <pre>public&nbsp;ProtoSchemaTranslator()</pre>
 </li>
 </ul>
 </li>
 </ul>
 <!-- ============ METHOD DETAIL ========== -->
 <ul class="blockList">
 <li class="blockList"><a name="method.detail">
 <!--   -->
 </a>
 <h3>Method Detail</h3>
 <a name="withFieldNumber-org.apache.beam.sdk.schemas.Schema.FieldType-int-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>withFieldNumber</h4>
 <pre>public static&nbsp;<a href="../../../../../../org/apache/beam/sdk/schemas/Schema.FieldType.html" title="class in org.apache.beam.sdk.schemas">Schema.FieldType</a>&nbsp;withFieldNumber(<a href="../../../../../../org/apache/beam/sdk/schemas/Schema.FieldType.html" title="class in org.apache.beam.sdk.schemas">Schema.FieldType</a>&nbsp;fieldType,
                                                int&nbsp;index)</pre>
 <div class="block">Attach a proto field number to a type.</div>
 </li>
 </ul>
 <a name="getFieldNumber-org.apache.beam.sdk.schemas.Schema.FieldType-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getFieldNumber</h4>
 <pre>public static&nbsp;int&nbsp;getFieldNumber(<a href="../../../../../../org/apache/beam/sdk/schemas/Schema.FieldType.html" title="class in org.apache.beam.sdk.schemas">Schema.FieldType</a>&nbsp;fieldType)</pre>
 <div class="block">Return the proto field number for a type.</div>
 </li>
 </ul>
 <a name="getSchema-java.lang.Class-">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>getSchema</h4>
 <pre>public static&nbsp;<a href="../../../../../../org/apache/beam/sdk/schemas/Schema.html" title="class in org.apache.beam.sdk.schemas">Schema</a>&nbsp;getSchema(java.lang.Class&lt;? extends <a href="https://static.javadoc.io/com.google.protobuf/protobuf-java/3.11.1/com/google/protobuf/Message.html?is-external=true" title="class or interface in com.google.protobuf">Message</a>&gt;&nbsp;clazz)</pre>
 <div class="block">Return a Beam scheam representing a proto class.</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>
 <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><a href="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/beam/sdk/extensions/protobuf/ProtoSchemaLogicalTypes.UInt64.html" title="class in org.apache.beam.sdk.extensions.protobuf"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li>Next&nbsp;Class</li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../../../index.html?org/apache/beam/sdk/extensions/protobuf/ProtoSchemaTranslator.html" target="_top">Frames</a></li>
 <li><a href="ProtoSchemaTranslator.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>
 <div>
 <ul class="subNavList">
 <li>Summary:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
 <li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
 <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method.summary">Method</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
 <li><a href="#constructor.detail">Constr</a>&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>
	<!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_181-google-v7) on Mon Jan 27 16:42:30 PST 2020 -->
	<title>ProtoSchemaTranslator (Apache Beam 2.20.0-SNAPSHOT)</title>
	<meta name="date" content="2020-01-27">
	<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="ProtoSchemaTranslator (Apache Beam 2.20.0-SNAPSHOT)";
	}
	}
	catch(err) {
	}
	//-->
	var methods = {"i0":9,"i1":9,"i2":9};
	var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]};
	var altColor = "altColor";
	var rowColor = "rowColor";
	var tableTab = "tableTab";
	var activeTableTab = "activeTableTab";
	</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><a href="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/beam/sdk/extensions/protobuf/ProtoSchemaLogicalTypes.UInt64.html" title="class in org.apache.beam.sdk.extensions.protobuf"><span class="typeNameLink">Prev Class</span></a></li>
	<li>Next Class</li>
	</ul>
	<ul class="navList">
	<li><a href="../../../../../../index.html?org/apache/beam/sdk/extensions/protobuf/ProtoSchemaTranslator.html" target="_top">Frames</a></li>
	<li><a href="ProtoSchemaTranslator.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: </li>
	<li>Nested \| </li>
	<li><a href="#field.summary">Field</a> \| </li>
	<li><a href="#constructor.summary">Constr</a> \| </li>
	<li><a href="#method.summary">Method</a></li>
	</ul>
	<ul class="subNavList">
	<li>Detail: </li>
	<li><a href="#field.detail">Field</a> \| </li>
	<li><a href="#constructor.detail">Constr</a> \| </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.beam.sdk.extensions.protobuf</div>
	<h2 title="Class ProtoSchemaTranslator" class="title">Class ProtoSchemaTranslator</h2>
	</div>
	<div class="contentContainer">
	<ul class="inheritance">
	<li>java.lang.Object</li>
	<li>
	<ul class="inheritance">
	<li>org.apache.beam.sdk.extensions.protobuf.ProtoSchemaTranslator</li>
	</ul>
	</li>
	</ul>
	<div class="description">
	<ul class="blockList">
	<li class="blockList">
	<hr>
	<br>
	<pre><a href="../../../../../../org/apache/beam/sdk/annotations/Experimental.html" title="annotation in org.apache.beam.sdk.annotations">@Experimental</a>(<a href="../../../../../../org/apache/beam/sdk/annotations/Experimental.html#value--">value</a>=<a href="../../../../../../org/apache/beam/sdk/annotations/Experimental.Kind.html#SCHEMAS">SCHEMAS</a>)
	public class <span class="typeNameLabel">ProtoSchemaTranslator</span>
	extends java.lang.Object</pre>
	<div class="block">This class provides utilities for inferring a Beam schema from a protocol buffer.

	<p>The following proto primitive types map to the following Beam types:

	<ul>
	<li>INT32 maps to FieldType.INT32
	<li>INT64 maps to FieldType.INT64
	<li>FLOAT maps to FieldType.FLOAT
	<li>DOUBLE maps to FieldType.DOUBLE
	<li>BOOL maps to FieldType.BOOLEAN
	<li>STRING maps to FieldType.STRING
	<li>BYTES maps to FieldType.BYTES
	</ul>

	<p>The following proto numeric types do not have have native Beam primitive types. LogicalType
	objects were created to represent these types. Normal numeric types are used as the base type of
	each of these logical types, so SQL queries should work as normal.

	<ul>
	<li>UINT32 maps to FieldType.logicalType(new ProtoSchemaLogicalTypes.UInt32()))
	<li>SINT32 maps to FieldType.logicalType(new ProtoSchemaLogicalTypes.SInt32()))
	<li>FIXED32 maps to FieldType.logicalType(new ProtoSchemaLogicalTypes.Fixed32()))
	<li>SFIXED32 maps to FieldType.logicalType(new ProtoSchemaLogicalTypes.SFixed32()))
	<li>UINT64 maps to FieldType.logicalType(new ProtoSchemaLogicalTypes.UInt64()))
	<li>SINT64 maps to FieldType.logicalType(new ProtoSchemaLogicalTypes.SInt64()))
	<li>FIXED64 maps to FieldType.logicalType(new ProtoSchemaLogicalTypes.Fixed64()))
	<li>SFIXED64 maps to FieldType.logicalType(new ProtoSchemaLogicalTypes.SFixed64()))
	</ul>

	<p>Protobuf maps are mapped to Beam FieldType.MAP types. Protobuf repeated fields are mapped to
	Beam FieldType.ARRAY types.

	<p>Beam schemas include the EnumerationType logical type to represent enumerations, and protobuf
	enumerations are translated to this logical type. The base representation type for this logical
	type is an INT32.

	<p>Beam schemas include the OneOfType logical type to represent unions, and protobuf oneOfs are
	translated to this logical type. The base representation type for this logical type is a subrow
	containing an optional field for each oneof option.

	<p>google.com.protobuf.Timestamp messages cannot be translated to FieldType.DATETIME types, as
	the proto type represents nanonseconds and Beam's native type does not currently support that. a
	new TimestampNanos logical type has been introduced to allow representing nanosecond timestamp,
	as well as a DurationNanos logical type to represent google.com.protobuf.Duration types.

	<p>Protobuf wrapper classes are translated to nullable types, as follows.

	<ul>
	<li>google.protobuf.Int32Value maps to a nullable FieldType.INT32
	<li>google.protobuf.Int64Value maps to a nullable FieldType.INT64
	<li>google.protobuf.UInt32Value maps to a nullable FieldType.logicalType(new UInt32())
	<li>google.protobuf.UInt64Value maps to a nullable Field.logicalType(new UInt64())
	<li>google.protobuf.FloatValue maps to a nullable FieldType.FLOAT
	<li>google.protobuf.DoubleValue maps to a nullable FieldType.DOUBLE
	<li>google.protobuf.BoolValue maps to a nullable FieldType.BOOLEAN
	<li>google.protobuf.StringValue maps to a nullable FieldType.STRING
	<li>google.protobuf.BytesValue maps to a nullable FieldType.BYTES
	</ul></div>
	</li>
	</ul>
	</div>
	<div class="summary">
	<ul class="blockList">
	<li class="blockList">
	<!-- =========== FIELD SUMMARY =========== -->
	<ul class="blockList">
	<li class="blockList"><a name="field.summary">
	<!-- -->
	</a>
	<h3>Field Summary</h3>
	<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
	<caption><span>Fields</span><span class="tabEnd"> </span></caption>
	<tr>
	<th class="colFirst" scope="col">Modifier and Type</th>
	<th class="colLast" scope="col">Field and Description</th>
	</tr>
	<tr class="altColor">
	<td class="colFirst"><code>static java.lang.String</code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/protobuf/ProtoSchemaTranslator.html#PROTO_NUMBER_METADATA_TAG">PROTO_NUMBER_METADATA_TAG</a></span></code>
	<div class="block">This METADATA tag is used to store the field number of a proto tag.</div>
	</td>
	</tr>
	</table>
	</li>
	</ul>
	<!-- ======== CONSTRUCTOR SUMMARY ======== -->
	<ul class="blockList">
	<li class="blockList"><a name="constructor.summary">
	<!-- -->
	</a>
	<h3>Constructor Summary</h3>
	<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
	<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
	<tr>
	<th class="colOne" scope="col">Constructor and Description</th>
	</tr>
	<tr class="altColor">
	<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/protobuf/ProtoSchemaTranslator.html#ProtoSchemaTranslator--">ProtoSchemaTranslator</a></span>()</code> </td>
	</tr>
	</table>
	</li>
	</ul>
	<!-- ========== METHOD SUMMARY =========== -->
	<ul class="blockList">
	<li class="blockList"><a name="method.summary">
	<!-- -->
	</a>
	<h3>Method Summary</h3>
	<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
	<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
	<tr>
	<th class="colFirst" scope="col">Modifier and Type</th>
	<th class="colLast" scope="col">Method and Description</th>
	</tr>
	<tr id="i0" class="altColor">
	<td class="colFirst"><code>static int</code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/protobuf/ProtoSchemaTranslator.html#getFieldNumber-org.apache.beam.sdk.schemas.Schema.FieldType-">getFieldNumber</a></span>(<a href="../../../../../../org/apache/beam/sdk/schemas/Schema.FieldType.html" title="class in org.apache.beam.sdk.schemas">Schema.FieldType</a> fieldType)</code>
	<div class="block">Return the proto field number for a type.</div>
	</td>
	</tr>
	<tr id="i1" class="rowColor">
	<td class="colFirst"><code>static <a href="../../../../../../org/apache/beam/sdk/schemas/Schema.html" title="class in org.apache.beam.sdk.schemas">Schema</a></code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/protobuf/ProtoSchemaTranslator.html#getSchema-java.lang.Class-">getSchema</a></span>(java.lang.Class<? extends <a href="https://static.javadoc.io/com.google.protobuf/protobuf-java/3.11.1/com/google/protobuf/Message.html?is-external=true" title="class or interface in com.google.protobuf">Message</a>> clazz)</code>
	<div class="block">Return a Beam scheam representing a proto class.</div>
	</td>
	</tr>
	<tr id="i2" class="altColor">
	<td class="colFirst"><code>static <a href="../../../../../../org/apache/beam/sdk/schemas/Schema.FieldType.html" title="class in org.apache.beam.sdk.schemas">Schema.FieldType</a></code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/extensions/protobuf/ProtoSchemaTranslator.html#withFieldNumber-org.apache.beam.sdk.schemas.Schema.FieldType-int-">withFieldNumber</a></span>(<a href="../../../../../../org/apache/beam/sdk/schemas/Schema.FieldType.html" title="class in org.apache.beam.sdk.schemas">Schema.FieldType</a> fieldType,
	int index)</code>
	<div class="block">Attach a proto field number to a type.</div>
	</td>
	</tr>
	</table>
	<ul class="blockList">
	<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
	<!-- -->
	</a>
	<h3>Methods inherited from class java.lang.Object</h3>
	<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
	</ul>
	</li>
	</ul>
	</li>
	</ul>
	</div>
	<div class="details">
	<ul class="blockList">
	<li class="blockList">
	<!-- ============ FIELD DETAIL =========== -->
	<ul class="blockList">
	<li class="blockList"><a name="field.detail">
	<!-- -->
	</a>
	<h3>Field Detail</h3>
	<a name="PROTO_NUMBER_METADATA_TAG">
	<!-- -->
	</a>
	<ul class="blockListLast">
	<li class="blockList">
	<h4>PROTO_NUMBER_METADATA_TAG</h4>
	<pre>public static final java.lang.String PROTO_NUMBER_METADATA_TAG</pre>
	<div class="block">This METADATA tag is used to store the field number of a proto tag.</div>
	<dl>
	<dt><span class="seeLabel">See Also:</span></dt>
	<dd><a href="../../../../../../constant-values.html#org.apache.beam.sdk.extensions.protobuf.ProtoSchemaTranslator.PROTO_NUMBER_METADATA_TAG">Constant Field Values</a></dd>
	</dl>
	</li>
	</ul>
	</li>
	</ul>
	<!-- ========= CONSTRUCTOR DETAIL ======== -->
	<ul class="blockList">
	<li class="blockList"><a name="constructor.detail">
	<!-- -->
	</a>
	<h3>Constructor Detail</h3>
	<a name="ProtoSchemaTranslator--">
	<!-- -->
	</a>
	<ul class="blockListLast">
	<li class="blockList">
	<h4>ProtoSchemaTranslator</h4>
	<pre>public ProtoSchemaTranslator()</pre>
	</li>
	</ul>
	</li>
	</ul>
	<!-- ============ METHOD DETAIL ========== -->
	<ul class="blockList">
	<li class="blockList"><a name="method.detail">
	<!-- -->
	</a>
	<h3>Method Detail</h3>
	<a name="withFieldNumber-org.apache.beam.sdk.schemas.Schema.FieldType-int-">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>withFieldNumber</h4>
	<pre>public static <a href="../../../../../../org/apache/beam/sdk/schemas/Schema.FieldType.html" title="class in org.apache.beam.sdk.schemas">Schema.FieldType</a> withFieldNumber(<a href="../../../../../../org/apache/beam/sdk/schemas/Schema.FieldType.html" title="class in org.apache.beam.sdk.schemas">Schema.FieldType</a> fieldType,
	int index)</pre>
	<div class="block">Attach a proto field number to a type.</div>
	</li>
	</ul>
	<a name="getFieldNumber-org.apache.beam.sdk.schemas.Schema.FieldType-">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>getFieldNumber</h4>
	<pre>public static int getFieldNumber(<a href="../../../../../../org/apache/beam/sdk/schemas/Schema.FieldType.html" title="class in org.apache.beam.sdk.schemas">Schema.FieldType</a> fieldType)</pre>
	<div class="block">Return the proto field number for a type.</div>
	</li>
	</ul>
	<a name="getSchema-java.lang.Class-">
	<!-- -->
	</a>
	<ul class="blockListLast">
	<li class="blockList">
	<h4>getSchema</h4>
	<pre>public static <a href="../../../../../../org/apache/beam/sdk/schemas/Schema.html" title="class in org.apache.beam.sdk.schemas">Schema</a> getSchema(java.lang.Class<? extends <a href="https://static.javadoc.io/com.google.protobuf/protobuf-java/3.11.1/com/google/protobuf/Message.html?is-external=true" title="class or interface in com.google.protobuf">Message</a>> clazz)</pre>
	<div class="block">Return a Beam scheam representing a proto class.</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>
	<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><a href="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/beam/sdk/extensions/protobuf/ProtoSchemaLogicalTypes.UInt64.html" title="class in org.apache.beam.sdk.extensions.protobuf"><span class="typeNameLink">Prev Class</span></a></li>
	<li>Next Class</li>
	</ul>
	<ul class="navList">
	<li><a href="../../../../../../index.html?org/apache/beam/sdk/extensions/protobuf/ProtoSchemaTranslator.html" target="_top">Frames</a></li>
	<li><a href="ProtoSchemaTranslator.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: </li>
	<li>Nested \| </li>
	<li><a href="#field.summary">Field</a> \| </li>
	<li><a href="#constructor.summary">Constr</a> \| </li>
	<li><a href="#method.summary">Method</a></li>
	</ul>
	<ul class="subNavList">
	<li>Detail: </li>
	<li><a href="#field.detail">Field</a> \| </li>
	<li><a href="#constructor.detail">Constr</a> \| </li>
	<li><a href="#method.detail">Method</a></li>
	</ul>
	</div>
	<a name="skip.navbar.bottom">
	<!-- -->
	</a></div>
	<!-- ======== END OF BOTTOM NAVBAR ======= -->
	</body>
	</html>