Google Git
Sign in
apache / beam-site / refs/heads/updates_release_2.15.0 / . / javadoc / 2.15.0 / org / apache / beam / runners / dataflow / util / TimeUtil.html
blob: 65222fc84f1459530a837df348cce51f0d455871 [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_181-google-v7) on Wed Aug 14 17:37:12 PDT 2019 -->
<title>TimeUtil (Apache Beam 2.15.0-SNAPSHOT)</title>
<meta name="date" content="2019-08-14">
<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="TimeUtil (Apache Beam 2.15.0-SNAPSHOT)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9,"i2":9,"i3":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/runners/dataflow/util/Structs.html" title="class in org.apache.beam.runners.dataflow.util"><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/runners/dataflow/util/TimeUtil.html" target="_top">Frames</a></li>
<li><a href="TimeUtil.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.runners.dataflow.util</div>
<h2 title="Class TimeUtil" class="title">Class TimeUtil</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.beam.runners.dataflow.util.TimeUtil</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public final class <span class="typeNameLabel">TimeUtil</span>
extends java.lang.Object</pre>
<div class="block">A helper class for converting between Dataflow API and SDK time representations.
<p>Dataflow API times are strings of the form <code>YYYY-MM-dd'T'HH:mm:ss[.nnnn]'Z'</code>: that is,
RFC 3339 strings with optional fractional seconds and a 'Z' offset.
<p>Dataflow API durations are strings of the form <code>['-']sssss[.nnnn]'s'</code>: that is, seconds
with optional fractional seconds and a literal 's' at the end.
<p>In both formats, fractional seconds are either three digits (millisecond resolution), six
digits (microsecond resolution), or nine digits (nanosecond resolution).</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 <a href="https://static.javadoc.io/joda-time/joda-time/2.10.1/org/joda/time/Duration.html?is-external=true" title="class or interface in org.joda.time">Duration</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/util/TimeUtil.html#fromCloudDuration-java.lang.String-">fromCloudDuration</a></span>(java.lang.String&nbsp;duration)</code>
<div class="block">Converts a Dataflow API duration string into a <a href="https://static.javadoc.io/joda-time/joda-time/2.10.1/org/joda/time/Duration.html?is-external=true" title="class or interface in org.joda.time"><code>Duration</code></a>.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static <a href="https://static.javadoc.io/joda-time/joda-time/2.10.1/org/joda/time/Instant.html?is-external=true" title="class or interface in org.joda.time">Instant</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/util/TimeUtil.html#fromCloudTime-java.lang.String-">fromCloudTime</a></span>(java.lang.String&nbsp;time)</code>
<div class="block">Converts a time value received via the Dataflow API into the corresponding <a href="https://static.javadoc.io/joda-time/joda-time/2.10.1/org/joda/time/Instant.html?is-external=true" title="class or interface in org.joda.time"><code>Instant</code></a>.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/util/TimeUtil.html#toCloudDuration-org.joda.time.ReadableDuration-">toCloudDuration</a></span>(<a href="https://static.javadoc.io/joda-time/joda-time/2.10.1/org/joda/time/ReadableDuration.html?is-external=true" title="class or interface in org.joda.time">ReadableDuration</a>&nbsp;duration)</code>
<div class="block">Converts a <a href="https://static.javadoc.io/joda-time/joda-time/2.10.1/org/joda/time/ReadableDuration.html?is-external=true" title="class or interface in org.joda.time"><code>ReadableDuration</code></a> into a Dataflow API duration string.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/dataflow/util/TimeUtil.html#toCloudTime-org.joda.time.ReadableInstant-">toCloudTime</a></span>(<a href="https://static.javadoc.io/joda-time/joda-time/2.10.1/org/joda/time/ReadableInstant.html?is-external=true" title="class or interface in org.joda.time">ReadableInstant</a>&nbsp;instant)</code>
<div class="block">Converts a <a href="https://static.javadoc.io/joda-time/joda-time/2.10.1/org/joda/time/ReadableInstant.html?is-external=true" title="class or interface in org.joda.time"><code>ReadableInstant</code></a> into a Dateflow API time value.</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">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="toCloudTime-org.joda.time.ReadableInstant-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toCloudTime</h4>
<pre>public static&nbsp;java.lang.String&nbsp;toCloudTime(<a href="https://static.javadoc.io/joda-time/joda-time/2.10.1/org/joda/time/ReadableInstant.html?is-external=true" title="class or interface in org.joda.time">ReadableInstant</a>&nbsp;instant)</pre>
<div class="block">Converts a <a href="https://static.javadoc.io/joda-time/joda-time/2.10.1/org/joda/time/ReadableInstant.html?is-external=true" title="class or interface in org.joda.time"><code>ReadableInstant</code></a> into a Dateflow API time value.</div>
</li>
</ul>
<a name="fromCloudTime-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fromCloudTime</h4>
<pre>@Nullable
public static&nbsp;<a href="https://static.javadoc.io/joda-time/joda-time/2.10.1/org/joda/time/Instant.html?is-external=true" title="class or interface in org.joda.time">Instant</a>&nbsp;fromCloudTime(java.lang.String&nbsp;time)</pre>
<div class="block">Converts a time value received via the Dataflow API into the corresponding <a href="https://static.javadoc.io/joda-time/joda-time/2.10.1/org/joda/time/Instant.html?is-external=true" title="class or interface in org.joda.time"><code>Instant</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the parsed time, or null if a parse error occurs</dd>
</dl>
</li>
</ul>
<a name="toCloudDuration-org.joda.time.ReadableDuration-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toCloudDuration</h4>
<pre>public static&nbsp;java.lang.String&nbsp;toCloudDuration(<a href="https://static.javadoc.io/joda-time/joda-time/2.10.1/org/joda/time/ReadableDuration.html?is-external=true" title="class or interface in org.joda.time">ReadableDuration</a>&nbsp;duration)</pre>
<div class="block">Converts a <a href="https://static.javadoc.io/joda-time/joda-time/2.10.1/org/joda/time/ReadableDuration.html?is-external=true" title="class or interface in org.joda.time"><code>ReadableDuration</code></a> into a Dataflow API duration string.</div>
</li>
</ul>
<a name="fromCloudDuration-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>fromCloudDuration</h4>
<pre>@Nullable
public static&nbsp;<a href="https://static.javadoc.io/joda-time/joda-time/2.10.1/org/joda/time/Duration.html?is-external=true" title="class or interface in org.joda.time">Duration</a>&nbsp;fromCloudDuration(java.lang.String&nbsp;duration)</pre>
<div class="block">Converts a Dataflow API duration string into a <a href="https://static.javadoc.io/joda-time/joda-time/2.10.1/org/joda/time/Duration.html?is-external=true" title="class or interface in org.joda.time"><code>Duration</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the parsed duration, or null if a parse error occurs</dd>
</dl>
</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/runners/dataflow/util/Structs.html" title="class in org.apache.beam.runners.dataflow.util"><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/runners/dataflow/util/TimeUtil.html" target="_top">Frames</a></li>
<li><a href="TimeUtil.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>