Package io.apicurio.registry.rest.client.groups.item.artifacts.item.rules

Class RulesRequestBuilder

java.lang.Object
com.microsoft.kiota.BaseRequestBuilder
io.apicurio.registry.rest.client.groups.item.artifacts.item.rules.RulesRequestBuilder
@Generated("com.microsoft.kiota") public class RulesRequestBuilder extends com.microsoft.kiota.BaseRequestBuilder
Manage the rules for a single artifact.

  • 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

    • byRuleType

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

    • delete

      public void delete()
      Deletes all of the rules configured for the artifact. After this is done, the globalrules apply to the artifact again.This operation can fail for the following reasons:* No artifact with this `artifactId` exists (HTTP error `404`)* A server error occurred (HTTP error `500`)
      Throws:
      ProblemDetails - When receiving a 401 status code
      ProblemDetails - When receiving a 403 status code
      ProblemDetails - When receiving a 404 status code
      ProblemDetails - When receiving a 500 status code

    • delete

      public void delete(@Nullable Consumer<RulesRequestBuilder.DeleteRequestConfiguration> requestConfiguration)
      Deletes all of the rules configured for the artifact. After this is done, the globalrules apply to the artifact again.This operation can fail for the following reasons:* No artifact with this `artifactId` exists (HTTP error `404`)* A server error occurred (HTTP error `500`)
      Parameters:
      requestConfiguration - Configuration for the request such as headers, query parameters, and middleware options.
      Throws:
      ProblemDetails - When receiving a 401 status code
      ProblemDetails - When receiving a 403 status code
      ProblemDetails - When receiving a 404 status code
      ProblemDetails - When receiving a 500 status code

    • get

      @Nullable public List<RuleType> get()
      Returns a list of all rules configured for the artifact. The set of rules determineshow the content of an artifact can evolve over time. If no rules are configured foran artifact, then the rules configured for the group is used. If no rules are configured at the group level, then the set of globally configured rules are used. If no global rules are defined, there are no restrictions on content evolution.This operation can fail for the following reasons:* No artifact with this `artifactId` exists (HTTP error `404`)* A server error occurred (HTTP error `500`)
      Returns:
      a List<RuleType>
      Throws:
      ProblemDetails - When receiving a 401 status code
      ProblemDetails - When receiving a 403 status code
      ProblemDetails - When receiving a 404 status code
      ProblemDetails - When receiving a 500 status code

    • get

      @Nullable public List<RuleType> get(@Nullable Consumer<RulesRequestBuilder.GetRequestConfiguration> requestConfiguration)
      Returns a list of all rules configured for the artifact. The set of rules determineshow the content of an artifact can evolve over time. If no rules are configured foran artifact, then the rules configured for the group is used. If no rules are configured at the group level, then the set of globally configured rules are used. If no global rules are defined, there are no restrictions on content evolution.This operation can fail for the following reasons:* No artifact with this `artifactId` exists (HTTP error `404`)* 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:
      ProblemDetails - When receiving a 401 status code
      ProblemDetails - When receiving a 403 status code
      ProblemDetails - When receiving a 404 status code
      ProblemDetails - When receiving a 500 status code

    • post

      public void post(@Nonnull CreateRule body)
      Adds a rule to the list of rules that get applied to the artifact when adding newversions. All configured rules must pass to successfully add a new artifact version.This operation can fail for the following reasons:* No artifact with this `artifactId` exists (HTTP error `404`)* Rule (named in the request body) is unknown (HTTP error `400`)* Rule is already configured (HTTP error `409`)* A server error occurred (HTTP error `500`)
      Parameters:
      body - The request body
      Throws:
      ProblemDetails - When receiving a 400 status code
      ProblemDetails - When receiving a 401 status code
      ProblemDetails - When receiving a 403 status code
      ProblemDetails - When receiving a 404 status code
      ProblemDetails - When receiving a 409 status code
      ProblemDetails - When receiving a 500 status code

    • post

      public void post(@Nonnull CreateRule body, @Nullable Consumer<RulesRequestBuilder.PostRequestConfiguration> requestConfiguration)
      Adds a rule to the list of rules that get applied to the artifact when adding newversions. All configured rules must pass to successfully add a new artifact version.This operation can fail for the following reasons:* No artifact with this `artifactId` exists (HTTP error `404`)* Rule (named in the request body) is unknown (HTTP error `400`)* Rule is already configured (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:
      ProblemDetails - When receiving a 400 status code
      ProblemDetails - When receiving a 401 status code
      ProblemDetails - When receiving a 403 status code
      ProblemDetails - When receiving a 404 status code
      ProblemDetails - When receiving a 409 status code
      ProblemDetails - When receiving a 500 status code

    • toDeleteRequestInformation

      @Nonnull public com.microsoft.kiota.RequestInformation toDeleteRequestInformation()
      Deletes all of the rules configured for the artifact. After this is done, the globalrules apply to the artifact again.This operation can fail for the following reasons:* No artifact with this `artifactId` exists (HTTP error `404`)* 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 of the rules configured for the artifact. After this is done, the globalrules apply to the artifact again.This operation can fail for the following reasons:* No artifact with this `artifactId` exists (HTTP error `404`)* 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()
      Returns a list of all rules configured for the artifact. The set of rules determineshow the content of an artifact can evolve over time. If no rules are configured foran artifact, then the rules configured for the group is used. If no rules are configured at the group level, then the set of globally configured rules are used. If no global rules are defined, there are no restrictions on content evolution.This operation can fail for the following reasons:* No artifact with this `artifactId` exists (HTTP error `404`)* A server error occurred (HTTP error `500`)
      Returns:
      a RequestInformation

    • toGetRequestInformation

      @Nonnull public com.microsoft.kiota.RequestInformation toGetRequestInformation(@Nullable Consumer<RulesRequestBuilder.GetRequestConfiguration> requestConfiguration)
      Returns a list of all rules configured for the artifact. The set of rules determineshow the content of an artifact can evolve over time. If no rules are configured foran artifact, then the rules configured for the group is used. If no rules are configured at the group level, then the set of globally configured rules are used. If no global rules are defined, there are no restrictions on content evolution.This operation can fail for the following reasons:* No artifact with this `artifactId` exists (HTTP error `404`)* 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 CreateRule body)
      Adds a rule to the list of rules that get applied to the artifact when adding newversions. All configured rules must pass to successfully add a new artifact version.This operation can fail for the following reasons:* No artifact with this `artifactId` exists (HTTP error `404`)* Rule (named in the request body) is unknown (HTTP error `400`)* Rule is already configured (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 CreateRule body, @Nullable Consumer<RulesRequestBuilder.PostRequestConfiguration> requestConfiguration)
      Adds a rule to the list of rules that get applied to the artifact when adding newversions. All configured rules must pass to successfully add a new artifact version.This operation can fail for the following reasons:* No artifact with this `artifactId` exists (HTTP error `404`)* Rule (named in the request body) is unknown (HTTP error `400`)* Rule is already configured (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