From 6a0010e837942d3cf76ca150c11bd1677cbb09fc Mon Sep 17 00:00:00 2001 From: Muyao Feng <92105726+Netyyyy@users.noreply.github.com> Date: Thu, 2 Mar 2023 09:36:38 +0800 Subject: [PATCH] clarify properties (#33802) --- .../core/retry/AmqpRetryConfigurationProperties.java | 2 +- .../storage/blob/properties/AzureStorageBlobProperties.java | 6 ++++-- .../storage/common/AzureStorageProperties.java | 2 +- .../storage/common/StorageRetryConfigurationProperties.java | 4 ++-- .../queue/properties/AzureStorageQueueProperties.java | 2 +- .../META-INF/additional-spring-configuration-metadata.json | 2 +- .../queue/core/properties/StorageQueueProperties.java | 2 +- 7 files changed, 11 insertions(+), 9 deletions(-) diff --git a/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/properties/core/retry/AmqpRetryConfigurationProperties.java b/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/properties/core/retry/AmqpRetryConfigurationProperties.java index 6af8200495059..16171be3a8fe5 100644 --- a/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/properties/core/retry/AmqpRetryConfigurationProperties.java +++ b/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/properties/core/retry/AmqpRetryConfigurationProperties.java @@ -14,7 +14,7 @@ public class AmqpRetryConfigurationProperties extends RetryConfigurationProperties implements RetryOptionsProvider.AmqpRetryOptions { /** - * Amount of time to wait until a timeout. + * Amount of time(Duration) to wait until a timeout. */ private Duration tryTimeout; diff --git a/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/storage/blob/properties/AzureStorageBlobProperties.java b/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/storage/blob/properties/AzureStorageBlobProperties.java index e71c4fb7a97e2..a475d64b95ab4 100644 --- a/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/storage/blob/properties/AzureStorageBlobProperties.java +++ b/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/storage/blob/properties/AzureStorageBlobProperties.java @@ -17,11 +17,13 @@ public class AzureStorageBlobProperties extends AzureStorageProperties implement private static final String BLOB_ENDPOINT_PATTERN = "https://%s.blob%s"; /** - * Customer provided key used to encrypt blob contents on the server. + * Customer-provided encryption key(base64 encoded string) used to encrypt blob contents on the server. + * See Microsoft doc about Customer-provided Keys for more details: https://learn.microsoft.com/azure/storage/blobs/encryption-customer-provided-keys */ private String customerProvidedKey; /** - * Encryption scope used to encrypt blob contents on the server. + * Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. + * See Microsoft doc about Encryption Scope for more details: https://learn.microsoft.com/azure/storage/blobs/encryption-scope-overview */ private String encryptionScope; /** diff --git a/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/storage/common/AzureStorageProperties.java b/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/storage/common/AzureStorageProperties.java index 9ffcb8783c5b7..688fd252ee655 100644 --- a/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/storage/common/AzureStorageProperties.java +++ b/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/storage/common/AzureStorageProperties.java @@ -17,7 +17,7 @@ public class AzureStorageProperties extends AbstractAzureServiceConfigurationPro public static final String PREFIX = "spring.cloud.azure.storage"; /** - * Endpoint for Azure Storage service. + * Endpoint for Azure Storage service. For instance, 'https://{storage-account-name}.blob.storage.azure.net' for blob or 'https://{storage-account-name}.file.storage.azure.net' for file share or 'https://{storage-account-name}.queue.storage.azure.net' for queue. */ protected String endpoint; /** diff --git a/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/storage/common/StorageRetryConfigurationProperties.java b/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/storage/common/StorageRetryConfigurationProperties.java index d895bdfc2c0ab..4c4057f18c068 100644 --- a/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/storage/common/StorageRetryConfigurationProperties.java +++ b/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/storage/common/StorageRetryConfigurationProperties.java @@ -14,11 +14,11 @@ public class StorageRetryConfigurationProperties extends RetryConfigurationProperties implements StorageRetry { /** - * Secondary Storage account to retry requests against. + * Secondary Storage account to retry requests against if the primary region becomes unavailable. For instance, 'https://{storage-account-name}-secondary.file.storage.azure.net'. */ private String secondaryHost; /** - * Amount of time to wait until a timeout. + * Amount of time(Duration) to wait until a timeout. */ private Duration tryTimeout; diff --git a/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/storage/queue/properties/AzureStorageQueueProperties.java b/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/storage/queue/properties/AzureStorageQueueProperties.java index d7701bc3a4436..73912773f601f 100644 --- a/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/storage/queue/properties/AzureStorageQueueProperties.java +++ b/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/storage/queue/properties/AzureStorageQueueProperties.java @@ -21,7 +21,7 @@ public class AzureStorageQueueProperties extends AzureStorageProperties implemen */ private QueueServiceVersion serviceVersion; /** - * How queue message body is represented in HTTP requests and responses. + * How queue message body is represented in HTTP requests and responses. All Supported types are: NONE, BASE64. */ private QueueMessageEncoding messageEncoding; /** diff --git a/sdk/spring/spring-cloud-azure-autoconfigure/src/main/resources/META-INF/additional-spring-configuration-metadata.json b/sdk/spring/spring-cloud-azure-autoconfigure/src/main/resources/META-INF/additional-spring-configuration-metadata.json index 72eeca281306b..ffb8615299244 100644 --- a/sdk/spring/spring-cloud-azure-autoconfigure/src/main/resources/META-INF/additional-spring-configuration-metadata.json +++ b/sdk/spring/spring-cloud-azure-autoconfigure/src/main/resources/META-INF/additional-spring-configuration-metadata.json @@ -870,7 +870,7 @@ { "name": "spring.cloud.azure.servicebus.retry-options.try-timeout", "type": "java.time.Duration", - "description": "Amount of time to wait until a timeout. This is a legacy property.", + "description": "Amount of time(Duration) to wait until a timeout. This is a legacy property.", "deprecation": { "level": "error", "reason": "Deprecate to keep consistent with the unified configuration options.", diff --git a/sdk/spring/spring-messaging-azure-storage-queue/src/main/java/com/azure/spring/messaging/storage/queue/core/properties/StorageQueueProperties.java b/sdk/spring/spring-messaging-azure-storage-queue/src/main/java/com/azure/spring/messaging/storage/queue/core/properties/StorageQueueProperties.java index 48762856b3116..4f24bdb80609a 100644 --- a/sdk/spring/spring-messaging-azure-storage-queue/src/main/java/com/azure/spring/messaging/storage/queue/core/properties/StorageQueueProperties.java +++ b/sdk/spring/spring-messaging-azure-storage-queue/src/main/java/com/azure/spring/messaging/storage/queue/core/properties/StorageQueueProperties.java @@ -15,7 +15,7 @@ public class StorageQueueProperties extends AzureHttpSdkProperties implements Qu private static final String QUEUE_ENDPOINT_PATTERN = "https://%s.queue%s"; /** - * Endpoint for Azure Storage service. + * Endpoint for Azure Storage service. For instance, 'https://{storage-account-name}.queue.storage.azure.net'. */ private String endpoint; /**