Skip to content

Commit b47aacc

Browse files
committed
Move to Javadoc
1 parent af60136 commit b47aacc

File tree

1 file changed

+7
-8
lines changed

1 file changed

+7
-8
lines changed

modules/repository-s3/src/main/java/org/elasticsearch/repositories/s3/RegionFromEndpointGuesser.java

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,16 +23,15 @@
2323
import java.util.Map;
2424

2525
/**
26-
* Simple mapping from S3 endpoint hostnames to AWS region names, in case the user does not specify a region.
26+
* Simple mapping from S3 endpoint hostnames to AWS region names, in case the user does not specify a region. This allows Elasticsearch to
27+
* guess an appropriate AWS region name, and keep working, if a user does not specify one. This is a best-effort attempt for backwards
28+
* compatibility: AWS SDK V1 would extrapolate the correct region but V2 considers it a fatal error not to be told the region name
29+
* explicitly.
30+
* <p>
31+
* The mapping is loaded from the JAR resource named {@code regions_by_endpoint.txt}.
32+
* </p>
2733
*/
2834
class RegionFromEndpointGuesser {
29-
/*
30-
* Loads JAR resource "regions_by_endpoint.txt" into a map from S3 endpoint hostnames to AWS region names, in case the user specifies a
31-
* regional endpoint but not a region. This allows Elasticsearch to guess an appropriate AWS region name, and keep working, if a user
32-
* does not specify one. This is a best-effort attempt for backwards compatibility: AWS SDK V1 would extrapolate the correct region but
33-
* V2 considers it a fatal error not to be told the region name explicitly.
34-
*/
35-
3635
private static final Map<String, String> regionsByEndpoint;
3736

3837
static {

0 commit comments

Comments
 (0)