com.azure.resourcemanager.storagecache.models.Cache Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure-resourcemanager-storagecache Show documentation
Show all versions of azure-resourcemanager-storagecache Show documentation
This package contains Microsoft Azure SDK for StorageCache Management SDK. For documentation on how to use this package, please see https://aka.ms/azsdk/java/mgmt. Azure Managed Lustre provides a fully managed Lustre® file system, integrated with Blob storage, for use on demand. These operations create and manage Azure Managed Lustre file systems. Package tag package-2024-03.
The newest version!
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
// Code generated by Microsoft (R) AutoRest Code Generator.
package com.azure.resourcemanager.storagecache.models;
import com.azure.core.management.Region;
import com.azure.core.management.SystemData;
import com.azure.core.util.Context;
import com.azure.resourcemanager.storagecache.fluent.models.CacheInner;
import java.util.List;
import java.util.Map;
/**
* An immutable client-side representation of Cache.
*/
public interface Cache {
/**
* Gets the id property: Fully qualified resource Id for the resource.
*
* @return the id value.
*/
String id();
/**
* Gets the name property: The name of the resource.
*
* @return the name value.
*/
String name();
/**
* Gets the type property: The type of the resource.
*
* @return the type value.
*/
String type();
/**
* Gets the location property: The geo-location where the resource lives.
*
* @return the location value.
*/
String location();
/**
* Gets the tags property: Resource tags.
*
* @return the tags value.
*/
Map tags();
/**
* Gets the identity property: The identity of the cache, if configured.
*
* @return the identity value.
*/
CacheIdentity identity();
/**
* Gets the systemData property: The system meta data relating to this resource.
*
* @return the systemData value.
*/
SystemData systemData();
/**
* Gets the sku property: SKU for the cache.
*
* @return the sku value.
*/
CacheSku sku();
/**
* Gets the cacheSizeGB property: The size of this Cache, in GB.
*
* @return the cacheSizeGB value.
*/
Integer cacheSizeGB();
/**
* Gets the health property: Health of the cache.
*
* @return the health value.
*/
CacheHealth health();
/**
* Gets the mountAddresses property: Array of IPv4 addresses that can be used by clients mounting this cache.
*
* @return the mountAddresses value.
*/
List mountAddresses();
/**
* Gets the provisioningState property: ARM provisioning state, see
* https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property.
*
* @return the provisioningState value.
*/
ProvisioningStateType provisioningState();
/**
* Gets the subnet property: Subnet used for the cache.
*
* @return the subnet value.
*/
String subnet();
/**
* Gets the upgradeStatus property: Upgrade status of the cache.
*
* @return the upgradeStatus value.
*/
CacheUpgradeStatus upgradeStatus();
/**
* Gets the upgradeSettings property: Upgrade settings of the cache.
*
* @return the upgradeSettings value.
*/
CacheUpgradeSettings upgradeSettings();
/**
* Gets the networkSettings property: Specifies network settings of the cache.
*
* @return the networkSettings value.
*/
CacheNetworkSettings networkSettings();
/**
* Gets the encryptionSettings property: Specifies encryption settings of the cache.
*
* @return the encryptionSettings value.
*/
CacheEncryptionSettings encryptionSettings();
/**
* Gets the securitySettings property: Specifies security settings of the cache.
*
* @return the securitySettings value.
*/
CacheSecuritySettings securitySettings();
/**
* Gets the directoryServicesSettings property: Specifies Directory Services settings of the cache.
*
* @return the directoryServicesSettings value.
*/
CacheDirectorySettings directoryServicesSettings();
/**
* Gets the zones property: Availability zones for resources. This field should only contain a single element in the
* array.
*
* @return the zones value.
*/
List zones();
/**
* Gets the primingJobs property: Specifies the priming jobs defined in the cache.
*
* @return the primingJobs value.
*/
List primingJobs();
/**
* Gets the spaceAllocation property: Specifies the space allocation percentage for each storage target in the
* cache.
*
* @return the spaceAllocation value.
*/
List spaceAllocation();
/**
* Gets the region of the resource.
*
* @return the region of the resource.
*/
Region region();
/**
* Gets the name of the resource region.
*
* @return the name of the resource region.
*/
String regionName();
/**
* Gets the name of the resource group.
*
* @return the name of the resource group.
*/
String resourceGroupName();
/**
* Gets the inner com.azure.resourcemanager.storagecache.fluent.models.CacheInner object.
*
* @return the inner object.
*/
CacheInner innerModel();
/**
* The entirety of the Cache definition.
*/
interface Definition extends DefinitionStages.Blank, DefinitionStages.WithLocation,
DefinitionStages.WithResourceGroup, DefinitionStages.WithCreate {
}
/**
* The Cache definition stages.
*/
interface DefinitionStages {
/**
* The first stage of the Cache definition.
*/
interface Blank extends WithLocation {
}
/**
* The stage of the Cache definition allowing to specify location.
*/
interface WithLocation {
/**
* Specifies the region for the resource.
*
* @param location The geo-location where the resource lives.
* @return the next definition stage.
*/
WithResourceGroup withRegion(Region location);
/**
* Specifies the region for the resource.
*
* @param location The geo-location where the resource lives.
* @return the next definition stage.
*/
WithResourceGroup withRegion(String location);
}
/**
* The stage of the Cache definition allowing to specify parent resource.
*/
interface WithResourceGroup {
/**
* Specifies resourceGroupName.
*
* @param resourceGroupName The name of the resource group. The name is case insensitive.
* @return the next definition stage.
*/
WithCreate withExistingResourceGroup(String resourceGroupName);
}
/**
* The stage of the Cache definition which contains all the minimum required properties for the resource to be
* created, but also allows for any other optional properties to be specified.
*/
interface WithCreate extends DefinitionStages.WithTags, DefinitionStages.WithIdentity, DefinitionStages.WithSku,
DefinitionStages.WithCacheSizeGB, DefinitionStages.WithSubnet, DefinitionStages.WithUpgradeSettings,
DefinitionStages.WithNetworkSettings, DefinitionStages.WithEncryptionSettings,
DefinitionStages.WithSecuritySettings, DefinitionStages.WithDirectoryServicesSettings,
DefinitionStages.WithZones {
/**
* Executes the create request.
*
* @return the created resource.
*/
Cache create();
/**
* Executes the create request.
*
* @param context The context to associate with this operation.
* @return the created resource.
*/
Cache create(Context context);
}
/**
* The stage of the Cache definition allowing to specify tags.
*/
interface WithTags {
/**
* Specifies the tags property: Resource tags..
*
* @param tags Resource tags.
* @return the next definition stage.
*/
WithCreate withTags(Map tags);
}
/**
* The stage of the Cache definition allowing to specify identity.
*/
interface WithIdentity {
/**
* Specifies the identity property: The identity of the cache, if configured..
*
* @param identity The identity of the cache, if configured.
* @return the next definition stage.
*/
WithCreate withIdentity(CacheIdentity identity);
}
/**
* The stage of the Cache definition allowing to specify sku.
*/
interface WithSku {
/**
* Specifies the sku property: SKU for the cache..
*
* @param sku SKU for the cache.
* @return the next definition stage.
*/
WithCreate withSku(CacheSku sku);
}
/**
* The stage of the Cache definition allowing to specify cacheSizeGB.
*/
interface WithCacheSizeGB {
/**
* Specifies the cacheSizeGB property: The size of this Cache, in GB..
*
* @param cacheSizeGB The size of this Cache, in GB.
* @return the next definition stage.
*/
WithCreate withCacheSizeGB(Integer cacheSizeGB);
}
/**
* The stage of the Cache definition allowing to specify subnet.
*/
interface WithSubnet {
/**
* Specifies the subnet property: Subnet used for the cache..
*
* @param subnet Subnet used for the cache.
* @return the next definition stage.
*/
WithCreate withSubnet(String subnet);
}
/**
* The stage of the Cache definition allowing to specify upgradeSettings.
*/
interface WithUpgradeSettings {
/**
* Specifies the upgradeSettings property: Upgrade settings of the cache..
*
* @param upgradeSettings Upgrade settings of the cache.
* @return the next definition stage.
*/
WithCreate withUpgradeSettings(CacheUpgradeSettings upgradeSettings);
}
/**
* The stage of the Cache definition allowing to specify networkSettings.
*/
interface WithNetworkSettings {
/**
* Specifies the networkSettings property: Specifies network settings of the cache..
*
* @param networkSettings Specifies network settings of the cache.
* @return the next definition stage.
*/
WithCreate withNetworkSettings(CacheNetworkSettings networkSettings);
}
/**
* The stage of the Cache definition allowing to specify encryptionSettings.
*/
interface WithEncryptionSettings {
/**
* Specifies the encryptionSettings property: Specifies encryption settings of the cache..
*
* @param encryptionSettings Specifies encryption settings of the cache.
* @return the next definition stage.
*/
WithCreate withEncryptionSettings(CacheEncryptionSettings encryptionSettings);
}
/**
* The stage of the Cache definition allowing to specify securitySettings.
*/
interface WithSecuritySettings {
/**
* Specifies the securitySettings property: Specifies security settings of the cache..
*
* @param securitySettings Specifies security settings of the cache.
* @return the next definition stage.
*/
WithCreate withSecuritySettings(CacheSecuritySettings securitySettings);
}
/**
* The stage of the Cache definition allowing to specify directoryServicesSettings.
*/
interface WithDirectoryServicesSettings {
/**
* Specifies the directoryServicesSettings property: Specifies Directory Services settings of the cache..
*
* @param directoryServicesSettings Specifies Directory Services settings of the cache.
* @return the next definition stage.
*/
WithCreate withDirectoryServicesSettings(CacheDirectorySettings directoryServicesSettings);
}
/**
* The stage of the Cache definition allowing to specify zones.
*/
interface WithZones {
/**
* Specifies the zones property: Availability zones for resources. This field should only contain a single
* element in the array..
*
* @param zones Availability zones for resources. This field should only contain a single element in the
* array.
* @return the next definition stage.
*/
WithCreate withZones(List zones);
}
}
/**
* Begins update for the Cache resource.
*
* @return the stage of resource update.
*/
Cache.Update update();
/**
* The template for Cache update.
*/
interface Update extends UpdateStages.WithTags, UpdateStages.WithIdentity, UpdateStages.WithUpgradeSettings,
UpdateStages.WithNetworkSettings, UpdateStages.WithEncryptionSettings, UpdateStages.WithSecuritySettings,
UpdateStages.WithDirectoryServicesSettings {
/**
* Executes the update request.
*
* @return the updated resource.
*/
Cache apply();
/**
* Executes the update request.
*
* @param context The context to associate with this operation.
* @return the updated resource.
*/
Cache apply(Context context);
}
/**
* The Cache update stages.
*/
interface UpdateStages {
/**
* The stage of the Cache update allowing to specify tags.
*/
interface WithTags {
/**
* Specifies the tags property: Resource tags..
*
* @param tags Resource tags.
* @return the next definition stage.
*/
Update withTags(Map tags);
}
/**
* The stage of the Cache update allowing to specify identity.
*/
interface WithIdentity {
/**
* Specifies the identity property: The identity of the cache, if configured..
*
* @param identity The identity of the cache, if configured.
* @return the next definition stage.
*/
Update withIdentity(CacheIdentity identity);
}
/**
* The stage of the Cache update allowing to specify upgradeSettings.
*/
interface WithUpgradeSettings {
/**
* Specifies the upgradeSettings property: Upgrade settings of the cache..
*
* @param upgradeSettings Upgrade settings of the cache.
* @return the next definition stage.
*/
Update withUpgradeSettings(CacheUpgradeSettings upgradeSettings);
}
/**
* The stage of the Cache update allowing to specify networkSettings.
*/
interface WithNetworkSettings {
/**
* Specifies the networkSettings property: Specifies network settings of the cache..
*
* @param networkSettings Specifies network settings of the cache.
* @return the next definition stage.
*/
Update withNetworkSettings(CacheNetworkSettings networkSettings);
}
/**
* The stage of the Cache update allowing to specify encryptionSettings.
*/
interface WithEncryptionSettings {
/**
* Specifies the encryptionSettings property: Specifies encryption settings of the cache..
*
* @param encryptionSettings Specifies encryption settings of the cache.
* @return the next definition stage.
*/
Update withEncryptionSettings(CacheEncryptionSettings encryptionSettings);
}
/**
* The stage of the Cache update allowing to specify securitySettings.
*/
interface WithSecuritySettings {
/**
* Specifies the securitySettings property: Specifies security settings of the cache..
*
* @param securitySettings Specifies security settings of the cache.
* @return the next definition stage.
*/
Update withSecuritySettings(CacheSecuritySettings securitySettings);
}
/**
* The stage of the Cache update allowing to specify directoryServicesSettings.
*/
interface WithDirectoryServicesSettings {
/**
* Specifies the directoryServicesSettings property: Specifies Directory Services settings of the cache..
*
* @param directoryServicesSettings Specifies Directory Services settings of the cache.
* @return the next definition stage.
*/
Update withDirectoryServicesSettings(CacheDirectorySettings directoryServicesSettings);
}
}
/**
* Refreshes the resource to sync with Azure.
*
* @return the refreshed resource.
*/
Cache refresh();
/**
* Refreshes the resource to sync with Azure.
*
* @param context The context to associate with this operation.
* @return the refreshed resource.
*/
Cache refresh(Context context);
/**
* Tells a cache to write generate debug info for support to process.
*
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
*/
void debugInfo();
/**
* Tells a cache to write generate debug info for support to process.
*
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
*/
void debugInfo(Context context);
/**
* Tells a cache to write all dirty data to the Storage Target(s). During the flush, clients will see errors
* returned until the flush is complete.
*
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
*/
void flush();
/**
* Tells a cache to write all dirty data to the Storage Target(s). During the flush, clients will see errors
* returned until the flush is complete.
*
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
*/
void flush(Context context);
/**
* Tells a Stopped state cache to transition to Active state.
*
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
*/
void start();
/**
* Tells a Stopped state cache to transition to Active state.
*
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
*/
void start(Context context);
/**
* Tells an Active cache to transition to Stopped state.
*
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
*/
void stop();
/**
* Tells an Active cache to transition to Stopped state.
*
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
*/
void stop(Context context);
/**
* Create a priming job. This operation is only allowed when the cache is healthy.
*
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
*/
void startPrimingJob();
/**
* Create a priming job. This operation is only allowed when the cache is healthy.
*
* @param primingjob Object containing the definition of a priming job.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
*/
void startPrimingJob(PrimingJob primingjob, Context context);
/**
* Schedule a priming job for deletion.
*
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
*/
void stopPrimingJob();
/**
* Schedule a priming job for deletion.
*
* @param primingJobId Object containing the priming job ID.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
*/
void stopPrimingJob(PrimingJobIdParameter primingJobId, Context context);
/**
* Schedule a priming job to be paused.
*
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
*/
void pausePrimingJob();
/**
* Schedule a priming job to be paused.
*
* @param primingJobId Object containing the priming job ID.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
*/
void pausePrimingJob(PrimingJobIdParameter primingJobId, Context context);
/**
* Resumes a paused priming job.
*
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
*/
void resumePrimingJob();
/**
* Resumes a paused priming job.
*
* @param primingJobId Object containing the priming job ID.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
*/
void resumePrimingJob(PrimingJobIdParameter primingJobId, Context context);
/**
* Upgrade a cache's firmware if a new version is available. Otherwise, this operation has no effect.
*
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
*/
void upgradeFirmware();
/**
* Upgrade a cache's firmware if a new version is available. Otherwise, this operation has no effect.
*
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
*/
void upgradeFirmware(Context context);
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy