Package org.eclipse.microprofile.openapi.models.parameters

Interface RequestBody

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      RequestBody content​(Content content)
      Sets the content of this instance of RequestBody, where the keys in content are media type names and the values describe it.
      RequestBody description​(java.lang.String description)
      Sets the description of this RequestBody and return this instance of RequestBody
      Content getContent​()
      Returns the content of this instance of RequestBody, where the keys in content are media type names and the values describe it.
      java.lang.String getDescription​()
      Returns the description of this instance of RequestBody.
      java.lang.Boolean getRequired​()
      Returns whether this instance of RequestBody is required for the operation.
      RequestBody required​(java.lang.Boolean required)
      Sets whether this instance of RequestBody is required or not and returns this instance of RequestBody
      void setContent​(Content content)
      Sets the content of this instance of RequestBody, where the keys in content are media type names and the values describe it.
      void setDescription​(java.lang.String description)
      Sets the description of this instance of RequestBody.
      void setRequired​(java.lang.Boolean required)
      Sets whether this instance of RequestBody is required or not.

    • Method Detail

      • getDescription

        java.lang.String getDescription​()
        Returns the description of this instance of RequestBody.
        Returns:
        a brief description of the RequestBody

      • setDescription

        void setDescription​(java.lang.String description)
        Sets the description of this instance of RequestBody. to the parameter.
        Parameters:
        description - the brief description of the RequestBody

      • description

        RequestBody description​(java.lang.String description)
        Sets the description of this RequestBody and return this instance of RequestBody
        Parameters:
        description - the brief description of the RequestBody
        Returns:
        this RequestBody instance

      • getContent

        Content getContent​()
        Returns the content of this instance of RequestBody, where the keys in content are media type names and the values describe it.
        Returns:
        the content of this RequestBody

      • setContent

        void setContent​(Content content)
        Sets the content of this instance of RequestBody, where the keys in content are media type names and the values describe it.
        Parameters:
        content - the content that describes the RequestBody

      • content

        RequestBody content​(Content content)
        Sets the content of this instance of RequestBody, where the keys in content are media type names and the values describe it.
        Parameters:
        content - the content that describes the RequestBody
        Returns:
        RequestBody instance with the modified content property

      • getRequired

        java.lang.Boolean getRequired​()
        Returns whether this instance of RequestBody is required for the operation.
        Returns:
        true iff the RequestBody is required, false otherwise

      • setRequired

        void setRequired​(java.lang.Boolean required)
        Sets whether this instance of RequestBody is required or not.
        Parameters:
        required - true iff the RequestBody is required, false otherwise

      • required

        RequestBody required​(java.lang.Boolean required)
        Sets whether this instance of RequestBody is required or not and returns this instance of RequestBody
        Parameters:
        required - true iff the RequestBody is required, false otherwise
        Returns:
        this RequestBody instance