blob: 791cddbd85bf725d937dde75dc88ea089c88393a [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 -->
<title>ZetaSqlBeamTranslationUtils (Apache Beam 2.38.0-SNAPSHOT)</title>
<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="ZetaSqlBeamTranslationUtils (Apache Beam 2.38.0-SNAPSHOT)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":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/sql/zetasql/TableResolution.html" title="class in org.apache.beam.sdk.extensions.sql.zetasql"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/apache/beam/sdk/extensions/sql/zetasql/ZetaSqlCalciteTranslationUtils.html" title="class in org.apache.beam.sdk.extensions.sql.zetasql"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/beam/sdk/extensions/sql/zetasql/ZetaSqlBeamTranslationUtils.html" target="_top">Frames</a></li>
<li><a href="ZetaSqlBeamTranslationUtils.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>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.beam.sdk.extensions.sql.zetasql</div>
<h2 title="Class ZetaSqlBeamTranslationUtils" class="title">Class ZetaSqlBeamTranslationUtils</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.beam.sdk.extensions.sql.zetasql.ZetaSqlBeamTranslationUtils</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre><a href="../../../../../../../org/apache/beam/sdk/annotations/Internal.html" title="annotation in org.apache.beam.sdk.annotations">@Internal</a>
public final class <span class="typeNameLabel">ZetaSqlBeamTranslationUtils</span>
extends java.lang.Object</pre>
<div class="block">Utility methods for ZetaSQL <=> Beam translation.
<p>Unsupported ZetaSQL types: INT32, UINT32, UINT64, FLOAT, ENUM, PROTO, GEOGRAPHY</div>
</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="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 java.lang.Object</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/extensions/sql/zetasql/ZetaSqlBeamTranslationUtils.html#toBeamObject-com.google.zetasql.Value-boolean-">toBeamObject</a></span>(com.google.zetasql.Value&nbsp;value,
boolean&nbsp;verifyValues)</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static java.lang.Object</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/extensions/sql/zetasql/ZetaSqlBeamTranslationUtils.html#toBeamObject-com.google.zetasql.Value-org.apache.beam.sdk.schemas.Schema.FieldType-boolean-">toBeamObject</a></span>(com.google.zetasql.Value&nbsp;value,
<a href="../../../../../../../org/apache/beam/sdk/schemas/Schema.FieldType.html" title="class in org.apache.beam.sdk.schemas">Schema.FieldType</a>&nbsp;fieldType,
boolean&nbsp;verifyValues)</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static <a href="../../../../../../../org/apache/beam/sdk/values/Row.html" title="class in org.apache.beam.sdk.values">Row</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/extensions/sql/zetasql/ZetaSqlBeamTranslationUtils.html#toBeamRow-com.google.zetasql.Value-org.apache.beam.sdk.schemas.Schema-boolean-">toBeamRow</a></span>(com.google.zetasql.Value&nbsp;structValue,
<a href="../../../../../../../org/apache/beam/sdk/schemas/Schema.html" title="class in org.apache.beam.sdk.schemas">Schema</a>&nbsp;schema,
boolean&nbsp;verifyValues)</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<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/sql/zetasql/ZetaSqlBeamTranslationUtils.html#toBeamType-com.google.zetasql.Type-">toBeamType</a></span>(com.google.zetasql.Type&nbsp;type)</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static com.google.zetasql.StructType</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/extensions/sql/zetasql/ZetaSqlBeamTranslationUtils.html#toZetaSqlStructType-org.apache.beam.sdk.schemas.Schema-">toZetaSqlStructType</a></span>(<a href="../../../../../../../org/apache/beam/sdk/schemas/Schema.html" title="class in org.apache.beam.sdk.schemas">Schema</a>&nbsp;schema)</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static com.google.zetasql.Value</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/extensions/sql/zetasql/ZetaSqlBeamTranslationUtils.html#toZetaSqlStructValue-org.apache.beam.sdk.values.Row-org.apache.beam.sdk.schemas.Schema-">toZetaSqlStructValue</a></span>(<a href="../../../../../../../org/apache/beam/sdk/values/Row.html" title="class in org.apache.beam.sdk.values">Row</a>&nbsp;row,
<a href="../../../../../../../org/apache/beam/sdk/schemas/Schema.html" title="class in org.apache.beam.sdk.schemas">Schema</a>&nbsp;schema)</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static com.google.zetasql.Type</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/extensions/sql/zetasql/ZetaSqlBeamTranslationUtils.html#toZetaSqlType-org.apache.beam.sdk.schemas.Schema.FieldType-">toZetaSqlType</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>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static com.google.zetasql.Value</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../../org/apache/beam/sdk/extensions/sql/zetasql/ZetaSqlBeamTranslationUtils.html#toZetaSqlValue-java.lang.Object-org.apache.beam.sdk.schemas.Schema.FieldType-">toZetaSqlValue</a></span>(<a href="https://static.javadoc.io/org.checkerframework/checker-qual/3.10.0/org/checkerframework/checker/nullness/qual/Nullable.html?is-external=true" title="class or interface in org.checkerframework.checker.nullness.qual">@Nullable</a> java.lang.Object&nbsp;object,
<a href="../../../../../../../org/apache/beam/sdk/schemas/Schema.FieldType.html" title="class in org.apache.beam.sdk.schemas">Schema.FieldType</a>&nbsp;fieldType)</code>&nbsp;</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">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="toZetaSqlType-org.apache.beam.sdk.schemas.Schema.FieldType-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toZetaSqlType</h4>
<pre>public static&nbsp;com.google.zetasql.Type&nbsp;toZetaSqlType(<a href="../../../../../../../org/apache/beam/sdk/schemas/Schema.FieldType.html" title="class in org.apache.beam.sdk.schemas">Schema.FieldType</a>&nbsp;fieldType)</pre>
</li>
</ul>
<a name="toZetaSqlStructType-org.apache.beam.sdk.schemas.Schema-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toZetaSqlStructType</h4>
<pre>public static&nbsp;com.google.zetasql.StructType&nbsp;toZetaSqlStructType(<a href="../../../../../../../org/apache/beam/sdk/schemas/Schema.html" title="class in org.apache.beam.sdk.schemas">Schema</a>&nbsp;schema)</pre>
</li>
</ul>
<a name="toZetaSqlValue-java.lang.Object-org.apache.beam.sdk.schemas.Schema.FieldType-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toZetaSqlValue</h4>
<pre>public static&nbsp;com.google.zetasql.Value&nbsp;toZetaSqlValue(<a href="https://static.javadoc.io/org.checkerframework/checker-qual/3.10.0/org/checkerframework/checker/nullness/qual/Nullable.html?is-external=true" title="class or interface in org.checkerframework.checker.nullness.qual">@Nullable</a> java.lang.Object&nbsp;object,
<a href="../../../../../../../org/apache/beam/sdk/schemas/Schema.FieldType.html" title="class in org.apache.beam.sdk.schemas">Schema.FieldType</a>&nbsp;fieldType)</pre>
</li>
</ul>
<a name="toZetaSqlStructValue-org.apache.beam.sdk.values.Row-org.apache.beam.sdk.schemas.Schema-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toZetaSqlStructValue</h4>
<pre>public static&nbsp;com.google.zetasql.Value&nbsp;toZetaSqlStructValue(<a href="../../../../../../../org/apache/beam/sdk/values/Row.html" title="class in org.apache.beam.sdk.values">Row</a>&nbsp;row,
<a href="../../../../../../../org/apache/beam/sdk/schemas/Schema.html" title="class in org.apache.beam.sdk.schemas">Schema</a>&nbsp;schema)</pre>
</li>
</ul>
<a name="toBeamType-com.google.zetasql.Type-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toBeamType</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;toBeamType(com.google.zetasql.Type&nbsp;type)</pre>
</li>
</ul>
<a name="toBeamObject-com.google.zetasql.Value-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toBeamObject</h4>
<pre>public static&nbsp;java.lang.Object&nbsp;toBeamObject(com.google.zetasql.Value&nbsp;value,
boolean&nbsp;verifyValues)</pre>
</li>
</ul>
<a name="toBeamObject-com.google.zetasql.Value-org.apache.beam.sdk.schemas.Schema.FieldType-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toBeamObject</h4>
<pre>public static&nbsp;java.lang.Object&nbsp;toBeamObject(com.google.zetasql.Value&nbsp;value,
<a href="../../../../../../../org/apache/beam/sdk/schemas/Schema.FieldType.html" title="class in org.apache.beam.sdk.schemas">Schema.FieldType</a>&nbsp;fieldType,
boolean&nbsp;verifyValues)</pre>
</li>
</ul>
<a name="toBeamRow-com.google.zetasql.Value-org.apache.beam.sdk.schemas.Schema-boolean-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toBeamRow</h4>
<pre>public static&nbsp;<a href="../../../../../../../org/apache/beam/sdk/values/Row.html" title="class in org.apache.beam.sdk.values">Row</a>&nbsp;toBeamRow(com.google.zetasql.Value&nbsp;structValue,
<a href="../../../../../../../org/apache/beam/sdk/schemas/Schema.html" title="class in org.apache.beam.sdk.schemas">Schema</a>&nbsp;schema,
boolean&nbsp;verifyValues)</pre>
</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/sql/zetasql/TableResolution.html" title="class in org.apache.beam.sdk.extensions.sql.zetasql"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../../org/apache/beam/sdk/extensions/sql/zetasql/ZetaSqlCalciteTranslationUtils.html" title="class in org.apache.beam.sdk.extensions.sql.zetasql"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/beam/sdk/extensions/sql/zetasql/ZetaSqlBeamTranslationUtils.html" target="_top">Frames</a></li>
<li><a href="ZetaSqlBeamTranslationUtils.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>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>