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

Java doc , annotation, method naming scrub for compute, redis, batch, networking #1106

Merged
merged 14 commits into from
Sep 27, 2016
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 @@ -7,7 +7,6 @@
package com.microsoft.azure.management.batch;

import com.microsoft.azure.management.apigeneration.LangDefinition;
import com.microsoft.azure.management.apigeneration.Method;
import com.microsoft.azure.management.batch.implementation.ApplicationPackageInner;
import com.microsoft.azure.management.resources.fluentcore.arm.models.ExternalChildResource;
import com.microsoft.azure.management.resources.fluentcore.model.Wrapper;
Expand Down Expand Up @@ -56,13 +55,11 @@ public interface ApplicationPackage extends
*
* @param format format of the uploaded package supported values zip, tar
*/
@Method
void activate(String format);

/**
* Deletes the application package.
*/
@Method
void delete();
}

Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
package com.microsoft.azure.management.batch;

import com.microsoft.azure.management.apigeneration.LangDefinition;
import com.microsoft.azure.management.apigeneration.Method;
import com.microsoft.azure.management.batch.implementation.BatchAccountInner;
import com.microsoft.azure.management.resources.fluentcore.arm.models.GroupableResource;
import com.microsoft.azure.management.resources.fluentcore.arm.models.Resource;
Expand Down Expand Up @@ -69,6 +70,7 @@ public interface BatchAccount extends
/**
* @return the access keys for this batch account
*/
@Method
BatchAccountKeys refreshKeys();

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,47 +27,31 @@ public interface AvailabilitySet extends
Wrapper<AvailabilitySetInner>,
Updatable<AvailabilitySet.Update> {


/**
* Returns the update domain count of an availability set.
* <p>
* An update domain represents the group of virtual
* machines and underlying physical hardware that can be rebooted at the same time.
*
* @return the update domain count
* @return the update domain count of this availability set
*/
int updateDomainCount();

/**
* Returns the fault domain count of availability set.
* <p>
* A fault domain represents the group of virtual
* machines that shares common power source and network switch.
*
* @return the fault domain count
* @return the fault domain count of this availability set
*/
int faultDomainCount();

/**
* Lists the resource IDs of the virtual machines in the availability set.
*
* @return list of resource ID strings
* @return the resource IDs of the virtual machines in the availability set
*/
List<String> virtualMachineIds();

/**
* Lists the statuses of the existing virtual machines in the availability set.
*
* @return list of virtual machine statuses
* @return the statuses of the existing virtual machines in the availability set
*/
List<InstanceViewStatus> statuses();


/**************************************************************
* Fluent interfaces to create an AvailabilitySet
**************************************************************/
// Fluent interfaces

/**
* Container interface for all the definitions.
* Container interface for all the definitions related to an availability set.
*/
interface Definition extends
DefinitionStages.Blank,
Expand Down Expand Up @@ -98,7 +82,7 @@ interface WithUpdateDomainCount {
/**
* Specifies the update domain count for the availability set.
* @param updateDomainCount update domain count
* @return the next stage of the resource definition
* @return the next stage of the definition
*/
WithCreate withUpdateDomainCount(int updateDomainCount);
}
Expand All @@ -109,8 +93,8 @@ interface WithUpdateDomainCount {
interface WithFaultDomainCount {
/**
* Specifies the fault domain count for the availability set.
* @param faultDomainCount fault domain count
* @return the next stage of the resource definition
* @param faultDomainCount the fault domain count
* @return the next stage of the definition
*/
WithCreate withFaultDomainCount(int faultDomainCount);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@

import com.microsoft.azure.PagedList;
import com.microsoft.azure.management.apigeneration.Fluent;
import com.microsoft.azure.management.apigeneration.LangMethodDefinition;
import com.microsoft.azure.management.apigeneration.LangMethodDefinition.LangMethodType;
import com.microsoft.azure.management.apigeneration.Method;
import com.microsoft.azure.management.compute.implementation.VirtualMachineInner;
import com.microsoft.azure.management.network.Network;
import com.microsoft.azure.management.network.NetworkInterface;
Expand Down Expand Up @@ -92,6 +91,7 @@ public interface VirtualMachine extends
*
* @return the refreshed instance view
*/
@Method
VirtualMachineInstanceView refreshInstanceView();

// Getters
Expand Down Expand Up @@ -139,7 +139,6 @@ public interface VirtualMachine extends
*
* @return the public IP of the primary network interface
*/
@LangMethodDefinition(AsType = LangMethodType.Method)
PublicIpAddress getPrimaryPublicIpAddress();

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,18 +50,9 @@ public interface VirtualMachineDataDisk extends
String sourceImageUri();

/**
* Gets the create option used while creating this disk.
* <p>
* Possible values include: 'fromImage', 'empty', 'attach'
* 'fromImage' - if data disk was created from a user image
* 'attach' - if an existing vhd was usd to back the data disk
* 'empty' - if the disk was created as an empty disk
* when disk is created using 'fromImage' option, a copy of user image vhd will be created first
* and it will be used as the vhd to back the data disk.
*
* @return disk create option
* @return the creation method used while creating this disk
*/
DiskCreateOptionTypes createOption();
DiskCreateOptionTypes creationMethod();

// fluent (setters)

Expand Down Expand Up @@ -268,7 +259,7 @@ interface WithAttach<ParentT> extends Attachable.InDefinition<ParentT> {
/** The entirety of a data disk definition as part of a virtual machine update.
* @param <ParentT> the return type of the final {@link UpdateDefinitionStages.WithAttach#attach()}
*/
interface UpdateDefinition<ParentT> extends
interface UpdateDefinition<ParentT> extends
UpdateDefinitionStages.Blank<ParentT>,
UpdateDefinitionStages.WithAttach<ParentT>,
UpdateDefinitionStages.WithStoreAt<ParentT> {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,21 +49,16 @@ public interface VirtualMachineExtensionImage extends

/**
* @return the schema defined by publisher, where extension consumers should provide settings in a matching schema
* <p>
* Note this field will be null since server provide null for them
*/
String handlerSchema();

/**
* @return true if the extension can be used on xRP Virtual Machine ScaleSets.
* <p>
* Note by default existing extensions are usable on scale sets, but there might be cases where a publisher wants to
* explicitly indicate the extension is only enabled for Compute Resource Provider VMs but not Virtual Machine ScaleSets.
* @return true if the extension can be used with virtual machine scale sets, false otherwise
*/
boolean vmScaleSetEnabled();
boolean supportsVirtualMachineScaleSets();

/**
* @return true if the handler can support multiple extensions.
* @return true if the handler can support multiple extensions
*/
boolean supportsMultipleExtensions();

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,22 +44,22 @@ public interface VirtualMachineImage extends
String version();

/**
* @return the image reference representing publisher, offer, sku and version of the virtual machine image
* @return the image reference representing the publisher, offer, SKU and version of the virtual machine image
*/
ImageReference imageReference();

/**
* @return the purchase plan for the virtual machine image.
* @return the purchase plan for the virtual machine image
*/
PurchasePlan plan();

/**
* @return description of the OS Disk image in the virtual machine image.
* @return OS disk image in the virtual machine image
*/
OSDiskImage osDiskImage();

/**
* @return description of the Data disk images in the virtual machine.
* @return data disk images in the virtual machine image
*/
List<DataDiskImage> dataDiskImages();
}
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ public interface VirtualMachineOffer {
String name();

/**
* @return Virtual machine image SKUs available in this offer.
* @return virtual machine image SKUs available in this offer
*/
VirtualMachineSkus skus();
}
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
@Fluent
public interface VirtualMachinePublisher {
/**
* @return the region where virtual machine images from this publisher is available
* @return the region where virtual machine images from this publisher are available
*/
Region region();

Expand All @@ -29,7 +29,7 @@ public interface VirtualMachinePublisher {
VirtualMachineOffers offers();

/**
* @return the virtual machine image extensions from this publisher.
* @return the virtual machine image extensions from this publisher
*/
VirtualMachineExtensionImageTypes extensionTypes();
}
Loading