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-appplatform #43458

Draft
wants to merge 1 commit 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 @@ -49,7 +49,6 @@
--add-opens com.azure.resourcemanager.appplatform/com.azure.resourcemanager.appplatform=ALL-UNNAMED
--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,7 +84,11 @@ private AppPlatformManager(HttpPipeline httpPipeline, AzureProfile profile) {
.buildClient());
}

/** @return Entry point for Spring Service management API. */
/**
* Gets the entry point for Spring Service management API.
*
* @return Entry point for Spring Service management API.
*/
public SpringServices springServices() {
if (springServices == null) {
springServices = new SpringServicesImpl(this);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,11 @@ public static RuntimeVersion fromString(String name) {
return fromString(name, RuntimeVersion.class);
}

/** @return known RuntimeVersion values. */
/**
* Gets known RuntimeVersion values.
*
* @return known RuntimeVersion values.
*/
public static Collection<RuntimeVersion> values() {
return values(RuntimeVersion.class);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,15 @@ public final class SkuName extends ExpandableStringEnum<SkuName> {
*/
public static final SkuName E0 = fromString("E0");

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

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

/** @return known SkuName values. */
/**
* Gets known SkuName values.
*
* @return known SkuName values.
*/
public static Collection<SkuName> values() {
return values(SkuName.class);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,61 +16,120 @@
@Fluent
public interface SpringApp extends ExternalChildResource<SpringApp, SpringService>, HasInnerModel<AppResourceInner>,
Updatable<SpringApp.Update> {
/** @return whether the app exposes public endpoint */
/**
* Check whether the app exposes public endpoint.
*
* @return whether the app exposes public endpoint
*/
boolean isPublic();

/** @return whether only https is allowed for the app */
/**
* Check whether only https is allowed for the app.
*
* @return whether only https is allowed for the app
*/
boolean isHttpsOnly();

/** @return the url of the app */
/**
* Gets the url of the app.
*
* @return the url of the app
*/
String url();

/** @return the fully qualified domain name (FQDN) of the app */
/**
* Gets the fully qualified domain name (FQDN) of the app.
*
* @return the fully qualified domain name (FQDN) of the app
*/
String fqdn();

/** @return the temporary disk of the app */
/**
* Gets the temporary disk of the app.
*
* @return the temporary disk of the app
*/
TemporaryDisk temporaryDisk();

/** @return the persistent disk of the app */
/**
* Gets the persistent disk of the app.
*
* @return the persistent disk of the app
*/
PersistentDisk persistentDisk();

/** @return the identity property of the app */
/**
* Gets the identity property of the app.
*
* @return the identity property of the app
*/
ManagedIdentityProperties identity();

/** @return the active deployment name */
/**
* Gets the active deployment name.
*
* @return the active deployment name
*/
String activeDeploymentName();

/** @return the active deployment */
/**
* Gets the active deployment.
*
* @return the active deployment
*/
SpringAppDeployment getActiveDeployment();

/** @return the active deployment */
/**
* Gets the active deployment.
*
* @return the active deployment
*/
Mono<SpringAppDeployment> getActiveDeploymentAsync();

/**
* Gets the entry point of the spring app deployment.
* @param <T> derived type of {@link SpringAppDeployment.DefinitionStages.WithCreate}
* @return the entry point of the spring app deployment
*/
<T extends SpringAppDeployment.DefinitionStages.WithCreate<T>> SpringAppDeployments<T> deployments();

/** @return the entry point of the spring app service binding */
/**
* Gets the entry point of the spring app service binding.
*
* @return the entry point of the spring app service binding
*/
SpringAppServiceBindings serviceBindings();

/** @return the entry point of the spring app custom domain */
/**
* Gets the entry point of the spring app custom domain.
*
* @return the entry point of the spring app custom domain
*/
SpringAppDomains customDomains();

/** @return the blob url to upload deployment */
/**
* Gets the blob url to upload deployment
*
* @return the blob url to upload deployment
*/
Mono<ResourceUploadDefinition> getResourceUploadUrlAsync();

/** @return the blob url to upload deployment */
/**
* Gets the blob url to upload deployment
*
* @return the blob url to upload deployment.
*/
ResourceUploadDefinition getResourceUploadUrl();

/**
* Check whether this app has binding to the default Configuration Service.
* (Enterprise Tier Only)
* @return whether this app has binding to the default Configuration Service
*/
boolean hasConfigurationServiceBinding();

/**
* Check whether this app has binding to the default Service Registry.
* (Enterprise Tier Only)
* @return whether this app has binding to the default Service Registry
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,19 +20,39 @@
@Fluent
public interface SpringAppDeployment extends ExternalChildResource<SpringAppDeployment, SpringApp>,
HasInnerModel<DeploymentResourceInner>, Updatable<SpringAppDeployment.Update> {
/** @return the app name of the deployment */
/**
* Gets the app name of the deployment.
*
* @return the app name of the deployment
*/
String appName();

/** @return the deploy settings of the deployment */
/**
* Gets the deploy settings of the deployment.
*
* @return the deploy settings of the deployment
*/
DeploymentSettings settings();

/** @return the status of the deployment */
/**
* Gets the status of the deployment.
*
* @return the status of the deployment
*/
DeploymentResourceStatus status();

/** @return whether the deployment is active */
/**
* Check whether the deployment is active.
*
* @return whether the deployment is active
*/
boolean isActive();

/** @return all the instances of the deployment */
/**
* Gets all the instances of the deployment.
*
* @return all the instances of the deployment
*/
List<DeploymentInstance> instances();

/** Starts the deployment. */
Expand Down Expand Up @@ -62,25 +82,52 @@ public interface SpringAppDeployment extends ExternalChildResource<SpringAppDepl
*/
Mono<Void> restartAsync();

/** @return the log file url of the deployment */
/**
* Gets the log file url of the deployment.
*
* @return the log file url of the deployment
*/
String getLogFileUrl();

/** @return the log file url of the deployment */
/**
* Gets the log file url of the deployment.
*
* @return the log file url of the deployment
*/
Mono<String> getLogFileUrlAsync();

/** @return (Enterprise Tier Only) config file patterns */
/**
* Gets config file patterns.
*
* @return (Enterprise Tier Only) config file patterns
*/
List<String> configFilePatterns();

/** @return cpu count, can be 0.5, 1, 2, etc */
/**
* Gets cpu count.
*
* @return cpu count, can be 0.5, 1, 2, etc
*/
Double cpu();

/** @return memory in GB, can be 0.5, 1, 2, etc */
/**
* Gets memory in GB.
*
* @return memory in GB, can be 0.5, 1, 2, etc */
Double memoryInGB();

/** @return RuntimeVersion of the deployment, only support Basic/Standard Tier, null for Enterprise Tier */
/**
* Gets runtimeVersion of the deployment.
*
* @return RuntimeVersion of the deployment, only support Basic/Standard Tier, null for Enterprise Tier
*/
RuntimeVersion runtimeVersion();

/** @return JVM options of the deployment */
/**
* Gets JVM options of the deployment.
*
* @return JVM options of the deployment
*/
String jvmOptions();

/**
Expand All @@ -95,11 +142,17 @@ interface Definition<ParentT, T> extends DefinitionStages.Blank<T>, DefinitionSt

/** Grouping of all the deployment definition stages. */
interface DefinitionStages {
/** The first stage of the deployment definition. */
/**
* The first stage of the deployment definition.
* @param <T> The return type of final stage
*/
interface Blank<T> extends WithSource<T> {
}

/** The stage of a deployment definition allowing to specify the source code or package. */
/**
* The stage of a deployment definition allowing to specify the source code or package.
* @param <T> The return type of final stage
*/
interface WithSource<T> {
/**
* Specifies the jar package for the deployment.
Expand Down Expand Up @@ -156,7 +209,10 @@ interface WithSource<T> {
T withExistingSource(UserSourceType type, String relativePath);
}

/** The stage of a deployment definition allowing to specify the module of the source code. */
/**
* The stage of a deployment definition allowing to specify the module of the source code.
* @param <T> The return type of final stage
*/
interface WithModule<T> {
/**
* Specifies the module of the source code.
Expand All @@ -172,7 +228,10 @@ interface WithModule<T> {
T withSingleModule();
}

/** The stage of a deployment definition allowing to specify deployment settings. */
/**
* The stage of a deployment definition allowing to specify deployment settings.
* @param <T> The return type of final stage
*/
interface WithSettings<T> {
/**
* Specifies the instance number of the deployment.
Expand Down Expand Up @@ -256,15 +315,23 @@ interface WithSettings<T> {
/**
* The stage of the definition which contains all the minimum required inputs for the resource to be created,
* but also allows for any other optional settings to be specified.
* @param <T> The return type of final stage
*/
interface Final<T> extends WithSettings<T> {
}

/** The final stage of the definition allowing to create a deployment */
/**
* The final stage of the definition allowing to create a deployment
* @param <T> The return type of final stage
*/
interface WithCreate<T> extends Creatable<SpringAppDeployment>, Final<T> {
}

/** The final stage of the definition allowing to attach a deployment to its parent */
/**
* The final stage of the definition allowing to attach a deployment to its parent
* @param <ParentT> the stage of the parent definition to return to after attaching this definition
* @param <T> The return type of final stage
*/
interface WithAttach<ParentT, T> extends Attachable<ParentT>, Final<T> {
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,10 @@
import com.azure.resourcemanager.resources.fluentcore.collection.SupportsDeletingByName;
import com.azure.resourcemanager.resources.fluentcore.collection.SupportsListing;

/** Entry point for Spring App Deployments API. */
/**
* Entry point for Spring App Deployments API.
* @param <T> The return type of final stage
*/
@Fluent
public interface SpringAppDeployments<T> extends HasManager<AppPlatformManager>, HasParent<SpringApp>,
SupportsCreating<SpringAppDeployment.DefinitionStages.Blank<T>>, SupportsGettingById<SpringAppDeployment>,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@
/** An immutable client-side representation of an Azure Spring App Custom Domain. */
public interface SpringAppDomain
extends ExternalChildResource<SpringAppDomain, SpringApp>, HasInnerModel<CustomDomainResourceInner> {
/** @return the properties of the spring app custom domain */
/**
* Gets the properties of the spring app custom domain.
*
* @return the properties of the spring app custom domain
*/
CustomDomainProperties properties();
}
Loading
Loading