Package com.azure.resourcemanager.apimanagement.models

Interface ApiIssueComments

public interface ApiIssueComments
Resource collection API of ApiIssueComments.

  • Method Details

    • listByService

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

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

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

    • getWithResponse

      com.azure.core.http.rest.Response<IssueCommentContract> 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. 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.
      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.

    • get

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

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

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

    • getById

      IssueCommentContract getById(String id)
      Gets the details of the issue Comment for an API specified by its identifier.
      Parameters:
      id - the resource ID.
      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.

    • getByIdWithResponse

      com.azure.core.http.rest.Response<IssueCommentContract> getByIdWithResponse(String id, com.azure.core.util.Context context)
      Gets the details of the issue Comment 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 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.

    • deleteById

      void deleteById(String id)
      Deletes the specified comment from an Issue.
      Parameters:
      id - the resource ID.
      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.

    • deleteByIdWithResponse

      com.azure.core.http.rest.Response<Void> deleteByIdWithResponse(String id, String ifMatch, com.azure.core.util.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.
      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.

    • define

      IssueCommentContract.DefinitionStages.Blank define(String name)
      Begins definition for a new IssueCommentContract resource.
      Parameters:
      name - resource name.
      Returns:
      the first stage of the new IssueCommentContract definition.