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-containerregistry #43517

Draft
wants to merge 4 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 @@ -41,7 +41,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 @@ -97,7 +97,11 @@ private ContainerRegistryManager(HttpPipeline httpPipeline, AzureProfile profile
.buildClient());
}

/** @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 Registries containerRegistries() {
if (this.registries == null) {
this.registries = new RegistriesImpl(this);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,15 @@ public class AccessKeyType extends ExpandableStringEnum<AccessKeyType> {
/** Secondary key. */
public static final AccessKeyType SECONDARY = fromString(PasswordName.PASSWORD2.toString());

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

/**
* Finds or creates an access key name based on the provided name.
*
Expand All @@ -23,7 +32,11 @@ public static AccessKeyType fromString(String name) {
return fromString(name, AccessKeyType.class);
}

/** @return known admin user access key names */
/**
* Gets known admin user access key names.
*
* @return known admin user access key names
*/
public static Collection<AccessKeyType> values() {
return values(AccessKeyType.class);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,24 @@
/** The result of checking for container registry name availability. */
@Fluent
public interface CheckNameAvailabilityResult extends HasInnerModel<RegistryNameStatusInner> {
/** @return true if the specified name is valid and available for use, otherwise false */
/**
* Checks whether the specified name is valid and available for use.
*
* @return true if the specified name is valid and available for use, otherwise false
*/
boolean isAvailable();

/** @return the reason why the user-provided name for the container registry could not be used */
/**
* Gets the reason why the user-provided name for the container registry could not be used.
*
* @return the reason why the user-provided name for the container registry could not be used
*/
String unavailabilityReason();

/** @return the error message that provides more detail for the reason why the name is not available */
/**
* Gets provides more detail for the reason why the name is not available.
*
* @return the error message that provides more detail for the reason why the name is not available
*/
String unavailabilityMessage();
}
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,20 @@ public OverridingArgument(String value, boolean isSecret) {
this.isSecret = isSecret;
}

/** @return the value of the overriding argument. */
/**
* Gets the value of the overriding argument.
*
* @return the value of the overriding argument.
*/
public String value() {
return this.value;
}

/** @return whether the overriding argument is secret or not. */
/**
* Checks whether the overriding argument is secret or not.
*
* @return whether the overriding argument is secret or not.
*/
public boolean isSecret() {
return this.isSecret;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,20 @@ public OverridingValue(String value, boolean isSecret) {
this.isSecret = isSecret;
}

/** @return the value of the overriding value. */
/**
* Gets the value of the overriding value.
*
* @return the value of the overriding value.
*/
public String value() {
return this.value;
}

/** @return whether the overriding value is secret or not. */
/**
* Gets whether the overriding value is secret or not..
*
* @return whether the overriding value is secret or not.
*/
public boolean isSecret() {
return this.isSecret;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,11 @@ Mono<RegistryCredentials> regenerateCredentialAsync(String resourceGroupName, St
*/
Mono<SourceUploadDefinition> getBuildSourceUploadUrlAsync(String rgName, String acrName);

/** @return returns entry point to manage container registry webhooks. */
/**
* Gets returns entry point to manage container registry webhooks.
*
* @return returns entry point to manage container registry webhooks.
*/
WebhooksClient webhooks();

/** Grouping of registry webhook actions. */
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,22 +27,46 @@ public interface Registry extends GroupableResource<ContainerRegistryManager, Re
Updatable<Registry.Update>, SupportsListingPrivateLinkResource, SupportsListingPrivateEndpointConnection,
SupportsUpdatingPrivateEndpointConnection {

/** @return the SKU of the container registry. */
/**
* Gets the SKU of the container registry..
*
* @return the SKU of the container registry.
*/
Sku sku();

/** @return the URL that can be used to log into the container registry */
/**
* Gets the URL that can be used to log into the container registry.
*
* @return the URL that can be used to log into the container registry
*/
String loginServerUrl();

/** @return the creation date of the container registry in ISO8601 format */
/**
* Gets the creation date of the container registry.
*
* @return the creation date of the container registry in ISO8601 format
*/
OffsetDateTime creationDate();

/** @return the value that indicates whether the admin user is enabled */
/**
* Checks whether the value that indicates whether the admin user is enabled.
*
* @return the value that indicates whether the admin user is enabled
*/
boolean adminUserEnabled();

/** @return the login credentials for the specified container registry */
/**
* Gets the login credentials for the specified container registry.
*
* @return the login credentials for the specified container registry
*/
RegistryCredentials getCredentials();

/** @return a representation of the future computation of this call */
/**
* Gets a representation of the future computation of this call.
*
* @return a representation of the future computation of this call
*/
Mono<RegistryCredentials> getCredentialsAsync();

/**
Expand Down Expand Up @@ -75,7 +99,11 @@ public interface Registry extends GroupableResource<ContainerRegistryManager, Re
*/
PagedFlux<RegistryUsage> listQuotaUsagesAsync();

/** @return returns the upload location for the user to be able to upload the source. */
/**
* Gets the upload location for the user to be able to upload the source.
*
* @return returns the upload location for the user to be able to upload the source.
*/
SourceUploadDefinition getBuildSourceUploadUrl();

/**
Expand All @@ -85,27 +113,53 @@ public interface Registry extends GroupableResource<ContainerRegistryManager, Re
*/
Mono<SourceUploadDefinition> getBuildSourceUploadUrlAsync();

/** @return returns entry point to manage container registry webhooks. */
/**
* Gets entry point to manage container registry webhooks.
*
* @return returns entry point to manage container registry webhooks.
*/
WebhookOperations webhooks();

/**
* Gets the state of public network access for the container registry.
*
* @return the state of public network access for the container registry.
*/
PublicNetworkAccess publicNetworkAccess();

/** @return whether the container registry can be access from trusted services */
/**
* Checks whether the container registry can be access from trusted services
*
* @return whether the container registry can be access from trusted services
*/
boolean canAccessFromTrustedServices();

/** @return the network rule set for the container registry */
/**
* Gets the network rule set for the container registry.
*
* @return the network rule set for the container registry
*/
NetworkRuleSet networkRuleSet();

/** @return whether the container registries dedicated data endpoints can be accessed from public network */
/**
* Checks whether the container registries dedicated data endpoints can be accessed from public network.
*
* @return whether the container registries dedicated data endpoints can be accessed from public network
*/
boolean isDedicatedDataEndpointsEnabled();

/** @return Whether or not zone redundancy is enabled for this container registry */
/**
* Checks whether zone redundancy is enabled for this container registry.
*
* @return Whether zone redundancy is enabled for this container registry
*/
boolean isZoneRedundancyEnabled();

/** @return list of host names that will serve data when isDedicatedDataEndpointsEnabled is true */
/**
* Gets list of host names that will serve data.
*
* @return list of host names that will serve data when isDedicatedDataEndpointsEnabled is true
*/
List<String> dedicatedDataEndpointsHostNames();

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,19 +11,39 @@
/** An immutable client-side representation of an Azure registry Docker task run request. */
@Fluent()
public interface RegistryDockerTaskRunRequest {
/** @return the length of the timeout. */
/**
* Gets the length of the timeout.
*
* @return the length of the timeout.
*/
int timeout();

/** @return the properties of the platform. */
/**
* Gets the properties of the platform.
*
* @return the properties of the platform.
*/
PlatformProperties platform();

/** @return the number of CPUs. */
/**
* Gets the number of CPUs.
*
* @return the number of CPUs.
*/
int cpuCount();

/** @return the location of the source control. */
/**
* Gets the location of the source control.
*
* @return the location of the source control.
*/
String sourceLocation();

/** @return whether archive is enabled. */
/**
* Checks whether archive is enabled.
*
* @return whether archive is enabled.
*/
boolean isArchiveEnabled();

/** Container interface for all the definitions related to a registry Docker task run request. */
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,39 @@
/** An immutable client-side representation of an Azure RegistryDockerTaskStep registry task. */
@Fluent()
public interface RegistryDockerTaskStep extends HasInnerModel<DockerTaskStep>, RegistryTaskStep {
/** @return the image names of this Docker task step */
/**
* Gets the image names of this Docker task step.
*
* @return the image names of this Docker task step
*/
List<String> imageNames();

/** @return whether push is enabled for this Docker task step */
/**
* Checks whether push is enabled for this Docker task step.
*
* @return whether push is enabled for this Docker task step
*/
boolean isPushEnabled();

/** @return whether there is no cache for this Docker task step */
/**
* Checks whether there is no cache for this Docker task step.
*
* @return whether there is no cache for this Docker task step
*/
boolean noCache();

/** @return Docker file path for this Docker task step */
/**
* Gets Docker file path for this Docker task step.
*
* @return Docker file path for this Docker task step
*/
String dockerFilePath();

/** @return the arguments this Docker task step */
/**
* Gets the arguments this Docker task step.
*
* @return the arguments this Docker task step
*/
List<Argument> arguments();

/** Container interface for all the definitions related to a RegistryDockerTaskStep. */
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,39 @@
/** An immutable client-side representation of an Azure registry Encoded task run request. */
@Fluent()
public interface RegistryEncodedTaskRunRequest {
/** @return the length of the timeout. */
/**
* Gets the length of the timeout.
*
* @return the length of the timeout.
*/
int timeout();

/** @return the properties of the platform. */
/**
* Gets the properties of the platform.
*
* @return the properties of the platform.
*/
PlatformProperties platform();

/** @return the number of CPUs. */
/**
* Gets the number of CPUs.
*
* @return the number of CPUs.
*/
int cpuCount();

/** @return the location of the source control. */
/**
* Gets the location of the source control.
*
* @return the location of the source control.
*/
String sourceLocation();

/** @return whether archive is enabled. */
/**
* Checks whether archive is enabled.
*
* @return whether archive is enabled.
*/
boolean isArchiveEnabled();

/** Container interface for all the definitions related to a registry Encoded task run request. */
Expand Down
Loading
Loading