blob: c71bac28ae1e6c4cbc9b5b85ff942680174f6a98 [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>SingleStoreIO.DataSourceConfiguration (Apache Beam 2.47.0)</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="SingleStoreIO.DataSourceConfiguration (Apache Beam 2.47.0)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":10,"i2":9,"i3":10,"i4":10,"i5":10,"i6":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance 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/io/singlestore/SingleStoreIO.html" title="class in org.apache.beam.sdk.io.singlestore"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/beam/sdk/io/singlestore/SingleStoreIO.Read.html" title="class in org.apache.beam.sdk.io.singlestore"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/beam/sdk/io/singlestore/SingleStoreIO.DataSourceConfiguration.html" target="_top">Frames</a></li>
<li><a href="SingleStoreIO.DataSourceConfiguration.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><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>Field&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.io.singlestore</div>
<h2 title="Class SingleStoreIO.DataSourceConfiguration" class="title">Class SingleStoreIO.DataSourceConfiguration</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.beam.sdk.io.singlestore.SingleStoreIO.DataSourceConfiguration</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable</dd>
</dl>
<dl>
<dt>Enclosing class:</dt>
<dd><a href="../../../../../../org/apache/beam/sdk/io/singlestore/SingleStoreIO.html" title="class in org.apache.beam.sdk.io.singlestore">SingleStoreIO</a></dd>
</dl>
<hr>
<br>
<pre><a href="../../../../../../org/apache/beam/sdk/schemas/annotations/DefaultSchema.html" title="annotation in org.apache.beam.sdk.schemas.annotations">@DefaultSchema</a>(<a href="../../../../../../org/apache/beam/sdk/schemas/annotations/DefaultSchema.html#value--">value</a>=<a href="../../../../../../org/apache/beam/sdk/schemas/AutoValueSchema.html" title="class in org.apache.beam.sdk.schemas">AutoValueSchema.class</a>)
public abstract static class <span class="typeNameLabel">SingleStoreIO.DataSourceConfiguration</span>
extends java.lang.Object
implements java.io.Serializable</pre>
<div class="block">A POJO describing a SingleStoreDB <code>DataSource</code> by providing all properties needed to
create it.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../serialized-form.html#org.apache.beam.sdk.io.singlestore.SingleStoreIO.DataSourceConfiguration">Serialized Form</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== 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/io/singlestore/SingleStoreIO.DataSourceConfiguration.html#DataSourceConfiguration--">DataSourceConfiguration</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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance 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="../../../../../../org/apache/beam/sdk/io/singlestore/SingleStoreIO.DataSourceConfiguration.html" title="class in org.apache.beam.sdk.io.singlestore">SingleStoreIO.DataSourceConfiguration</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/singlestore/SingleStoreIO.DataSourceConfiguration.html#create-java.lang.String-">create</a></span>(java.lang.String&nbsp;endpoint)</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>javax.sql.DataSource</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/singlestore/SingleStoreIO.DataSourceConfiguration.html#getDataSource--">getDataSource</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/singlestore/SingleStoreIO.DataSourceConfiguration.html#populateDisplayData-org.apache.beam.sdk.io.singlestore.SingleStoreIO.DataSourceConfiguration-org.apache.beam.sdk.transforms.display.DisplayData.Builder-">populateDisplayData</a></span>(<a href="https://static.javadoc.io/org.checkerframework/checker-qual/3.27.0/org/checkerframework/checker/nullness/qual/Nullable.html?is-external=true" title="class or interface in org.checkerframework.checker.nullness.qual">@Nullable</a> <a href="../../../../../../org/apache/beam/sdk/io/singlestore/SingleStoreIO.DataSourceConfiguration.html" title="class in org.apache.beam.sdk.io.singlestore">SingleStoreIO.DataSourceConfiguration</a>&nbsp;dataSourceConfiguration,
<a href="../../../../../../org/apache/beam/sdk/transforms/display/DisplayData.Builder.html" title="interface in org.apache.beam.sdk.transforms.display">DisplayData.Builder</a>&nbsp;builder)</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/io/singlestore/SingleStoreIO.DataSourceConfiguration.html" title="class in org.apache.beam.sdk.io.singlestore">SingleStoreIO.DataSourceConfiguration</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/singlestore/SingleStoreIO.DataSourceConfiguration.html#withConnectionProperties-java.lang.String-">withConnectionProperties</a></span>(java.lang.String&nbsp;connectionProperties)</code>
<div class="block">Sets the connection properties passed to driver.connect(...).</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/io/singlestore/SingleStoreIO.DataSourceConfiguration.html" title="class in org.apache.beam.sdk.io.singlestore">SingleStoreIO.DataSourceConfiguration</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/singlestore/SingleStoreIO.DataSourceConfiguration.html#withDatabase-java.lang.String-">withDatabase</a></span>(java.lang.String&nbsp;database)</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/io/singlestore/SingleStoreIO.DataSourceConfiguration.html" title="class in org.apache.beam.sdk.io.singlestore">SingleStoreIO.DataSourceConfiguration</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/singlestore/SingleStoreIO.DataSourceConfiguration.html#withPassword-java.lang.String-">withPassword</a></span>(java.lang.String&nbsp;password)</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/beam/sdk/io/singlestore/SingleStoreIO.DataSourceConfiguration.html" title="class in org.apache.beam.sdk.io.singlestore">SingleStoreIO.DataSourceConfiguration</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/singlestore/SingleStoreIO.DataSourceConfiguration.html#withUsername-java.lang.String-">withUsername</a></span>(java.lang.String&nbsp;username)</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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="DataSourceConfiguration--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DataSourceConfiguration</h4>
<pre>public&nbsp;DataSourceConfiguration()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="create-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>create</h4>
<pre>public static&nbsp;<a href="../../../../../../org/apache/beam/sdk/io/singlestore/SingleStoreIO.DataSourceConfiguration.html" title="class in org.apache.beam.sdk.io.singlestore">SingleStoreIO.DataSourceConfiguration</a>&nbsp;create(java.lang.String&nbsp;endpoint)</pre>
</li>
</ul>
<a name="withUsername-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withUsername</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/beam/sdk/io/singlestore/SingleStoreIO.DataSourceConfiguration.html" title="class in org.apache.beam.sdk.io.singlestore">SingleStoreIO.DataSourceConfiguration</a>&nbsp;withUsername(java.lang.String&nbsp;username)</pre>
</li>
</ul>
<a name="withPassword-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withPassword</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/beam/sdk/io/singlestore/SingleStoreIO.DataSourceConfiguration.html" title="class in org.apache.beam.sdk.io.singlestore">SingleStoreIO.DataSourceConfiguration</a>&nbsp;withPassword(java.lang.String&nbsp;password)</pre>
</li>
</ul>
<a name="withDatabase-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withDatabase</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/beam/sdk/io/singlestore/SingleStoreIO.DataSourceConfiguration.html" title="class in org.apache.beam.sdk.io.singlestore">SingleStoreIO.DataSourceConfiguration</a>&nbsp;withDatabase(java.lang.String&nbsp;database)</pre>
</li>
</ul>
<a name="withConnectionProperties-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withConnectionProperties</h4>
<pre>public&nbsp;<a href="../../../../../../org/apache/beam/sdk/io/singlestore/SingleStoreIO.DataSourceConfiguration.html" title="class in org.apache.beam.sdk.io.singlestore">SingleStoreIO.DataSourceConfiguration</a>&nbsp;withConnectionProperties(java.lang.String&nbsp;connectionProperties)</pre>
<div class="block">Sets the connection properties passed to driver.connect(...). Format of the string must be
[propertyName=property;]*
<p>NOTE - The "user" and "password" properties can be add via <a href="../../../../../../org/apache/beam/sdk/io/singlestore/SingleStoreIO.DataSourceConfiguration.html#withUsername-java.lang.String-"><code>withUsername(String)</code></a>,
<a href="../../../../../../org/apache/beam/sdk/io/singlestore/SingleStoreIO.DataSourceConfiguration.html#withPassword-java.lang.String-"><code>withPassword(String)</code></a>, so they do not need to be included here.
<p>Full list of supported properties can be found here <a
href="https://docs.singlestore.com/managed-service/en/developer-resources/connect-with-application-development-tools/connect-with-java-jdbc/the-singlestore-jdbc-driver.html#connection-string-parameters">...</a></div>
</li>
</ul>
<a name="populateDisplayData-org.apache.beam.sdk.io.singlestore.SingleStoreIO.DataSourceConfiguration-org.apache.beam.sdk.transforms.display.DisplayData.Builder-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>populateDisplayData</h4>
<pre>public static&nbsp;void&nbsp;populateDisplayData(<a href="https://static.javadoc.io/org.checkerframework/checker-qual/3.27.0/org/checkerframework/checker/nullness/qual/Nullable.html?is-external=true" title="class or interface in org.checkerframework.checker.nullness.qual">@Nullable</a> <a href="../../../../../../org/apache/beam/sdk/io/singlestore/SingleStoreIO.DataSourceConfiguration.html" title="class in org.apache.beam.sdk.io.singlestore">SingleStoreIO.DataSourceConfiguration</a>&nbsp;dataSourceConfiguration,
<a href="../../../../../../org/apache/beam/sdk/transforms/display/DisplayData.Builder.html" title="interface in org.apache.beam.sdk.transforms.display">DisplayData.Builder</a>&nbsp;builder)</pre>
</li>
</ul>
<a name="getDataSource--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getDataSource</h4>
<pre>public&nbsp;javax.sql.DataSource&nbsp;getDataSource()</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/io/singlestore/SingleStoreIO.html" title="class in org.apache.beam.sdk.io.singlestore"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/beam/sdk/io/singlestore/SingleStoreIO.Read.html" title="class in org.apache.beam.sdk.io.singlestore"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/beam/sdk/io/singlestore/SingleStoreIO.DataSourceConfiguration.html" target="_top">Frames</a></li>
<li><a href="SingleStoreIO.DataSourceConfiguration.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><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>Field&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>