Package io.apicurio.registry.rest.client.v2.admin.rules

Class RulesRequestBuilder

java.lang.Object
com.microsoft.kiota.BaseRequestBuilder
io.apicurio.registry.rest.client.v2.admin.rules.RulesRequestBuilder
@Generated("com.microsoft.kiota") public class RulesRequestBuilder extends com.microsoft.kiota.BaseRequestBuilder
Manage the global rules that apply to all artifacts if not otherwise configured.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    class 
    RulesRequestBuilder.DeleteRequestConfiguration
    Configuration for the request such as headers, query parameters, and middleware options.
    class 
    RulesRequestBuilder.GetRequestConfiguration
    Configuration for the request such as headers, query parameters, and middleware options.
    class 
    RulesRequestBuilder.PostRequestConfiguration
    Configuration for the request such as headers, query parameters, and middleware options.

  • Field Summary

    Fields inherited from class com.microsoft.kiota.BaseRequestBuilder

    pathParameters, requestAdapter, urlTemplate

  • Constructor Summary

    Constructors
    Constructor
    Description
    RulesRequestBuilder(String rawUrl, com.microsoft.kiota.RequestAdapter requestAdapter)
    Instantiates a new RulesRequestBuilder and sets the default values.
    RulesRequestBuilder(HashMap<String,Object> pathParameters, com.microsoft.kiota.RequestAdapter requestAdapter)
    Instantiates a new RulesRequestBuilder and sets the default values.

  • Method Summary

    Modifier and Type
    Method
    Description
    WithRuleItemRequestBuilder
    byRule(String rule)
    Manage the configuration of a single global artifact rule.
    void
    delete()
    Deletes all globally configured rules.This operation can fail for the following reasons:* A server error occurred (HTTP error `500`)
    void
    delete(Consumer<RulesRequestBuilder.DeleteRequestConfiguration> requestConfiguration)
    Deletes all globally configured rules.This operation can fail for the following reasons:* A server error occurred (HTTP error `500`)
    List<RuleType>
    get()
    Gets a list of all the currently configured global rules (if any).This operation can fail for the following reasons:* A server error occurred (HTTP error `500`)
    List<RuleType>
    get(Consumer<RulesRequestBuilder.GetRequestConfiguration> requestConfiguration)
    Gets a list of all the currently configured global rules (if any).This operation can fail for the following reasons:* A server error occurred (HTTP error `500`)
    void
    post(Rule body)
    Adds a rule to the list of globally configured rules.This operation can fail for the following reasons:* The rule type is unknown (HTTP error `400`)* The rule already exists (HTTP error `409`)* A server error occurred (HTTP error `500`)
    void
    post(Rule body, Consumer<RulesRequestBuilder.PostRequestConfiguration> requestConfiguration)
    Adds a rule to the list of globally configured rules.This operation can fail for the following reasons:* The rule type is unknown (HTTP error `400`)* The rule already exists (HTTP error `409`)* A server error occurred (HTTP error `500`)
    com.microsoft.kiota.RequestInformation
    toDeleteRequestInformation()
    Deletes all globally configured rules.This operation can fail for the following reasons:* A server error occurred (HTTP error `500`)
    com.microsoft.kiota.RequestInformation
    toDeleteRequestInformation(Consumer<RulesRequestBuilder.DeleteRequestConfiguration> requestConfiguration)
    Deletes all globally configured rules.This operation can fail for the following reasons:* A server error occurred (HTTP error `500`)
    com.microsoft.kiota.RequestInformation
    toGetRequestInformation()
    Gets a list of all the currently configured global rules (if any).This operation can fail for the following reasons:* A server error occurred (HTTP error `500`)
    com.microsoft.kiota.RequestInformation
    toGetRequestInformation(Consumer<RulesRequestBuilder.GetRequestConfiguration> requestConfiguration)
    Gets a list of all the currently configured global rules (if any).This operation can fail for the following reasons:* A server error occurred (HTTP error `500`)
    com.microsoft.kiota.RequestInformation
    toPostRequestInformation(Rule body)
    Adds a rule to the list of globally configured rules.This operation can fail for the following reasons:* The rule type is unknown (HTTP error `400`)* The rule already exists (HTTP error `409`)* A server error occurred (HTTP error `500`)
    com.microsoft.kiota.RequestInformation
    toPostRequestInformation(Rule body, Consumer<RulesRequestBuilder.PostRequestConfiguration> requestConfiguration)
    Adds a rule to the list of globally configured rules.This operation can fail for the following reasons:* The rule type is unknown (HTTP error `400`)* The rule already exists (HTTP error `409`)* A server error occurred (HTTP error `500`)
    RulesRequestBuilder
    withUrl(String rawUrl)
    Returns a request builder with the provided arbitrary URL.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • RulesRequestBuilder

      public RulesRequestBuilder(@Nonnull HashMap<String,Object> pathParameters, @Nonnull com.microsoft.kiota.RequestAdapter requestAdapter)
      Instantiates a new RulesRequestBuilder and sets the default values.
      Parameters:
      pathParameters - Path parameters for the request
      requestAdapter - The request adapter to use to execute the requests.

    • RulesRequestBuilder

      public RulesRequestBuilder(@Nonnull String rawUrl, @Nonnull com.microsoft.kiota.RequestAdapter requestAdapter)
      Instantiates a new RulesRequestBuilder and sets the default values.
      Parameters:
      rawUrl - The raw URL to use for the request builder.
      requestAdapter - The request adapter to use to execute the requests.

  • Method Details

    • byRule

      @Nonnull public WithRuleItemRequestBuilder byRule(@Nonnull String rule)
      Manage the configuration of a single global artifact rule.
      Parameters:
      rule - The unique name/type of a rule.
      Returns:
      a WithRuleItemRequestBuilder

    • delete

      public void delete()
      Deletes all globally configured rules.This operation can fail for the following reasons:* A server error occurred (HTTP error `500`)
      Throws:
      AuthError - When receiving a 401 status code
      AuthError - When receiving a 403 status code
      Error - When receiving a 500 status code

    • delete

      public void delete(@Nullable Consumer<RulesRequestBuilder.DeleteRequestConfiguration> requestConfiguration)
      Deletes all globally configured rules.This operation can fail for the following reasons:* A server error occurred (HTTP error `500`)
      Parameters:
      requestConfiguration - Configuration for the request such as headers, query parameters, and middleware options.
      Throws:
      AuthError - When receiving a 401 status code
      AuthError - When receiving a 403 status code
      Error - When receiving a 500 status code

    • get

      @Nullable public List<RuleType> get()
      Gets a list of all the currently configured global rules (if any).This operation can fail for the following reasons:* A server error occurred (HTTP error `500`)
      Returns:
      a List<RuleType>
      Throws:
      AuthError - When receiving a 401 status code
      AuthError - When receiving a 403 status code
      Error - When receiving a 500 status code

    • get

      @Nullable public List<RuleType> get(@Nullable Consumer<RulesRequestBuilder.GetRequestConfiguration> requestConfiguration)
      Gets a list of all the currently configured global rules (if any).This operation can fail for the following reasons:* A server error occurred (HTTP error `500`)
      Parameters:
      requestConfiguration - Configuration for the request such as headers, query parameters, and middleware options.
      Returns:
      a List<RuleType>
      Throws:
      AuthError - When receiving a 401 status code
      AuthError - When receiving a 403 status code
      Error - When receiving a 500 status code

    • post

      public void post(@Nonnull Rule body)
      Adds a rule to the list of globally configured rules.This operation can fail for the following reasons:* The rule type is unknown (HTTP error `400`)* The rule already exists (HTTP error `409`)* A server error occurred (HTTP error `500`)
      Parameters:
      body - The request body
      Throws:
      Error - When receiving a 400 status code
      AuthError - When receiving a 401 status code
      AuthError - When receiving a 403 status code
      Error - When receiving a 409 status code
      Error - When receiving a 500 status code

    • post

      public void post(@Nonnull Rule body, @Nullable Consumer<RulesRequestBuilder.PostRequestConfiguration> requestConfiguration)
      Adds a rule to the list of globally configured rules.This operation can fail for the following reasons:* The rule type is unknown (HTTP error `400`)* The rule already exists (HTTP error `409`)* A server error occurred (HTTP error `500`)
      Parameters:
      body - The request body
      requestConfiguration - Configuration for the request such as headers, query parameters, and middleware options.
      Throws:
      Error - When receiving a 400 status code
      AuthError - When receiving a 401 status code
      AuthError - When receiving a 403 status code
      Error - When receiving a 409 status code
      Error - When receiving a 500 status code

    • toDeleteRequestInformation

      @Nonnull public com.microsoft.kiota.RequestInformation toDeleteRequestInformation()
      Deletes all globally configured rules.This operation can fail for the following reasons:* A server error occurred (HTTP error `500`)
      Returns:
      a RequestInformation

    • toDeleteRequestInformation

      @Nonnull public com.microsoft.kiota.RequestInformation toDeleteRequestInformation(@Nullable Consumer<RulesRequestBuilder.DeleteRequestConfiguration> requestConfiguration)
      Deletes all globally configured rules.This operation can fail for the following reasons:* A server error occurred (HTTP error `500`)
      Parameters:
      requestConfiguration - Configuration for the request such as headers, query parameters, and middleware options.
      Returns:
      a RequestInformation

    • toGetRequestInformation

      @Nonnull public com.microsoft.kiota.RequestInformation toGetRequestInformation()
      Gets a list of all the currently configured global rules (if any).This operation can fail for the following reasons:* A server error occurred (HTTP error `500`)
      Returns:
      a RequestInformation

    • toGetRequestInformation

      @Nonnull public com.microsoft.kiota.RequestInformation toGetRequestInformation(@Nullable Consumer<RulesRequestBuilder.GetRequestConfiguration> requestConfiguration)
      Gets a list of all the currently configured global rules (if any).This operation can fail for the following reasons:* A server error occurred (HTTP error `500`)
      Parameters:
      requestConfiguration - Configuration for the request such as headers, query parameters, and middleware options.
      Returns:
      a RequestInformation

    • toPostRequestInformation

      @Nonnull public com.microsoft.kiota.RequestInformation toPostRequestInformation(@Nonnull Rule body)
      Adds a rule to the list of globally configured rules.This operation can fail for the following reasons:* The rule type is unknown (HTTP error `400`)* The rule already exists (HTTP error `409`)* A server error occurred (HTTP error `500`)
      Parameters:
      body - The request body
      Returns:
      a RequestInformation

    • toPostRequestInformation

      @Nonnull public com.microsoft.kiota.RequestInformation toPostRequestInformation(@Nonnull Rule body, @Nullable Consumer<RulesRequestBuilder.PostRequestConfiguration> requestConfiguration)
      Adds a rule to the list of globally configured rules.This operation can fail for the following reasons:* The rule type is unknown (HTTP error `400`)* The rule already exists (HTTP error `409`)* A server error occurred (HTTP error `500`)
      Parameters:
      body - The request body
      requestConfiguration - Configuration for the request such as headers, query parameters, and middleware options.
      Returns:
      a RequestInformation

    • withUrl

      @Nonnull public RulesRequestBuilder withUrl(@Nonnull String rawUrl)
      Returns a request builder with the provided arbitrary URL. Using this method means any other path or query parameters are ignored.
      Parameters:
      rawUrl - The raw URL to use for the request builder.
      Returns:
      a RulesRequestBuilder