javadoc/2.38.0/org/apache/beam/sdk/schemas/annotations/SchemaCaseFormat.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 -->
 <title>SchemaCaseFormat (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="SchemaCaseFormat (Apache Beam 2.38.0-SNAPSHOT)";
         }
     }
     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><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/schemas/annotations/DefaultSchema.DefaultSchemaProviderRegistrar.html" title="class in org.apache.beam.sdk.schemas.annotations"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li><a href="../../../../../../org/apache/beam/sdk/schemas/annotations/SchemaCreate.html" title="annotation in org.apache.beam.sdk.schemas.annotations"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../../../index.html?org/apache/beam/sdk/schemas/annotations/SchemaCaseFormat.html" target="_top">Frames</a></li>
 <li><a href="SchemaCaseFormat.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>Field&nbsp;|&nbsp;</li>
 <li><a href="#annotation.type.required.element.summary">Required</a>&nbsp;|&nbsp;</li>
 <li>Optional</li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li><a href="#annotation.type.element.detail">Element</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.schemas.annotations</div>
 <h2 title="Annotation Type SchemaCaseFormat" class="title">Annotation Type SchemaCaseFormat</h2>
 </div>
 <div class="contentContainer">
 <div class="description">
 <ul class="blockList">
 <li class="blockList">
 <hr>
 <br>
 <pre>@Documented
  @Retention(value=RUNTIME)
  @Target(value={FIELD,METHOD,TYPE})
  <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 @interface <span class="memberNameLabel">SchemaCaseFormat</span></pre>
 <div class="block">When used on a <a href="../../../../../../org/apache/beam/sdk/schemas/JavaFieldSchema.html" title="class in org.apache.beam.sdk.schemas"><code>POJO</code></a>, <a href="../../../../../../org/apache/beam/sdk/schemas/JavaBeanSchema.html" title="class in org.apache.beam.sdk.schemas"><code>Java Bean</code></a>, or <a href="../../../../../../org/apache/beam/sdk/schemas/AutoValueSchema.html" title="class in org.apache.beam.sdk.schemas"><code>AutoValue</code></a> class the specified case format will be
  used for all the generated Schema fields.

  <p>The annotation can also be used on individual POJO fields, and Java Bean and AutoValue getters
  to change the case format just for those fields.

  <p>For example, say we have a POJO with fields that we want in our schema but under names with a
  different case format:

  <pre><code>
   @DefaultSchema(JavaFieldSchema.class)
   @SchemaCaseFormat(CaseFormat.LOWER_UNDERSCORE)
    class MyClass {
      public String user;
      public int ageInYears;
      @SchemaCaseFormat(CaseFormat.UPPER_CAMEL)
      public boolean knowsJavascript;
    }
  </code></pre>

  <p>The resulting schema will have fields named "user", "age_in_years", "KnowsJavascript".

  <p>A common application of this annotation is to make schema fields use the <code>lower_underscore</code> case format, which is recommended for schemas that will be used across language
  boundaries.

  <p><b>NOTE:</b> This annotation assumes that field and method names follow the convention of
  using the <code>lowerCamel</code> case format. If that is not the case, we make a best effort to
  convert the field name but the result is not well defined.</div>
 </li>
 </ul>
 </div>
 <div class="summary">
 <ul class="blockList">
 <li class="blockList">
 <!-- =========== ANNOTATION TYPE REQUIRED MEMBER SUMMARY =========== -->
 <ul class="blockList">
 <li class="blockList"><a name="annotation.type.required.element.summary">
 <!--   -->
 </a>
 <h3>Required Element Summary</h3>
 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Required Element Summary table, listing required elements, and an explanation">
 <caption><span>Required Elements</span><span class="tabEnd">&nbsp;</span></caption>
 <tr>
 <th class="colFirst" scope="col">Modifier and Type</th>
 <th class="colLast" scope="col">Required Element and Description</th>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>org.apache.beam.vendor.guava.v26_0_jre.com.google.common.base.CaseFormat</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/schemas/annotations/SchemaCaseFormat.html#value--">value</a></span></code>
 <div class="block">The name to use for the generated schema field.</div>
 </td>
 </tr>
 </table>
 </li>
 </ul>
 </li>
 </ul>
 </div>
 <div class="details">
 <ul class="blockList">
 <li class="blockList">
 <!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
 <ul class="blockList">
 <li class="blockList"><a name="annotation.type.element.detail">
 <!--   -->
 </a>
 <h3>Element Detail</h3>
 <a name="value--">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>value</h4>
 <pre><a href="https://static.javadoc.io/com.google.code.findbugs/jsr305/3.0.2/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a>
 public abstract&nbsp;org.apache.beam.vendor.guava.v26_0_jre.com.google.common.base.CaseFormat&nbsp;value</pre>
 <div class="block">The name to use for the generated schema field.</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/schemas/annotations/DefaultSchema.DefaultSchemaProviderRegistrar.html" title="class in org.apache.beam.sdk.schemas.annotations"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li><a href="../../../../../../org/apache/beam/sdk/schemas/annotations/SchemaCreate.html" title="annotation in org.apache.beam.sdk.schemas.annotations"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../../../index.html?org/apache/beam/sdk/schemas/annotations/SchemaCaseFormat.html" target="_top">Frames</a></li>
 <li><a href="SchemaCaseFormat.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>Field&nbsp;|&nbsp;</li>
 <li><a href="#annotation.type.required.element.summary">Required</a>&nbsp;|&nbsp;</li>
 <li>Optional</li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li><a href="#annotation.type.element.detail">Element</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 -->
	<title>SchemaCaseFormat (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="SchemaCaseFormat (Apache Beam 2.38.0-SNAPSHOT)";
	}
	}
	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><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/schemas/annotations/DefaultSchema.DefaultSchemaProviderRegistrar.html" title="class in org.apache.beam.sdk.schemas.annotations"><span class="typeNameLink">Prev Class</span></a></li>
	<li><a href="../../../../../../org/apache/beam/sdk/schemas/annotations/SchemaCreate.html" title="annotation in org.apache.beam.sdk.schemas.annotations"><span class="typeNameLink">Next Class</span></a></li>
	</ul>
	<ul class="navList">
	<li><a href="../../../../../../index.html?org/apache/beam/sdk/schemas/annotations/SchemaCaseFormat.html" target="_top">Frames</a></li>
	<li><a href="SchemaCaseFormat.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>Field \| </li>
	<li><a href="#annotation.type.required.element.summary">Required</a> \| </li>
	<li>Optional</li>
	</ul>
	<ul class="subNavList">
	<li>Detail: </li>
	<li>Field \| </li>
	<li><a href="#annotation.type.element.detail">Element</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.schemas.annotations</div>
	<h2 title="Annotation Type SchemaCaseFormat" class="title">Annotation Type SchemaCaseFormat</h2>
	</div>
	<div class="contentContainer">
	<div class="description">
	<ul class="blockList">
	<li class="blockList">
	<hr>
	<br>
	<pre>@Documented
	@Retention(value=RUNTIME)
	@Target(value={FIELD,METHOD,TYPE})
	<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 @interface <span class="memberNameLabel">SchemaCaseFormat</span></pre>
	<div class="block">When used on a <a href="../../../../../../org/apache/beam/sdk/schemas/JavaFieldSchema.html" title="class in org.apache.beam.sdk.schemas"><code>POJO</code></a>, <a href="../../../../../../org/apache/beam/sdk/schemas/JavaBeanSchema.html" title="class in org.apache.beam.sdk.schemas"><code>Java Bean</code></a>, or <a href="../../../../../../org/apache/beam/sdk/schemas/AutoValueSchema.html" title="class in org.apache.beam.sdk.schemas"><code>AutoValue</code></a> class the specified case format will be
	used for all the generated Schema fields.

	<p>The annotation can also be used on individual POJO fields, and Java Bean and AutoValue getters
	to change the case format just for those fields.

	<p>For example, say we have a POJO with fields that we want in our schema but under names with a
	different case format:

	<pre><code>
	@DefaultSchema(JavaFieldSchema.class)
	@SchemaCaseFormat(CaseFormat.LOWER_UNDERSCORE)
	class MyClass {
	public String user;
	public int ageInYears;
	@SchemaCaseFormat(CaseFormat.UPPER_CAMEL)
	public boolean knowsJavascript;
	}
	</code></pre>

	<p>The resulting schema will have fields named "user", "age_in_years", "KnowsJavascript".

	<p>A common application of this annotation is to make schema fields use the <code>lower_underscore</code> case format, which is recommended for schemas that will be used across language
	boundaries.

	<p><b>NOTE:</b> This annotation assumes that field and method names follow the convention of
	using the <code>lowerCamel</code> case format. If that is not the case, we make a best effort to
	convert the field name but the result is not well defined.</div>
	</li>
	</ul>
	</div>
	<div class="summary">
	<ul class="blockList">
	<li class="blockList">
	<!-- =========== ANNOTATION TYPE REQUIRED MEMBER SUMMARY =========== -->
	<ul class="blockList">
	<li class="blockList"><a name="annotation.type.required.element.summary">
	<!-- -->
	</a>
	<h3>Required Element Summary</h3>
	<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Required Element Summary table, listing required elements, and an explanation">
	<caption><span>Required Elements</span><span class="tabEnd"> </span></caption>
	<tr>
	<th class="colFirst" scope="col">Modifier and Type</th>
	<th class="colLast" scope="col">Required Element and Description</th>
	</tr>
	<tr class="altColor">
	<td class="colFirst"><code>org.apache.beam.vendor.guava.v26_0_jre.com.google.common.base.CaseFormat</code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/schemas/annotations/SchemaCaseFormat.html#value--">value</a></span></code>
	<div class="block">The name to use for the generated schema field.</div>
	</td>
	</tr>
	</table>
	</li>
	</ul>
	</li>
	</ul>
	</div>
	<div class="details">
	<ul class="blockList">
	<li class="blockList">
	<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
	<ul class="blockList">
	<li class="blockList"><a name="annotation.type.element.detail">
	<!-- -->
	</a>
	<h3>Element Detail</h3>
	<a name="value--">
	<!-- -->
	</a>
	<ul class="blockListLast">
	<li class="blockList">
	<h4>value</h4>
	<pre><a href="https://static.javadoc.io/com.google.code.findbugs/jsr305/3.0.2/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a>
	public abstract org.apache.beam.vendor.guava.v26_0_jre.com.google.common.base.CaseFormat value</pre>
	<div class="block">The name to use for the generated schema field.</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/schemas/annotations/DefaultSchema.DefaultSchemaProviderRegistrar.html" title="class in org.apache.beam.sdk.schemas.annotations"><span class="typeNameLink">Prev Class</span></a></li>
	<li><a href="../../../../../../org/apache/beam/sdk/schemas/annotations/SchemaCreate.html" title="annotation in org.apache.beam.sdk.schemas.annotations"><span class="typeNameLink">Next Class</span></a></li>
	</ul>
	<ul class="navList">
	<li><a href="../../../../../../index.html?org/apache/beam/sdk/schemas/annotations/SchemaCaseFormat.html" target="_top">Frames</a></li>
	<li><a href="SchemaCaseFormat.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>Field \| </li>
	<li><a href="#annotation.type.required.element.summary">Required</a> \| </li>
	<li>Optional</li>
	</ul>
	<ul class="subNavList">
	<li>Detail: </li>
	<li>Field \| </li>
	<li><a href="#annotation.type.element.detail">Element</a></li>
	</ul>
	</div>
	<a name="skip.navbar.bottom">
	<!-- -->
	</a></div>
	<!-- ======== END OF BOTTOM NAVBAR ======= -->
	</body>
	</html>