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

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      Integer cacheSizeGB()
      Gets the cacheSizeGB property: The size of this Cache, in GB.
      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 IP 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.
      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.
      CacheSecuritySettings securitySettings()
      Gets the securitySettings property: Specifies security settings of the cache.
      CacheSku sku()
      Gets the sku property: SKU for 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 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.
      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.
      CacheUpgradeStatus upgradeStatus()
      Gets the upgradeStatus property: Upgrade status of the Cache.
      List<String> zones()
      Gets the zones property: Availability zones for resources.

    • Method Detail

      • 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.

      • 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.

      • 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.

      • 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.

      • 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.