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

Class WithGroupItemRequestBuilder

java.lang.Object
com.microsoft.kiota.BaseRequestBuilder
io.apicurio.registry.rest.client.groups.item.WithGroupItemRequestBuilder
@Generated("com.microsoft.kiota") public class WithGroupItemRequestBuilder extends com.microsoft.kiota.BaseRequestBuilder
Collection to manage a single group in the registry.

  • Constructor Details

    • WithGroupItemRequestBuilder

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

    • WithGroupItemRequestBuilder

      public WithGroupItemRequestBuilder(@Nonnull String rawUrl, @Nonnull com.microsoft.kiota.RequestAdapter requestAdapter)
      Instantiates a new WithGroupItemRequestBuilder 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

    • artifacts

      @Nonnull public ArtifactsRequestBuilder artifacts()
      Manage the collection of artifacts within a single group in the registry.
      Returns:
      a ArtifactsRequestBuilder

    • contracts

      @Nonnull public ContractsRequestBuilder contracts()
      Manage ODCS data contracts within a group.
      Returns:
      a ContractsRequestBuilder

    • rules

      @Nonnull public RulesRequestBuilder rules()
      Manage the rules for a group.
      Returns:
      a RulesRequestBuilder

    • delete

      public void delete()
      Deletes a group by identifier. This operation also deletes all artifacts withinthe group, so should be used very carefully.This operation can fail for the following reasons:* A server error occurred (HTTP error `500`)* The group does not exist (HTTP error `404`)
      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 405 status code
      ProblemDetails - When receiving a 500 status code

    • delete

      public void delete(@Nullable Consumer<WithGroupItemRequestBuilder.DeleteRequestConfiguration> requestConfiguration)
      Deletes a group by identifier. This operation also deletes all artifacts withinthe group, so should be used very carefully.This operation can fail for the following reasons:* A server error occurred (HTTP error `500`)* The group does not exist (HTTP error `404`)
      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 405 status code
      ProblemDetails - When receiving a 500 status code

    • get

      @Nullable public GroupMetaData get()
      Returns a group using the specified id.This operation can fail for the following reasons:* No group exists with the specified ID (HTTP error `404`)* A server error occurred (HTTP error `500`)
      Returns:
      a GroupMetaData
      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 GroupMetaData get(@Nullable Consumer<WithGroupItemRequestBuilder.GetRequestConfiguration> requestConfiguration)
      Returns a group using the specified id.This operation can fail for the following reasons:* No group exists with the specified ID (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 GroupMetaData
      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

    • put

      public void put(@Nonnull EditableGroupMetaData body)
      Updates the metadata of a group using the specified id.This operation can fail for the following reasons:* No group exists with the specified ID (HTTP error `404`)* A server error occurred (HTTP error `500`)
      Parameters:
      body - The request body
      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

    • put

      public void put(@Nonnull EditableGroupMetaData body, @Nullable Consumer<WithGroupItemRequestBuilder.PutRequestConfiguration> requestConfiguration)
      Updates the metadata of a group using the specified id.This operation can fail for the following reasons:* No group exists with the specified ID (HTTP error `404`)* 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 401 status code
      ProblemDetails - When receiving a 403 status code
      ProblemDetails - When receiving a 404 status code
      ProblemDetails - When receiving a 500 status code

    • toDeleteRequestInformation

      @Nonnull public com.microsoft.kiota.RequestInformation toDeleteRequestInformation()
      Deletes a group by identifier. This operation also deletes all artifacts withinthe group, so should be used very carefully.This operation can fail for the following reasons:* A server error occurred (HTTP error `500`)* The group does not exist (HTTP error `404`)
      Returns:
      a RequestInformation

    • toDeleteRequestInformation

      @Nonnull public com.microsoft.kiota.RequestInformation toDeleteRequestInformation(@Nullable Consumer<WithGroupItemRequestBuilder.DeleteRequestConfiguration> requestConfiguration)
      Deletes a group by identifier. This operation also deletes all artifacts withinthe group, so should be used very carefully.This operation can fail for the following reasons:* A server error occurred (HTTP error `500`)* The group does not exist (HTTP error `404`)
      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 group using the specified id.This operation can fail for the following reasons:* No group exists with the specified ID (HTTP error `404`)* A server error occurred (HTTP error `500`)
      Returns:
      a RequestInformation

    • toGetRequestInformation

      @Nonnull public com.microsoft.kiota.RequestInformation toGetRequestInformation(@Nullable Consumer<WithGroupItemRequestBuilder.GetRequestConfiguration> requestConfiguration)
      Returns a group using the specified id.This operation can fail for the following reasons:* No group exists with the specified ID (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

    • toPutRequestInformation

      @Nonnull public com.microsoft.kiota.RequestInformation toPutRequestInformation(@Nonnull EditableGroupMetaData body)
      Updates the metadata of a group using the specified id.This operation can fail for the following reasons:* No group exists with the specified ID (HTTP error `404`)* A server error occurred (HTTP error `500`)
      Parameters:
      body - The request body
      Returns:
      a RequestInformation

    • toPutRequestInformation

      @Nonnull public com.microsoft.kiota.RequestInformation toPutRequestInformation(@Nonnull EditableGroupMetaData body, @Nullable Consumer<WithGroupItemRequestBuilder.PutRequestConfiguration> requestConfiguration)
      Updates the metadata of a group using the specified id.This operation can fail for the following reasons:* No group exists with the specified ID (HTTP error `404`)* 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 WithGroupItemRequestBuilder 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 WithGroupItemRequestBuilder