Skip to content

Commit ef20b7d

Browse files
committed
Add missing javadoc for withScyllaCloudConnectionConfig
1 parent b3f3eba commit ef20b7d

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
@@ -1385,19 +1385,57 @@ public Builder withNoCompact() {
13851385
return this;
13861386
}
13871387

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

1400+
/**
1401+
* Configure for Scylla Cloud Serverless cluster using URL to configuration bundle.
1402+
*
1403+
* @param configurationUrl
1404+
* @return
1405+
* @throws IOException
1406+
* @see Builder#withScyllaCloudConnectionConfig(ScyllaCloudConnectionConfig)
1407+
*/
13921408
public Builder withScyllaCloudConnectionConfig(URL configurationUrl) throws IOException {
13931409
return withScyllaCloudConnectionConfig(configurationUrl.openStream());
13941410
}
13951411

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

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

0 commit comments

Comments
 (0)