Interface CachesClient
public interface CachesClient
An instance of this class provides access to all the operations defined in CachesClient.
-
Method Summary
Modifier and TypeMethodDescriptioncom.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<CacheInner>,
CacheInner> beginCreateOrUpdate
(String resourceGroupName, String cacheName, CacheInner cache) Create or update a cache.com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<CacheInner>,
CacheInner> beginCreateOrUpdate
(String resourceGroupName, String cacheName, CacheInner cache, com.azure.core.util.Context context) Create or update a cache.beginDebugInfo
(String resourceGroupName, String cacheName) Tells a cache to write generate debug info for support to process.beginDebugInfo
(String resourceGroupName, String cacheName, com.azure.core.util.Context context) Tells a cache to write generate debug info for support to process.beginDelete
(String resourceGroupName, String cacheName) Schedules a cache for deletion.beginDelete
(String resourceGroupName, String cacheName, com.azure.core.util.Context context) Schedules a cache for deletion.beginFlush
(String resourceGroupName, String cacheName) Tells a cache to write all dirty data to the Storage Target(s).beginFlush
(String resourceGroupName, String cacheName, com.azure.core.util.Context context) Tells a cache to write all dirty data to the Storage Target(s).beginPausePrimingJob
(String resourceGroupName, String cacheName) Schedule a priming job to be paused.beginPausePrimingJob
(String resourceGroupName, String cacheName, PrimingJobIdParameter primingJobId, com.azure.core.util.Context context) Schedule a priming job to be paused.beginResumePrimingJob
(String resourceGroupName, String cacheName) Resumes a paused priming job.beginResumePrimingJob
(String resourceGroupName, String cacheName, PrimingJobIdParameter primingJobId, com.azure.core.util.Context context) Resumes a paused priming job.beginSpaceAllocation
(String resourceGroupName, String cacheName) Update cache space allocation.beginSpaceAllocation
(String resourceGroupName, String cacheName, List<StorageTargetSpaceAllocation> spaceAllocation, com.azure.core.util.Context context) Update cache space allocation.beginStart
(String resourceGroupName, String cacheName) Tells a Stopped state cache to transition to Active state.beginStart
(String resourceGroupName, String cacheName, com.azure.core.util.Context context) Tells a Stopped state cache to transition to Active state.beginStartPrimingJob
(String resourceGroupName, String cacheName) Create a priming job.beginStartPrimingJob
(String resourceGroupName, String cacheName, PrimingJob primingjob, com.azure.core.util.Context context) Create a priming job.Tells an Active cache to transition to Stopped state.Tells an Active cache to transition to Stopped state.beginStopPrimingJob
(String resourceGroupName, String cacheName) Schedule a priming job for deletion.beginStopPrimingJob
(String resourceGroupName, String cacheName, PrimingJobIdParameter primingJobId, com.azure.core.util.Context context) Schedule a priming job for deletion.com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<CacheInner>,
CacheInner> beginUpdate
(String resourceGroupName, String cacheName) Update a cache instance.com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<CacheInner>,
CacheInner> beginUpdate
(String resourceGroupName, String cacheName, CacheInner cache, com.azure.core.util.Context context) Update a cache instance.beginUpgradeFirmware
(String resourceGroupName, String cacheName) Upgrade a cache's firmware if a new version is available.beginUpgradeFirmware
(String resourceGroupName, String cacheName, com.azure.core.util.Context context) Upgrade a cache's firmware if a new version is available.createOrUpdate
(String resourceGroupName, String cacheName, CacheInner cache) Create or update a cache.createOrUpdate
(String resourceGroupName, String cacheName, CacheInner cache, com.azure.core.util.Context context) Create or update a cache.void
Tells a cache to write generate debug info for support to process.void
Tells a cache to write generate debug info for support to process.void
Schedules a cache for deletion.void
Schedules a cache for deletion.void
Tells a cache to write all dirty data to the Storage Target(s).void
Tells a cache to write all dirty data to the Storage Target(s).getByResourceGroup
(String resourceGroupName, String cacheName) Returns a cache.com.azure.core.http.rest.Response<CacheInner>
getByResourceGroupWithResponse
(String resourceGroupName, String cacheName, com.azure.core.util.Context context) Returns a cache.com.azure.core.http.rest.PagedIterable<CacheInner>
list()
Returns all caches the user has access to under a subscription.com.azure.core.http.rest.PagedIterable<CacheInner>
list
(com.azure.core.util.Context context) Returns all caches the user has access to under a subscription.com.azure.core.http.rest.PagedIterable<CacheInner>
listByResourceGroup
(String resourceGroupName) Returns all caches the user has access to under a resource group.com.azure.core.http.rest.PagedIterable<CacheInner>
listByResourceGroup
(String resourceGroupName, com.azure.core.util.Context context) Returns all caches the user has access to under a resource group.void
pausePrimingJob
(String resourceGroupName, String cacheName) Schedule a priming job to be paused.void
pausePrimingJob
(String resourceGroupName, String cacheName, PrimingJobIdParameter primingJobId, com.azure.core.util.Context context) Schedule a priming job to be paused.void
resumePrimingJob
(String resourceGroupName, String cacheName) Resumes a paused priming job.void
resumePrimingJob
(String resourceGroupName, String cacheName, PrimingJobIdParameter primingJobId, com.azure.core.util.Context context) Resumes a paused priming job.void
spaceAllocation
(String resourceGroupName, String cacheName) Update cache space allocation.void
spaceAllocation
(String resourceGroupName, String cacheName, List<StorageTargetSpaceAllocation> spaceAllocation, com.azure.core.util.Context context) Update cache space allocation.void
Tells a Stopped state cache to transition to Active state.void
Tells a Stopped state cache to transition to Active state.void
startPrimingJob
(String resourceGroupName, String cacheName) Create a priming job.void
startPrimingJob
(String resourceGroupName, String cacheName, PrimingJob primingjob, com.azure.core.util.Context context) Create a priming job.void
Tells an Active cache to transition to Stopped state.void
Tells an Active cache to transition to Stopped state.void
stopPrimingJob
(String resourceGroupName, String cacheName) Schedule a priming job for deletion.void
stopPrimingJob
(String resourceGroupName, String cacheName, PrimingJobIdParameter primingJobId, com.azure.core.util.Context context) Schedule a priming job for deletion.Update a cache instance.update
(String resourceGroupName, String cacheName, CacheInner cache, com.azure.core.util.Context context) Update a cache instance.void
upgradeFirmware
(String resourceGroupName, String cacheName) Upgrade a cache's firmware if a new version is available.void
upgradeFirmware
(String resourceGroupName, String cacheName, com.azure.core.util.Context context) Upgrade a cache's firmware if a new version is available.
-
Method Details
-
list
com.azure.core.http.rest.PagedIterable<CacheInner> 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
. - 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.
-
list
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
. - 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.
-
listByResourceGroup
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
. - 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.
-
listByResourceGroup
com.azure.core.http.rest.PagedIterable<CacheInner> listByResourceGroup(String resourceGroupName, com.azure.core.util.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
. - 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.
-
beginDelete
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginDelete(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.- Returns:
- the
SyncPoller
for polling of long-running 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.
-
beginDelete
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginDelete(String resourceGroupName, String cacheName, com.azure.core.util.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.- Returns:
- the
SyncPoller
for polling of long-running 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.
-
delete
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.- 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.
-
delete
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.- 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.
-
getByResourceGroupWithResponse
com.azure.core.http.rest.Response<CacheInner> getByResourceGroupWithResponse(String resourceGroupName, String cacheName, com.azure.core.util.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
. - 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.
-
getByResourceGroup
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.
- 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.
-
beginCreateOrUpdate
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<CacheInner>,CacheInner> beginCreateOrUpdate(String resourceGroupName, String cacheName, CacheInner cache) Create or update 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.cache
- Object containing the user-selectable properties of the new cache. If read-only properties are included, they must match the existing values of those properties.- Returns:
- the
SyncPoller
for polling of a cache instance. - 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.
-
beginCreateOrUpdate
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<CacheInner>,CacheInner> beginCreateOrUpdate(String resourceGroupName, String cacheName, CacheInner cache, com.azure.core.util.Context context) Create or update 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.cache
- Object containing the user-selectable properties of the new cache. If read-only properties are included, they must match the existing values of those properties.context
- The context to associate with this operation.- Returns:
- the
SyncPoller
for polling of a cache instance. - 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.
-
createOrUpdate
Create or update 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.cache
- Object containing the user-selectable properties of the new cache. If read-only properties are included, they must match the existing values of those properties.- Returns:
- a cache instance.
- 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.
-
createOrUpdate
CacheInner createOrUpdate(String resourceGroupName, String cacheName, CacheInner cache, com.azure.core.util.Context context) Create or update 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.cache
- Object containing the user-selectable properties of the new cache. If read-only properties are included, they must match the existing values of those properties.context
- The context to associate with this operation.- Returns:
- a cache instance.
- 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.
-
beginUpdate
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<CacheInner>,CacheInner> beginUpdate(String resourceGroupName, String cacheName) Update a cache instance.- 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:
- the
SyncPoller
for polling of a cache instance. - 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.
-
beginUpdate
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<CacheInner>,CacheInner> beginUpdate(String resourceGroupName, String cacheName, CacheInner cache, com.azure.core.util.Context context) Update a cache instance.- 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.cache
- Object containing the user-selectable properties of the cache. If read-only properties are included, they must match the existing values of those properties.context
- The context to associate with this operation.- Returns:
- the
SyncPoller
for polling of a cache instance. - 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.
-
update
Update a cache instance.- 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.
- 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.
-
update
CacheInner update(String resourceGroupName, String cacheName, CacheInner cache, com.azure.core.util.Context context) Update a cache instance.- 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.cache
- Object containing the user-selectable properties of the cache. If read-only properties are included, they must match the existing values of those properties.context
- The context to associate with this operation.- Returns:
- a cache instance.
- 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.
-
beginDebugInfo
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginDebugInfo(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.- Returns:
- the
SyncPoller
for polling of long-running 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.
-
beginDebugInfo
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginDebugInfo(String resourceGroupName, String cacheName, com.azure.core.util.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.- Returns:
- the
SyncPoller
for polling of long-running 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.
-
debugInfo
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.- 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.
-
debugInfo
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.- 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.
-
beginFlush
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginFlush(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.- Returns:
- the
SyncPoller
for polling of long-running 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.
-
beginFlush
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginFlush(String resourceGroupName, String cacheName, 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:
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:
- the
SyncPoller
for polling of long-running 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
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.- 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
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.- 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.
-
beginStart
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginStart(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.- Returns:
- the
SyncPoller
for polling of long-running 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.
-
beginStart
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginStart(String resourceGroupName, String cacheName, com.azure.core.util.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.- Returns:
- the
SyncPoller
for polling of long-running 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
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.- 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
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.- 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.
-
beginStop
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginStop(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.- Returns:
- the
SyncPoller
for polling of long-running 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.
-
beginStop
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginStop(String resourceGroupName, String cacheName, com.azure.core.util.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.- Returns:
- the
SyncPoller
for polling of long-running 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
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.- 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
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.- 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.
-
beginStartPrimingJob
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginStartPrimingJob(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.- Returns:
- the
SyncPoller
for polling of long-running 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.
-
beginStartPrimingJob
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginStartPrimingJob(String resourceGroupName, String cacheName, PrimingJob primingjob, com.azure.core.util.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.- Returns:
- the
SyncPoller
for polling of long-running 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
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.- 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(String resourceGroupName, String cacheName, PrimingJob primingjob, com.azure.core.util.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.- 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.
-
beginStopPrimingJob
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginStopPrimingJob(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.- Returns:
- the
SyncPoller
for polling of long-running 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.
-
beginStopPrimingJob
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginStopPrimingJob(String resourceGroupName, String cacheName, PrimingJobIdParameter primingJobId, com.azure.core.util.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.- Returns:
- the
SyncPoller
for polling of long-running 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
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.- 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(String resourceGroupName, String cacheName, PrimingJobIdParameter primingJobId, com.azure.core.util.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.- 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.
-
beginPausePrimingJob
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginPausePrimingJob(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.- Returns:
- the
SyncPoller
for polling of long-running 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.
-
beginPausePrimingJob
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginPausePrimingJob(String resourceGroupName, String cacheName, PrimingJobIdParameter primingJobId, com.azure.core.util.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.- Returns:
- the
SyncPoller
for polling of long-running 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
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.- 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(String resourceGroupName, String cacheName, PrimingJobIdParameter primingJobId, com.azure.core.util.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.- 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.
-
beginResumePrimingJob
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginResumePrimingJob(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.- Returns:
- the
SyncPoller
for polling of long-running 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.
-
beginResumePrimingJob
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginResumePrimingJob(String resourceGroupName, String cacheName, PrimingJobIdParameter primingJobId, com.azure.core.util.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.- Returns:
- the
SyncPoller
for polling of long-running 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
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.- 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(String resourceGroupName, String cacheName, PrimingJobIdParameter primingJobId, com.azure.core.util.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.- 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.
-
beginUpgradeFirmware
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginUpgradeFirmware(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.- Returns:
- the
SyncPoller
for polling of long-running 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.
-
beginUpgradeFirmware
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginUpgradeFirmware(String resourceGroupName, String cacheName, com.azure.core.util.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.- Returns:
- the
SyncPoller
for polling of long-running 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
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.- 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(String resourceGroupName, String cacheName, com.azure.core.util.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.- 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.
-
beginSpaceAllocation
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginSpaceAllocation(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.- Returns:
- the
SyncPoller
for polling of long-running 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.
-
beginSpaceAllocation
com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginSpaceAllocation(String resourceGroupName, String cacheName, List<StorageTargetSpaceAllocation> spaceAllocation, com.azure.core.util.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.- Returns:
- the
SyncPoller
for polling of long-running 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.
-
spaceAllocation
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.- 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.
-
spaceAllocation
void spaceAllocation(String resourceGroupName, String cacheName, List<StorageTargetSpaceAllocation> spaceAllocation, com.azure.core.util.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.- 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.
-