Skip to content

Commit e492f4a

Browse files
author
aws-crypto-tools-ci-bot
committed
docs: updating javadocs
1 parent 7954a36 commit e492f4a

File tree

192 files changed

+826
-802
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

192 files changed

+826
-802
lines changed

allclasses-index.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (11.0.18) on Tue Mar 21 01:49:47 UTC 2023 -->
6-
<title>All Classes (Amazon S3 Encryption Client 2.4.1 API)</title>
5+
<!-- Generated by javadoc (11.0.18) on Thu Mar 23 06:54:47 UTC 2023 -->
6+
<title>All Classes (Amazon S3 Encryption Client 2.5.0 API)</title>
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8-
<meta name="dc.created" content="2023-03-21">
8+
<meta name="dc.created" content="2023-03-23">
99
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
1010
<link rel="stylesheet" type="text/css" href="jquery/jquery-ui.min.css" title="Style">
1111
<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
@@ -22,7 +22,7 @@
2222
<script type="text/javascript"><!--
2323
try {
2424
if (location.href.indexOf('is-external=true') == -1) {
25-
parent.document.title="All Classes (Amazon S3 Encryption Client 2.4.1 API)";
25+
parent.document.title="All Classes (Amazon S3 Encryption Client 2.5.0 API)";
2626
}
2727
}
2828
catch(err) {

allclasses.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (11.0.18) on Tue Mar 21 01:49:47 UTC 2023 -->
6-
<title>All Classes (Amazon S3 Encryption Client 2.4.1 API)</title>
5+
<!-- Generated by javadoc (11.0.18) on Thu Mar 23 06:54:47 UTC 2023 -->
6+
<title>All Classes (Amazon S3 Encryption Client 2.5.0 API)</title>
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8-
<meta name="dc.created" content="2023-03-21">
8+
<meta name="dc.created" content="2023-03-23">
99
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
1010
<link rel="stylesheet" type="text/css" href="jquery/jquery-ui.min.css" title="Style">
1111
<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">

allpackages-index.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (11.0.18) on Tue Mar 21 01:49:47 UTC 2023 -->
6-
<title>All Packages (Amazon S3 Encryption Client 2.4.1 API)</title>
5+
<!-- Generated by javadoc (11.0.18) on Thu Mar 23 06:54:47 UTC 2023 -->
6+
<title>All Packages (Amazon S3 Encryption Client 2.5.0 API)</title>
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8-
<meta name="dc.created" content="2023-03-21">
8+
<meta name="dc.created" content="2023-03-23">
99
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
1010
<link rel="stylesheet" type="text/css" href="jquery/jquery-ui.min.css" title="Style">
1111
<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
@@ -22,7 +22,7 @@
2222
<script type="text/javascript"><!--
2323
try {
2424
if (location.href.indexOf('is-external=true') == -1) {
25-
parent.document.title="All Packages (Amazon S3 Encryption Client 2.4.1 API)";
25+
parent.document.title="All Packages (Amazon S3 Encryption Client 2.5.0 API)";
2626
}
2727
}
2828
catch(err) {

constant-values.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (11.0.18) on Tue Mar 21 01:49:47 UTC 2023 -->
6-
<title>Constant Field Values (Amazon S3 Encryption Client 2.4.1 API)</title>
5+
<!-- Generated by javadoc (11.0.18) on Thu Mar 23 06:54:47 UTC 2023 -->
6+
<title>Constant Field Values (Amazon S3 Encryption Client 2.5.0 API)</title>
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8-
<meta name="dc.created" content="2023-03-21">
8+
<meta name="dc.created" content="2023-03-23">
99
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
1010
<link rel="stylesheet" type="text/css" href="jquery/jquery-ui.min.css" title="Style">
1111
<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
@@ -22,7 +22,7 @@
2222
<script type="text/javascript"><!--
2323
try {
2424
if (location.href.indexOf('is-external=true') == -1) {
25-
parent.document.title="Constant Field Values (Amazon S3 Encryption Client 2.4.1 API)";
25+
parent.document.title="Constant Field Values (Amazon S3 Encryption Client 2.5.0 API)";
2626
}
2727
}
2828
catch(err) {

deprecated-list.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (11.0.18) on Tue Mar 21 01:49:47 UTC 2023 -->
6-
<title>Deprecated List (Amazon S3 Encryption Client 2.4.1 API)</title>
5+
<!-- Generated by javadoc (11.0.18) on Thu Mar 23 06:54:47 UTC 2023 -->
6+
<title>Deprecated List (Amazon S3 Encryption Client 2.5.0 API)</title>
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8-
<meta name="dc.created" content="2023-03-21">
8+
<meta name="dc.created" content="2023-03-23">
99
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
1010
<link rel="stylesheet" type="text/css" href="jquery/jquery-ui.min.css" title="Style">
1111
<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
@@ -22,7 +22,7 @@
2222
<script type="text/javascript"><!--
2323
try {
2424
if (location.href.indexOf('is-external=true') == -1) {
25-
parent.document.title="Deprecated List (Amazon S3 Encryption Client 2.4.1 API)";
25+
parent.document.title="Deprecated List (Amazon S3 Encryption Client 2.5.0 API)";
2626
}
2727
}
2828
catch(err) {

help-doc.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (11.0.18) on Tue Mar 21 01:49:47 UTC 2023 -->
6-
<title>API Help (Amazon S3 Encryption Client 2.4.1 API)</title>
5+
<!-- Generated by javadoc (11.0.18) on Thu Mar 23 06:54:47 UTC 2023 -->
6+
<title>API Help (Amazon S3 Encryption Client 2.5.0 API)</title>
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8-
<meta name="dc.created" content="2023-03-21">
8+
<meta name="dc.created" content="2023-03-23">
99
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
1010
<link rel="stylesheet" type="text/css" href="jquery/jquery-ui.min.css" title="Style">
1111
<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
@@ -22,7 +22,7 @@
2222
<script type="text/javascript"><!--
2323
try {
2424
if (location.href.indexOf('is-external=true') == -1) {
25-
parent.document.title="API Help (Amazon S3 Encryption Client 2.4.1 API)";
25+
parent.document.title="API Help (Amazon S3 Encryption Client 2.5.0 API)";
2626
}
2727
}
2828
catch(err) {

index-all.html

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (11.0.18) on Tue Mar 21 01:49:47 UTC 2023 -->
6-
<title>Index (Amazon S3 Encryption Client 2.4.1 API)</title>
5+
<!-- Generated by javadoc (11.0.18) on Thu Mar 23 06:54:47 UTC 2023 -->
6+
<title>Index (Amazon S3 Encryption Client 2.5.0 API)</title>
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8-
<meta name="dc.created" content="2023-03-21">
8+
<meta name="dc.created" content="2023-03-23">
99
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
1010
<link rel="stylesheet" type="text/css" href="jquery/jquery-ui.min.css" title="Style">
1111
<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
@@ -22,7 +22,7 @@
2222
<script type="text/javascript"><!--
2323
try {
2424
if (location.href.indexOf('is-external=true') == -1) {
25-
parent.document.title="Index (Amazon S3 Encryption Client 2.4.1 API)";
25+
parent.document.title="Index (Amazon S3 Encryption Client 2.5.0 API)";
2626
}
2727
}
2828
catch(err) {
@@ -318,6 +318,8 @@ <h2 class="title">C</h2>
318318
</dd>
319319
<dt><span class="memberNameLink"><a href="software/amazon/encryption/s3/internal/CipherAsyncRequestBody.html#%3Cinit%3E(software.amazon.awssdk.core.async.AsyncRequestBody,java.lang.Long,software.amazon.encryption.s3.materials.CryptographicMaterials,byte%5B%5D)">CipherAsyncRequestBody(AsyncRequestBody, Long, CryptographicMaterials, byte[])</a></span> - Constructor for class software.amazon.encryption.s3.internal.<a href="software/amazon/encryption/s3/internal/CipherAsyncRequestBody.html" title="class in software.amazon.encryption.s3.internal">CipherAsyncRequestBody</a></dt>
320320
<dd>&nbsp;</dd>
321+
<dt><span class="memberNameLink"><a href="software/amazon/encryption/s3/internal/CipherAsyncRequestBody.html#%3Cinit%3E(software.amazon.awssdk.core.async.AsyncRequestBody,java.lang.Long,software.amazon.encryption.s3.materials.CryptographicMaterials,byte%5B%5D,boolean)">CipherAsyncRequestBody(AsyncRequestBody, Long, CryptographicMaterials, byte[], boolean)</a></span> - Constructor for class software.amazon.encryption.s3.internal.<a href="software/amazon/encryption/s3/internal/CipherAsyncRequestBody.html" title="class in software.amazon.encryption.s3.internal">CipherAsyncRequestBody</a></dt>
322+
<dd>&nbsp;</dd>
321323
<dt><span class="memberNameLink"><a href="software/amazon/encryption/s3/algorithms/AlgorithmSuite.html#cipherBlockSizeBytes()">cipherBlockSizeBytes()</a></span> - Method in enum software.amazon.encryption.s3.algorithms.<a href="software/amazon/encryption/s3/algorithms/AlgorithmSuite.html" title="enum in software.amazon.encryption.s3.algorithms">AlgorithmSuite</a></dt>
322324
<dd>&nbsp;</dd>
323325
<dt><a href="software/amazon/encryption/s3/internal/CipherInputStream.html" title="class in software.amazon.encryption.s3.internal"><span class="typeNameLink">CipherInputStream</span></a> - Class in <a href="software/amazon/encryption/s3/internal/package-summary.html">software.amazon.encryption.s3.internal</a></dt>
@@ -847,14 +849,10 @@ <h2 class="title">I</h2>
847849
<dd>&nbsp;</dd>
848850
<dt><span class="memberNameLink"><a href="software/amazon/encryption/s3/S3EncryptionClientUtilities.html#INSTRUCTION_FILE_SUFFIX">INSTRUCTION_FILE_SUFFIX</a></span> - Static variable in class software.amazon.encryption.s3.<a href="software/amazon/encryption/s3/S3EncryptionClientUtilities.html" title="class in software.amazon.encryption.s3">S3EncryptionClientUtilities</a></dt>
849851
<dd>&nbsp;</dd>
850-
<dt><span class="memberNameLink"><a href="software/amazon/encryption/s3/S3EncryptionClient.html#IS_LAST_PART">IS_LAST_PART</a></span> - Static variable in class software.amazon.encryption.s3.<a href="software/amazon/encryption/s3/S3EncryptionClient.html" title="class in software.amazon.encryption.s3">S3EncryptionClient</a></dt>
851-
<dd>&nbsp;</dd>
852852
<dt><span class="memberNameLink"><a href="software/amazon/encryption/s3/internal/MultiFileOutputStream.html#isClosed()">isClosed()</a></span> - Method in class software.amazon.encryption.s3.internal.<a href="software/amazon/encryption/s3/internal/MultiFileOutputStream.html" title="class in software.amazon.encryption.s3.internal">MultiFileOutputStream</a></dt>
853853
<dd>&nbsp;</dd>
854854
<dt><span class="memberNameLink"><a href="software/amazon/encryption/s3/internal/PartCreationEvent.html#isLastPart()">isLastPart()</a></span> - Method in class software.amazon.encryption.s3.internal.<a href="software/amazon/encryption/s3/internal/PartCreationEvent.html" title="class in software.amazon.encryption.s3.internal">PartCreationEvent</a></dt>
855855
<dd>&nbsp;</dd>
856-
<dt><span class="memberNameLink"><a href="software/amazon/encryption/s3/S3EncryptionClient.html#isLastPart(java.lang.Boolean)">isLastPart(Boolean)</a></span> - Static method in class software.amazon.encryption.s3.<a href="software/amazon/encryption/s3/S3EncryptionClient.html" title="class in software.amazon.encryption.s3">S3EncryptionClient</a></dt>
857-
<dd>&nbsp;</dd>
858856
<dt><span class="memberNameLink"><a href="software/amazon/encryption/s3/algorithms/AlgorithmSuite.html#isLegacy()">isLegacy()</a></span> - Method in enum software.amazon.encryption.s3.algorithms.<a href="software/amazon/encryption/s3/algorithms/AlgorithmSuite.html" title="enum in software.amazon.encryption.s3.algorithms">AlgorithmSuite</a></dt>
859857
<dd>&nbsp;</dd>
860858
<dt><span class="memberNameLink"><a href="software/amazon/encryption/s3/materials/DecryptDataKeyStrategy.html#isLegacy()">isLegacy()</a></span> - Method in interface software.amazon.encryption.s3.materials.<a href="software/amazon/encryption/s3/materials/DecryptDataKeyStrategy.html" title="interface in software.amazon.encryption.s3.materials">DecryptDataKeyStrategy</a></dt>
@@ -1283,6 +1281,8 @@ <h2 class="title">U</h2>
12831281
<dd>&nbsp;</dd>
12841282
<dt><span class="memberNameLink"><a href="software/amazon/encryption/s3/internal/UploadObjectObserver.html#uploadPart(software.amazon.awssdk.services.s3.model.UploadPartRequest,software.amazon.awssdk.core.async.AsyncRequestBody)">uploadPart(UploadPartRequest, AsyncRequestBody)</a></span> - Method in class software.amazon.encryption.s3.internal.<a href="software/amazon/encryption/s3/internal/UploadObjectObserver.html" title="class in software.amazon.encryption.s3.internal">UploadObjectObserver</a></dt>
12851283
<dd>&nbsp;</dd>
1284+
<dt><span class="memberNameLink"><a href="software/amazon/encryption/s3/internal/MultipartUploadObjectPipeline.html#uploadPart(software.amazon.awssdk.services.s3.model.UploadPartRequest,software.amazon.awssdk.core.sync.RequestBody)">uploadPart(UploadPartRequest, RequestBody)</a></span> - Method in class software.amazon.encryption.s3.internal.<a href="software/amazon/encryption/s3/internal/MultipartUploadObjectPipeline.html" title="class in software.amazon.encryption.s3.internal">MultipartUploadObjectPipeline</a></dt>
1285+
<dd>&nbsp;</dd>
12861286
<dt><span class="memberNameLink"><a href="software/amazon/encryption/s3/S3EncryptionClient.html#uploadPart(software.amazon.awssdk.services.s3.model.UploadPartRequest,software.amazon.awssdk.core.sync.RequestBody)">uploadPart(UploadPartRequest, RequestBody)</a></span> - Method in class software.amazon.encryption.s3.<a href="software/amazon/encryption/s3/S3EncryptionClient.html" title="class in software.amazon.encryption.s3">S3EncryptionClient</a></dt>
12871287
<dd>
12881288
<div class="block">
@@ -1291,8 +1291,6 @@ <h2 class="title">U</h2>
12911291
S3EncryptionClient (as opposed to the normal S3Client) must
12921292
be uploaded serially, and in order.</div>
12931293
</dd>
1294-
<dt><span class="memberNameLink"><a href="software/amazon/encryption/s3/internal/MultipartUploadObjectPipeline.html#uploadPart(software.amazon.awssdk.services.s3.model.UploadPartRequest,software.amazon.awssdk.core.sync.RequestBody,boolean)">uploadPart(UploadPartRequest, RequestBody, boolean)</a></span> - Method in class software.amazon.encryption.s3.internal.<a href="software/amazon/encryption/s3/internal/MultipartUploadObjectPipeline.html" title="class in software.amazon.encryption.s3.internal">MultipartUploadObjectPipeline</a></dt>
1295-
<dd>&nbsp;</dd>
12961294
</dl>
12971295
<a id="I:V">
12981296
<!-- -->
@@ -1322,12 +1320,16 @@ <h2 class="title">W</h2>
13221320
<dd>&nbsp;</dd>
13231321
<dt><span class="memberNameLink"><a href="software/amazon/encryption/s3/S3EncryptionClient.Builder.html#wrappedAsyncClient(software.amazon.awssdk.services.s3.S3AsyncClient)">wrappedAsyncClient(S3AsyncClient)</a></span> - Method in class software.amazon.encryption.s3.<a href="software/amazon/encryption/s3/S3EncryptionClient.Builder.html" title="class in software.amazon.encryption.s3">S3EncryptionClient.Builder</a></dt>
13241322
<dd>
1325-
<div class="block">Note that this does NOT create a defensive clone of S3AsyncClient.</div>
1323+
<div class="block">Sets the wrappedAsyncClient to be used for cryptographic operations.</div>
13261324
</dd>
13271325
<dt><span class="memberNameLink"><a href="software/amazon/encryption/s3/S3AsyncEncryptionClient.Builder.html#wrappedClient(software.amazon.awssdk.services.s3.S3AsyncClient)">wrappedClient(S3AsyncClient)</a></span> - Method in class software.amazon.encryption.s3.<a href="software/amazon/encryption/s3/S3AsyncEncryptionClient.Builder.html" title="class in software.amazon.encryption.s3">S3AsyncEncryptionClient.Builder</a></dt>
13281326
<dd>
13291327
<div class="block">Note that this does NOT create a defensive clone of S3Client.</div>
13301328
</dd>
1329+
<dt><span class="memberNameLink"><a href="software/amazon/encryption/s3/S3EncryptionClient.Builder.html#wrappedClient(software.amazon.awssdk.services.s3.S3Client)">wrappedClient(S3Client)</a></span> - Method in class software.amazon.encryption.s3.<a href="software/amazon/encryption/s3/S3EncryptionClient.Builder.html" title="class in software.amazon.encryption.s3">S3EncryptionClient.Builder</a></dt>
1330+
<dd>
1331+
<div class="block">Sets the wrappedClient to be used for non-cryptographic operations.</div>
1332+
</dd>
13311333
<dt><span class="memberNameLink"><a href="software/amazon/encryption/s3/materials/AesKeyring.Builder.html#wrappingKey(javax.crypto.SecretKey)">wrappingKey(SecretKey)</a></span> - Method in class software.amazon.encryption.s3.materials.<a href="software/amazon/encryption/s3/materials/AesKeyring.Builder.html" title="class in software.amazon.encryption.s3.materials">AesKeyring.Builder</a></dt>
13321334
<dd>&nbsp;</dd>
13331335
<dt><span class="memberNameLink"><a href="software/amazon/encryption/s3/materials/KmsKeyring.Builder.html#wrappingKeyId(java.lang.String)">wrappingKeyId(String)</a></span> - Method in class software.amazon.encryption.s3.materials.<a href="software/amazon/encryption/s3/materials/KmsKeyring.Builder.html" title="class in software.amazon.encryption.s3.materials">KmsKeyring.Builder</a></dt>

index.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (11.0.18) on Tue Mar 21 01:49:47 UTC 2023 -->
6-
<title>Overview (Amazon S3 Encryption Client 2.4.1 API)</title>
5+
<!-- Generated by javadoc (11.0.18) on Thu Mar 23 06:54:47 UTC 2023 -->
6+
<title>Overview (Amazon S3 Encryption Client 2.5.0 API)</title>
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
8-
<meta name="dc.created" content="2023-03-21">
8+
<meta name="dc.created" content="2023-03-23">
99
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
1010
<link rel="stylesheet" type="text/css" href="jquery/jquery-ui.min.css" title="Style">
1111
<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
@@ -22,7 +22,7 @@
2222
<script type="text/javascript"><!--
2323
try {
2424
if (location.href.indexOf('is-external=true') == -1) {
25-
parent.document.title="Overview (Amazon S3 Encryption Client 2.4.1 API)";
25+
parent.document.title="Overview (Amazon S3 Encryption Client 2.5.0 API)";
2626
}
2727
}
2828
catch(err) {
@@ -95,7 +95,7 @@
9595
</header>
9696
<main role="main">
9797
<div class="header">
98-
<h1 class="title">Amazon S3 Encryption Client 2.4.1 API</h1>
98+
<h1 class="title">Amazon S3 Encryption Client 2.5.0 API</h1>
9999
</div>
100100
<div class="contentContainer">
101101
<table class="overviewSummary">

member-search-index.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

member-search-index.zip

-22 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)