ContentItemsClient Interface

public interface ContentItemsClient

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

Method Summary

Modifier and Type Method and Description
abstract ContentItemContractInner createOrUpdate(String resourceGroupName, String serviceName, String contentTypeId, String contentItemId, ContentItemContractInner parameters)

Creates a new developer portal's content item specified by the provided content type.

abstract ContentItemsCreateOrUpdateResponse createOrUpdateWithResponse(String resourceGroupName, String serviceName, String contentTypeId, String contentItemId, ContentItemContractInner parameters, String ifMatch, Context context)

Creates a new developer portal's content item specified by the provided content type.

abstract void delete(String resourceGroupName, String serviceName, String contentTypeId, String contentItemId, String ifMatch)

Removes the specified developer portal's content item.

abstract Response<Void> deleteWithResponse(String resourceGroupName, String serviceName, String contentTypeId, String contentItemId, String ifMatch, Context context)

Removes the specified developer portal's content item.

abstract ContentItemContractInner get(String resourceGroupName, String serviceName, String contentTypeId, String contentItemId)

Returns the developer portal's content item specified by its identifier.

abstract void getEntityTag(String resourceGroupName, String serviceName, String contentTypeId, String contentItemId)

Returns the entity state (ETag) version of the developer portal's content item specified by its identifier.

abstract ContentItemsGetEntityTagResponse getEntityTagWithResponse(String resourceGroupName, String serviceName, String contentTypeId, String contentItemId, Context context)

Returns the entity state (ETag) version of the developer portal's content item specified by its identifier.

abstract ContentItemsGetResponse getWithResponse(String resourceGroupName, String serviceName, String contentTypeId, String contentItemId, Context context)

Returns the developer portal's content item specified by its identifier.

abstract PagedIterable<ContentItemContractInner> listByService(String resourceGroupName, String serviceName, String contentTypeId)

Lists developer portal's content items specified by the provided content type.

abstract PagedIterable<ContentItemContractInner> listByService(String resourceGroupName, String serviceName, String contentTypeId, Context context)

Lists developer portal's content items specified by the provided content type.

Method Details

createOrUpdate

public abstract ContentItemContractInner createOrUpdate(String resourceGroupName, String serviceName, String contentTypeId, String contentItemId, ContentItemContractInner parameters)

Creates a new developer portal's content item specified by the provided content type.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
serviceName - The name of the API Management service.
contentTypeId - Content type identifier.
contentItemId - Content item identifier.
parameters - Create or update parameters.

Returns:

content type contract details.

createOrUpdateWithResponse

public abstract ContentItemsCreateOrUpdateResponse createOrUpdateWithResponse(String resourceGroupName, String serviceName, String contentTypeId, String contentItemId, ContentItemContractInner parameters, String ifMatch, Context context)

Creates a new developer portal's content item specified by the provided content type.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
serviceName - The name of the API Management service.
contentTypeId - Content type identifier.
contentItemId - Content item 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:

content type contract details.

delete

public abstract void delete(String resourceGroupName, String serviceName, String contentTypeId, String contentItemId, String ifMatch)

Removes the specified developer portal's content item.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
serviceName - The name of the API Management service.
contentTypeId - Content type identifier.
contentItemId - Content item 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.

deleteWithResponse

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

Removes the specified developer portal's content item.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
serviceName - The name of the API Management service.
contentTypeId - Content type identifier.
contentItemId - Content item 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:

get

public abstract ContentItemContractInner get(String resourceGroupName, String serviceName, String contentTypeId, String contentItemId)

Returns the developer portal's content item 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.
contentTypeId - Content type identifier.
contentItemId - Content item identifier.

Returns:

content type contract details.

getEntityTag

public abstract void getEntityTag(String resourceGroupName, String serviceName, String contentTypeId, String contentItemId)

Returns the entity state (ETag) version of the developer portal's content item 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.
contentTypeId - Content type identifier.
contentItemId - Content item identifier.

getEntityTagWithResponse

public abstract ContentItemsGetEntityTagResponse getEntityTagWithResponse(String resourceGroupName, String serviceName, String contentTypeId, String contentItemId, Context context)

Returns the entity state (ETag) version of the developer portal's content item 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.
contentTypeId - Content type identifier.
contentItemId - Content item identifier.
context - The context to associate with this operation.

Returns:

the response.

getWithResponse

public abstract ContentItemsGetResponse getWithResponse(String resourceGroupName, String serviceName, String contentTypeId, String contentItemId, Context context)

Returns the developer portal's content item 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.
contentTypeId - Content type identifier.
contentItemId - Content item identifier.
context - The context to associate with this operation.

Returns:

content type contract details.

listByService

public abstract PagedIterable listByService(String resourceGroupName, String serviceName, String contentTypeId)

Lists developer portal's content items specified by the provided content type.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
serviceName - The name of the API Management service.
contentTypeId - Content type identifier.

Returns:

paged list of content items as paginated response with PagedIterable<T>.

listByService

public abstract PagedIterable listByService(String resourceGroupName, String serviceName, String contentTypeId, Context context)

Lists developer portal's content items specified by the provided content type.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
serviceName - The name of the API Management service.
contentTypeId - Content type identifier.
context - The context to associate with this operation.

Returns:

paged list of content items as paginated response with PagedIterable<T>.

Applies to