From a9b7be7930a4fa06d9ff7afec5d9b6a617565006 Mon Sep 17 00:00:00 2001 From: "Hong Li(MSFT)" <74638143+v-hongli1@users.noreply.github.com> Date: Thu, 26 Dec 2024 13:46:31 +0800 Subject: [PATCH] Update Javadoc of premium SDK for azure-resourcemanager-privatedns (#43612) --- .../azure-resourcemanager-privatedns/pom.xml | 1 - .../privatedns/PrivateDnsZoneManager.java | 2 + .../privatedns/models/ARecordSet.java | 6 +- .../privatedns/models/AaaaRecordSet.java | 6 +- .../privatedns/models/CnameRecordSet.java | 6 +- .../privatedns/models/MxRecordSet.java | 6 +- .../models/PrivateDnsRecordSet.java | 13 +++ .../privatedns/models/PrivateDnsZone.java | 84 ++++++++++++++++--- .../privatedns/models/PtrRecordSet.java | 6 +- .../privatedns/models/SoaRecordSet.java | 6 +- .../privatedns/models/SrvRecordSet.java | 6 +- .../privatedns/models/TxtRecordSet.java | 6 +- .../privatedns/models/VirtualNetworkLink.java | 11 +++ 13 files changed, 139 insertions(+), 20 deletions(-) diff --git a/sdk/resourcemanager/azure-resourcemanager-privatedns/pom.xml b/sdk/resourcemanager/azure-resourcemanager-privatedns/pom.xml index 7bf00dee3dd43..e0bf3f07c90ec 100644 --- a/sdk/resourcemanager/azure-resourcemanager-privatedns/pom.xml +++ b/sdk/resourcemanager/azure-resourcemanager-privatedns/pom.xml @@ -48,7 +48,6 @@ --add-opens com.azure.core/com.azure.core.implementation.util=ALL-UNNAMED - - diff --git a/sdk/resourcemanager/azure-resourcemanager-privatedns/src/main/java/com/azure/resourcemanager/privatedns/PrivateDnsZoneManager.java b/sdk/resourcemanager/azure-resourcemanager-privatedns/src/main/java/com/azure/resourcemanager/privatedns/PrivateDnsZoneManager.java index 290553b4b28f8..000b02a3d793f 100644 --- a/sdk/resourcemanager/azure-resourcemanager-privatedns/src/main/java/com/azure/resourcemanager/privatedns/PrivateDnsZoneManager.java +++ b/sdk/resourcemanager/azure-resourcemanager-privatedns/src/main/java/com/azure/resourcemanager/privatedns/PrivateDnsZoneManager.java @@ -84,6 +84,8 @@ private PrivateDnsZoneManager(HttpPipeline httpPipeline, AzureProfile profile) { } /** + * Gets the entry point to private DNS zone management. + * * @return the entry point to private DNS zone management. */ public PrivateDnsZones privateZones() { diff --git a/sdk/resourcemanager/azure-resourcemanager-privatedns/src/main/java/com/azure/resourcemanager/privatedns/models/ARecordSet.java b/sdk/resourcemanager/azure-resourcemanager-privatedns/src/main/java/com/azure/resourcemanager/privatedns/models/ARecordSet.java index 902fdc014814a..7d9f0e29d8adc 100644 --- a/sdk/resourcemanager/azure-resourcemanager-privatedns/src/main/java/com/azure/resourcemanager/privatedns/models/ARecordSet.java +++ b/sdk/resourcemanager/azure-resourcemanager-privatedns/src/main/java/com/azure/resourcemanager/privatedns/models/ARecordSet.java @@ -9,6 +9,10 @@ /** An immutable client-side representation of a A (IPv4) record set in Azure Private DNS Zone. */ @Fluent public interface ARecordSet extends PrivateDnsRecordSet { - /** @return the IP v4 addresses of A records in this record set */ + /** + * Gets the IP v4 addresses of A records in this record set. + * + * @return the IP v4 addresses of A records in this record set + */ List ipv4Addresses(); } diff --git a/sdk/resourcemanager/azure-resourcemanager-privatedns/src/main/java/com/azure/resourcemanager/privatedns/models/AaaaRecordSet.java b/sdk/resourcemanager/azure-resourcemanager-privatedns/src/main/java/com/azure/resourcemanager/privatedns/models/AaaaRecordSet.java index f084c50ff6dc0..a480f070132b3 100644 --- a/sdk/resourcemanager/azure-resourcemanager-privatedns/src/main/java/com/azure/resourcemanager/privatedns/models/AaaaRecordSet.java +++ b/sdk/resourcemanager/azure-resourcemanager-privatedns/src/main/java/com/azure/resourcemanager/privatedns/models/AaaaRecordSet.java @@ -9,6 +9,10 @@ /** An immutable client-side representation of a AAAA (IPv6) record set in Azure Private DNS Zone. */ @Fluent public interface AaaaRecordSet extends PrivateDnsRecordSet { - /** @return the IPv6 addresses of AAAA records in this record set */ + /** + * Gets the IPv6 addresses of AAAA records in this record set. + * + * @return the IPv6 addresses of AAAA records in this record set + */ List ipv6Addresses(); } diff --git a/sdk/resourcemanager/azure-resourcemanager-privatedns/src/main/java/com/azure/resourcemanager/privatedns/models/CnameRecordSet.java b/sdk/resourcemanager/azure-resourcemanager-privatedns/src/main/java/com/azure/resourcemanager/privatedns/models/CnameRecordSet.java index 2bd3ed44b4caf..379c74b0b0d6c 100644 --- a/sdk/resourcemanager/azure-resourcemanager-privatedns/src/main/java/com/azure/resourcemanager/privatedns/models/CnameRecordSet.java +++ b/sdk/resourcemanager/azure-resourcemanager-privatedns/src/main/java/com/azure/resourcemanager/privatedns/models/CnameRecordSet.java @@ -7,6 +7,10 @@ /** An immutable client-side representation of a CNAME (canonical name) record set in Azure Private DNS Zone. */ @Fluent public interface CnameRecordSet extends PrivateDnsRecordSet { - /** @return the canonical name (without a terminating dot) of CName record in this record set */ + /** + * Gets the canonical name (without a terminating dot) of CName record in this record set. + * + * @return the canonical name (without a terminating dot) of CName record in this record set + */ String canonicalName(); } diff --git a/sdk/resourcemanager/azure-resourcemanager-privatedns/src/main/java/com/azure/resourcemanager/privatedns/models/MxRecordSet.java b/sdk/resourcemanager/azure-resourcemanager-privatedns/src/main/java/com/azure/resourcemanager/privatedns/models/MxRecordSet.java index 2d3e43d3d9c15..20835280dee51 100644 --- a/sdk/resourcemanager/azure-resourcemanager-privatedns/src/main/java/com/azure/resourcemanager/privatedns/models/MxRecordSet.java +++ b/sdk/resourcemanager/azure-resourcemanager-privatedns/src/main/java/com/azure/resourcemanager/privatedns/models/MxRecordSet.java @@ -9,6 +9,10 @@ /** An immutable client-side representation of an MX (mail exchange) record set in an Azure Private DNS Zone. */ @Fluent public interface MxRecordSet extends PrivateDnsRecordSet { - /** @return the MX records in this record set */ + /** + * Gets the MX records in this record set. + * + * @return the MX records in this record set + */ List records(); } diff --git a/sdk/resourcemanager/azure-resourcemanager-privatedns/src/main/java/com/azure/resourcemanager/privatedns/models/PrivateDnsRecordSet.java b/sdk/resourcemanager/azure-resourcemanager-privatedns/src/main/java/com/azure/resourcemanager/privatedns/models/PrivateDnsRecordSet.java index 0206a1574cd72..8608a66f7e91c 100644 --- a/sdk/resourcemanager/azure-resourcemanager-privatedns/src/main/java/com/azure/resourcemanager/privatedns/models/PrivateDnsRecordSet.java +++ b/sdk/resourcemanager/azure-resourcemanager-privatedns/src/main/java/com/azure/resourcemanager/privatedns/models/PrivateDnsRecordSet.java @@ -17,31 +17,44 @@ public interface PrivateDnsRecordSet extends ExternalChildResource, HasInnerModel { /** + * Gets the type of the record set. + * * @return the type of the record set. */ RecordType recordType(); /** + * Gets the ETag of the record set. + * * @return the ETag of the record set. */ String etag(); /** + * Gets the metadata attached to the record set. + * * @return the metadata attached to the record set. */ Map metadata(); /** + * Gets the time-to-live of the records in the record set. + * * @return the time-to-live of the records in the record set. */ long timeToLive(); /** + * Gets the fully qualified domain name of the record set. + * * @return the fully qualified domain name of the record set. */ String fqdn(); /** + * Gets the property whether the record set is auto-registered in the private DNS zone + * through a virtual network link. + * * @return the property whether the record set is auto-registered in the private DNS zone * through a virtual network link. */ diff --git a/sdk/resourcemanager/azure-resourcemanager-privatedns/src/main/java/com/azure/resourcemanager/privatedns/models/PrivateDnsZone.java b/sdk/resourcemanager/azure-resourcemanager-privatedns/src/main/java/com/azure/resourcemanager/privatedns/models/PrivateDnsZone.java index 7d319a114878a..24c9ac7042745 100644 --- a/sdk/resourcemanager/azure-resourcemanager-privatedns/src/main/java/com/azure/resourcemanager/privatedns/models/PrivateDnsZone.java +++ b/sdk/resourcemanager/azure-resourcemanager-privatedns/src/main/java/com/azure/resourcemanager/privatedns/models/PrivateDnsZone.java @@ -20,51 +20,77 @@ public interface PrivateDnsZone extends GroupableResource, Updatable { /** + * Gets the ETag of the zone. + * * @return the ETag of the zone. */ String etag(); /** + * Gets the maximum number of record sets that can be created in this Private DNS zone. + * * @return the maximum number of record sets that can be created in this Private DNS zone. */ long maxNumberOfRecordSets(); /** + * Gets the numberOfRecordSets property. + * * @return the numberOfRecordSets property: The current number of record sets in this Private DNS zone. */ long numberOfRecordSets(); /** + * Gets the maximum number of virtual networks that can be linked to this Private DNS zone. + * * @return the maximum number of virtual networks that can be linked to this Private DNS zone. */ long maxNumberOfVirtualNetworkLinks(); /** + * Gets the current number of virtual networks that are linked to this Private DNS zone. + * * @return the current number of virtual networks that are linked to this Private DNS zone. */ long numberOfVirtualNetworkLinks(); /** + * Gets the maximum number of virtual networks that can be linked to this Private DNS zone + * with registration enabled. + * * @return the maximum number of virtual networks that can be linked to this Private DNS zone * with registration enabled. */ long maxNumberOfVirtualNetworkLinksWithRegistration(); /** + * Gets the current number of virtual networks that are linked to this Private DNS zone + * with registration enabled. + * * @return the current number of virtual networks that are linked to this Private DNS zone * with registration enabled. */ long numberOfVirtualNetworkLinksWithRegistration(); /** + * Gets the provisioning state of the resource. + * * @return the provisioning state of the resource. */ ProvisioningState provisioningState(); - /** @return the record sets in this zone. */ + /** + * Gets the record sets in this zone. + * + * @return the record sets in this zone. + */ PagedIterable listRecordSets(); - /** @return the record sets in this zone asynchronously. */ + /** + * Gets the record sets in this zone asynchronously. + * + * @return the record sets in this zone asynchronously. + */ PagedFlux listRecordSetsAsync(); /** @@ -119,31 +145,67 @@ public interface PrivateDnsZone extends GroupableResource listRecordSetsAsync(String recordSetNameSuffix, int pageSize); - /** @return entry point to manage record sets in this zone containing AAAA (IPv6 address) records */ + /** + * Gets entry point to manage record sets in this zone containing AAAA (IPv6 address) records. + * + * @return entry point to manage record sets in this zone containing AAAA (IPv6 address) records + */ AaaaRecordSets aaaaRecordSets(); - /** @return entry point to manage record sets in this zone containing A (IPv4 address) records */ + /** + * Gets entry point to manage record sets in this zone containing A (IPv4 address) records. + * + * @return entry point to manage record sets in this zone containing A (IPv4 address) records + */ ARecordSets aRecordSets(); - /** @return the CNAME (canonical name) record set */ + /** + * Gets the CNAME (canonical name) record set. + * + * @return the CNAME (canonical name) record set + */ CnameRecordSets cnameRecordSets(); - /** @return entry point to manage record sets in this zone containing MX (mail exchange) records */ + /** + * Gets entry point to manage record sets in this zone containing MX (mail exchange) records. + * + * @return entry point to manage record sets in this zone containing MX (mail exchange) records + */ MxRecordSets mxRecordSets(); - /** @return entry point to manage record sets in this zone containing PTR (pointer) records */ + /** + * Gets entry point to manage record sets in this zone containing PTR (pointer) records. + * + * @return entry point to manage record sets in this zone containing PTR (pointer) records + */ PtrRecordSets ptrRecordSets(); - /** @return the record set containing SOA (start of authority) record associated with this DNS zone */ + /** + * Gets the record set containing SOA (start of authority) record associated with this DNS zone. + * + * @return the record set containing SOA (start of authority) record associated with this DNS zone + */ SoaRecordSet getSoaRecordSet(); - /** @return entry point to manage record sets in this zone containing SRV (service) records */ + /** + * Gets entry point to manage record sets in this zone containing SRV (service) records. + * + * @return entry point to manage record sets in this zone containing SRV (service) records + */ SrvRecordSets srvRecordSets(); - /** @return entry point to manage record sets in this zone containing TXT (text) records */ + /** + * Gets entry point to manage record sets in this zone containing TXT (text) records. + * + * @return entry point to manage record sets in this zone containing TXT (text) records + */ TxtRecordSets txtRecordSets(); - /** @return entry point to manage virtual network links in this zone */ + /** + * Gets entry point to manage virtual network links in this zone. + * + * @return entry point to manage virtual network links in this zone + */ VirtualNetworkLinks virtualNetworkLinks(); /** The entirety of the private DNS zone definition. */ diff --git a/sdk/resourcemanager/azure-resourcemanager-privatedns/src/main/java/com/azure/resourcemanager/privatedns/models/PtrRecordSet.java b/sdk/resourcemanager/azure-resourcemanager-privatedns/src/main/java/com/azure/resourcemanager/privatedns/models/PtrRecordSet.java index acb84d2d7c58f..b494aa806cfd4 100644 --- a/sdk/resourcemanager/azure-resourcemanager-privatedns/src/main/java/com/azure/resourcemanager/privatedns/models/PtrRecordSet.java +++ b/sdk/resourcemanager/azure-resourcemanager-privatedns/src/main/java/com/azure/resourcemanager/privatedns/models/PtrRecordSet.java @@ -9,6 +9,10 @@ /** An immutable client-side representation of a PTR (pointer) record set in Azure Private DNS Zone. */ @Fluent public interface PtrRecordSet extends PrivateDnsRecordSet { - /** @return the target domain names of PTR records in this record set */ + /** + * Gets the target domain names of PTR records in this record set. + * + * @return the target domain names of PTR records in this record set + */ List targetDomainNames(); } diff --git a/sdk/resourcemanager/azure-resourcemanager-privatedns/src/main/java/com/azure/resourcemanager/privatedns/models/SoaRecordSet.java b/sdk/resourcemanager/azure-resourcemanager-privatedns/src/main/java/com/azure/resourcemanager/privatedns/models/SoaRecordSet.java index 6f3163b632a56..f1b97831e98b3 100644 --- a/sdk/resourcemanager/azure-resourcemanager-privatedns/src/main/java/com/azure/resourcemanager/privatedns/models/SoaRecordSet.java +++ b/sdk/resourcemanager/azure-resourcemanager-privatedns/src/main/java/com/azure/resourcemanager/privatedns/models/SoaRecordSet.java @@ -7,6 +7,10 @@ /** An immutable client-side representation of a SOA (start of authority) record set in Azure Private DNS Zone. */ @Fluent public interface SoaRecordSet extends PrivateDnsRecordSet { - /** @return the SOA record in this record set */ + /** + * Gets the SOA record in this record set. + * + * @return the SOA record in this record set + */ SoaRecord record(); } diff --git a/sdk/resourcemanager/azure-resourcemanager-privatedns/src/main/java/com/azure/resourcemanager/privatedns/models/SrvRecordSet.java b/sdk/resourcemanager/azure-resourcemanager-privatedns/src/main/java/com/azure/resourcemanager/privatedns/models/SrvRecordSet.java index 58524343a5cdf..d8019d604efd1 100644 --- a/sdk/resourcemanager/azure-resourcemanager-privatedns/src/main/java/com/azure/resourcemanager/privatedns/models/SrvRecordSet.java +++ b/sdk/resourcemanager/azure-resourcemanager-privatedns/src/main/java/com/azure/resourcemanager/privatedns/models/SrvRecordSet.java @@ -9,6 +9,10 @@ /** An immutable client-side representation of an SVR (service) record set in Azure Private DNS Zone. */ @Fluent public interface SrvRecordSet extends PrivateDnsRecordSet { - /** @return the SRV records in this record set */ + /** + * Gets the SRV records in this record set. + * + * @return the SRV records in this record set + */ List records(); } diff --git a/sdk/resourcemanager/azure-resourcemanager-privatedns/src/main/java/com/azure/resourcemanager/privatedns/models/TxtRecordSet.java b/sdk/resourcemanager/azure-resourcemanager-privatedns/src/main/java/com/azure/resourcemanager/privatedns/models/TxtRecordSet.java index cbea9e4c51891..6c6d484d890bc 100644 --- a/sdk/resourcemanager/azure-resourcemanager-privatedns/src/main/java/com/azure/resourcemanager/privatedns/models/TxtRecordSet.java +++ b/sdk/resourcemanager/azure-resourcemanager-privatedns/src/main/java/com/azure/resourcemanager/privatedns/models/TxtRecordSet.java @@ -9,6 +9,10 @@ /** An immutable client-side representation of a TXT (text) record set in Azure Private DNS Zone. */ @Fluent public interface TxtRecordSet extends PrivateDnsRecordSet { - /** @return the TXT records in this record set */ + /** + * Gets the TXT records in this record set. + * + * @return the TXT records in this record set + */ List records(); } diff --git a/sdk/resourcemanager/azure-resourcemanager-privatedns/src/main/java/com/azure/resourcemanager/privatedns/models/VirtualNetworkLink.java b/sdk/resourcemanager/azure-resourcemanager-privatedns/src/main/java/com/azure/resourcemanager/privatedns/models/VirtualNetworkLink.java index bda4aa924296f..a60da4117a782 100644 --- a/sdk/resourcemanager/azure-resourcemanager-privatedns/src/main/java/com/azure/resourcemanager/privatedns/models/VirtualNetworkLink.java +++ b/sdk/resourcemanager/azure-resourcemanager-privatedns/src/main/java/com/azure/resourcemanager/privatedns/models/VirtualNetworkLink.java @@ -15,27 +15,38 @@ public interface VirtualNetworkLink extends ExternalChildResource, HasInnerModel { /** + * Gets the ETag of the virtual network link. + * * @return the ETag of the virtual network link. */ String etag(); /** + * Gets the id of referenced virtual network. + * * @return the id of referenced virtual network. */ String referencedVirtualNetworkId(); /** + * Checks whether auto-registration of virtual machine records in the virtual network + * gets enabled in the private DNS zone. + * * @return whether auto-registration of virtual machine records in the virtual network * gets enabled in the private DNS zone. */ boolean isAutoRegistrationEnabled(); /** + * Gets the status of the virtual network link to the private DNS zone. + * * @return the status of the virtual network link to the private DNS zone. */ VirtualNetworkLinkState virtualNetworkLinkState(); /** + * Gets the provisioning state of the virtual network link. + * * @return the provisioning state of the virtual network link. */ ProvisioningState provisioningState();