Package com.azure.resourcemanager.apimanagement.fluent

Interface CachesClient

public interface CachesClient

An instance of this class provides access to all the operations defined in CachesClient.

Method Summary

Modifier and Type	Method	Description
CacheContractInner	createOrUpdate(String resourceGroupName, String serviceName, String cacheId, CacheContractInner parameters)	Creates or updates an External Cache to be used in Api Management instance.
CachesCreateOrUpdateResponse	createOrUpdateWithResponse(String resourceGroupName, String serviceName, String cacheId, CacheContractInner parameters, String ifMatch, com.azure.core.util.Context context)	Creates or updates an External Cache to be used in Api Management instance.
void	delete(String resourceGroupName, String serviceName, String cacheId, String ifMatch)	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.
CacheContractInner	get(String resourceGroupName, String serviceName, String cacheId)	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.
CachesGetResponse	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<CacheContractInner>	listByService(String resourceGroupName, String serviceName)	Lists a collection of all external Caches in the specified service instance.
com.azure.core.http.rest.PagedIterable<CacheContractInner>	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.
CacheContractInner	update(String resourceGroupName, String serviceName, String cacheId, String ifMatch, CacheUpdateParameters parameters)	Updates the details of the cache specified by its identifier.
CachesUpdateResponse	updateWithResponse(String resourceGroupName, String serviceName, String cacheId, String ifMatch, CacheUpdateParameters parameters, com.azure.core.util.Context context)	Updates the details of the cache specified by its identifier.

Method Detail

listByService

com.azure.core.http.rest.PagedIterable<CacheContractInner> 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<CacheContractInner> 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

CacheContractInner 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

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

createOrUpdate

CacheContractInner createOrUpdate(String resourceGroupName,
                                  String serviceName,
                                  String cacheId,
                                  CacheContractInner parameters)

Creates or updates an External Cache to be used in Api Management instance.

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

parameters - Create or Update parameters.

Returns:

cache details.

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.

createOrUpdateWithResponse

CachesCreateOrUpdateResponse createOrUpdateWithResponse(String resourceGroupName,
                                                        String serviceName,
                                                        String cacheId,
                                                        CacheContractInner parameters,
                                                        String ifMatch,
                                                        com.azure.core.util.Context context)

Creates or updates an External Cache to be used in Api Management instance.

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

parameters - Create or Update parameters.

ifMatch - ETag of the Entity. Not required when creating an entity, but required when updating an entity.

context - The context to associate with this operation.

Returns:

cache details.

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

CacheContractInner update(String resourceGroupName,
                          String serviceName,
                          String cacheId,
                          String ifMatch,
                          CacheUpdateParameters parameters)

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

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.

parameters - Update parameters.

Returns:

cache details.

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.

updateWithResponse

CachesUpdateResponse updateWithResponse(String resourceGroupName,
                                        String serviceName,
                                        String cacheId,
                                        String ifMatch,
                                        CacheUpdateParameters parameters,
                                        com.azure.core.util.Context context)

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

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.

parameters - Update parameters.

context - The context to associate with this operation.

Returns:

cache details.

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.