This is an automated email from the ASF dual-hosted git repository.
tustvold pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/arrow-rs.git
The following commit(s) were added to refs/heads/master by this push:
new 2460c88a33 docs(object_store): Mention `with_allow_http` in docs of
`with_endpoint` (#5275)
2460c88a33 is described below
commit 2460c88a331721ffd8ec204a46df69a49fee71c6
Author: Xuanwo <[email protected]>
AuthorDate: Wed Jan 3 18:59:17 2024 +0800
docs(object_store): Mention `with_allow_http` in docs of `with_endpoint`
(#5275)
Signed-off-by: Xuanwo <[email protected]>
---
object_store/src/aws/builder.rs | 3 +++
object_store/src/azure/builder.rs | 3 +++
2 files changed, 6 insertions(+)
diff --git a/object_store/src/aws/builder.rs b/object_store/src/aws/builder.rs
index 5e05b05f46..542f17af30 100644
--- a/object_store/src/aws/builder.rs
+++ b/object_store/src/aws/builder.rs
@@ -595,6 +595,9 @@ impl AmazonS3Builder {
/// i.e. if `virtual_hosted_style_request` is set to true then `endpoint`
/// should have the bucket name included.
///
+ /// By default, only HTTPS schemes are enabled. To connect to an HTTP
endpoint, enable
+ /// [`Self::with_allow_http`].
+ ///
/// [region endpoint]:
https://docs.aws.amazon.com/general/latest/gr/s3.html
pub fn with_endpoint(mut self, endpoint: impl Into<String>) -> Self {
self.endpoint = Some(endpoint.into());
diff --git a/object_store/src/azure/builder.rs
b/object_store/src/azure/builder.rs
index 2de0a7c05f..905fa5216f 100644
--- a/object_store/src/azure/builder.rs
+++ b/object_store/src/azure/builder.rs
@@ -687,6 +687,9 @@ impl MicrosoftAzureBuilder {
/// Override the endpoint used to communicate with blob storage
///
/// Defaults to `https://{account}.blob.core.windows.net`
+ ///
+ /// By default, only HTTPS schemes are enabled. To connect to an HTTP
endpoint, enable
+ /// [`Self::with_allow_http`].
pub fn with_endpoint(mut self, endpoint: String) -> Self {
self.endpoint = Some(endpoint);
self
