Cache Interface

Package:

com.azure.resourcemanager.storagecache.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-storagecache:1.0.0-beta.10

public interface Cache

An immutable client-side representation of Cache.

Method Summary

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

Method Details

cacheSizeGB

public abstract Integer cacheSizeGB()

Gets the cacheSizeGB property: The size of this Cache, in GB.

Returns:

the cacheSizeGB value.

debugInfo

public abstract void debugInfo()

Tells a cache to write generate debug info for support to process.

debugInfo

public abstract void debugInfo(Context context)

Tells a cache to write generate debug info for support to process.

Parameters:

context - The context to associate with this operation.

directoryServicesSettings

public abstract CacheDirectorySettings directoryServicesSettings()

Gets the directoryServicesSettings property: Specifies Directory Services settings of the cache.

Returns:

the directoryServicesSettings value.

encryptionSettings

public abstract CacheEncryptionSettings encryptionSettings()

Gets the encryptionSettings property: Specifies encryption settings of the cache.

Returns:

the encryptionSettings value.

flush

public abstract 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.

flush

public abstract void flush(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.

health

public abstract CacheHealth health()

Gets the health property: Health of the cache.

Returns:

the health value.

id

public abstract String id()

Gets the id property: Fully qualified resource Id for the resource.

Returns:

the id value.

identity

public abstract CacheIdentity identity()

Gets the identity property: The identity of the cache, if configured.

Returns:

the identity value.

innerModel

public abstract CacheInner innerModel()

Gets the inner com.azure.resourcemanager.storagecache.fluent.models.CacheInner object.

Returns:

the inner object.

location

public abstract String location()

Gets the location property: The geo-location where the resource lives.

Returns:

the location value.

mountAddresses

public abstract List mountAddresses()

Gets the mountAddresses property: Array of IPv4 addresses that can be used by clients mounting this cache.

Returns:

the mountAddresses value.

name

public abstract String name()

Gets the name property: The name of the resource.

Returns:

the name value.

networkSettings

public abstract CacheNetworkSettings networkSettings()

Gets the networkSettings property: Specifies network settings of the cache.

Returns:

the networkSettings value.

pausePrimingJob

public abstract void pausePrimingJob()

Schedule a priming job to be paused.

pausePrimingJob

public abstract void pausePrimingJob(PrimingJobIdParameter primingJobId, 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.

primingJobs

public abstract List primingJobs()

Gets the primingJobs property: Specifies the priming jobs defined in the cache.

Returns:

the primingJobs value.

provisioningState

public abstract 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.

refresh

public abstract Cache refresh()

Refreshes the resource to sync with Azure.

Returns:

the refreshed resource.

refresh

public abstract Cache refresh(Context context)

Refreshes the resource to sync with Azure.

Parameters:

context - The context to associate with this operation.

Returns:

the refreshed resource.

region

public abstract Region region()

Gets the region of the resource.

Returns:

the region of the resource.

regionName

public abstract String regionName()

Gets the name of the resource region.

Returns:

the name of the resource region.

resourceGroupName

public abstract String resourceGroupName()

Gets the name of the resource group.

Returns:

the name of the resource group.

resumePrimingJob

public abstract void resumePrimingJob()

Resumes a paused priming job.

resumePrimingJob

public abstract void resumePrimingJob(PrimingJobIdParameter primingJobId, Context context)

Resumes a paused priming job.

Parameters:

primingJobId - Object containing the priming job ID.

context - The context to associate with this operation.

securitySettings

public abstract CacheSecuritySettings securitySettings()

Gets the securitySettings property: Specifies security settings of the cache.

Returns:

the securitySettings value.

sku

public abstract CacheSku sku()

Gets the sku property: SKU for the cache.

Returns:

the sku value.

spaceAllocation

public abstract List spaceAllocation()

Gets the spaceAllocation property: Specifies the space allocation percentage for each storage target in the cache.

Returns:

the spaceAllocation value.

start

public abstract void start()

Tells a Stopped state cache to transition to Active state.

start

public abstract void start(Context context)

Tells a Stopped state cache to transition to Active state.

Parameters:

context - The context to associate with this operation.

startPrimingJob

public abstract void startPrimingJob()

Create a priming job. This operation is only allowed when the cache is healthy.

startPrimingJob

public abstract void startPrimingJob(PrimingJob primingjob, 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.

stop

public abstract void stop()

Tells an Active cache to transition to Stopped state.

stop

public abstract void stop(Context context)

Tells an Active cache to transition to Stopped state.

Parameters:

context - The context to associate with this operation.

stopPrimingJob

public abstract void stopPrimingJob()

Schedule a priming job for deletion.

stopPrimingJob

public abstract void stopPrimingJob(PrimingJobIdParameter primingJobId, Context context)

Schedule a priming job for deletion.

Parameters:

primingJobId - Object containing the priming job ID.

context - The context to associate with this operation.

subnet

public abstract String subnet()

Gets the subnet property: Subnet used for the cache.

Returns:

the subnet value.

systemData

public abstract SystemData systemData()

Gets the systemData property: The system meta data relating to this resource.

Returns:

the systemData value.

tags

public abstract Map tags()

Gets the tags property: Resource tags.

Returns:

the tags value.

type

public abstract String type()

Gets the type property: The type of the resource.

Returns:

the type value.

update

public abstract Cache.Update update()

Begins update for the Cache resource.

Returns:

the stage of resource update.

upgradeFirmware

public abstract void upgradeFirmware()

Upgrade a cache's firmware if a new version is available. Otherwise, this operation has no effect.

upgradeFirmware

public abstract void upgradeFirmware(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.

upgradeSettings

public abstract CacheUpgradeSettings upgradeSettings()

Gets the upgradeSettings property: Upgrade settings of the cache.

Returns:

the upgradeSettings value.

upgradeStatus

public abstract CacheUpgradeStatus upgradeStatus()

Gets the upgradeStatus property: Upgrade status of the cache.

Returns:

the upgradeStatus value.

zones

public abstract List zones()

Gets the zones property: Availability zones for resources. This field should only contain a single element in the array.

Returns:

the zones value.