Package io.apicurio.registry.rest.client.system.uiconfig

Class UiConfigRequestBuilder

java.lang.Object
com.microsoft.kiota.BaseRequestBuilder
io.apicurio.registry.rest.client.system.uiconfig.UiConfigRequestBuilder
@Generated("com.microsoft.kiota") public class UiConfigRequestBuilder extends com.microsoft.kiota.BaseRequestBuilder
This endpoint is used by the user interface to retrieve UI specific configurationin a JSON payload. This allows the UI and the backend to be configured in the same place (the backend process/pod). When the UI loads, it will make an API callto this endpoint to determine what UI features and options are configured.

  • Constructor Details

    • UiConfigRequestBuilder

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

    • UiConfigRequestBuilder

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

    • get

      @Nullable public UserInterfaceConfig get()
      Returns the UI configuration properties for this server. The registry UI can beconnected to a backend using just a URL. The rest of the UI configuration can thenbe fetched from the backend using this operation. This allows UI and backend toboth be configured in the same place.This operation may fail for one of the following reasons:* A server error occurred (HTTP error `500`)
      Returns:
      a UserInterfaceConfig
      Throws:
      ProblemDetails - When receiving a 500 status code

    • get

      @Nullable public UserInterfaceConfig get(@Nullable Consumer<UiConfigRequestBuilder.GetRequestConfiguration> requestConfiguration)
      Returns the UI configuration properties for this server. The registry UI can beconnected to a backend using just a URL. The rest of the UI configuration can thenbe fetched from the backend using this operation. This allows UI and backend toboth be configured in the same place.This operation may fail for one of 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 UserInterfaceConfig
      Throws:
      ProblemDetails - When receiving a 500 status code

    • toGetRequestInformation

      @Nonnull public com.microsoft.kiota.RequestInformation toGetRequestInformation()
      Returns the UI configuration properties for this server. The registry UI can beconnected to a backend using just a URL. The rest of the UI configuration can thenbe fetched from the backend using this operation. This allows UI and backend toboth be configured in the same place.This operation may fail for one of the following reasons:* A server error occurred (HTTP error `500`)
      Returns:
      a RequestInformation

    • toGetRequestInformation

      @Nonnull public com.microsoft.kiota.RequestInformation toGetRequestInformation(@Nullable Consumer<UiConfigRequestBuilder.GetRequestConfiguration> requestConfiguration)
      Returns the UI configuration properties for this server. The registry UI can beconnected to a backend using just a URL. The rest of the UI configuration can thenbe fetched from the backend using this operation. This allows UI and backend toboth be configured in the same place.This operation may fail for one of 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

    • withUrl

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