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-containerservice #43518

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft
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 @@ -42,7 +42,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 @@ -87,7 +87,11 @@ private ContainerServiceManager(HttpPipeline httpPipeline, AzureProfile profile)
.buildClient());
}

/** @return the Azure Kubernetes cluster resource management API entry point */
/**
* Gets he Azure Kubernetes cluster resource management API entry point.
*
* @return the Azure Kubernetes cluster resource management API entry point
*/
public KubernetesClusters kubernetesClusters() {
if (this.kubernetesClusters == null) {
this.kubernetesClusters = new KubernetesClustersImpl(this);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,86 +13,178 @@
*/
public interface AgentPool extends HasName {

/** @return the provisioning state of the agent pool */
/**
* Gets the provisioning state of the agent pool.
*
* @return the provisioning state of the agent pool
*/
String provisioningState();

/** @return the number of agents (virtual machines) to host docker containers */
/**
* Gets the number of agents (virtual machines) to host docker containers.
*
* @return the number of agents (virtual machines) to host docker containers
*/
int count();

/** @return size of each agent virtual machine in the agent pool */
/**
* Gets size of each agent virtual machine in the agent pool.
*
* @return size of each agent virtual machine in the agent pool
*/
ContainerServiceVMSizeTypes vmSize();

/** @return OS disk size in GB set for each virtual machine in the agent pool */
/**
* Gets OS disk size in GB set for each virtual machine in the agent pool.
*
* @return OS disk size in GB set for each virtual machine in the agent pool
*/
int osDiskSizeInGB();

/** @return OS of each virtual machine in the agent pool */
/**
* Gets OS of each virtual machine in the agent pool.
*
* @return OS of each virtual machine in the agent pool
*/
OSType osType();

/** @return agent pool type */
/**
* Gets agent pool type.
*
* @return agent pool type
*/
AgentPoolType type();

/** @return agent pool mode */
/**
* Gets agent pool mode.
*
* @return agent pool mode
*/
AgentPoolMode mode();

/** @return the name of the subnet used by each virtual machine in the agent pool */
/**
* Gets the name of the subnet used by each virtual machine in the agent pool.
*
* @return the name of the subnet used by each virtual machine in the agent pool
*/
String subnetName();

/** @return the ID of the virtual network used by each virtual machine in the agent pool */
/**
* Gets the ID of the virtual network used by each virtual machine in the agent pool.
*
* @return the ID of the virtual network used by each virtual machine in the agent pool
*/
String networkId();

/** @return the list of availability zones */
/**
* Gets the list of availability zones.
*
* @return the list of availability zones
*/
List<String> availabilityZones();

/** @return the map of node labels */
/**
* Gets the map of node labels.
*
* @return the map of node labels
*/
Map<String, String> nodeLabels();

/** @return the list of node taints */
/**
* Gets the list of node taints.
*
* @return the list of node taints
*/
List<String> nodeTaints();

/** @return the power state, Running or Stopped */
/**
* Gets the power state.
*
* @return the power state, Running or Stopped
*/
PowerState powerState();

/** @return the number of agents (VMs) to host docker containers */
/**
* Gets the number of agents (VMs) to host docker containers.
*
* @return the number of agents (VMs) to host docker containers
*/
int nodeSize();

/** @return the maximum number of pods per node */
/**
* Gets the maximum number of pods per node.
*
* @return the maximum number of pods per node
*/
int maximumPodsPerNode();

/** @return whether auto-scaling is enabled */
/**
* Checks whether auto-scaling is enabled.
*
* @return whether auto-scaling is enabled
*/
boolean isAutoScalingEnabled();

/** @return the minimum number of nodes for auto-scaling */
/**
* Gets the minimum number of nodes for auto-scaling.
*
* @return the minimum number of nodes for auto-scaling
*/
int minimumNodeSize();

/** @return the maximum number of nodes for auto-scaling */
/**
* Gets the maximum number of nodes for auto-scaling.
*
* @return the maximum number of nodes for auto-scaling
*/
int maximumNodeSize();

/** @return the priority of each virtual machines in the agent pool */
/**
* Gets the priority of each virtual machines in the agent pool.
*
* @return the priority of each virtual machines in the agent pool
*/
ScaleSetPriority virtualMachinePriority();

/** @return the eviction policy of each virtual machines in the agent pool */
/**
* Gets the eviction policy of each virtual machines in the agent pool.
*
* @return the eviction policy of each virtual machines in the agent pool
*/
ScaleSetEvictionPolicy virtualMachineEvictionPolicy();

/** @return the maximum price of each spot virtual machines in the agent pool, -1 means pay-as-you-go prices */
/**
* Gets the maximum price of each spot virtual machines in the agent pool.
*
* @return the maximum price of each spot virtual machines in the agent pool, -1 means pay-as-you-go prices
*/
Double virtualMachineMaximumPrice();

/**
* Gets the maximum price of each spot virtual machines in the agent pool.
*
* @return the OS disk type to be used for machines in the agent pool
*/
OSDiskType osDiskType();

/**
* Gets the disk type for the placement.
*
* @return the disk type for the placement of emptyDir volumes, container runtime data root,
* and Kubelet ephemeral storage
*/
KubeletDiskType kubeletDiskType();

/**
* Gets the tags of the agents.
*
* @return the tags of the agents.
*/
Map<String, String> tags();

/**
* Checks whether FIPS-enabled OS is been used for agent pool's machines.
*
* @return whether FIPS-enabled OS is been used for agent pool's machines
* @see <a href="https://docs.microsoft.com/azure/aks/use-multiple-node-pools#add-a-fips-enabled-node-pool-preview">
* Add a FIPS-enabled node pool</a> for more details.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,15 @@ public class ContainerServiceResourceTypes extends ExpandableStringEnum<Containe
/** Static value managedClusters for ContainerServiceResourceTypes. */
public static final ContainerServiceResourceTypes MANAGED_CLUSTERS = fromString("managedClusters");

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

/**
* Creates or finds a ContainerServiceResourceTypes from its string representation.
*
Expand All @@ -23,7 +32,11 @@ public static ContainerServiceResourceTypes fromString(String name) {
return fromString(name, ContainerServiceResourceTypes.class);
}

/** @return known ExtendedLocationTypes values. */
/**
* Gets known ExtendedLocationTypes values..
*
* @return known ExtendedLocationTypes values.
*/
public static Collection<ContainerServiceResourceTypes> values() {
return values(ContainerServiceResourceTypes.class);
}
Expand Down
Loading
Loading