blob: 08b65db59f0a918e717fa89a06d2bce1620a4bb1 [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_40) on Thu Jul 20 13:17:28 PDT 2017 -->
<title>SourceSpecificLayer (gobblin-core 0.11.0 API)</title>
<meta name="date" content="2017-07-20">
<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="SourceSpecificLayer (gobblin-core 0.11.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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="../../../../gobblin/source/extractor/extract/QueryBasedSource.SourceEntity.html" title="class in gobblin.source.extractor.extract"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?gobblin/source/extractor/extract/SourceSpecificLayer.html" target="_top">Frames</a></li>
<li><a href="SourceSpecificLayer.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">gobblin.source.extractor.extract</div>
<h2 title="Interface SourceSpecificLayer" class="title">Interface SourceSpecificLayer&lt;S,D&gt;</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>D</code> - type of data record</dd>
<dd><code>S</code> - type of schema</dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../gobblin/source/extractor/extract/restapi/RestApiExtractor.html" title="class in gobblin.source.extractor.extract.restapi">RestApiExtractor</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">SourceSpecificLayer&lt;S,D&gt;</span></pre>
<div class="block">An interface for source extractors</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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../gobblin/source/extractor/extract/SourceSpecificLayer.html#getCount-gobblin.source.extractor.extract.CommandOutput-">getCount</a></span>(<a href="../../../../gobblin/source/extractor/extract/CommandOutput.html" title="interface in gobblin.source.extractor.extract">CommandOutput</a>&lt;?,?&gt;&nbsp;response)</code>
<div class="block">Record count from the response</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../gobblin/source/extractor/extract/Command.html" title="interface in gobblin.source.extractor.extract">Command</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../gobblin/source/extractor/extract/SourceSpecificLayer.html#getCountMetadata-java.lang.String-java.lang.String-gobblin.source.workunit.WorkUnit-java.util.List-">getCountMetadata</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;schema,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;entity,
<a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/source/workunit/WorkUnit.html?is-external=true" title="class or interface in gobblin.source.workunit">WorkUnit</a>&nbsp;workUnit,
<a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../gobblin/source/extractor/watermark/Predicate.html" title="class in gobblin.source.extractor.watermark">Predicate</a>&gt;&nbsp;predicateList)</code>
<div class="block">Metadata for record count(like url, query)</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a>&lt;<a href="../../../../gobblin/source/extractor/extract/SourceSpecificLayer.html" title="type parameter in SourceSpecificLayer">D</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../gobblin/source/extractor/extract/SourceSpecificLayer.html#getData-gobblin.source.extractor.extract.CommandOutput-">getData</a></span>(<a href="../../../../gobblin/source/extractor/extract/CommandOutput.html" title="interface in gobblin.source.extractor.extract">CommandOutput</a>&lt;?,?&gt;&nbsp;response)</code>
<div class="block">Set of data records from the response</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../gobblin/source/extractor/extract/Command.html" title="interface in gobblin.source.extractor.extract">Command</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../gobblin/source/extractor/extract/SourceSpecificLayer.html#getDataMetadata-java.lang.String-java.lang.String-gobblin.source.workunit.WorkUnit-java.util.List-">getDataMetadata</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;schema,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;entity,
<a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/source/workunit/WorkUnit.html?is-external=true" title="class or interface in gobblin.source.workunit">WorkUnit</a>&nbsp;workUnit,
<a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../gobblin/source/extractor/watermark/Predicate.html" title="class in gobblin.source.extractor.watermark">Predicate</a>&gt;&nbsp;predicateList)</code>
<div class="block">Metadata for data records(like url, query)</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../gobblin/source/extractor/extract/SourceSpecificLayer.html#getDataTypeMap--">getDataTypeMap</a></span>()</code>
<div class="block">Data type of source</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../gobblin/source/extractor/extract/SourceSpecificLayer.html#getHighWatermark-gobblin.source.extractor.extract.CommandOutput-java.lang.String-java.lang.String-">getHighWatermark</a></span>(<a href="../../../../gobblin/source/extractor/extract/CommandOutput.html" title="interface in gobblin.source.extractor.extract">CommandOutput</a>&lt;?,?&gt;&nbsp;response,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;watermarkColumn,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;predicateColumnFormat)</code>
<div class="block">High watermark from the response</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../gobblin/source/extractor/extract/Command.html" title="interface in gobblin.source.extractor.extract">Command</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../gobblin/source/extractor/extract/SourceSpecificLayer.html#getHighWatermarkMetadata-java.lang.String-java.lang.String-java.lang.String-java.util.List-">getHighWatermarkMetadata</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;schema,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;entity,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;watermarkColumn,
<a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../gobblin/source/extractor/watermark/Predicate.html" title="class in gobblin.source.extractor.watermark">Predicate</a>&gt;&nbsp;predicateList)</code>
<div class="block">Metadata for high watermark(like url, query)</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a>&lt;<a href="../../../../gobblin/source/extractor/extract/SourceSpecificLayer.html" title="type parameter in SourceSpecificLayer">D</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../gobblin/source/extractor/extract/SourceSpecificLayer.html#getRecordSetFromSourceApi-java.lang.String-java.lang.String-gobblin.source.workunit.WorkUnit-java.util.List-">getRecordSetFromSourceApi</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;schema,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;entity,
<a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/source/workunit/WorkUnit.html?is-external=true" title="class or interface in gobblin.source.workunit">WorkUnit</a>&nbsp;workUnit,
<a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../gobblin/source/extractor/watermark/Predicate.html" title="class in gobblin.source.extractor.watermark">Predicate</a>&gt;&nbsp;predicateList)</code>
<div class="block">Get records using source specific api (Example: bulk api in salesforce source)
record set: data records with an iterator</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../../../gobblin/source/extractor/extract/SourceSpecificLayer.html" title="type parameter in SourceSpecificLayer">S</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../gobblin/source/extractor/extract/SourceSpecificLayer.html#getSchema-gobblin.source.extractor.extract.CommandOutput-">getSchema</a></span>(<a href="../../../../gobblin/source/extractor/extract/CommandOutput.html" title="interface in gobblin.source.extractor.extract">CommandOutput</a>&lt;?,?&gt;&nbsp;response)</code>
<div class="block">Raw schema from the response</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../gobblin/source/extractor/extract/Command.html" title="interface in gobblin.source.extractor.extract">Command</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../gobblin/source/extractor/extract/SourceSpecificLayer.html#getSchemaMetadata-java.lang.String-java.lang.String-">getSchemaMetadata</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;schema,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;entity)</code>
<div class="block">Metadata to extract raw schema(like url, query)</div>
</td>
</tr>
</table>
</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="getSchemaMetadata-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSchemaMetadata</h4>
<pre><a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../gobblin/source/extractor/extract/Command.html" title="interface in gobblin.source.extractor.extract">Command</a>&gt;&nbsp;getSchemaMetadata(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;schema,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;entity)
throws <a href="../../../../gobblin/source/extractor/exception/SchemaException.html" title="class in gobblin.source.extractor.exception">SchemaException</a></pre>
<div class="block">Metadata to extract raw schema(like url, query)</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>source</code> - schema name</dd>
<dd><code>source</code> - entity name</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>list of commands to get schema</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../gobblin/source/extractor/exception/SchemaException.html" title="class in gobblin.source.extractor.exception">SchemaException</a></code> - if there is anything wrong in building metadata for schema extraction</dd>
</dl>
</li>
</ul>
<a name="getSchema-gobblin.source.extractor.extract.CommandOutput-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSchema</h4>
<pre><a href="../../../../gobblin/source/extractor/extract/SourceSpecificLayer.html" title="type parameter in SourceSpecificLayer">S</a>&nbsp;getSchema(<a href="../../../../gobblin/source/extractor/extract/CommandOutput.html" title="interface in gobblin.source.extractor.extract">CommandOutput</a>&lt;?,?&gt;&nbsp;response)
throws <a href="../../../../gobblin/source/extractor/exception/SchemaException.html" title="class in gobblin.source.extractor.exception">SchemaException</a>,
<a href="https://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Raw schema from the response</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>response</code> - is the output from a source call</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>S representation of the schema</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../gobblin/source/extractor/exception/SchemaException.html" title="class in gobblin.source.extractor.exception">SchemaException</a></code> - if there is anything wrong in getting raw schema</dd>
<dd><code><a href="https://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="getHighWatermarkMetadata-java.lang.String-java.lang.String-java.lang.String-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHighWatermarkMetadata</h4>
<pre><a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../gobblin/source/extractor/extract/Command.html" title="interface in gobblin.source.extractor.extract">Command</a>&gt;&nbsp;getHighWatermarkMetadata(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;schema,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;entity,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;watermarkColumn,
<a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../gobblin/source/extractor/watermark/Predicate.html" title="class in gobblin.source.extractor.watermark">Predicate</a>&gt;&nbsp;predicateList)
throws <a href="../../../../gobblin/source/extractor/exception/HighWatermarkException.html" title="class in gobblin.source.extractor.exception">HighWatermarkException</a></pre>
<div class="block">Metadata for high watermark(like url, query)</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>source</code> - schema name</dd>
<dd><code>source</code> - entity name</dd>
<dd><code>water</code> - mark column</dd>
<dd><code>lis</code> - of all predicates that needs to be applied</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>list of commands to get the high watermark</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../gobblin/source/extractor/exception/HighWatermarkException.html" title="class in gobblin.source.extractor.exception">HighWatermarkException</a></code> - if there is anything wrong in building metadata to get high watermark</dd>
</dl>
</li>
</ul>
<a name="getHighWatermark-gobblin.source.extractor.extract.CommandOutput-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHighWatermark</h4>
<pre>long&nbsp;getHighWatermark(<a href="../../../../gobblin/source/extractor/extract/CommandOutput.html" title="interface in gobblin.source.extractor.extract">CommandOutput</a>&lt;?,?&gt;&nbsp;response,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;watermarkColumn,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;predicateColumnFormat)
throws <a href="../../../../gobblin/source/extractor/exception/HighWatermarkException.html" title="class in gobblin.source.extractor.exception">HighWatermarkException</a></pre>
<div class="block">High watermark from the response</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>source</code> - schema name</dd>
<dd><code>source</code> - entity name</dd>
<dd><code>water</code> - mark column</dd>
<dd><code>lis</code> - of all predicates that needs to be applied</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>high water mark from source</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../gobblin/source/extractor/exception/HighWatermarkException.html" title="class in gobblin.source.extractor.exception">HighWatermarkException</a></code> - if there is anything wrong in building metadata to get high watermark</dd>
</dl>
</li>
</ul>
<a name="getCountMetadata-java.lang.String-java.lang.String-gobblin.source.workunit.WorkUnit-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCountMetadata</h4>
<pre><a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../gobblin/source/extractor/extract/Command.html" title="interface in gobblin.source.extractor.extract">Command</a>&gt;&nbsp;getCountMetadata(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;schema,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;entity,
<a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/source/workunit/WorkUnit.html?is-external=true" title="class or interface in gobblin.source.workunit">WorkUnit</a>&nbsp;workUnit,
<a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../gobblin/source/extractor/watermark/Predicate.html" title="class in gobblin.source.extractor.watermark">Predicate</a>&gt;&nbsp;predicateList)
throws <a href="../../../../gobblin/source/extractor/exception/RecordCountException.html" title="class in gobblin.source.extractor.exception">RecordCountException</a></pre>
<div class="block">Metadata for record count(like url, query)</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>source</code> - schema name</dd>
<dd><code>source</code> - entity name</dd>
<dd><code>work</code> - unit: properties</dd>
<dd><code>lis</code> - of all predicates that needs to be applied</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>list of commands to get the count</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../gobblin/source/extractor/exception/RecordCountException.html" title="class in gobblin.source.extractor.exception">RecordCountException</a></code> - if there is anything wrong in building metadata for record counts</dd>
</dl>
</li>
</ul>
<a name="getCount-gobblin.source.extractor.extract.CommandOutput-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCount</h4>
<pre>long&nbsp;getCount(<a href="../../../../gobblin/source/extractor/extract/CommandOutput.html" title="interface in gobblin.source.extractor.extract">CommandOutput</a>&lt;?,?&gt;&nbsp;response)
throws <a href="../../../../gobblin/source/extractor/exception/RecordCountException.html" title="class in gobblin.source.extractor.exception">RecordCountException</a></pre>
<div class="block">Record count from the response</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>record count</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../gobblin/source/extractor/exception/RecordCountException.html" title="class in gobblin.source.extractor.exception">RecordCountException</a></code> - if there is anything wrong in getting record count</dd>
</dl>
</li>
</ul>
<a name="getDataMetadata-java.lang.String-java.lang.String-gobblin.source.workunit.WorkUnit-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDataMetadata</h4>
<pre><a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../gobblin/source/extractor/extract/Command.html" title="interface in gobblin.source.extractor.extract">Command</a>&gt;&nbsp;getDataMetadata(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;schema,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;entity,
<a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/source/workunit/WorkUnit.html?is-external=true" title="class or interface in gobblin.source.workunit">WorkUnit</a>&nbsp;workUnit,
<a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../gobblin/source/extractor/watermark/Predicate.html" title="class in gobblin.source.extractor.watermark">Predicate</a>&gt;&nbsp;predicateList)
throws <a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/source/extractor/DataRecordException.html?is-external=true" title="class or interface in gobblin.source.extractor">DataRecordException</a></pre>
<div class="block">Metadata for data records(like url, query)</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>source</code> - schema name</dd>
<dd><code>source</code> - entity name</dd>
<dd><code>work</code> - unit: properties</dd>
<dd><code>list</code> - of all predicates that needs to be applied</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>list of commands to get the data</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/source/extractor/DataRecordException.html?is-external=true" title="class or interface in gobblin.source.extractor">DataRecordException</a></code> - if there is anything wrong in building metadata for data records</dd>
</dl>
</li>
</ul>
<a name="getData-gobblin.source.extractor.extract.CommandOutput-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getData</h4>
<pre><a href="https://docs.oracle.com/javase/7/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a>&lt;<a href="../../../../gobblin/source/extractor/extract/SourceSpecificLayer.html" title="type parameter in SourceSpecificLayer">D</a>&gt;&nbsp;getData(<a href="../../../../gobblin/source/extractor/extract/CommandOutput.html" title="interface in gobblin.source.extractor.extract">CommandOutput</a>&lt;?,?&gt;&nbsp;response)
throws <a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/source/extractor/DataRecordException.html?is-external=true" title="class or interface in gobblin.source.extractor">DataRecordException</a>,
<a href="https://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Set of data records from the response</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Iterator over objects of type D</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/source/extractor/DataRecordException.html?is-external=true" title="class or interface in gobblin.source.extractor">DataRecordException</a></code> - if there is anything wrong in getting data records</dd>
<dd><code><a href="https://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="getDataTypeMap--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDataTypeMap</h4>
<pre><a href="https://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;getDataTypeMap()</pre>
<div class="block">Data type of source</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Map of source and target data types</dd>
</dl>
</li>
</ul>
<a name="getRecordSetFromSourceApi-java.lang.String-java.lang.String-gobblin.source.workunit.WorkUnit-java.util.List-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getRecordSetFromSourceApi</h4>
<pre><a href="https://docs.oracle.com/javase/7/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a>&lt;<a href="../../../../gobblin/source/extractor/extract/SourceSpecificLayer.html" title="type parameter in SourceSpecificLayer">D</a>&gt;&nbsp;getRecordSetFromSourceApi(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;schema,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;entity,
<a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/source/workunit/WorkUnit.html?is-external=true" title="class or interface in gobblin.source.workunit">WorkUnit</a>&nbsp;workUnit,
<a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../gobblin/source/extractor/watermark/Predicate.html" title="class in gobblin.source.extractor.watermark">Predicate</a>&gt;&nbsp;predicateList)
throws <a href="https://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Get records using source specific api (Example: bulk api in salesforce source)
record set: data records with an iterator</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>source</code> - schema name</dd>
<dd><code>source</code> - entity name</dd>
<dd><code>work</code> - unit: properties</dd>
<dd><code>list</code> - of all predicates that needs to be applied</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>iterator with set of records</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../gobblin/source/extractor/exception/SchemaException.html" title="class in gobblin.source.extractor.exception">SchemaException</a></code> - if there is anything wrong in getting data records</dd>
<dd><code><a href="https://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></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="../../../../gobblin/source/extractor/extract/QueryBasedSource.SourceEntity.html" title="class in gobblin.source.extractor.extract"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?gobblin/source/extractor/extract/SourceSpecificLayer.html" target="_top">Frames</a></li>
<li><a href="SourceSpecificLayer.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>