Package com.azure.resourcemanager.apimanagement.fluent

Interface ApiIssuesClient

public interface ApiIssuesClient

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

Method Summary

Modifier and Type	Method	Description
IssueContractInner	createOrUpdate(String resourceGroupName, String serviceName, String apiId, String issueId, IssueContractInner parameters)	Creates a new Issue for an API or updates an existing one.
ApiIssuesCreateOrUpdateResponse	createOrUpdateWithResponse(String resourceGroupName, String serviceName, String apiId, String issueId, IssueContractInner parameters, String ifMatch, com.azure.core.util.Context context)	Creates a new Issue for an API or updates an existing one.
void	delete(String resourceGroupName, String serviceName, String apiId, String issueId, String ifMatch)	Deletes the specified Issue from an API.
com.azure.core.http.rest.Response<Void>	deleteWithResponse(String resourceGroupName, String serviceName, String apiId, String issueId, String ifMatch, com.azure.core.util.Context context)	Deletes the specified Issue from an API.
IssueContractInner	get(String resourceGroupName, String serviceName, String apiId, String issueId)	Gets the details of the Issue for an API specified by its identifier.
void	getEntityTag(String resourceGroupName, String serviceName, String apiId, String issueId)	Gets the entity state (Etag) version of the Issue for an API specified by its identifier.
ApiIssuesGetEntityTagResponse	getEntityTagWithResponse(String resourceGroupName, String serviceName, String apiId, String issueId, com.azure.core.util.Context context)	Gets the entity state (Etag) version of the Issue for an API specified by its identifier.
ApiIssuesGetResponse	getWithResponse(String resourceGroupName, String serviceName, String apiId, String issueId, Boolean expandCommentsAttachments, com.azure.core.util.Context context)	Gets the details of the Issue for an API specified by its identifier.
com.azure.core.http.rest.PagedIterable<IssueContractInner>	listByService(String resourceGroupName, String serviceName, String apiId)	Lists all issues associated with the specified API.
com.azure.core.http.rest.PagedIterable<IssueContractInner>	listByService(String resourceGroupName, String serviceName, String apiId, String filter, Boolean expandCommentsAttachments, Integer top, Integer skip, com.azure.core.util.Context context)	Lists all issues associated with the specified API.
IssueContractInner	update(String resourceGroupName, String serviceName, String apiId, String issueId, String ifMatch, IssueUpdateContract parameters)	Updates an existing issue for an API.
ApiIssuesUpdateResponse	updateWithResponse(String resourceGroupName, String serviceName, String apiId, String issueId, String ifMatch, IssueUpdateContract parameters, com.azure.core.util.Context context)	Updates an existing issue for an API.

Method Detail

listByService

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

Lists all issues 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.

Returns:

paged Issue 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<IssueContractInner> listByService(String resourceGroupName,
                                                                         String serviceName,
                                                                         String apiId,
                                                                         String filter,
                                                                         Boolean expandCommentsAttachments,
                                                                         Integer top,
                                                                         Integer skip,
                                                                         com.azure.core.util.Context context)

Lists all issues 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.

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>| state | filter | eq | |</br>.

expandCommentsAttachments - Expand the comment attachments.

top - Number of records to return.

skip - Number of records to skip.

context - The context to associate with this operation.

Returns:

paged Issue 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)

Gets the entity state (Etag) version of the Issue 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.

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

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

Gets the entity state (Etag) version of the Issue 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.

context - The context to associate with this operation.

Returns:

the entity state (Etag) version of the Issue 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

IssueContractInner get(String resourceGroupName,
                       String serviceName,
                       String apiId,
                       String issueId)

Gets the details of the Issue 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.

Returns:

the details of the Issue 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

ApiIssuesGetResponse getWithResponse(String resourceGroupName,
                                     String serviceName,
                                     String apiId,
                                     String issueId,
                                     Boolean expandCommentsAttachments,
                                     com.azure.core.util.Context context)

Gets the details of the Issue 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.

expandCommentsAttachments - Expand the comment attachments.

context - The context to associate with this operation.

Returns:

the details of the Issue 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

IssueContractInner createOrUpdate(String resourceGroupName,
                                  String serviceName,
                                  String apiId,
                                  String issueId,
                                  IssueContractInner parameters)

Creates a new Issue for 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.

parameters - Create parameters.

Returns:

issue 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

ApiIssuesCreateOrUpdateResponse createOrUpdateWithResponse(String resourceGroupName,
                                                           String serviceName,
                                                           String apiId,
                                                           String issueId,
                                                           IssueContractInner parameters,
                                                           String ifMatch,
                                                           com.azure.core.util.Context context)

Creates a new Issue for 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.

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

update

IssueContractInner update(String resourceGroupName,
                          String serviceName,
                          String apiId,
                          String issueId,
                          String ifMatch,
                          IssueUpdateContract parameters)

Updates an existing issue for an 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.

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.

parameters - Update parameters.

Returns:

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

updateWithResponse

ApiIssuesUpdateResponse updateWithResponse(String resourceGroupName,
                                           String serviceName,
                                           String apiId,
                                           String issueId,
                                           String ifMatch,
                                           IssueUpdateContract parameters,
                                           com.azure.core.util.Context context)

Updates an existing issue for an 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.

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.

parameters - Update parameters.

context - The context to associate with this operation.

Returns:

issue 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 ifMatch)

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

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

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

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.