Skip to content

App Configuration - Added Description #49351

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mrm9084 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

App Configuration - Added Description #49351

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions sdk/appconfiguration/azure-data-appconfiguration/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
### Features Added

- Added `checkConfigurationSettings` method to `ConfigurationClient` and `ConfigurationAsyncClient` that performs HEAD requests to efficiently check if configuration settings have changed by comparing page-level ETags without retrieving the full response body.
- Added `description` property to `ConfigurationSetting` and `ConfigurationSnapshot`, along with corresponding `DESCRIPTION` values on `SettingFields` and `SnapshotFields`.

### Breaking Changes

Expand Down
2 changes: 1 addition & 1 deletion sdk/appconfiguration/azure-data-appconfiguration/assets.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
"AssetsRepo": "Azure/azure-sdk-assets",
"AssetsRepoPrefixPath": "java",
"TagPrefix": "java/appconfiguration/azure-data-appconfiguration",
"Tag": "java/appconfiguration/azure-data-appconfiguration_3dbe0483cd"
"Tag": "java/appconfiguration/azure-data-appconfiguration_e077cad6cf"
}
42 changes: 42 additions & 0 deletions ...src/main/java/com/azure/data/appconfiguration/implementation/ConfigurationClientImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1005,6 +1005,7 @@ public Response<Void> checkKeysWithResponse(RequestOptions requestOptions) {
* tags (Optional): {
* String: String (Required)
* }
* description: String (Optional)
* locked: Boolean (Optional)
* etag: String (Optional)
* }
Expand Down Expand Up @@ -1081,6 +1082,7 @@ public Mono<PagedResponse<BinaryData>> listConfigurationSettingsSinglePageAsync(
* tags (Optional): {
* String: String (Required)
* }
* description: String (Optional)
* locked: Boolean (Optional)
* etag: String (Optional)
* }
Expand Down Expand Up @@ -1156,6 +1158,7 @@ public PagedFlux<BinaryData> listConfigurationSettingsAsync(RequestOptions reque
* tags (Optional): {
* String: String (Required)
* }
* description: String (Optional)
* locked: Boolean (Optional)
* etag: String (Optional)
* }
Expand Down Expand Up @@ -1231,6 +1234,7 @@ public PagedResponse<BinaryData> listConfigurationSettingsSinglePage(RequestOpti
* tags (Optional): {
* String: String (Required)
* }
* description: String (Optional)
* locked: Boolean (Optional)
* etag: String (Optional)
* }
Expand Down Expand Up @@ -1405,6 +1409,7 @@ public Response<Void> checkKeyValuesWithResponse(RequestOptions requestOptions)
* tags (Optional): {
* String: String (Required)
* }
* description: String (Optional)
* locked: Boolean (Optional)
* etag: String (Optional)
* }
Expand Down Expand Up @@ -1470,6 +1475,7 @@ public Mono<Response<BinaryData>> getKeyValueWithResponseAsync(String key, Reque
* tags (Optional): {
* String: String (Required)
* }
* description: String (Optional)
* locked: Boolean (Optional)
* etag: String (Optional)
* }
Expand Down Expand Up @@ -1527,6 +1533,7 @@ public Response<BinaryData> getKeyValueWithResponse(String key, RequestOptions r
* tags (Optional): {
* String: String (Required)
* }
* description: String (Optional)
* locked: Boolean (Optional)
* etag: String (Optional)
* }
Expand All @@ -1546,6 +1553,7 @@ public Response<BinaryData> getKeyValueWithResponse(String key, RequestOptions r
* tags (Optional): {
* String: String (Required)
* }
* description: String (Optional)
* locked: Boolean (Optional)
* etag: String (Optional)
* }
Expand Down Expand Up @@ -1611,6 +1619,7 @@ public Mono<Response<BinaryData>> setConfigurationSettingWithResponseAsync(Strin
* tags (Optional): {
* String: String (Required)
* }
* description: String (Optional)
* locked: Boolean (Optional)
* etag: String (Optional)
* }
Expand All @@ -1630,6 +1639,7 @@ public Mono<Response<BinaryData>> setConfigurationSettingWithResponseAsync(Strin
* tags (Optional): {
* String: String (Required)
* }
* description: String (Optional)
* locked: Boolean (Optional)
* etag: String (Optional)
* }
Expand Down Expand Up @@ -1690,6 +1700,7 @@ public Response<BinaryData> setConfigurationSettingWithResponse(String key, Requ
* tags (Optional): {
* String: String (Required)
* }
* description: String (Optional)
* locked: Boolean (Optional)
* etag: String (Optional)
* }
Expand Down Expand Up @@ -1746,6 +1757,7 @@ public Mono<Response<BinaryData>> deleteConfigurationSettingWithResponseAsync(St
* tags (Optional): {
* String: String (Required)
* }
* description: String (Optional)
* locked: Boolean (Optional)
* etag: String (Optional)
* }
Expand Down Expand Up @@ -1908,6 +1920,7 @@ public Response<Void> checkKeyValueWithResponse(String key, RequestOptions reque
* tags (Optional): {
* String: String (Required)
* }
* description: String (Optional)
* etag: String (Optional)
* }
* }
Expand Down Expand Up @@ -1979,6 +1992,7 @@ public Mono<PagedResponse<BinaryData>> getSnapshotsSinglePageAsync(RequestOption
* tags (Optional): {
* String: String (Required)
* }
* description: String (Optional)
* etag: String (Optional)
* }
* }
Expand Down Expand Up @@ -2049,6 +2063,7 @@ public PagedFlux<BinaryData> getSnapshotsAsync(RequestOptions requestOptions) {
* tags (Optional): {
* String: String (Required)
* }
* description: String (Optional)
* etag: String (Optional)
* }
* }
Expand Down Expand Up @@ -2119,6 +2134,7 @@ public PagedResponse<BinaryData> getSnapshotsSinglePage(RequestOptions requestOp
* tags (Optional): {
* String: String (Required)
* }
* description: String (Optional)
* etag: String (Optional)
* }
* }
Expand Down Expand Up @@ -2255,6 +2271,7 @@ public Response<Void> checkSnapshotsWithResponse(RequestOptions requestOptions)
* tags (Optional): {
* String: String (Required)
* }
* description: String (Optional)
* etag: String (Optional)
* }
* }
Expand Down Expand Up @@ -2324,6 +2341,7 @@ public Mono<Response<BinaryData>> getSnapshotWithResponseAsync(String name, Requ
* tags (Optional): {
* String: String (Required)
* }
* description: String (Optional)
* etag: String (Optional)
* }
* }
Expand Down Expand Up @@ -2461,6 +2479,7 @@ public Response<BinaryData> getOperationDetailsWithResponse(String snapshot, Req
* tags (Optional): {
* String: String (Required)
* }
* description: String (Optional)
* etag: String (Optional)
* }
* }
Expand Down Expand Up @@ -2491,6 +2510,7 @@ public Response<BinaryData> getOperationDetailsWithResponse(String snapshot, Req
* tags (Optional): {
* String: String (Required)
* }
* description: String (Optional)
* etag: String (Optional)
* }
* }
Expand Down Expand Up @@ -2551,6 +2571,7 @@ public Mono<Response<BinaryData>> createSnapshotWithResponseAsync(String content
* tags (Optional): {
* String: String (Required)
* }
* description: String (Optional)
* etag: String (Optional)
* }
* }
Expand Down Expand Up @@ -2581,6 +2602,7 @@ public Mono<Response<BinaryData>> createSnapshotWithResponseAsync(String content
* tags (Optional): {
* String: String (Required)
* }
* description: String (Optional)
* etag: String (Optional)
* }
* }
Expand Down Expand Up @@ -2641,6 +2663,7 @@ public Response<BinaryData> createSnapshotWithResponse(String contentType, Strin
* tags (Optional): {
* String: String (Required)
* }
* description: String (Optional)
* etag: String (Optional)
* }
* }
Expand Down Expand Up @@ -2671,6 +2694,7 @@ public Response<BinaryData> createSnapshotWithResponse(String contentType, Strin
* tags (Optional): {
* String: String (Required)
* }
* description: String (Optional)
* etag: String (Optional)
* }
* }
Expand Down Expand Up @@ -2737,6 +2761,7 @@ public PollerFlux<BinaryData, BinaryData> beginCreateSnapshotAsync(String conten
* tags (Optional): {
* String: String (Required)
* }
* description: String (Optional)
* etag: String (Optional)
* }
* }
Expand Down Expand Up @@ -2767,6 +2792,7 @@ public PollerFlux<BinaryData, BinaryData> beginCreateSnapshotAsync(String conten
* tags (Optional): {
* String: String (Required)
* }
* description: String (Optional)
* etag: String (Optional)
* }
* }
Expand Down Expand Up @@ -2849,6 +2875,7 @@ public SyncPoller<BinaryData, BinaryData> beginCreateSnapshot(String contentType
* tags (Optional): {
* String: String (Required)
* }
* description: String (Optional)
* etag: String (Optional)
* }
* }
Expand Down Expand Up @@ -2924,6 +2951,7 @@ public Mono<Response<BinaryData>> updateSnapshotWithResponseAsync(String content
* tags (Optional): {
* String: String (Required)
* }
* description: String (Optional)
* etag: String (Optional)
* }
* }
Expand Down Expand Up @@ -3329,6 +3357,7 @@ public Response<Void> checkLabelsWithResponse(RequestOptions requestOptions) {
* tags (Optional): {
* String: String (Required)
* }
* description: String (Optional)
* locked: Boolean (Optional)
* etag: String (Optional)
* }
Expand Down Expand Up @@ -3387,6 +3416,7 @@ public Mono<Response<BinaryData>> putLockWithResponseAsync(String key, RequestOp
* tags (Optional): {
* String: String (Required)
* }
* description: String (Optional)
* locked: Boolean (Optional)
* etag: String (Optional)
* }
Expand Down Expand Up @@ -3444,6 +3474,7 @@ public Response<BinaryData> putLockWithResponse(String key, RequestOptions reque
* tags (Optional): {
* String: String (Required)
* }
* description: String (Optional)
* locked: Boolean (Optional)
* etag: String (Optional)
* }
Expand Down Expand Up @@ -3502,6 +3533,7 @@ public Mono<Response<BinaryData>> deleteLockWithResponseAsync(String key, Reques
* tags (Optional): {
* String: String (Required)
* }
* description: String (Optional)
* locked: Boolean (Optional)
* etag: String (Optional)
* }
Expand Down Expand Up @@ -3567,6 +3599,7 @@ public Response<BinaryData> deleteLockWithResponse(String key, RequestOptions re
* tags (Optional): {
* String: String (Required)
* }
* description: String (Optional)
* locked: Boolean (Optional)
* etag: String (Optional)
* }
Expand Down Expand Up @@ -3634,6 +3667,7 @@ public Mono<PagedResponse<BinaryData>> getRevisionsSinglePageAsync(RequestOption
* tags (Optional): {
* String: String (Required)
* }
* description: String (Optional)
* locked: Boolean (Optional)
* etag: String (Optional)
* }
Expand Down Expand Up @@ -3700,6 +3734,7 @@ public PagedFlux<BinaryData> getRevisionsAsync(RequestOptions requestOptions) {
* tags (Optional): {
* String: String (Required)
* }
* description: String (Optional)
* locked: Boolean (Optional)
* etag: String (Optional)
* }
Expand Down Expand Up @@ -3766,6 +3801,7 @@ public PagedResponse<BinaryData> getRevisionsSinglePage(RequestOptions requestOp
* tags (Optional): {
* String: String (Required)
* }
* description: String (Optional)
* locked: Boolean (Optional)
* etag: String (Optional)
* }
Expand Down Expand Up @@ -3996,6 +4032,7 @@ public PagedResponse<BinaryData> getKeysNextSinglePage(String nextLink, RequestO
* tags (Optional): {
* String: String (Required)
* }
* description: String (Optional)
* locked: Boolean (Optional)
* etag: String (Optional)
* }
Expand Down Expand Up @@ -4055,6 +4092,7 @@ public Mono<PagedResponse<BinaryData>> listConfigurationSettingsNextSinglePageAs
* tags (Optional): {
* String: String (Required)
* }
* description: String (Optional)
* locked: Boolean (Optional)
* etag: String (Optional)
* }
Expand Down Expand Up @@ -4116,6 +4154,7 @@ public PagedResponse<BinaryData> listConfigurationSettingsNextSinglePage(String
* tags (Optional): {
* String: String (Required)
* }
* description: String (Optional)
* etag: String (Optional)
* }
* }
Expand Down Expand Up @@ -4177,6 +4216,7 @@ public Mono<PagedResponse<BinaryData>> getSnapshotsNextSinglePageAsync(String ne
* tags (Optional): {
* String: String (Required)
* }
* description: String (Optional)
* etag: String (Optional)
* }
* }
Expand Down Expand Up @@ -4313,6 +4353,7 @@ public PagedResponse<BinaryData> getLabelsNextSinglePage(String nextLink, Reques
* tags (Optional): {
* String: String (Required)
* }
* description: String (Optional)
* locked: Boolean (Optional)
* etag: String (Optional)
* }
Expand Down Expand Up @@ -4366,6 +4407,7 @@ public Mono<PagedResponse<BinaryData>> getRevisionsNextSinglePageAsync(String ne
* tags (Optional): {
* String: String (Required)
* }
* description: String (Optional)
* locked: Boolean (Optional)
* etag: String (Optional)
* }
Expand Down
6 changes: 4 additions & 2 deletions ...azure/data/appconfiguration/implementation/ConfigurationSettingDeserializationHelper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,8 @@ public static ConfigurationSetting toConfigurationSetting(KeyValue keyValue) {
.setLabel(label)
.setContentType(contentType)
.setETag(etag)
.setTags(tags);
.setTags(tags)
.setDescription(keyValue.getDescription());
Comment on lines 79 to +83
ConfigurationSettingHelper.setLastModified(setting, keyValue.getLastModified());
ConfigurationSettingHelper.setReadOnly(setting, keyValue.isLocked() != null && keyValue.isLocked());
try {
Expand All @@ -97,7 +98,8 @@ public static ConfigurationSetting toConfigurationSetting(KeyValue keyValue) {
.setLabel(label)
.setETag(etag)
.setContentType(contentType)
.setTags(tags);
.setTags(tags)
.setDescription(setting.getDescription());
} else {
// Configuration Setting
return setting;
Expand Down
3 changes: 2 additions & 1 deletion ...ppconfiguration/src/main/java/com/azure/data/appconfiguration/implementation/Utility.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,8 @@ public static KeyValue toKeyValue(ConfigurationSetting setting) {
.setEtag(setting.getETag())
.setLastModified(setting.getLastModified())
.setLocked(setting.isReadOnly())
.setTags(setting.getTags());
.setTags(setting.getTags())
.setDescription(setting.getDescription());
}

// SettingFields[] to List<SettingFields>
Expand Down
Loading