Caches Interface

Package:

com.azure.resourcemanager.storagecache.models

Maven Artifact:

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

public interface Caches

Resource collection API of Caches.

Method Summary

Modifier and Type	Method and Description
abstract void	debugInfo(String resourceGroupName, String cacheName) Tells a cache to write generate debug info for support to process.
abstract void	debugInfo(String resourceGroupName, String cacheName, Context context) Tells a cache to write generate debug info for support to process.
abstract Blank	define(String name) Begins definition for a new Cache resource.
abstract void	delete(String resourceGroupName, String cacheName, Context context) Schedules a cache for deletion.
abstract void	deleteById(String id) Schedules a cache for deletion.
abstract void	deleteByIdWithResponse(String id, Context context) Schedules a cache for deletion.
abstract void	deleteByResourceGroup(String resourceGroupName, String cacheName) Schedules a cache for deletion.
abstract void	flush(String resourceGroupName, String cacheName) Tells a cache to write all dirty data to the Storage Target(s).
abstract void	flush(String resourceGroupName, String cacheName, Context context) Tells a cache to write all dirty data to the Storage Target(s).
abstract Cache	getById(String id) Returns a cache.
abstract Response<Cache>	getByIdWithResponse(String id, Context context) Returns a cache.
abstract Cache	getByResourceGroup(String resourceGroupName, String cacheName) Returns a cache.
abstract Response<Cache>	getByResourceGroupWithResponse(String resourceGroupName, String cacheName, Context context) Returns a cache.
abstract PagedIterable<Cache>	list() Returns all caches the user has access to under a subscription.
abstract PagedIterable<Cache>	list(Context context) Returns all caches the user has access to under a subscription.
abstract PagedIterable<Cache>	listByResourceGroup(String resourceGroupName) Returns all caches the user has access to under a resource group.
abstract PagedIterable<Cache>	listByResourceGroup(String resourceGroupName, Context context) Returns all caches the user has access to under a resource group.
abstract void	pausePrimingJob(String resourceGroupName, String cacheName) Schedule a priming job to be paused.
abstract void	pausePrimingJob(String resourceGroupName, String cacheName, PrimingJobIdParameter primingJobId, Context context) Schedule a priming job to be paused.
abstract void	resumePrimingJob(String resourceGroupName, String cacheName) Resumes a paused priming job.
abstract void	resumePrimingJob(String resourceGroupName, String cacheName, PrimingJobIdParameter primingJobId, Context context) Resumes a paused priming job.
abstract void	spaceAllocation(String resourceGroupName, String cacheName) Update cache space allocation.
abstract void	spaceAllocation(String resourceGroupName, String cacheName, List<StorageTargetSpaceAllocation> spaceAllocation, Context context) Update cache space allocation.
abstract void	start(String resourceGroupName, String cacheName) Tells a Stopped state cache to transition to Active state.
abstract void	start(String resourceGroupName, String cacheName, Context context) Tells a Stopped state cache to transition to Active state.
abstract void	startPrimingJob(String resourceGroupName, String cacheName) Create a priming job.
abstract void	startPrimingJob(String resourceGroupName, String cacheName, PrimingJob primingjob, Context context) Create a priming job.
abstract void	stop(String resourceGroupName, String cacheName) Tells an Active cache to transition to Stopped state.
abstract void	stop(String resourceGroupName, String cacheName, Context context) Tells an Active cache to transition to Stopped state.
abstract void	stopPrimingJob(String resourceGroupName, String cacheName) Schedule a priming job for deletion.
abstract void	stopPrimingJob(String resourceGroupName, String cacheName, PrimingJobIdParameter primingJobId, Context context) Schedule a priming job for deletion.
abstract void	upgradeFirmware(String resourceGroupName, String cacheName) Upgrade a cache's firmware if a new version is available.
abstract void	upgradeFirmware(String resourceGroupName, String cacheName, Context context) Upgrade a cache's firmware if a new version is available.

Method Details

debugInfo

public abstract void debugInfo(String resourceGroupName, String cacheName)

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

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

cacheName - Name of cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.

debugInfo

public abstract void debugInfo(String resourceGroupName, String cacheName, Context context)

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

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

cacheName - Name of cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.

context - The context to associate with this operation.

define

public abstract Cache.DefinitionStages.Blank define(String name)

Begins definition for a new Cache resource.

Parameters:

name - resource name.

Returns:

the first stage of the new Cache definition.

delete

public abstract void delete(String resourceGroupName, String cacheName, Context context)

Schedules a cache for deletion.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

cacheName - Name of cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.

context - The context to associate with this operation.

deleteById

public abstract void deleteById(String id)

Schedules a cache for deletion.

Parameters:

id - the resource ID.

deleteByIdWithResponse

public abstract void deleteByIdWithResponse(String id, Context context)

Schedules a cache for deletion.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

deleteByResourceGroup

public abstract void deleteByResourceGroup(String resourceGroupName, String cacheName)

Schedules a cache for deletion.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

cacheName - Name of cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.

flush

public abstract void flush(String resourceGroupName, String cacheName)

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:

resourceGroupName - The name of the resource group. The name is case insensitive.

cacheName - Name of cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.

flush

public abstract void flush(String resourceGroupName, String cacheName, 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:

resourceGroupName - The name of the resource group. The name is case insensitive.

cacheName - Name of cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.

context - The context to associate with this operation.

getById

public abstract Cache getById(String id)

Returns a cache.

Parameters:

id - the resource ID.

Returns:

a cache instance along with Response<T>.

getByIdWithResponse

public abstract Response getByIdWithResponse(String id, Context context)

Returns a cache.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

a cache instance along with Response<T>.

getByResourceGroup

public abstract Cache getByResourceGroup(String resourceGroupName, String cacheName)

Returns a cache.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

cacheName - Name of cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.

Returns:

a cache instance.

getByResourceGroupWithResponse

public abstract Response getByResourceGroupWithResponse(String resourceGroupName, String cacheName, Context context)

Returns a cache.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

cacheName - Name of cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.

context - The context to associate with this operation.

Returns:

a cache instance along with Response<T>.

list

public abstract PagedIterable list()

Returns all caches the user has access to under a subscription.

Returns:

result of the request to list caches as paginated response with PagedIterable<T>.

list

public abstract PagedIterable list(Context context)

Returns all caches the user has access to under a subscription.

Parameters:

context - The context to associate with this operation.

Returns:

result of the request to list caches as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable listByResourceGroup(String resourceGroupName)

Returns all caches the user has access to under a resource group.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

Returns:

result of the request to list caches as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable listByResourceGroup(String resourceGroupName, Context context)

Returns all caches the user has access to under a resource group.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

context - The context to associate with this operation.

Returns:

result of the request to list caches as paginated response with PagedIterable<T>.

pausePrimingJob

public abstract void pausePrimingJob(String resourceGroupName, String cacheName)

Schedule a priming job to be paused.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

cacheName - Name of cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.

pausePrimingJob

public abstract void pausePrimingJob(String resourceGroupName, String cacheName, PrimingJobIdParameter primingJobId, Context context)

Schedule a priming job to be paused.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

cacheName - Name of cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.

primingJobId - Object containing the priming job ID.

context - The context to associate with this operation.

resumePrimingJob

public abstract void resumePrimingJob(String resourceGroupName, String cacheName)

Resumes a paused priming job.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

cacheName - Name of cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.

resumePrimingJob

public abstract void resumePrimingJob(String resourceGroupName, String cacheName, PrimingJobIdParameter primingJobId, Context context)

Resumes a paused priming job.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

cacheName - Name of cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.

primingJobId - Object containing the priming job ID.

context - The context to associate with this operation.

spaceAllocation

public abstract void spaceAllocation(String resourceGroupName, String cacheName)

Update cache space allocation.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

cacheName - Name of cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.

spaceAllocation

public abstract void spaceAllocation(String resourceGroupName, String cacheName, List spaceAllocation, Context context)

Update cache space allocation.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

cacheName - Name of cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.

spaceAllocation - List containing storage target cache space percentage allocations.

context - The context to associate with this operation.

start

public abstract void start(String resourceGroupName, String cacheName)

Tells a Stopped state cache to transition to Active state.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

cacheName - Name of cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.

start

public abstract void start(String resourceGroupName, String cacheName, Context context)

Tells a Stopped state cache to transition to Active state.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

cacheName - Name of cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.

context - The context to associate with this operation.

startPrimingJob

public abstract void startPrimingJob(String resourceGroupName, String cacheName)

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

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

cacheName - Name of cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.

startPrimingJob

public abstract void startPrimingJob(String resourceGroupName, String cacheName, PrimingJob primingjob, Context context)

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

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

cacheName - Name of cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.

primingjob - Object containing the definition of a priming job.

context - The context to associate with this operation.

stop

public abstract void stop(String resourceGroupName, String cacheName)

Tells an Active cache to transition to Stopped state.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

cacheName - Name of cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.

stop

public abstract void stop(String resourceGroupName, String cacheName, Context context)

Tells an Active cache to transition to Stopped state.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

cacheName - Name of cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.

context - The context to associate with this operation.

stopPrimingJob

public abstract void stopPrimingJob(String resourceGroupName, String cacheName)

Schedule a priming job for deletion.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

cacheName - Name of cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.

stopPrimingJob

public abstract void stopPrimingJob(String resourceGroupName, String cacheName, PrimingJobIdParameter primingJobId, Context context)

Schedule a priming job for deletion.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

cacheName - Name of cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.

primingJobId - Object containing the priming job ID.

context - The context to associate with this operation.

upgradeFirmware

public abstract void upgradeFirmware(String resourceGroupName, String cacheName)

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

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

cacheName - Name of cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.

upgradeFirmware

public abstract void upgradeFirmware(String resourceGroupName, String cacheName, Context context)

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

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

cacheName - Name of cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.

context - The context to associate with this operation.