blob: 5a191e645a4b0a3def979eb21738ffc4344b6d41 [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>AliyunProperties</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="AliyunProperties";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10};
var tabs = {65535:["t0","All 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/iceberg/aliyun/AliyunClientFactory.html" title="interface in org.apache.iceberg.aliyun"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/iceberg/aliyun/AliyunProperties.html" target="_top">Frames</a></li>
<li><a href="AliyunProperties.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><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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.iceberg.aliyun</div>
<h2 title="Class AliyunProperties" class="title">Class AliyunProperties</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.iceberg.aliyun.AliyunProperties</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>
<hr>
<br>
<pre>public class <span class="typeNameLabel">AliyunProperties</span>
extends java.lang.Object
implements java.io.Serializable</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../serialized-form.html#org.apache.iceberg.aliyun.AliyunProperties">Serialized Form</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/aliyun/AliyunProperties.html#CLIENT_ACCESS_KEY_ID">CLIENT_ACCESS_KEY_ID</a></span></code>
<div class="block">Aliyun uses an AccessKey pair, which includes an AccessKey ID and an AccessKey secret to
implement symmetric encryption and verify the identity of a requester.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/aliyun/AliyunProperties.html#CLIENT_ACCESS_KEY_SECRET">CLIENT_ACCESS_KEY_SECRET</a></span></code>
<div class="block">Aliyun uses an AccessKey pair, which includes an AccessKey ID and an AccessKey secret to
implement symmetric encryption and verify the identity of a requester.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/aliyun/AliyunProperties.html#CLIENT_FACTORY">CLIENT_FACTORY</a></span></code>
<div class="block">The implementation class of <a href="../../../../org/apache/iceberg/aliyun/AliyunClientFactory.html" title="interface in org.apache.iceberg.aliyun"><code>AliyunClientFactory</code></a> to customize Aliyun client
configurations.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/aliyun/AliyunProperties.html#OSS_ENDPOINT">OSS_ENDPOINT</a></span></code>
<div class="block">The domain name used to access OSS.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/aliyun/AliyunProperties.html#OSS_STAGING_DIRECTORY">OSS_STAGING_DIRECTORY</a></span></code>
<div class="block">Location to put staging files for uploading to OSS, defaults to the directory value of
java.io.tmpdir.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== 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/iceberg/aliyun/AliyunProperties.html#AliyunProperties--">AliyunProperties</a></span>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/aliyun/AliyunProperties.html#AliyunProperties-java.util.Map-">AliyunProperties</a></span>(java.util.Map&lt;java.lang.String,java.lang.String&gt;&nbsp;properties)</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="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>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/aliyun/AliyunProperties.html#accessKeyId--">accessKeyId</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/aliyun/AliyunProperties.html#accessKeySecret--">accessKeySecret</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/aliyun/AliyunProperties.html#ossEndpoint--">ossEndpoint</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/iceberg/aliyun/AliyunProperties.html#ossStagingDirectory--">ossStagingDirectory</a></span>()</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">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="OSS_ENDPOINT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>OSS_ENDPOINT</h4>
<pre>public static final&nbsp;java.lang.String OSS_ENDPOINT</pre>
<div class="block">The domain name used to access OSS. OSS uses HTTP Restful APIs to provide services. Different
regions are accessed by using different endpoints. For the same region, access over the
internal network or over the Internet also uses different endpoints. For more information, see:
https://www.alibabacloud.com/help/doc-detail/31837.htm</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.apache.iceberg.aliyun.AliyunProperties.OSS_ENDPOINT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="CLIENT_ACCESS_KEY_ID">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CLIENT_ACCESS_KEY_ID</h4>
<pre>public static final&nbsp;java.lang.String CLIENT_ACCESS_KEY_ID</pre>
<div class="block">Aliyun uses an AccessKey pair, which includes an AccessKey ID and an AccessKey secret to
implement symmetric encryption and verify the identity of a requester. The AccessKey ID is used
to identify a user.
<p>For more information about how to obtain an AccessKey pair, see:
https://www.alibabacloud.com/help/doc-detail/53045.htm</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.apache.iceberg.aliyun.AliyunProperties.CLIENT_ACCESS_KEY_ID">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="CLIENT_ACCESS_KEY_SECRET">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CLIENT_ACCESS_KEY_SECRET</h4>
<pre>public static final&nbsp;java.lang.String CLIENT_ACCESS_KEY_SECRET</pre>
<div class="block">Aliyun uses an AccessKey pair, which includes an AccessKey ID and an AccessKey secret to
implement symmetric encryption and verify the identity of a requester. The AccessKey secret is
used to encrypt and verify the signature string.
<p>For more information about how to obtain an AccessKey pair, see:
https://www.alibabacloud.com/help/doc-detail/53045.htm</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.apache.iceberg.aliyun.AliyunProperties.CLIENT_ACCESS_KEY_SECRET">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="CLIENT_FACTORY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CLIENT_FACTORY</h4>
<pre>public static final&nbsp;java.lang.String CLIENT_FACTORY</pre>
<div class="block">The implementation class of <a href="../../../../org/apache/iceberg/aliyun/AliyunClientFactory.html" title="interface in org.apache.iceberg.aliyun"><code>AliyunClientFactory</code></a> to customize Aliyun client
configurations. If set, all Aliyun clients will be initialized by the specified factory. If not
set, <a href="../../../../org/apache/iceberg/aliyun/AliyunClientFactories.html#defaultFactory--"><code>AliyunClientFactories.defaultFactory()</code></a> is used as default factory.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.apache.iceberg.aliyun.AliyunProperties.CLIENT_FACTORY">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="OSS_STAGING_DIRECTORY">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>OSS_STAGING_DIRECTORY</h4>
<pre>public static final&nbsp;java.lang.String OSS_STAGING_DIRECTORY</pre>
<div class="block">Location to put staging files for uploading to OSS, defaults to the directory value of
java.io.tmpdir.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.apache.iceberg.aliyun.AliyunProperties.OSS_STAGING_DIRECTORY">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="AliyunProperties--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>AliyunProperties</h4>
<pre>public&nbsp;AliyunProperties()</pre>
</li>
</ul>
<a name="AliyunProperties-java.util.Map-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AliyunProperties</h4>
<pre>public&nbsp;AliyunProperties(java.util.Map&lt;java.lang.String,java.lang.String&gt;&nbsp;properties)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="ossEndpoint--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ossEndpoint</h4>
<pre>public&nbsp;java.lang.String&nbsp;ossEndpoint()</pre>
</li>
</ul>
<a name="accessKeyId--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>accessKeyId</h4>
<pre>public&nbsp;java.lang.String&nbsp;accessKeyId()</pre>
</li>
</ul>
<a name="accessKeySecret--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>accessKeySecret</h4>
<pre>public&nbsp;java.lang.String&nbsp;accessKeySecret()</pre>
</li>
</ul>
<a name="ossStagingDirectory--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ossStagingDirectory</h4>
<pre>public&nbsp;java.lang.String&nbsp;ossStagingDirectory()</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/iceberg/aliyun/AliyunClientFactory.html" title="interface in org.apache.iceberg.aliyun"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/iceberg/aliyun/AliyunProperties.html" target="_top">Frames</a></li>
<li><a href="AliyunProperties.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><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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>