Skip to content

Update Javadoc of premium SDK for azure-resourcemanager-redis #43632

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

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
1 change: 0 additions & 1 deletion sdk/resourcemanager/azure-resourcemanager-redis/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,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 @@ -85,7 +85,11 @@ private RedisManager(HttpPipeline httpPipeline, AzureProfile profile) {
.buildClient());
}

/** @return the Redis Cache management API entry point */
/**
* Gets the API entry point of the Redis Cache management.
*
* @return the Redis Cache management API entry point
*/
public RedisCaches redisCaches() {
if (redisCaches == null) {
redisCaches = new RedisCachesImpl(this);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,17 @@
/** The <code>RedisCache.keys()</code> action result. */
@Fluent
public interface RedisAccessKeys {
/** @return a primary key value. */
/**
* Gets a primary key value.
*
* @return a primary key value.
*/
String primaryKey();

/** @return a secondary key value. */
/**
* Gets a secondary key value.
*
* @return a secondary key value.
*/
String secondaryKey();
}
Original file line number Diff line number Diff line change
Expand Up @@ -27,52 +27,116 @@ public interface RedisCache extends GroupableResource<RedisManager, RedisResourc
Updatable<RedisCache.Update>, SupportsListingPrivateLinkResource, SupportsListingPrivateEndpointConnection,
SupportsUpdatingPrivateEndpointConnection {

/** @return exposes features available only to Premium Sku Redis Cache instances. */
/**
* Gets an instance of the Azure Redis cache with Premium SKU.
*
* @return exposes features available only to Premium Sku Redis Cache instances.
*/
RedisCachePremium asPremium();

/** @return returns true if current Redis Cache instance has Premium Sku. */
/**
* Checks whether current Redis Cache instance has Premium Sku.
*
* @return returns true if current Redis Cache instance has Premium Sku.
*/
boolean isPremium();

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

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

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

/** @return the sslPort value */
/**
* Gets SSL port.
*
* @return the sslPort value
*/
int sslPort();

/** @return the Redis version value */
/**
* Gets the redis version
*
* @return the Redis version value
*/
String redisVersion();

/** @return the sku value */
/**
* Gets the SKU.
*
* @return the sku value
*/
Sku sku();

/** @return the Redis configuration value */
/**
* Gets the redis configuration.
*
* @return the Redis configuration value
*/
Map<String, String> redisConfiguration();

/** @return true if non SSL port is enabled, false otherwise */
/**
* Checks whether non SSL port is enabled.
*
* @return true if non SSL port is enabled, false otherwise
*/
boolean nonSslPort();

/** @return the shardCount value */
/**
* Gets count of the shard.
*
* @return the shardCount value
*/
int shardCount();

/** @return the subnetId value */
/**
* Gets the resource id of the subnet.
*
* @return the subnetId value
*/
String subnetId();

/** @return the staticIP value */
/**
* Gets the static IP.
*
* @return the staticIP value
*/
String staticIp();

/** @return the minimum TLS version (or higher) that clients require to use. */
/**
* Gets the minimum TLS version (or higher) that clients require to use.
*
* @return the minimum TLS version (or higher) that clients require to use.
*/
TlsVersion minimumTlsVersion();

/** @return Firewall Rules in the Redis Cache, indexed by name */
/**
* Gets firewall rules in the Redis Cache.
*
* @return Firewall Rules in the Redis Cache, indexed by name
*/
Map<String, RedisFirewallRule> firewallRules();

/** @return List of patch schedules for current Redis Cache. */
/**
* Gets list of patch schedules for current Redis Cache.
*
* @return List of patch schedules for current Redis Cache.
*/
List<ScheduleEntry> patchSchedules();

/**
Expand All @@ -84,7 +148,11 @@ public interface RedisCache extends GroupableResource<RedisManager, RedisResourc
*/
void forceReboot(RebootType rebootType);

/** @return a Redis Cache's access keys. This operation requires write permission to the Cache resource. */
/**
* Gets a Redis Cache's access keys.
*
* @return a Redis Cache's access keys. This operation requires write permission to the Cache resource.
*/
RedisAccessKeys keys();

/**
Expand Down
Loading