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

Class GroupsRequestBuilder

java.lang.Object
com.microsoft.kiota.BaseRequestBuilder
io.apicurio.registry.rest.client.groups.GroupsRequestBuilder
@Generated("com.microsoft.kiota") public class GroupsRequestBuilder extends com.microsoft.kiota.BaseRequestBuilder
Collection of the groups in the registry.

  • Constructor Details

    • GroupsRequestBuilder

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

    • GroupsRequestBuilder

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

    • byGroupId

      @Nonnull public WithGroupItemRequestBuilder byGroupId(@Nonnull String groupId)
      Collection to manage a single group in the registry.
      Parameters:
      groupId - The artifact group ID. Must be a string provided by the client, representing the name of the grouping of artifacts. Must follow the ".{1,512}" pattern.
      Returns:
      a WithGroupItemRequestBuilder

    • get

      @Nullable public GroupSearchResults get()
      Returns a list of all groups. This list is paged.
      Returns:
      a GroupSearchResults
      Throws:
      ProblemDetails - When receiving a 401 status code
      ProblemDetails - When receiving a 403 status code
      ProblemDetails - When receiving a 500 status code

    • get

      @Nullable public GroupSearchResults get(@Nullable Consumer<GroupsRequestBuilder.GetRequestConfiguration> requestConfiguration)
      Returns a list of all groups. This list is paged.
      Parameters:
      requestConfiguration - Configuration for the request such as headers, query parameters, and middleware options.
      Returns:
      a GroupSearchResults
      Throws:
      ProblemDetails - When receiving a 401 status code
      ProblemDetails - When receiving a 403 status code
      ProblemDetails - When receiving a 500 status code

    • post

      @Nullable public GroupMetaData post(@Nonnull CreateGroup body)
      Creates a new group.This operation can fail for the following reasons:* A server error occurred (HTTP error `500`)* The group already exist (HTTP error `409`)* Invalid group ID (e.g., reserved name 'default') (HTTP error `400`)
      Parameters:
      body - The request body
      Returns:
      a GroupMetaData
      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 409 status code
      ProblemDetails - When receiving a 500 status code

    • post

      @Nullable public GroupMetaData post(@Nonnull CreateGroup body, @Nullable Consumer<GroupsRequestBuilder.PostRequestConfiguration> requestConfiguration)
      Creates a new group.This operation can fail for the following reasons:* A server error occurred (HTTP error `500`)* The group already exist (HTTP error `409`)* Invalid group ID (e.g., reserved name 'default') (HTTP error `400`)
      Parameters:
      body - The request body
      requestConfiguration - Configuration for the request such as headers, query parameters, and middleware options.
      Returns:
      a GroupMetaData
      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 409 status code
      ProblemDetails - When receiving a 500 status code

    • toGetRequestInformation

      @Nonnull public com.microsoft.kiota.RequestInformation toGetRequestInformation()
      Returns a list of all groups. This list is paged.
      Returns:
      a RequestInformation

    • toGetRequestInformation

      @Nonnull public com.microsoft.kiota.RequestInformation toGetRequestInformation(@Nullable Consumer<GroupsRequestBuilder.GetRequestConfiguration> requestConfiguration)
      Returns a list of all groups. This list is paged.
      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 CreateGroup body)
      Creates a new group.This operation can fail for the following reasons:* A server error occurred (HTTP error `500`)* The group already exist (HTTP error `409`)* Invalid group ID (e.g., reserved name 'default') (HTTP error `400`)
      Parameters:
      body - The request body
      Returns:
      a RequestInformation

    • toPostRequestInformation

      @Nonnull public com.microsoft.kiota.RequestInformation toPostRequestInformation(@Nonnull CreateGroup body, @Nullable Consumer<GroupsRequestBuilder.PostRequestConfiguration> requestConfiguration)
      Creates a new group.This operation can fail for the following reasons:* A server error occurred (HTTP error `500`)* The group already exist (HTTP error `409`)* Invalid group ID (e.g., reserved name 'default') (HTTP error `400`)
      Parameters:
      body - The request body
      requestConfiguration - Configuration for the request such as headers, query parameters, and middleware options.
      Returns:
      a RequestInformation

    • withUrl

      @Nonnull public GroupsRequestBuilder 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 GroupsRequestBuilder