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-compute #43499

Merged
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 @@ -56,7 +56,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 @@ -70,17 +70,29 @@ public final class ComputeManager extends Manager<ComputeManagementClient> {
private GalleryImageVersions galleryImageVersions;
private DiskEncryptionSets diskEncryptionSets;

/** @return the storage manager */
/**
* Gets the storage manager.
*
* @return the storage manager
*/
public StorageManager storageManager() {
return storageManager;
}

/** @return the network manager */
/**
* Gets the network manager.
*
* @return the network manager
*/
public NetworkManager networkManager() {
return networkManager;
}

/** @return the authorization manager */
/**
* Gets the authorization manager.
*
* @return the authorization manager
*/
public AuthorizationManager authorizationManager() {
return authorizationManager;
}
Expand Down Expand Up @@ -151,23 +163,35 @@ private ComputeManager(HttpPipeline httpPipeline, AzureProfile profile) {
authorizationManager = AuthorizationManager.authenticate(httpPipeline, profile);
}

/** @return the availability set resource management API entry point */
/**
* Gets the availability set resource management API entry point.
*
* @return the availability set resource management API entry point
*/
public AvailabilitySets availabilitySets() {
if (availabilitySets == null) {
availabilitySets = new AvailabilitySetsImpl(this);
}
return availabilitySets;
}

/** @return the virtual machine resource management API entry point */
/**
* Gets the virtual machine resource management API entry point.
*
* @return the virtual machine resource management API entry point
*/
public VirtualMachines virtualMachines() {
if (virtualMachines == null) {
virtualMachines = new VirtualMachinesImpl(this, storageManager, networkManager, authorizationManager);
}
return virtualMachines;
}

/** @return the virtual machine image resource management API entry point */
/**
* Gets the virtual machine image resource management API entry point.
*
* @return the virtual machine image resource management API entry point
*/
public VirtualMachineImages virtualMachineImages() {
if (virtualMachineImages == null) {
virtualMachineImages = new VirtualMachineImagesImpl(
Expand All @@ -178,7 +202,11 @@ public VirtualMachineImages virtualMachineImages() {
return virtualMachineImages;
}

/** @return the virtual machine extension image resource management API entry point */
/**
* Gets the virtual machine extension image resource management API entry point.
*
* @return the virtual machine extension image resource management API entry point
*/
public VirtualMachineExtensionImages virtualMachineExtensionImages() {
if (virtualMachineExtensionImages == null) {
virtualMachineExtensionImages = new VirtualMachineExtensionImagesImpl(
Expand All @@ -188,7 +216,11 @@ public VirtualMachineExtensionImages virtualMachineExtensionImages() {
return virtualMachineExtensionImages;
}

/** @return the virtual machine scale set resource management API entry point */
/**
* Gets the virtual machine scale set resource management API entry point.
*
* @return the virtual machine scale set resource management API entry point
*/
public VirtualMachineScaleSets virtualMachineScaleSets() {
if (virtualMachineScaleSets == null) {
virtualMachineScaleSets
Expand All @@ -197,71 +229,107 @@ public VirtualMachineScaleSets virtualMachineScaleSets() {
return virtualMachineScaleSets;
}

/** @return the compute resource usage management API entry point */
/**
* Gets the compute resource usage management API entry point.
*
* @return the compute resource usage management API entry point
*/
public ComputeUsages usages() {
if (computeUsages == null) {
computeUsages = new ComputeUsagesImpl(this.serviceClient());
}
return computeUsages;
}

/** @return the virtual machine custom image management API entry point */
/**
* Gets the virtual machine custom image management API entry point.
*
* @return the virtual machine custom image management API entry point
*/
public VirtualMachineCustomImages virtualMachineCustomImages() {
if (virtualMachineCustomImages == null) {
virtualMachineCustomImages = new VirtualMachineCustomImagesImpl(this);
}
return virtualMachineCustomImages;
}

/** @return the managed disk management API entry point */
/**
* Gets the managed disk management API entry point.
*
* @return the managed disk management API entry point
*/
public Disks disks() {
if (disks == null) {
disks = new DisksImpl(this);
}
return disks;
}

/** @return the managed snapshot management API entry point */
/**
* Gets the managed snapshot management API entry point.
*
* @return the managed snapshot management API entry point
*/
public Snapshots snapshots() {
if (snapshots == null) {
snapshots = new SnapshotsImpl(this);
}
return snapshots;
}

/** @return the compute service SKU management API entry point */
/**
* Gets the compute service SKU management API entry point.
*
* @return the compute service SKU management API entry point
*/
public ComputeSkus computeSkus() {
if (computeSkus == null) {
computeSkus = new ComputeSkusImpl(this);
}
return computeSkus;
}

/** @return the compute service gallery management entry point */
/**
* Gets the compute service gallery management entry point.
*
* @return the compute service gallery management entry point
*/
public Galleries galleries() {
if (galleries == null) {
galleries = new GalleriesImpl(this);
}
return galleries;
}

/** @return the compute service gallery image management entry point */
/**
* Gets the compute service gallery image management entry point.
*
* @return the compute service gallery image management entry point
*/
public GalleryImages galleryImages() {
if (galleryImages == null) {
galleryImages = new GalleryImagesImpl(this);
}
return galleryImages;
}

/** @return the compute service gallery image version management entry point */
/**
* Gets the compute service gallery image version management entry point.
*
* @return the compute service gallery image version management entry point
*/
public GalleryImageVersions galleryImageVersions() {
if (galleryImageVersions == null) {
galleryImageVersions = new GalleryImageVersionsImpl(this);
}
return galleryImageVersions;
}

/** @return the disk encryption set management entry point */
/**
* Gets the disk encryption set management entry point.
*
* @return the disk encryption set management entry point
*/
public DiskEncryptionSets diskEncryptionSets() {
if (diskEncryptionSets == null) {
diskEncryptionSets = new DiskEncryptionSetsImpl(this);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,20 @@ class EncryptionExtensionIdentifier {
private static final String LINUX_ENCRYPTION_TYPE_NAME = "AzureDiskEncryptionForLinux";
private static final String WINDOWS_ENCRYPTION_TYPE_NAME = "AzureDiskEncryption";

/** @return encryption extension publisher name */
/**
* Gets encryption extension publisher name.
*
* @return encryption extension publisher name
*/
static String publisherName() {
return ENCRYPTION_EXTENSION_PUBLISHER;
}

/** @return OS specific encryption extension type */
/**
* Gets OS specific encryption extension type.
*
* @return OS specific encryption extension type
*/
static String typeName(OperatingSystemTypes osType) {
if (osType == OperatingSystemTypes.LINUX) {
return LINUX_ENCRYPTION_TYPE_NAME;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,25 @@

/** Internal base type exposing settings to enable and disable disk encryption extension. */
abstract class EncryptionSettings {
/** @return encryption specific settings to be set on virtual machine storage profile */
/**
* Gets encryption specific settings to be set on virtual machine storage profile.
*
* @return encryption specific settings to be set on virtual machine storage profile
*/
abstract DiskEncryptionSettings storageProfileEncryptionSettings();

/** @return encryption extension public settings */
/**
* Gets encryption extension public settings.
*
* @return encryption extension public settings
*/
abstract HashMap<String, Object> extensionPublicSettings();

/** @return encryption extension protected settings */
/**
* Gets encryption extension protected settings.
*
* @return encryption extension protected settings
*/
abstract HashMap<String, Object> extensionProtectedSettings();

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,19 +34,31 @@ class VirtualMachineExtensionsImpl extends
this.cacheCollection();
}

/** @return the extension as a map indexed by name. */
/**
* Gets the extension as a map indexed by name.
*
* @return the extension as a map indexed by name.
*/
public Map<String, VirtualMachineExtension> asMap() {
return this.asMapAsync().block();
}

/** @return an observable emits extensions in this collection as a map indexed by name. */
/**
* Gets an observable emits extensions in this collection as a map indexed by name.
*
* @return an observable emits extensions in this collection as a map indexed by name.
*/
public Mono<Map<String, VirtualMachineExtension>> asMapAsync() {
return listAsync().flatMapMany(Flux::fromIterable)
.collect(Collectors.toMap(extension -> extension.name(), extension -> extension))
.map(map -> Collections.unmodifiableMap(map));
}

/** @return a Mono emits extensions in this collection */
/**
* Gets a Mono emits extensions in this collection.
*
* @return a Mono emits extensions in this collection
*/
public Mono<List<VirtualMachineExtension>> listAsync() {
Flux<VirtualMachineExtensionImpl> extensions = Flux.fromIterable(this.collection().values());
// Resolve reference getExtensions
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,16 +20,32 @@
public interface AvailabilitySet extends GroupableResource<ComputeManager, AvailabilitySetInner>,
Refreshable<AvailabilitySet>, Updatable<AvailabilitySet.Update> {

/** @return the update domain count of this availability set */
/**
* Gets the update domain count of this availability set.
*
* @return the update domain count of this availability set
*/
int updateDomainCount();

/** @return the fault domain count of this availability set */
/**
* Gets the fault domain count of this availability set.
*
* @return the fault domain count of this availability set
*/
int faultDomainCount();

/** @return the availability set SKU */
/**
* Gets the availability set SKU.
*
* @return the availability set SKU
*/
AvailabilitySetSkuTypes sku();

/** @return the resource IDs of the virtual machines in the availability set */
/**
* Gets the resource IDs of the virtual machines in the availability set.
*
* @return the resource IDs of the virtual machines in the availability set
*/
Set<String> virtualMachineIds();

/**
Expand All @@ -40,10 +56,18 @@ public interface AvailabilitySet extends GroupableResource<ComputeManager, Avail
*/
ProximityPlacementGroup proximityPlacementGroup();

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

/** @return the virtual machine sizes supported in the availability set */
/**
* Gets the virtual machine sizes supported in the availability set.
*
* @return the virtual machine sizes supported in the availability set
*/
PagedIterable<VirtualMachineSize> listVirtualMachineSizes();

// Fluent interfaces
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,15 @@ public class ComputeResourceType extends ExpandableStringEnum<ComputeResourceTyp
/** Static value virtualMachines for ComputeResourceType. */
public static final ComputeResourceType VIRTUALMACHINES = fromString("virtualMachines");

/**
* Creates a new instance of ComputeResourceType value.
*
* @deprecated Use the {@link #fromString(String)} factory method.
*/
@Deprecated
public ComputeResourceType() {
}

/**
* Finds or creates compute resource type based on the specified string.
*
Expand All @@ -30,7 +39,11 @@ public static ComputeResourceType fromString(String str) {
return fromString(str, ComputeResourceType.class);
}

/** @return known compute resource types */
/**
* Gets known compute resource types.
*
* @return known compute resource types
*/
public static Collection<ComputeResourceType> values() {
return values(ComputeResourceType.class);
}
Expand Down
Loading
Loading