Package com.azure.resourcemanager.apimanagement.fluent

Interface ApiIssueCommentsClient

public interface ApiIssueCommentsClient

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

Method Summary

Modifier and Type	Method	Description
IssueCommentContractInner	createOrUpdate(String resourceGroupName, String serviceName, String apiId, String issueId, String commentId, IssueCommentContractInner parameters)	Creates a new Comment for the Issue in an API or updates an existing one.
ApiIssueCommentsCreateOrUpdateResponse	createOrUpdateWithResponse(String resourceGroupName, String serviceName, String apiId, String issueId, String commentId, IssueCommentContractInner parameters, String ifMatch, com.azure.core.util.Context context)	Creates a new Comment for the Issue in an API or updates an existing one.
void	delete(String resourceGroupName, String serviceName, String apiId, String issueId, String commentId, String ifMatch)	Deletes the specified comment from an Issue.
com.azure.core.http.rest.Response<Void>	deleteWithResponse(String resourceGroupName, String serviceName, String apiId, String issueId, String commentId, String ifMatch, com.azure.core.util.Context context)	Deletes the specified comment from an Issue.
IssueCommentContractInner	get(String resourceGroupName, String serviceName, String apiId, String issueId, String commentId)	Gets the details of the issue Comment for an API specified by its identifier.
void	getEntityTag(String resourceGroupName, String serviceName, String apiId, String issueId, String commentId)	Gets the entity state (Etag) version of the issue Comment for an API specified by its identifier.
ApiIssueCommentsGetEntityTagResponse	getEntityTagWithResponse(String resourceGroupName, String serviceName, String apiId, String issueId, String commentId, com.azure.core.util.Context context)	Gets the entity state (Etag) version of the issue Comment for an API specified by its identifier.
ApiIssueCommentsGetResponse	getWithResponse(String resourceGroupName, String serviceName, String apiId, String issueId, String commentId, com.azure.core.util.Context context)	Gets the details of the issue Comment for an API specified by its identifier.
com.azure.core.http.rest.PagedIterable<IssueCommentContractInner>	listByService(String resourceGroupName, String serviceName, String apiId, String issueId)	Lists all comments for the Issue associated with the specified API.
com.azure.core.http.rest.PagedIterable<IssueCommentContractInner>	listByService(String resourceGroupName, String serviceName, String apiId, String issueId, String filter, Integer top, Integer skip, com.azure.core.util.Context context)	Lists all comments for the Issue associated with the specified API.

Method Detail

listByService

com.azure.core.http.rest.PagedIterable<IssueCommentContractInner> listByService(String resourceGroupName,
                                                                                String serviceName,
                                                                                String apiId,
                                                                                String issueId)

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

Parameters:

resourceGroupName - The name of the resource group.

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 Comment 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<IssueCommentContractInner> listByService(String resourceGroupName,
                                                                                String serviceName,
                                                                                String apiId,
                                                                                String issueId,
                                                                                String filter,
                                                                                Integer top,
                                                                                Integer skip,
                                                                                com.azure.core.util.Context context)

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

Parameters:

resourceGroupName - The name of the resource group.

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 Comment 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 apiId,
                  String issueId,
                  String commentId)

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

Parameters:

resourceGroupName - The name of the resource group.

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.

commentId - Comment identifier within an Issue. Must be unique in the current Issue.

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

ApiIssueCommentsGetEntityTagResponse getEntityTagWithResponse(String resourceGroupName,
                                                              String serviceName,
                                                              String apiId,
                                                              String issueId,
                                                              String commentId,
                                                              com.azure.core.util.Context context)

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

Parameters:

resourceGroupName - The name of the resource group.

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.

commentId - Comment 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 Comment for an API 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

IssueCommentContractInner get(String resourceGroupName,
                              String serviceName,
                              String apiId,
                              String issueId,
                              String commentId)

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

Parameters:

resourceGroupName - The name of the resource group.

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.

commentId - Comment identifier within an Issue. Must be unique in the current Issue.

Returns:

the details of the issue Comment for an API 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

ApiIssueCommentsGetResponse getWithResponse(String resourceGroupName,
                                            String serviceName,
                                            String apiId,
                                            String issueId,
                                            String commentId,
                                            com.azure.core.util.Context context)

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

Parameters:

resourceGroupName - The name of the resource group.

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.

commentId - Comment 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 Comment for an API 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

IssueCommentContractInner createOrUpdate(String resourceGroupName,
                                         String serviceName,
                                         String apiId,
                                         String issueId,
                                         String commentId,
                                         IssueCommentContractInner parameters)

Creates a new Comment for the Issue in an API or updates an existing one.

Parameters:

resourceGroupName - The name of the resource group.

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.

commentId - Comment identifier within an Issue. Must be unique in the current Issue.

parameters - Create parameters.

Returns:

issue Comment Contract 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

ApiIssueCommentsCreateOrUpdateResponse createOrUpdateWithResponse(String resourceGroupName,
                                                                  String serviceName,
                                                                  String apiId,
                                                                  String issueId,
                                                                  String commentId,
                                                                  IssueCommentContractInner parameters,
                                                                  String ifMatch,
                                                                  com.azure.core.util.Context context)

Creates a new Comment for the Issue in an API or updates an existing one.

Parameters:

resourceGroupName - The name of the resource group.

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.

commentId - Comment identifier within an Issue. Must be unique in the current Issue.

parameters - Create 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:

issue Comment Contract 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 apiId,
            String issueId,
            String commentId,
            String ifMatch)

Deletes the specified comment from an Issue.

Parameters:

resourceGroupName - The name of the resource group.

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.

commentId - Comment 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.

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 apiId,
                                                           String issueId,
                                                           String commentId,
                                                           String ifMatch,
                                                           com.azure.core.util.Context context)

Deletes the specified comment from an Issue.

Parameters:

resourceGroupName - The name of the resource group.

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.

commentId - Comment 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.

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.