Skip to content

Commit

Permalink
Update Javadoc of premium SDK for azure-resourcemanager-cdn (#43498)
Browse files Browse the repository at this point in the history
  • Loading branch information
v-hongli1 authored Dec 20, 2024
1 parent df77afd commit ec53ba1
Show file tree
Hide file tree
Showing 9 changed files with 120 additions and 86 deletions.
1 change: 0 additions & 1 deletion sdk/resourcemanager/azure-resourcemanager-cdn/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,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 @@ -92,6 +92,8 @@ private CdnManager(HttpPipeline httpPipeline, AzureProfile profile) {
}

/**
* Gets entry point to CDN manager profile management.
*
* @return entry point to CDN manager profile management
*/
public CdnProfiles profiles() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,7 @@ public final class AzureFirstPartyManagedCertificateParameters extends SecretPar

/*
* Resource reference to the Azure Key Vault certificate. Expected to be in format of
* /subscriptions/{​​​​​​​​​subscriptionId}​​​​​​​​​/resourceGroups/{​​​​​​​​​resourceGroupName}
* ​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​/providers/Microsoft.KeyVault/vaults/{vaultName}
* ​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​/secrets/{certificateName}
* ​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​
* /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{certificateName}
*/
private ResourceReference secretSource;

Expand Down Expand Up @@ -63,7 +60,7 @@ public AzureFirstPartyManagedCertificateParameters() {

/**
* Get the type property: The type of the secret resource.
*
*
* @return the type value.
*/
@Override
Expand All @@ -73,8 +70,8 @@ public SecretType type() {

/**
* Get the secretSource property: Resource reference to the Azure Key Vault certificate. Expected to be in format of
* /subscriptions/{​​​​​​​​​subscriptionId}​​​​​​​​​/resourceGroups/{​​​​​​​​​resourceGroupName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​/providers/Microsoft.KeyVault/vaults/{vaultName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​/secrets/{certificateName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​.
*
* /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{certificateName}.
*
* @return the secretSource value.
*/
public ResourceReference secretSource() {
Expand All @@ -83,7 +80,7 @@ public ResourceReference secretSource() {

/**
* Get the subject property: Subject name in the certificate.
*
*
* @return the subject value.
*/
public String subject() {
Expand All @@ -92,7 +89,7 @@ public String subject() {

/**
* Get the expirationDate property: Certificate expiration date.
*
*
* @return the expirationDate value.
*/
public String expirationDate() {
Expand All @@ -101,7 +98,7 @@ public String expirationDate() {

/**
* Get the certificateAuthority property: Certificate issuing authority.
*
*
* @return the certificateAuthority value.
*/
public String certificateAuthority() {
Expand All @@ -110,7 +107,7 @@ public String certificateAuthority() {

/**
* Get the subjectAlternativeNames property: The list of SANs.
*
*
* @return the subjectAlternativeNames value.
*/
public List<String> subjectAlternativeNames() {
Expand All @@ -119,7 +116,7 @@ public List<String> subjectAlternativeNames() {

/**
* Set the subjectAlternativeNames property: The list of SANs.
*
*
* @param subjectAlternativeNames the subjectAlternativeNames value to set.
* @return the AzureFirstPartyManagedCertificateParameters object itself.
*/
Expand All @@ -131,7 +128,7 @@ public List<String> subjectAlternativeNames() {

/**
* Get the thumbprint property: Certificate thumbprint.
*
*
* @return the thumbprint value.
*/
public String thumbprint() {
Expand All @@ -140,7 +137,7 @@ public String thumbprint() {

/**
* Validates the instance.
*
*
* @throws IllegalArgumentException thrown if the instance is not valid.
*/
@Override
Expand All @@ -165,7 +162,7 @@ public JsonWriter toJson(JsonWriter jsonWriter) throws IOException {

/**
* Reads an instance of AzureFirstPartyManagedCertificateParameters from the JsonReader.
*
*
* @param jsonReader The JsonReader being read.
* @return An instance of AzureFirstPartyManagedCertificateParameters if the JsonReader was pointing to an instance
* of it, or null if it was pointing to JSON null.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,81 +23,113 @@
public interface CdnEndpoint extends ExternalChildResource<CdnEndpoint, CdnProfile>, HasInnerModel<EndpointInner> {

/**
* Gets origin host header.
*
* @return origin host header
*/
String originHostHeader();

/**
* Gets origin path.
*
* @return origin path
*/
String originPath();

/**
* Gets content types to be compressed.
*
* @return content types to be compressed
*/
Set<String> contentTypesToCompress();

/**
* Check whether content compression is enabled.
*
* @return true if content compression is enabled, otherwise false
*/
boolean isCompressionEnabled();

/**
* Check whether HTTP traffic is allowed.
*
* @return true if HTTP traffic is allowed, otherwise false.
*/
boolean isHttpAllowed();

/**
* Check whether HTTPS traffic is allowed.
*
* @return true if HTTPS traffic is allowed, otherwise false
*/
boolean isHttpsAllowed();

/**
* Gets query string caching behavior.
*
* @return query string caching behavior
*/
QueryStringCachingBehavior queryStringCachingBehavior();

/**
* Gets optimization type.
*
* @return optimization type
*/
String optimizationType();

/**
* Gets list of Geo filters.
*
* @return list of Geo filters
*/
Collection<GeoFilter> geoFilters();

/**
* Gets endpoint host name.
*
* @return endpoint host name
*/
String hostname();

/**
* Gets endpoint state.
*
* @return endpoint state
*/
EndpointResourceState resourceState();

/**
* Gets endpoint provisioning state.
*
* @return endpoint provisioning state
*/
String provisioningState();

/**
* Gets origin host nam.
*
* @return origin host name
*/
String originHostName();

/**
* Gets HTTP port value.
*
* @return HTTP port value
*/
int httpPort();

/**
* Gets HTTPS port value.
*
* @return HTTPS port value
*/
int httpsPort();

/**
* Gets custom domains associated with this endpoint.
*
* @return custom domains associated with this endpoint
*/
Set<String> customDomains();
Expand Down Expand Up @@ -185,6 +217,8 @@ public interface CdnEndpoint extends ExternalChildResource<CdnEndpoint, CdnProfi
PagedIterable<ResourceUsage> listResourceUsage();

/**
* Gets the map of the Standard rules engine rules.
*
* @return the map of the Standard rules engine rules, indexed by rule name
* (note: this is only available for Standard Microsoft CDN Sku endpoints)
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,15 @@ public interface CdnProfile
extends GroupableResource<CdnManager, ProfileInner>, Refreshable<CdnProfile>, Updatable<CdnProfile.Update> {

/**
* Gets the SKU of the CDN profile.
*
* @return the SKU of the CDN profile
*/
Sku sku();

/**
* Gets CDN profile state.
*
* @return CDN profile state
*/
String resourceState();
Expand Down Expand Up @@ -161,11 +165,15 @@ public interface CdnProfile
Mono<CheckNameAvailabilityResult> checkEndpointNameAvailabilityAsync(String name);

/**
* Check whether this CDN profile's SKU is of Premium Verizon.
*
* @return true if this CDN profile's SKU is of Premium Verizon, else false.
*/
boolean isPremiumVerizon();

/**
* Gets quotas and actual usages of endpoints under the current CDN profile.
*
* @return quotas and actual usages of endpoints under the current CDN profile
*/
PagedIterable<ResourceUsage> listResourceUsage();
Expand Down
Loading

0 comments on commit ec53ba1

Please sign in to comment.