public interface Cache
An immutable client-side representation of Cache.
  • 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.
      Returns:
      the cacheSizeGB 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 IP 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

      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(PrimingJob primingjob)
      Create a priming job. This operation is only allowed when the cache is healthy.
      Parameters:
      primingjob - Object containing the definition of a priming job.
      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(PrimingJobIdParameter primingJobId)
      Schedule a priming job for deletion.
      Parameters:
      primingJobId - Object containing the priming job ID.
      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(PrimingJobIdParameter primingJobId)
      Schedule a priming job to be paused.
      Parameters:
      primingJobId - Object containing the priming job ID.
      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(PrimingJobIdParameter primingJobId)
      Resumes a paused priming job.
      Parameters:
      primingJobId - Object containing the priming job ID.
      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.