blob: 2a1babab4ccdf01e41ad4bdcf30ed108ecf6d398 [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:29 PDT 2017 -->
<title>ObjectStoreClient (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="ObjectStoreClient (gobblin-core 0.11.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":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>Prev&nbsp;Class</li>
<li><a href="../../../gobblin/writer/objectstore/ObjectStoreDeleteOperation.html" title="class in gobblin.writer.objectstore"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?gobblin/writer/objectstore/ObjectStoreClient.html" target="_top">Frames</a></li>
<li><a href="ObjectStoreClient.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.writer.objectstore</div>
<h2 title="Interface ObjectStoreClient" class="title">Interface ObjectStoreClient</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre><a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/annotation/Alpha.html?is-external=true" title="class or interface in gobblin.annotation">@Alpha</a>
public interface <span class="typeNameLabel">ObjectStoreClient</span></pre>
<div class="block">A client interface to interact with an object store. Supports basic operations like put,delete and get.</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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/writer/objectstore/ObjectStoreClient.html#close--">close</a></span>()</code>
<div class="block">Close the client</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/writer/objectstore/ObjectStoreClient.html#delete-byte:A-com.typesafe.config.Config-">delete</a></span>(byte[]&nbsp;objectId,
<a href="http://typesafehub.github.io/config/latest/api/com/typesafe/config/Config.html?is-external=true" title="class or interface in com.typesafe.config">Config</a>&nbsp;deleteConfig)</code>
<div class="block">Delete an object with <code>objectId</code> in the store.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../gobblin/writer/objectstore/response/GetObjectResponse.html" title="class in gobblin.writer.objectstore.response">GetObjectResponse</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/writer/objectstore/ObjectStoreClient.html#getObject-byte:A-">getObject</a></span>(byte[]&nbsp;objectId)</code>
<div class="block">Get an object with id <code>objectId</code> stored in the store.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="http://typesafehub.github.io/config/latest/api/com/typesafe/config/Config.html?is-external=true" title="class or interface in com.typesafe.config">Config</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/writer/objectstore/ObjectStoreClient.html#getObjectProps-byte:A-">getObjectProps</a></span>(byte[]&nbsp;objectId)</code>
<div class="block">Get metadata associated with an object</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/writer/objectstore/ObjectStoreClient.html#put-java.io.InputStream-byte:A-com.typesafe.config.Config-">put</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a>&nbsp;objectStream,
byte[]&nbsp;objectId,
<a href="http://typesafehub.github.io/config/latest/api/com/typesafe/config/Config.html?is-external=true" title="class or interface in com.typesafe.config">Config</a>&nbsp;putConfig)</code>
<div class="block">Puts an object in <code>objectStream</code> to the store at <code>objectId</code>.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/writer/objectstore/ObjectStoreClient.html#put-java.io.InputStream-com.typesafe.config.Config-">put</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a>&nbsp;objectStream,
<a href="http://typesafehub.github.io/config/latest/api/com/typesafe/config/Config.html?is-external=true" title="class or interface in com.typesafe.config">Config</a>&nbsp;putConfig)</code>
<div class="block">Puts an object in <code>objectStream</code> to the store.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../gobblin/writer/objectstore/ObjectStoreClient.html#setObjectProps-byte:A-com.typesafe.config.Config-">setObjectProps</a></span>(byte[]&nbsp;objectId,
<a href="http://typesafehub.github.io/config/latest/api/com/typesafe/config/Config.html?is-external=true" title="class or interface in com.typesafe.config">Config</a>&nbsp;objectProps)</code>
<div class="block">Set metadata associated with an object</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="put-java.io.InputStream-com.typesafe.config.Config-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>put</h4>
<pre>byte[]&nbsp;put(<a href="https://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a>&nbsp;objectStream,
<a href="http://typesafehub.github.io/config/latest/api/com/typesafe/config/Config.html?is-external=true" title="class or interface in com.typesafe.config">Config</a>&nbsp;putConfig)
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">Puts an object in <code>objectStream</code> to the store. Returns the id of the object created.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>objectStream</code> - to put in the store</dd>
<dd><code>putConfig</code> - additional config if any (User metadata, put options etc.)</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the id of newly created object</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<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> - if put failed</dd>
</dl>
</li>
</ul>
<a name="put-java.io.InputStream-byte:A-com.typesafe.config.Config-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>put</h4>
<pre>byte[]&nbsp;put(<a href="https://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a>&nbsp;objectStream,
<a href="https://docs.oracle.com/javase/7/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a>
byte[]&nbsp;objectId,
<a href="http://typesafehub.github.io/config/latest/api/com/typesafe/config/Config.html?is-external=true" title="class or interface in com.typesafe.config">Config</a>&nbsp;putConfig)
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">Puts an object in <code>objectStream</code> to the store at <code>objectId</code>.
Returns the id of the object created.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>objectStream</code> - to put in the store</dd>
<dd><code>objectId</code> - to put in the store</dd>
<dd><code>putConfig</code> - additional config if any (User metadata, put options etc.)</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the id of newly created object</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<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> - if put failed</dd>
</dl>
</li>
</ul>
<a name="delete-byte:A-com.typesafe.config.Config-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>delete</h4>
<pre>void&nbsp;delete(<a href="https://docs.oracle.com/javase/7/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a>
byte[]&nbsp;objectId,
<a href="http://typesafehub.github.io/config/latest/api/com/typesafe/config/Config.html?is-external=true" title="class or interface in com.typesafe.config">Config</a>&nbsp;deleteConfig)
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">Delete an object with <code>objectId</code> in the store. Operation is a noop if object does not exist</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>objectId</code> - to delete</dd>
<dd><code>deleteConfig</code> - additional config if any</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<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> - if delete failed</dd>
</dl>
</li>
</ul>
<a name="getObjectProps-byte:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getObjectProps</h4>
<pre><a href="http://typesafehub.github.io/config/latest/api/com/typesafe/config/Config.html?is-external=true" title="class or interface in com.typesafe.config">Config</a>&nbsp;getObjectProps(<a href="https://docs.oracle.com/javase/7/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a>
byte[]&nbsp;objectId)
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 metadata associated with an object</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>objectId</code> - for which metadata is retrieved</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>object metadata</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<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> - if get object metadata fails</dd>
</dl>
</li>
</ul>
<a name="setObjectProps-byte:A-com.typesafe.config.Config-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setObjectProps</h4>
<pre>void&nbsp;setObjectProps(<a href="https://docs.oracle.com/javase/7/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a>
byte[]&nbsp;objectId,
<a href="http://typesafehub.github.io/config/latest/api/com/typesafe/config/Config.html?is-external=true" title="class or interface in com.typesafe.config">Config</a>&nbsp;objectProps)
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">Set metadata associated with an object</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>objectId</code> - for which metadata is set</dd>
<dd><code>objectProps</code> - to set for this object</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<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> - if setting metadata fails</dd>
</dl>
</li>
</ul>
<a name="getObject-byte:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getObject</h4>
<pre><a href="../../../gobblin/writer/objectstore/response/GetObjectResponse.html" title="class in gobblin.writer.objectstore.response">GetObjectResponse</a>&nbsp;getObject(<a href="https://docs.oracle.com/javase/7/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation">@Nonnull</a>
byte[]&nbsp;objectId)
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 an object with id <code>objectId</code> stored in the store.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>objectId</code> - to retrieve</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <a href="../../../gobblin/writer/objectstore/response/GetObjectResponse.html" title="class in gobblin.writer.objectstore.response"><code>GetObjectResponse</code></a> with an <a href="https://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io"><code>InputStream</code></a> to the object and object metadata</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<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> - if object does not exist or there was a failure reading the object</dd>
</dl>
</li>
</ul>
<a name="close--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>close</h4>
<pre>void&nbsp;close()
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">Close the client</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<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>Prev&nbsp;Class</li>
<li><a href="../../../gobblin/writer/objectstore/ObjectStoreDeleteOperation.html" title="class in gobblin.writer.objectstore"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?gobblin/writer/objectstore/ObjectStoreClient.html" target="_top">Frames</a></li>
<li><a href="ObjectStoreClient.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>