ApiIssueAttachments Interface

Package:

com.azure.resourcemanager.apimanagement.models

Maven Artifact:

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

public interface ApiIssueAttachments

Resource collection API of ApiIssueAttachments.

Method Summary

Modifier and Type	Method and Description
abstract Blank	define(String name) Begins definition for a new IssueAttachmentContract resource.
abstract void	delete(String resourceGroupName, String serviceName, String apiId, String issueId, String attachmentId, String ifMatch) Deletes the specified comment from an Issue.
abstract void	deleteById(String id) Deletes the specified comment from an Issue.
abstract Response<Void>	deleteByIdWithResponse(String id, String ifMatch, Context context) Deletes the specified comment from an Issue.
abstract Response<Void>	deleteWithResponse(String resourceGroupName, String serviceName, String apiId, String issueId, String attachmentId, String ifMatch, Context context) Deletes the specified comment from an Issue.
abstract IssueAttachmentContract	get(String resourceGroupName, String serviceName, String apiId, String issueId, String attachmentId) Gets the details of the issue Attachment for an API specified by its identifier.
abstract IssueAttachmentContract	getById(String id) Gets the details of the issue Attachment for an API specified by its identifier.
abstract Response<IssueAttachmentContract>	getByIdWithResponse(String id, Context context) Gets the details of the issue Attachment for an API specified by its identifier.
abstract void	getEntityTag(String resourceGroupName, String serviceName, String apiId, String issueId, String attachmentId) Gets the entity state (Etag) version of the issue Attachment for an API specified by its identifier.
abstract ApiIssueAttachmentsGetEntityTagResponse	getEntityTagWithResponse(String resourceGroupName, String serviceName, String apiId, String issueId, String attachmentId, Context context) Gets the entity state (Etag) version of the issue Attachment for an API specified by its identifier.
abstract Response<IssueAttachmentContract>	getWithResponse(String resourceGroupName, String serviceName, String apiId, String issueId, String attachmentId, Context context) Gets the details of the issue Attachment for an API specified by its identifier.
abstract PagedIterable<IssueAttachmentContract>	listByService(String resourceGroupName, String serviceName, String apiId, String issueId) Lists all attachments for the Issue associated with the specified API.
abstract PagedIterable<IssueAttachmentContract>	listByService(String resourceGroupName, String serviceName, String apiId, String issueId, String filter, Integer top, Integer skip, Context context) Lists all attachments for the Issue associated with the specified API.

Method Details

define

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

Begins definition for a new IssueAttachmentContract resource.

Parameters:

name - resource name.

Returns:

the first stage of the new IssueAttachmentContract definition.

delete

public abstract void delete(String resourceGroupName, String serviceName, String apiId, String issueId, String attachmentId, String ifMatch)

Deletes the specified comment from an Issue.

Parameters:

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

serviceName - The name of the API Management service.

apiId - API identifier. Must be unique in the current API Management service instance.

issueId - Issue identifier. Must be unique in the current API Management service instance.

attachmentId - Attachment identifier within an Issue. Must be unique in the current Issue.

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 the specified comment from an Issue.

Parameters:

id - the resource ID.

deleteByIdWithResponse

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

Deletes the specified comment from an Issue.

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 apiId, String issueId, String attachmentId, String ifMatch, Context context)

Deletes the specified comment from an Issue.

Parameters:

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

serviceName - The name of the API Management service.

apiId - API identifier. Must be unique in the current API Management service instance.

issueId - Issue identifier. Must be unique in the current API Management service instance.

attachmentId - Attachment identifier within an Issue. Must be unique in the current Issue.

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 IssueAttachmentContract get(String resourceGroupName, String serviceName, String apiId, String issueId, String attachmentId)

Gets the details of the issue Attachment for an API 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.

apiId - API identifier. Must be unique in the current API Management service instance.

issueId - Issue identifier. Must be unique in the current API Management service instance.

attachmentId - Attachment identifier within an Issue. Must be unique in the current Issue.

Returns:

the details of the issue Attachment for an API specified by its identifier.

getById

public abstract IssueAttachmentContract getById(String id)

Gets the details of the issue Attachment for an API specified by its identifier.

Parameters:

id - the resource ID.

Returns:

the details of the issue Attachment for an API specified by its identifier.

getByIdWithResponse

public abstract Response getByIdWithResponse(String id, Context context)

Gets the details of the issue Attachment for an API specified by its identifier.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

the details of the issue Attachment for an API specified by its identifier.

getEntityTag

public abstract void getEntityTag(String resourceGroupName, String serviceName, String apiId, String issueId, String attachmentId)

Gets the entity state (Etag) version of the issue Attachment for an API 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.

apiId - API identifier. Must be unique in the current API Management service instance.

issueId - Issue identifier. Must be unique in the current API Management service instance.

attachmentId - Attachment identifier within an Issue. Must be unique in the current Issue.

getEntityTagWithResponse

public abstract ApiIssueAttachmentsGetEntityTagResponse getEntityTagWithResponse(String resourceGroupName, String serviceName, String apiId, String issueId, String attachmentId, Context context)

Gets the entity state (Etag) version of the issue Attachment for an API 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.

apiId - API identifier. Must be unique in the current API Management service instance.

issueId - Issue identifier. Must be unique in the current API Management service instance.

attachmentId - Attachment identifier within an Issue. Must be unique in the current Issue.

context - The context to associate with this operation.

Returns:

the entity state (Etag) version of the issue Attachment for an API specified by its identifier.

getWithResponse

public abstract Response getWithResponse(String resourceGroupName, String serviceName, String apiId, String issueId, String attachmentId, Context context)

Gets the details of the issue Attachment for an API 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.

apiId - API identifier. Must be unique in the current API Management service instance.

issueId - Issue identifier. Must be unique in the current API Management service instance.

attachmentId - Attachment identifier within an Issue. Must be unique in the current Issue.

context - The context to associate with this operation.

Returns:

the details of the issue Attachment for an API specified by its identifier.

listByService

public abstract PagedIterable listByService(String resourceGroupName, String serviceName, String apiId, String issueId)

Lists all attachments for the Issue associated with the specified API.

Parameters:

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

serviceName - The name of the API Management service.

apiId - API identifier. Must be unique in the current API Management service instance.

issueId - Issue identifier. Must be unique in the current API Management service instance.

Returns:

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

listByService

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

Lists all attachments for the Issue associated with the specified API.

Parameters:

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

serviceName - The name of the API Management service.

apiId - API identifier. Must be unique in the current API Management service instance.

issueId - Issue identifier. Must be unique in the current API Management service instance.

filter - | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>.

top - Number of records to return.

skip - Number of records to skip.

context - The context to associate with this operation.

Returns:

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