Interface Caches
-
public interface Caches
Resource collection API of Caches.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description CacheContract.DefinitionStages.Blank
define(String name)
Begins definition for a new CacheContract resource.void
delete(String resourceGroupName, String serviceName, String cacheId, String ifMatch)
Deletes specific Cache.void
deleteById(String id)
Deletes specific Cache.com.azure.core.http.rest.Response<Void>
deleteByIdWithResponse(String id, String ifMatch, com.azure.core.util.Context context)
Deletes specific Cache.com.azure.core.http.rest.Response<Void>
deleteWithResponse(String resourceGroupName, String serviceName, String cacheId, String ifMatch, com.azure.core.util.Context context)
Deletes specific Cache.CacheContract
get(String resourceGroupName, String serviceName, String cacheId)
Gets the details of the Cache specified by its identifier.CacheContract
getById(String id)
Gets the details of the Cache specified by its identifier.com.azure.core.http.rest.Response<CacheContract>
getByIdWithResponse(String id, com.azure.core.util.Context context)
Gets the details of the Cache specified by its identifier.void
getEntityTag(String resourceGroupName, String serviceName, String cacheId)
Gets the entity state (Etag) version of the Cache specified by its identifier.CachesGetEntityTagResponse
getEntityTagWithResponse(String resourceGroupName, String serviceName, String cacheId, com.azure.core.util.Context context)
Gets the entity state (Etag) version of the Cache specified by its identifier.com.azure.core.http.rest.Response<CacheContract>
getWithResponse(String resourceGroupName, String serviceName, String cacheId, com.azure.core.util.Context context)
Gets the details of the Cache specified by its identifier.com.azure.core.http.rest.PagedIterable<CacheContract>
listByService(String resourceGroupName, String serviceName)
Lists a collection of all external Caches in the specified service instance.com.azure.core.http.rest.PagedIterable<CacheContract>
listByService(String resourceGroupName, String serviceName, Integer top, Integer skip, com.azure.core.util.Context context)
Lists a collection of all external Caches in the specified service instance.
-
-
-
Method Detail
-
listByService
com.azure.core.http.rest.PagedIterable<CacheContract> listByService(String resourceGroupName, String serviceName)
Lists a collection of all external Caches in the specified service instance.- Parameters:
resourceGroupName
- The name of the resource group.serviceName
- The name of the API Management service.- Returns:
- paged Caches list representation 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.
-
listByService
com.azure.core.http.rest.PagedIterable<CacheContract> listByService(String resourceGroupName, String serviceName, Integer top, Integer skip, com.azure.core.util.Context context)
Lists a collection of all external Caches in the specified service instance.- Parameters:
resourceGroupName
- The name of the resource group.serviceName
- The name of the API Management service.top
- Number of records to return.skip
- Number of records to skip.context
- The context to associate with this operation.- Returns:
- paged Caches list representation 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.
-
getEntityTag
void getEntityTag(String resourceGroupName, String serviceName, String cacheId)
Gets the entity state (Etag) version of the Cache specified by its identifier.- Parameters:
resourceGroupName
- The name of the resource group.serviceName
- The name of the API Management service.cacheId
- Identifier of the Cache entity. Cache identifier (should be either 'default' or valid Azure region identifier).- 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.
-
getEntityTagWithResponse
CachesGetEntityTagResponse getEntityTagWithResponse(String resourceGroupName, String serviceName, String cacheId, com.azure.core.util.Context context)
Gets the entity state (Etag) version of the Cache specified by its identifier.- Parameters:
resourceGroupName
- The name of the resource group.serviceName
- The name of the API Management service.cacheId
- Identifier of the Cache entity. Cache identifier (should be either 'default' or valid Azure region identifier).context
- The context to associate with this operation.- Returns:
- the entity state (Etag) version of the Cache specified by its identifier.
- 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.
-
get
CacheContract get(String resourceGroupName, String serviceName, String cacheId)
Gets the details of the Cache specified by its identifier.- Parameters:
resourceGroupName
- The name of the resource group.serviceName
- The name of the API Management service.cacheId
- Identifier of the Cache entity. Cache identifier (should be either 'default' or valid Azure region identifier).- Returns:
- the details of the Cache specified by its identifier.
- 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.
-
getWithResponse
com.azure.core.http.rest.Response<CacheContract> getWithResponse(String resourceGroupName, String serviceName, String cacheId, com.azure.core.util.Context context)
Gets the details of the Cache specified by its identifier.- Parameters:
resourceGroupName
- The name of the resource group.serviceName
- The name of the API Management service.cacheId
- Identifier of the Cache entity. Cache identifier (should be either 'default' or valid Azure region identifier).context
- The context to associate with this operation.- Returns:
- the details of the Cache specified by its identifier.
- 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
void delete(String resourceGroupName, String serviceName, String cacheId, String ifMatch)
Deletes specific Cache.- Parameters:
resourceGroupName
- The name of the resource group.serviceName
- The name of the API Management service.cacheId
- Identifier of the Cache entity. Cache identifier (should be either 'default' or valid Azure region identifier).ifMatch
- ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.- 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.
-
deleteWithResponse
com.azure.core.http.rest.Response<Void> deleteWithResponse(String resourceGroupName, String serviceName, String cacheId, String ifMatch, com.azure.core.util.Context context)
Deletes specific Cache.- Parameters:
resourceGroupName
- The name of the resource group.serviceName
- The name of the API Management service.cacheId
- Identifier of the Cache entity. Cache identifier (should be either 'default' or valid Azure region identifier).ifMatch
- ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.context
- The context to associate with this operation.- Returns:
- the
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.
-
getById
CacheContract getById(String id)
Gets the details of the Cache specified by its identifier.- Parameters:
id
- the resource ID.- Returns:
- the details of the Cache specified by its identifier.
- 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.
-
getByIdWithResponse
com.azure.core.http.rest.Response<CacheContract> getByIdWithResponse(String id, com.azure.core.util.Context context)
Gets the details of the Cache specified by its identifier.- Parameters:
id
- the resource ID.context
- The context to associate with this operation.- Returns:
- the details of the Cache specified by its identifier.
- 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.
-
deleteById
void deleteById(String id)
Deletes specific Cache.- Parameters:
id
- the resource ID.- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
deleteByIdWithResponse
com.azure.core.http.rest.Response<Void> deleteByIdWithResponse(String id, String ifMatch, com.azure.core.util.Context context)
Deletes specific Cache.- Parameters:
id
- the resource ID.ifMatch
- ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.context
- The context to associate with this operation.- Returns:
- the
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.
-
define
CacheContract.DefinitionStages.Blank define(String name)
Begins definition for a new CacheContract resource.- Parameters:
name
- resource name.- Returns:
- the first stage of the new CacheContract definition.
-
-