Caches Interface

Package:

com.azure.resourcemanager.apimanagement.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-apimanagement:1.0.0-beta.4

public interface Caches

Resource collection API of Caches.

Method Summary

Modifier and Type	Method and Description
abstract Blank	define(String name) Begins definition for a new CacheContract resource.
abstract void	delete(String resourceGroupName, String serviceName, String cacheId, String ifMatch) Deletes specific Cache.
abstract void	deleteById(String id) Deletes specific Cache.
abstract Response<Void>	deleteByIdWithResponse(String id, String ifMatch, Context context) Deletes specific Cache.
abstract Response<Void>	deleteWithResponse(String resourceGroupName, String serviceName, String cacheId, String ifMatch, Context context) Deletes specific Cache.
abstract CacheContract	get(String resourceGroupName, String serviceName, String cacheId) Gets the details of the Cache specified by its identifier.
abstract CacheContract	getById(String id) Gets the details of the Cache specified by its identifier.
abstract Response<CacheContract>	getByIdWithResponse(String id, Context context) Gets the details of the Cache specified by its identifier.
abstract void	getEntityTag(String resourceGroupName, String serviceName, String cacheId) Gets the entity state (Etag) version of the Cache specified by its identifier.
abstract CachesGetEntityTagResponse	getEntityTagWithResponse(String resourceGroupName, String serviceName, String cacheId, Context context) Gets the entity state (Etag) version of the Cache specified by its identifier.
abstract Response<CacheContract>	getWithResponse(String resourceGroupName, String serviceName, String cacheId, Context context) Gets the details of the Cache specified by its identifier.
abstract PagedIterable<CacheContract>	listByService(String resourceGroupName, String serviceName) Lists a collection of all external Caches in the specified service instance.
abstract PagedIterable<CacheContract>	listByService(String resourceGroupName, String serviceName, Integer top, Integer skip, Context context) Lists a collection of all external Caches in the specified service instance.

Method Details

define

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

delete

public abstract void delete(String resourceGroupName, String serviceName, String cacheId, String ifMatch)

Deletes specific Cache.

Parameters:

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

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.

deleteById

public abstract void deleteById(String id)

Deletes specific Cache.

Parameters:

id - the resource ID.

deleteByIdWithResponse

public abstract Response deleteByIdWithResponse(String id, String ifMatch, 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<T>.

deleteWithResponse

public abstract Response deleteWithResponse(String resourceGroupName, String serviceName, String cacheId, String ifMatch, Context context)

Deletes specific Cache.

Parameters:

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

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

get

public abstract 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. The name is case insensitive.

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.

getById

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

getByIdWithResponse

public abstract Response getByIdWithResponse(String id, 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.

getEntityTag

public abstract 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. The name is case insensitive.

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

getEntityTagWithResponse

public abstract CachesGetEntityTagResponse getEntityTagWithResponse(String resourceGroupName, String serviceName, String cacheId, Context context)

Gets the entity state (Etag) version of the Cache specified by its identifier.

Parameters:

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

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.

getWithResponse

public abstract Response getWithResponse(String resourceGroupName, String serviceName, String cacheId, Context context)

Gets the details of the Cache specified by its identifier.

Parameters:

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

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.

listByService

public abstract PagedIterable 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. The name is case insensitive.

serviceName - The name of the API Management service.

Returns:

paged Caches list representation as paginated response with PagedIterable<T>.

listByService

public abstract PagedIterable listByService(String resourceGroupName, String serviceName, Integer top, Integer skip, Context context)

Lists a collection of all external Caches in the specified service instance.

Parameters:

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

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