Interface GraphQLApiResolversClient


public interface GraphQLApiResolversClient
An instance of this class provides access to all the operations defined in GraphQLApiResolversClient.
  • Method Details

    • listByApi

      com.azure.core.http.rest.PagedIterable<ResolverContractInner> listByApi(String resourceGroupName, String serviceName, String apiId)
      Lists a collection of the resolvers for the specified GraphQL API.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      apiId - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
      Returns:
      paged Resolver 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.
    • listByApi

      com.azure.core.http.rest.PagedIterable<ResolverContractInner> listByApi(String resourceGroupName, String serviceName, String apiId, String filter, Integer top, Integer skip, com.azure.core.util.Context context)
      Lists a collection of the resolvers for the specified GraphQL API.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      apiId - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
      filter - | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| path | 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 Resolver 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

      GraphQLApiResolversGetEntityTagResponse getEntityTagWithResponse(String resourceGroupName, String serviceName, String apiId, String resolverId, com.azure.core.util.Context context)
      Gets the entity state (Etag) version of the GraphQL API resolver 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 revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
      resolverId - Resolver identifier within a GraphQL API. 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 GraphQL API resolver 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 resolverId)
      Gets the entity state (Etag) version of the GraphQL API resolver 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 revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
      resolverId - Resolver identifier within a GraphQL API. 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.
    • getWithResponse

      GraphQLApiResolversGetResponse getWithResponse(String resourceGroupName, String serviceName, String apiId, String resolverId, com.azure.core.util.Context context)
      Gets the details of the GraphQL API Resolver 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 revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
      resolverId - Resolver identifier within a GraphQL API. Must be unique in the current API Management service instance.
      context - The context to associate with this operation.
      Returns:
      the details of the GraphQL API Resolver 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

      ResolverContractInner get(String resourceGroupName, String serviceName, String apiId, String resolverId)
      Gets the details of the GraphQL API Resolver 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 revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
      resolverId - Resolver identifier within a GraphQL API. Must be unique in the current API Management service instance.
      Returns:
      the details of the GraphQL API Resolver 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.
    • createOrUpdateWithResponse

      GraphQLApiResolversCreateOrUpdateResponse createOrUpdateWithResponse(String resourceGroupName, String serviceName, String apiId, String resolverId, ResolverContractInner parameters, String ifMatch, com.azure.core.util.Context context)
      Creates a new resolver in the GraphQL API or updates an existing one.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      apiId - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
      resolverId - Resolver identifier within a GraphQL API. 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:
      graphQL API Resolver 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.
    • createOrUpdate

      ResolverContractInner createOrUpdate(String resourceGroupName, String serviceName, String apiId, String resolverId, ResolverContractInner parameters)
      Creates a new resolver in the GraphQL API or updates an existing one.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      apiId - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
      resolverId - Resolver identifier within a GraphQL API. Must be unique in the current API Management service instance.
      parameters - Create parameters.
      Returns:
      graphQL API Resolver 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

      GraphQLApiResolversUpdateResponse updateWithResponse(String resourceGroupName, String serviceName, String apiId, String resolverId, String ifMatch, ResolverUpdateContract parameters, com.azure.core.util.Context context)
      Updates the details of the resolver in the GraphQL 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 revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
      resolverId - Resolver identifier within a GraphQL API. 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 - GraphQL API Resolver Update parameters.
      context - The context to associate with this operation.
      Returns:
      graphQL API Resolver 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

      ResolverContractInner update(String resourceGroupName, String serviceName, String apiId, String resolverId, String ifMatch, ResolverUpdateContract parameters)
      Updates the details of the resolver in the GraphQL 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 revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
      resolverId - Resolver identifier within a GraphQL API. 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 - GraphQL API Resolver Update parameters.
      Returns:
      graphQL API Resolver 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.
    • deleteWithResponse

      com.azure.core.http.rest.Response<Void> deleteWithResponse(String resourceGroupName, String serviceName, String apiId, String resolverId, String ifMatch, com.azure.core.util.Context context)
      Deletes the specified resolver in the GraphQL API.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      apiId - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
      resolverId - Resolver identifier within a GraphQL API. 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.
    • delete

      void delete(String resourceGroupName, String serviceName, String apiId, String resolverId, String ifMatch)
      Deletes the specified resolver in the GraphQL API.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      apiId - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
      resolverId - Resolver identifier within a GraphQL API. 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.