Skip to content
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.

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

Update Javadoc of premium SDK for azure-resourcemanager-privatedns #43612

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,6 @@

--add-opens com.azure.core/com.azure.core.implementation.util=ALL-UNNAMED
</javaModulesSurefireArgLine>
<doclintMissingInclusion>-</doclintMissingInclusion>
</properties>

<developers>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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<String> ipv4Addresses();
}
Original file line number Diff line number Diff line change
Expand Up @@ -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<String> ipv6Addresses();
}
Original file line number Diff line number Diff line change
Expand Up @@ -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();
}
Original file line number Diff line number Diff line change
Expand Up @@ -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<MxRecord> records();
}
Original file line number Diff line number Diff line change
Expand Up @@ -17,31 +17,44 @@
public interface PrivateDnsRecordSet
extends ExternalChildResource<PrivateDnsRecordSet, PrivateDnsZone>, HasInnerModel<RecordSetInner> {
/**
* 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<String, String> 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.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,51 +20,77 @@ public interface PrivateDnsZone extends GroupableResource<PrivateDnsZoneManager,
Refreshable<PrivateDnsZone>, Updatable<PrivateDnsZone.Update> {

/**
* 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<PrivateDnsRecordSet> 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<PrivateDnsRecordSet> listRecordSetsAsync();

/**
Expand Down Expand Up @@ -119,31 +145,67 @@ public interface PrivateDnsZone extends GroupableResource<PrivateDnsZoneManager,
*/
PagedFlux<PrivateDnsRecordSet> 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. */
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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<String> targetDomainNames();
}
Original file line number Diff line number Diff line change
Expand Up @@ -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();
}
Original file line number Diff line number Diff line change
Expand Up @@ -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<SrvRecord> records();
}
Original file line number Diff line number Diff line change
Expand Up @@ -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<TxtRecord> records();
}
Original file line number Diff line number Diff line change
Expand Up @@ -15,27 +15,38 @@
public interface VirtualNetworkLink
extends ExternalChildResource<VirtualNetworkLink, PrivateDnsZone>, HasInnerModel<VirtualNetworkLinkInner> {
/**
* 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();
Expand Down
Loading