ContentItems Interface

public interface ContentItems

Resource collection API of ContentItems.

Method Summary

Modifier and Type Method and Description
abstract Blank define(String name)

Begins definition for a new ContentItemContract resource.

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

Removes the specified developer portal's content item.

abstract void deleteById(String id)

Removes the specified developer portal's content item.

abstract Response<Void> deleteByIdWithResponse(String id, String ifMatch, Context context)

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 ContentItemContract get(String resourceGroupName, String serviceName, String contentTypeId, String contentItemId)

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

abstract ContentItemContract getById(String id)

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

abstract Response<ContentItemContract> getByIdWithResponse(String id, Context context)

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 Response<ContentItemContract> getWithResponse(String resourceGroupName, String serviceName, String contentTypeId, String contentItemId, Context context)

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

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

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

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

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

Method Details

define

public abstract ContentItemContract.DefinitionStages.Blank define(String name)

Begins definition for a new ContentItemContract resource.

Parameters:

name - resource name.

Returns:

the first stage of the new ContentItemContract definition.

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.

deleteById

public abstract void deleteById(String id)

Removes the specified developer portal's content item.

Parameters:

id - the resource ID.

deleteByIdWithResponse

public abstract Response deleteByIdWithResponse(String id, String ifMatch, Context context)

Removes the specified developer portal's content item.

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:

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

getById

public abstract ContentItemContract getById(String id)

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

Parameters:

id - the resource ID.

Returns:

content type contract details.

getByIdWithResponse

public abstract Response getByIdWithResponse(String id, Context context)

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

Parameters:

id - the resource ID.
context - The context to associate with this operation.

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 Response 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