Package com.azure.resourcemanager.storagecache.models

Interface Cache

public interface Cache
An immutable client-side representation of Cache.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    Cache.Definition
    The entirety of the Cache definition.
    static interface 
    Cache.DefinitionStages
    The Cache definition stages.
    static interface 
    Cache.Update
    The template for Cache update.
    static interface 
    Cache.UpdateStages
    The Cache update stages.

  • Method Summary

    Modifier and Type
    Method
    Description
    Integer
    cacheSizeGB()
    Gets the cacheSizeGB property: The size of this cache, in GB, when scalingFactor is 1.0.
    void
    debugInfo()
    Tells a cache to write generate debug info for support to process.
    void
    debugInfo(com.azure.core.util.Context context)
    Tells a cache to write generate debug info for support to process.
    CacheDirectorySettings
    directoryServicesSettings()
    Gets the directoryServicesSettings property: Specifies Directory Services settings of the cache.
    CacheEncryptionSettings
    encryptionSettings()
    Gets the encryptionSettings property: Specifies encryption settings of the cache.
    void
    flush()
    Tells a cache to write all dirty data to the Storage Target(s).
    void
    flush(com.azure.core.util.Context context)
    Tells a cache to write all dirty data to the Storage Target(s).
    CacheHealth
    health()
    Gets the health property: Health of the cache.
    String
    id()
    Gets the id property: Fully qualified resource Id for the resource.
    CacheIdentity
    identity()
    Gets the identity property: The identity of the cache, if configured.
    CacheInner
    innerModel()
    Gets the inner com.azure.resourcemanager.storagecache.fluent.models.CacheInner object.
    String
    location()
    Gets the location property: The geo-location where the resource lives.
    List<String>
    mountAddresses()
    Gets the mountAddresses property: Array of IPv4 addresses that can be used by clients mounting this cache.
    String
    name()
    Gets the name property: The name of the resource.
    CacheNetworkSettings
    networkSettings()
    Gets the networkSettings property: Specifies network settings of the cache.
    void
    pausePrimingJob()
    Schedule a priming job to be paused.
    void
    pausePrimingJob(PrimingJobIdParameter primingJobId, com.azure.core.util.Context context)
    Schedule a priming job to be paused.
    List<PrimingJob>
    primingJobs()
    Gets the primingJobs property: Specifies the priming jobs defined in the cache.
    ProvisioningStateType
    provisioningState()
    Gets the provisioningState property: ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property.
    Cache
    refresh()
    Refreshes the resource to sync with Azure.
    Cache
    refresh(com.azure.core.util.Context context)
    Refreshes the resource to sync with Azure.
    com.azure.core.management.Region
    region()
    Gets the region of the resource.
    String
    regionName()
    Gets the name of the resource region.
    String
    resourceGroupName()
    Gets the name of the resource group.
    void
    resumePrimingJob()
    Resumes a paused priming job.
    void
    resumePrimingJob(PrimingJobIdParameter primingJobId, com.azure.core.util.Context context)
    Resumes a paused priming job.
    Double
    scalingFactor()
    Gets the scalingFactor property: Multiplier that sets the current storage and throughput capacity of the cache.
    CacheSecuritySettings
    securitySettings()
    Gets the securitySettings property: Specifies security settings of the cache.
    CacheSku
    sku()
    Gets the sku property: SKU for the cache.
    List<StorageTargetSpaceAllocation>
    spaceAllocation()
    Gets the spaceAllocation property: Specifies the space allocation percentage for each storage target in the cache.
    void
    start()
    Tells a Stopped state cache to transition to Active state.
    void
    start(com.azure.core.util.Context context)
    Tells a Stopped state cache to transition to Active state.
    void
    startPrimingJob()
    Create a priming job.
    void
    startPrimingJob(PrimingJob primingjob, com.azure.core.util.Context context)
    Create a priming job.
    void
    stop()
    Tells an Active cache to transition to Stopped state.
    void
    stop(com.azure.core.util.Context context)
    Tells an Active cache to transition to Stopped state.
    void
    stopPrimingJob()
    Schedule a priming job for deletion.
    void
    stopPrimingJob(PrimingJobIdParameter primingJobId, com.azure.core.util.Context context)
    Schedule a priming job for deletion.
    String
    subnet()
    Gets the subnet property: Subnet used for the cache.
    com.azure.core.management.SystemData
    systemData()
    Gets the systemData property: The system meta data relating to this resource.
    Map<String,String>
    tags()
    Gets the tags property: Resource tags.
    String
    type()
    Gets the type property: The type of the resource.
    Cache.Update
    update()
    Begins update for the Cache resource.
    void
    upgradeFirmware()
    Upgrade a cache's firmware if a new version is available.
    void
    upgradeFirmware(com.azure.core.util.Context context)
    Upgrade a cache's firmware if a new version is available.
    CacheUpgradeSettings
    upgradeSettings()
    Gets the upgradeSettings property: Upgrade settings of the cache.
    CacheUpgradeStatus
    upgradeStatus()
    Gets the upgradeStatus property: Upgrade status of the cache.
    List<String>
    zones()
    Gets the zones property: Availability zones for resources.

  • Method Details

    • id

      String id()
      Gets the id property: Fully qualified resource Id for the resource.
      Returns:
      the id value.

    • name

      String name()
      Gets the name property: The name of the resource.
      Returns:
      the name value.

    • type

      String type()
      Gets the type property: The type of the resource.
      Returns:
      the type value.

    • location

      String location()
      Gets the location property: The geo-location where the resource lives.
      Returns:
      the location value.

    • tags

      Map<String,String> tags()
      Gets the tags property: Resource tags.
      Returns:
      the tags value.

    • identity

      CacheIdentity identity()
      Gets the identity property: The identity of the cache, if configured.
      Returns:
      the identity value.

    • systemData

      com.azure.core.management.SystemData systemData()
      Gets the systemData property: The system meta data relating to this resource.
      Returns:
      the systemData value.

    • sku

      CacheSku sku()
      Gets the sku property: SKU for the cache.
      Returns:
      the sku value.

    • cacheSizeGB

      Integer cacheSizeGB()
      Gets the cacheSizeGB property: The size of this cache, in GB, when scalingFactor is 1.0. Values depend on the cache SKU - <a href="https://learn.microsoft.com/en-us/rest/api/storagecache/skus/list?tabs=HTTP">List SKUs</a>.
      Returns:
      the cacheSizeGB value.

    • scalingFactor

      Double scalingFactor()
      Gets the scalingFactor property: Multiplier that sets the current storage and throughput capacity of the cache. Values depend on the cache SKU - <a href="https://learn.microsoft.com/en-us/rest/api/storagecache/skus/list?tabs=HTTP">List SKUs</a>. Values above 1.0 increase the cache size and throughput - for example, the scaling factor 1.33 gives a cache that's 33% larger than its base size.
      Returns:
      the scalingFactor value.

    • health

      CacheHealth health()
      Gets the health property: Health of the cache.
      Returns:
      the health value.

    • mountAddresses

      List<String> mountAddresses()
      Gets the mountAddresses property: Array of IPv4 addresses that can be used by clients mounting this cache.
      Returns:
      the mountAddresses value.

    • provisioningState

      ProvisioningStateType provisioningState()
      Gets the provisioningState property: ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property.
      Returns:
      the provisioningState value.

    • subnet

      String subnet()
      Gets the subnet property: Subnet used for the cache.
      Returns:
      the subnet value.

    • upgradeStatus

      CacheUpgradeStatus upgradeStatus()
      Gets the upgradeStatus property: Upgrade status of the cache.
      Returns:
      the upgradeStatus value.

    • upgradeSettings

      CacheUpgradeSettings upgradeSettings()
      Gets the upgradeSettings property: Upgrade settings of the cache.
      Returns:
      the upgradeSettings value.

    • networkSettings

      CacheNetworkSettings networkSettings()
      Gets the networkSettings property: Specifies network settings of the cache.
      Returns:
      the networkSettings value.

    • encryptionSettings

      CacheEncryptionSettings encryptionSettings()
      Gets the encryptionSettings property: Specifies encryption settings of the cache.
      Returns:
      the encryptionSettings value.

    • securitySettings

      CacheSecuritySettings securitySettings()
      Gets the securitySettings property: Specifies security settings of the cache.
      Returns:
      the securitySettings value.

    • directoryServicesSettings

      CacheDirectorySettings directoryServicesSettings()
      Gets the directoryServicesSettings property: Specifies Directory Services settings of the cache.
      Returns:
      the directoryServicesSettings value.

    • zones

      List<String> zones()
      Gets the zones property: Availability zones for resources. This field should only contain a single element in the array.
      Returns:
      the zones value.

    • primingJobs

      List<PrimingJob> primingJobs()
      Gets the primingJobs property: Specifies the priming jobs defined in the cache.
      Returns:
      the primingJobs value.

    • spaceAllocation

      List<StorageTargetSpaceAllocation> spaceAllocation()
      Gets the spaceAllocation property: Specifies the space allocation percentage for each storage target in the cache.
      Returns:
      the spaceAllocation value.

    • region

      com.azure.core.management.Region region()
      Gets the region of the resource.
      Returns:
      the region of the resource.

    • regionName

      String regionName()
      Gets the name of the resource region.
      Returns:
      the name of the resource region.

    • resourceGroupName

      String resourceGroupName()
      Gets the name of the resource group.
      Returns:
      the name of the resource group.

    • innerModel

      CacheInner innerModel()
      Gets the inner com.azure.resourcemanager.storagecache.fluent.models.CacheInner object.
      Returns:
      the inner object.

    • update

      Cache.Update update()
      Begins update for the Cache resource.
      Returns:
      the stage of resource update.

    • refresh

      Cache refresh()
      Refreshes the resource to sync with Azure.
      Returns:
      the refreshed resource.

    • refresh

      Cache refresh(com.azure.core.util.Context context)
      Refreshes the resource to sync with Azure.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      the refreshed resource.

    • debugInfo

      void debugInfo()
      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.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • debugInfo

      void debugInfo(com.azure.core.util.Context context)
      Tells a cache to write generate debug info for support to process.
      Parameters:
      context - The context to associate with this operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • flush

      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.
      Throws:
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • flush

      void flush(com.azure.core.util.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.
      Parameters:
      context - The context to associate with this operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • start

      void start()
      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.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • start

      void start(com.azure.core.util.Context context)
      Tells a Stopped state cache to transition to Active state.
      Parameters:
      context - The context to associate with this operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • stop

      void stop()
      Tells an Active cache to transition to Stopped state.
      Throws:
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • stop

      void stop(com.azure.core.util.Context context)
      Tells an Active cache to transition to Stopped state.
      Parameters:
      context - The context to associate with this operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • startPrimingJob

      void startPrimingJob()
      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.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • startPrimingJob

      void startPrimingJob(PrimingJob primingjob, com.azure.core.util.Context context)
      Create a priming job. This operation is only allowed when the cache is healthy.
      Parameters:
      primingjob - Object containing the definition of a priming job.
      context - The context to associate with this operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • stopPrimingJob

      void stopPrimingJob()
      Schedule a priming job for deletion.
      Throws:
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • stopPrimingJob

      void stopPrimingJob(PrimingJobIdParameter primingJobId, com.azure.core.util.Context context)
      Schedule a priming job for deletion.
      Parameters:
      primingJobId - Object containing the priming job ID.
      context - The context to associate with this operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • pausePrimingJob

      void pausePrimingJob()
      Schedule a priming job to be paused.
      Throws:
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • pausePrimingJob

      void pausePrimingJob(PrimingJobIdParameter primingJobId, com.azure.core.util.Context context)
      Schedule a priming job to be paused.
      Parameters:
      primingJobId - Object containing the priming job ID.
      context - The context to associate with this operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • resumePrimingJob

      void resumePrimingJob()
      Resumes a paused priming job.
      Throws:
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • resumePrimingJob

      void resumePrimingJob(PrimingJobIdParameter primingJobId, com.azure.core.util.Context context)
      Resumes a paused priming job.
      Parameters:
      primingJobId - Object containing the priming job ID.
      context - The context to associate with this operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • upgradeFirmware

      void upgradeFirmware()
      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.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • upgradeFirmware

      void upgradeFirmware(com.azure.core.util.Context context)
      Upgrade a cache's firmware if a new version is available. Otherwise, this operation has no effect.
      Parameters:
      context - The context to associate with this operation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.