From 44596f269fb084bcc04dc27029b18da419fd23cf Mon Sep 17 00:00:00 2001 From: anuchan Date: Wed, 21 Sep 2016 18:08:22 -0700 Subject: [PATCH] Addressing vmss::javadoc review comments --- .../compute/VirtualMachineScaleSet.java | 92 +++++++++---------- .../VirtualMachineScaleSetImpl.java | 4 +- ...VirtualMachineScaleSetOperationsTests.java | 8 +- 3 files changed, 52 insertions(+), 52 deletions(-) diff --git a/azure-mgmt-compute/src/main/java/com/microsoft/azure/management/compute/VirtualMachineScaleSet.java b/azure-mgmt-compute/src/main/java/com/microsoft/azure/management/compute/VirtualMachineScaleSet.java index 28558f7375ff..71d2ec540d89 100644 --- a/azure-mgmt-compute/src/main/java/com/microsoft/azure/management/compute/VirtualMachineScaleSet.java +++ b/azure-mgmt-compute/src/main/java/com/microsoft/azure/management/compute/VirtualMachineScaleSet.java @@ -123,7 +123,7 @@ public interface VirtualMachineScaleSet extends boolean overProvisionEnabled(); /** - * @return the sku of the virtual machines in the scale set + * @return the SKU of the virtual machines in the scale set */ VirtualMachineScaleSetSkuTypes sku(); @@ -137,14 +137,14 @@ public interface VirtualMachineScaleSet extends * in the scale set. *

* A primary internal load balancer associated with the primary network interfaces of the scale set - * virtual machine will be also belongs to this network + * virtual machine will be also belong to this network *

* @throws IOException the IO exception */ Network primaryNetwork() throws IOException; /** - * @return the internet facing load balancer associated with the primary network interface of + * @return the internet-facing load balancer associated with the primary network interface of * the virtual machines in the scale set. * * @throws IOException the IO exception @@ -152,15 +152,15 @@ public interface VirtualMachineScaleSet extends LoadBalancer primaryInternetFacingLoadBalancer() throws IOException; /** - * @return the internet facing load balancer's backends associated with the primary network interface + * @return the internet-facing load balancer's backends associated with the primary network interface * of the virtual machines in the scale set * * @throws IOException the IO exception */ - Map primaryInternetFacingLoadBalancerBackEnds() throws IOException; + Map primaryInternetFacingLoadBalancerBackends() throws IOException; /** - * @return the internet facing load balancer's inbound NAT pool associated with the primary network interface + * @return the internet-facing load balancer's inbound NAT pool associated with the primary network interface * of the virtual machines in the scale set * * @throws IOException the IO exception @@ -181,7 +181,7 @@ public interface VirtualMachineScaleSet extends * * @throws IOException the IO exception */ - Map primaryInternalLoadBalancerBackEnds() throws IOException; + Map primaryInternalLoadBalancerBackends() throws IOException; /** * @return the internal load balancer's inbound NAT pool associated with the primary network interface @@ -192,14 +192,14 @@ public interface VirtualMachineScaleSet extends Map primaryInternalLoadBalancerInboundNatPools() throws IOException; /** - * @return the list of ids of public Ip addresses associated with the primary internet facing load balancer + * @return the list of IDs of public Ip addresses associated with the primary internet-facing load balancer * of the scale set * @throws IOException the IO exception */ List primaryPublicIpAddressIds() throws IOException; /** - * @return the url to storage containers that stores vhds of virtual machines in the scale set + * @return the URL to storage containers that store vhds of virtual machines in the scale set */ List vhdContainers(); @@ -214,7 +214,7 @@ public interface VirtualMachineScaleSet extends VirtualMachineScaleSetNetworkProfile networkProfile(); /** - * @return the extensions attached to the Virtual Machines in the scale set + * @return the extensions attached to the virtual machines in the scale set */ Map extensions(); @@ -261,28 +261,28 @@ interface WithGroup } /** - * The stage of the virtual machine scale set definition allowing to specify Sku for the virtual machines. + * The stage of the virtual machine scale set definition allowing to specify SKU for the virtual machines. */ interface WithSku { /** - * Specifies sku for the virtual machines in the scale set. + * Specifies the SKU for the virtual machines in the scale set. * - * @param skuType the sku type + * @param skuType the SKU type * @return the stage representing creatable VM scale set definition */ WithNetworkSubnet withSku(VirtualMachineScaleSetSkuTypes skuType); /** - * Specifies sku for the virtual machines in the scale set. + * Specifies the SKU for the virtual machines in the scale set. * - * @param sku a sku from the list of available sizes for the virtual machines in this scale set + * @param sku a SKU from the list of available sizes for the virtual machines in this scale set * @return the stage representing creatable VM scale set definition */ WithNetworkSubnet withSku(VirtualMachineScaleSetSku sku); } /** - * The stage of the virtual machine scale set definition allowing to specify virtual network subnet for the + * The stage of the virtual machine scale set definition allowing to specify the virtual network subnet for the * primary network configuration. */ interface WithNetworkSubnet { @@ -299,14 +299,14 @@ interface WithNetworkSubnet { /** * The stage of the virtual machine scale set definition allowing to specify a public load balancer for - * the primary network interface of the scale set virtual machines. + * the primary network interface of the virtual machines in the scale set. */ interface WithPrimaryInternetFacingLoadBalancer { /** - * Specify the public load balancer where it's backends and/or NAT pools can be assigned to the primary network - * interface of the scale set virtual machines. + * Specify the Internet-facing load balancer whose backends and/or NAT pools can be assigned to the primary + * network interfaces of the virtual machines in the scale set. *

- * By default all the backend and inbound NAT pool of the load balancer will be associated with the primary + * By default all the backends and inbound NAT pools of the load balancer will be associated with the primary * network interface of the scale set virtual machines unless subset of them is selected in the next stages * {@link WithPrimaryInternetFacingLoadBalancerBackendOrNatPool}. *

@@ -316,7 +316,7 @@ interface WithPrimaryInternetFacingLoadBalancer { WithPrimaryInternetFacingLoadBalancerBackendOrNatPool withPrimaryInternetFacingLoadBalancer(LoadBalancer loadBalancer); /** - * Specifies that no public load balancer needs to be associated with virtual machine scale set. + * Specifies that no public load balancer needs to be associated with the virtual machine scale set. * * @return the next stage of the virtual machine scale set definition */ @@ -325,14 +325,14 @@ interface WithPrimaryInternetFacingLoadBalancer { /** * The stage of the virtual machine scale set definition allowing to specify an internal load balancer for - * the primary network interface of the scale set virtual machines. + * the primary network interface of the virtual machines in the scale set. */ interface WithPrimaryInternalLoadBalancer { /** * Specify the internal load balancer where it's backends and/or NAT pools can be assigned to the primary network * interface of the scale set virtual machines. *

- * By default all the backend and inbound NAT pool of the load balancer will be associated with the primary + * By default all the backends and inbound NAT pools of the load balancer will be associated with the primary * network interface of the scale set virtual machines unless subset of them is selected in the next stages * {@link WithInternalLoadBalancerBackendOrNatPool}. *

@@ -352,12 +352,12 @@ interface WithPrimaryInternalLoadBalancer { /** * The stage of the virtual machine scale set definition allowing to associate backend pool and/or inbound NAT pool - * of the internet facing load balancer selected in the previous state {@link WithPrimaryInternetFacingLoadBalancer} - * with the primary network interface of the scale set virtual machines. + * of the internet-facing load balancer selected in the previous state {@link WithPrimaryInternetFacingLoadBalancer} + * with the primary network interface of the virtual machines in the scale set. */ interface WithPrimaryInternetFacingLoadBalancerBackendOrNatPool extends WithPrimaryInternetFacingLoadBalancerNatPool { /** - * Associate internet facing load balancer backends with the primary network interface of the scale set virtual machines. + * Associate internet-facing load balancer backends with the primary network interface of the the virtual machines in the scale set. * * @param backendNames the backend names * @return the next stage of the virtual machine scale set definition @@ -372,7 +372,7 @@ interface WithPrimaryInternetFacingLoadBalancerBackendOrNatPool extends WithPrim */ interface WithPrimaryInternetFacingLoadBalancerNatPool extends WithPrimaryInternalLoadBalancer { /** - * Associate internet facing load balancer inbound NAT pools with the the primary network interface of the + * Associate internet-facing load balancer inbound NAT pools with the the primary network interface of the * scale set virtual machines. * * @param natPoolNames the inbound NAT pool names @@ -388,7 +388,7 @@ interface WithPrimaryInternetFacingLoadBalancerNatPool extends WithPrimaryIntern */ interface WithInternalLoadBalancerBackendOrNatPool extends WithCreate { /** - * Associate internal load balancer backends with the primary network interface of the scale set virtual machines. + * Associate internal load balancer backends with the primary network interface of the virtual machines in the scale set. * * @param backendNames the backend names * @return the next stage of the virtual machine scale set definition @@ -438,7 +438,7 @@ interface WithOS { /** * Specifies the version of a marketplace Windows image needs to be used. * - * @param imageReference describes publisher, offer, sku and version of the market-place image + * @param imageReference describes publisher, offer, SKU and version of the market-place image * @return the next stage of the virtual machine scale set definition */ WithAdminUserName withSpecificWindowsImageVersion(ImageReference imageReference); @@ -477,7 +477,7 @@ interface WithOS { /** * Specifies the version of a market-place Linux image needs to be used. * - * @param imageReference describes publisher, offer, sku and version of the market-place image + * @param imageReference describes publisher, offer, SKU and version of the market-place image * @return the next stage of the virtual machine scale set definition */ WithRootUserName withSpecificLinuxImageVersion(ImageReference imageReference); @@ -771,16 +771,16 @@ interface UpdateStages { */ interface WithPrimaryLoadBalancer extends WithPrimaryInternalLoadBalancer { /** - * Specifies load balancer to tbe used as the internet facing load balancer for the virtual machines in the + * Specifies load balancer to tbe used as the internet-facing load balancer for the virtual machines in the * scale set. *

- * This will replace the current internet facing load balancer associated with the virtual machines in the + * This will replace the current internet-facing load balancer associated with the virtual machines in the * scale set (if any). * By default all the backend and inbound NAT pool of the load balancer will be associated with the primary * network interface of the scale set virtual machines unless subset of them is selected in the next stages * {@link WithPrimaryInternetFacingLoadBalancerBackendOrNatPool}. *

- * @param loadBalancer the primary internet facing load balancer + * @param loadBalancer the primary internet-facing load balancer * @return the next stage of the virtual machine scale set update allowing to choose backends or inbound * nat pool from the load balancer. */ @@ -789,12 +789,12 @@ interface WithPrimaryLoadBalancer extends WithPrimaryInternalLoadBalancer { /** * The stage of the virtual machine scale set update allowing to associate backend pool and/or inbound NAT pool - * of the internet facing load balancer selected in the previous state {@link WithPrimaryLoadBalancer} + * of the internet-facing load balancer selected in the previous state {@link WithPrimaryLoadBalancer} * with the primary network interface of the scale set virtual machines. */ interface WithPrimaryInternetFacingLoadBalancerBackendOrNatPool extends WithPrimaryInternetFacingLoadBalancerNatPool { /** - * Associate internet facing load balancer backends with the primary network interface of the scale set virtual machines. + * Associate internet-facing load balancer backends with the primary network interface of the scale set virtual machines. * * @param backendNames the backend names * @return the next stage of the virtual machine scale set update allowing to choose inbound nat pool from @@ -810,7 +810,7 @@ interface WithPrimaryInternetFacingLoadBalancerBackendOrNatPool extends WithPrim */ interface WithPrimaryInternetFacingLoadBalancerNatPool extends WithPrimaryInternalLoadBalancer { /** - * Associate internet facing load balancer inbound NAT pools with the the primary network interface of the + * Associate internet-facing load balancer inbound NAT pools with the the primary network interface of the * scale set virtual machines. * * @param natPoolNames the inbound NAT pool names @@ -834,7 +834,7 @@ interface WithPrimaryInternalLoadBalancer extends WithApply { * network interface of the scale set virtual machines unless subset of them is selected in the next stages * {@link WithPrimaryInternalLoadBalancerBackendOrNatPool}. *

- * @param loadBalancer the primary internet facing load balancer + * @param loadBalancer the primary internet-facing load balancer * @return the next stage of the virtual machine scale set update allowing to choose backends or inbound * nat pool from the load balancer */ @@ -864,7 +864,7 @@ interface WithPrimaryInternalLoadBalancerBackendOrNatPool extends WithPrimaryInt */ interface WithPrimaryInternalLoadBalancerNatPool extends WithApply { /** - * Associate internet facing load balancer inbound NAT pools with the the primary network interface of the + * Associate internet-facing load balancer inbound NAT pools with the the primary network interface of the * scale set virtual machines. * * @param natPoolNames the inbound NAT pool names @@ -874,21 +874,21 @@ interface WithPrimaryInternalLoadBalancerNatPool extends WithApply { } /** - * The stage of the virtual machine scale set update allowing to change Sku for the virtual machines in the scale set. + * The stage of the virtual machine scale set update allowing to change SKU for the virtual machines in the scale set. */ interface WithSku { /** - * Specifies sku for the virtual machines in the scale set. + * Specifies the SKU for the virtual machines in the scale set. * - * @param skuType the sku type + * @param skuType the SKU type * @return the next stage of the virtual machine scale set update */ WithApply withSku(VirtualMachineScaleSetSkuTypes skuType); /** - * Specifies sku for the virtual machines in the scale set. + * Specifies the SKU for the virtual machines in the scale set. * - * @param sku a sku from the list of available sizes for the virtual machines in this scale set + * @param sku a SKU from the list of available sizes for the virtual machines in this scale set * @return the next stage of the virtual machine scale set update */ WithApply withSku(VirtualMachineScaleSetSku sku); @@ -945,7 +945,7 @@ interface WithExtension { */ interface WithoutPrimaryLoadBalancer { /** - * Remove the internet facing load balancer associated to the primary network interface configuration. + * Remove the internet-facing load balancer associated to the primary network interface configuration. *

* This removes the association between primary network interface configuration and all backend and * inbound NAT pools in the load balancer. @@ -973,7 +973,7 @@ interface WithoutPrimaryLoadBalancer { */ interface WithoutPrimaryLoadBalancerBackend { /** - * Removes association between the primary network interface configuration and backend of the internet facing + * Removes association between the primary network interface configuration and backend of the internet-facing * load balancer. * * @param backendNames the existing backend names to remove @@ -997,7 +997,7 @@ interface WithoutPrimaryLoadBalancerBackend { interface WithoutPrimaryLoadBalancerNatPool { /** * Removes association between the primary network interface configuration and inbound NAT pool of the - * internet facing load balancer. + * internet-facing load balancer. * * @param natPoolNames the name of an existing inbound NAT pools to remove * @return the next stage of the virtual machine scale set update diff --git a/azure-mgmt-compute/src/main/java/com/microsoft/azure/management/compute/implementation/VirtualMachineScaleSetImpl.java b/azure-mgmt-compute/src/main/java/com/microsoft/azure/management/compute/implementation/VirtualMachineScaleSetImpl.java index fd1672da35d1..2e2be227c00d 100644 --- a/azure-mgmt-compute/src/main/java/com/microsoft/azure/management/compute/implementation/VirtualMachineScaleSetImpl.java +++ b/azure-mgmt-compute/src/main/java/com/microsoft/azure/management/compute/implementation/VirtualMachineScaleSetImpl.java @@ -229,7 +229,7 @@ public LoadBalancer primaryInternetFacingLoadBalancer() throws IOException { } @Override - public Map primaryInternetFacingLoadBalancerBackEnds() throws IOException { + public Map primaryInternetFacingLoadBalancerBackends() throws IOException { if (this.primaryInternetFacingLoadBalancer() != null) { return getBackendsAssociatedWithIpConfiguration(this.primaryInternetFacingLoadBalancer, primaryNicDefaultIPConfiguration()); @@ -255,7 +255,7 @@ public LoadBalancer primaryInternalLoadBalancer() throws IOException { } @Override - public Map primaryInternalLoadBalancerBackEnds() throws IOException { + public Map primaryInternalLoadBalancerBackends() throws IOException { if (this.primaryInternalLoadBalancer() != null) { return getBackendsAssociatedWithIpConfiguration(this.primaryInternalLoadBalancer, primaryNicDefaultIPConfiguration()); diff --git a/azure-mgmt-compute/src/test/java/com/microsoft/azure/management/compute/VirtualMachineScaleSetOperationsTests.java b/azure-mgmt-compute/src/test/java/com/microsoft/azure/management/compute/VirtualMachineScaleSetOperationsTests.java index 307f0ad2f3ca..b7cbff894c4e 100644 --- a/azure-mgmt-compute/src/test/java/com/microsoft/azure/management/compute/VirtualMachineScaleSetOperationsTests.java +++ b/azure-mgmt-compute/src/test/java/com/microsoft/azure/management/compute/VirtualMachineScaleSetOperationsTests.java @@ -154,11 +154,11 @@ public void canCreateVirtualMachineScaleSet() throws Exception { .create(); Assert.assertNull(virtualMachineScaleSet.primaryInternalLoadBalancer()); - Assert.assertTrue(virtualMachineScaleSet.primaryInternalLoadBalancerBackEnds().size() == 0); + Assert.assertTrue(virtualMachineScaleSet.primaryInternalLoadBalancerBackends().size() == 0); Assert.assertTrue(virtualMachineScaleSet.primaryInternalLoadBalancerInboundNatPools().size() == 0); Assert.assertNotNull(virtualMachineScaleSet.primaryInternetFacingLoadBalancer()); - Assert.assertTrue(virtualMachineScaleSet.primaryInternetFacingLoadBalancerBackEnds().size() == 2); + Assert.assertTrue(virtualMachineScaleSet.primaryInternetFacingLoadBalancerBackends().size() == 2); Assert.assertTrue(virtualMachineScaleSet.primaryInternetFacingLoadBalancerInboundNatPools().size() == 2); Assert.assertNotNull(virtualMachineScaleSet.primaryNetwork()); @@ -193,11 +193,11 @@ public void canCreateVirtualMachineScaleSet() throws Exception { .getByGroup(RG_NAME, vmss_name); Assert.assertNotNull(virtualMachineScaleSet.primaryInternetFacingLoadBalancer()); - Assert.assertTrue(virtualMachineScaleSet.primaryInternetFacingLoadBalancerBackEnds().size() == 2); + Assert.assertTrue(virtualMachineScaleSet.primaryInternetFacingLoadBalancerBackends().size() == 2); Assert.assertTrue(virtualMachineScaleSet.primaryInternetFacingLoadBalancerInboundNatPools().size() == 1); Assert.assertNotNull(virtualMachineScaleSet.primaryInternalLoadBalancer()); - Assert.assertTrue(virtualMachineScaleSet.primaryInternalLoadBalancerBackEnds().size() == 2); + Assert.assertTrue(virtualMachineScaleSet.primaryInternalLoadBalancerBackends().size() == 2); Assert.assertTrue(virtualMachineScaleSet.primaryInternalLoadBalancerInboundNatPools().size() == 2); }