Skip to content

Commit c2d7fb3

Browse files
authored
Add missing javadoc for withScyllaCloudConnectionConfig (#204)
Adds javadoc comments for each variation of `withScyllaCloudConnectionConfig` in `Cluster.Builder`
1 parent 31a7a72 commit c2d7fb3

File tree

1 file changed

+38
-0
lines changed
  • driver-core/src/main/java/com/datastax/driver/core

1 file changed

+38
-0
lines changed

driver-core/src/main/java/com/datastax/driver/core/Cluster.java

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1384,19 +1384,57 @@ public Builder withNoCompact() {
13841384
return this;
13851385
}
13861386

1387+
/**
1388+
* Configure for Scylla Cloud Serverless cluster using configuration bundle.
1389+
*
1390+
* @param configurationFile configuration bundle file.
1391+
* @return this builder.
1392+
* @throws IOException
1393+
* @see Builder#withScyllaCloudConnectionConfig(ScyllaCloudConnectionConfig)
1394+
*/
13871395
public Builder withScyllaCloudConnectionConfig(File configurationFile) throws IOException {
13881396
return withScyllaCloudConnectionConfig(configurationFile.toURI().toURL());
13891397
}
13901398

1399+
/**
1400+
* Configure for Scylla Cloud Serverless cluster using URL to configuration bundle.
1401+
*
1402+
* @param configurationUrl URL from which configuration bundle can be read.
1403+
* @return this builder.
1404+
* @throws IOException
1405+
* @see Builder#withScyllaCloudConnectionConfig(ScyllaCloudConnectionConfig)
1406+
*/
13911407
public Builder withScyllaCloudConnectionConfig(URL configurationUrl) throws IOException {
13921408
return withScyllaCloudConnectionConfig(configurationUrl.openStream());
13931409
}
13941410

1411+
/**
1412+
* Configure for Scylla Cloud Serverless cluster using InputStream of configuration bundle.
1413+
*
1414+
* @param inputStream input stream containing configuration bundle format data.
1415+
* @return this builder.
1416+
* @throws IOException
1417+
* @see Builder#withScyllaCloudConnectionConfig(ScyllaCloudConnectionConfig)
1418+
*/
13951419
public Builder withScyllaCloudConnectionConfig(InputStream inputStream) throws IOException {
13961420
return withScyllaCloudConnectionConfig(
13971421
ScyllaCloudConnectionConfig.fromInputStream(inputStream));
13981422
}
13991423

1424+
/**
1425+
* Sets a collection of options for connecting to Scylla Cloud Serverless cluster.
1426+
*
1427+
* <p>Sets several options according to provided {@link ScyllaCloudConnectionConfig}. This
1428+
* includes calling {@link Builder#withEndPointFactory(EndPointFactory)}, {@link
1429+
* Builder#withSSL(SSLOptions)}, {@link Builder#withAuthProvider(AuthProvider)}, {@link
1430+
* Builder#withoutAdvancedShardAwareness()} with parameters derived from the config.
1431+
*
1432+
* <p>Cannot be combined with {@link Builder#addContactPoint}. All contact points should already
1433+
* be provided in {@link ScyllaCloudConnectionConfig}.
1434+
*
1435+
* @param config instantiated ScyllaCloudConnectionConfig.
1436+
* @return this builder.
1437+
*/
14001438
protected Builder withScyllaCloudConnectionConfig(ScyllaCloudConnectionConfig config) {
14011439
try {
14021440
ScyllaCloudDatacenter currentDatacenter = config.getCurrentDatacenter();

0 commit comments

Comments
 (0)