com.ibm.broker.rest

Interface Request



  • public interface Request
    An interface that describes a possible request for an operation in an API.
    Since:
    IBM Integration Bus v10
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method and Description
      java.lang.String getDescription()
      Get the request description
      com.ibm.broker.rest.schema.Schema getSchema()
      Get the Schema for this request.
      java.lang.String getSchemaAsString(com.ibm.broker.rest.schema.SchemaType schemaType)
      Get the schema for this request as a string.
      boolean isRequired()
      Determine whether or not if this request body is required.
      Request setDescription(java.lang.String description)
      Set the request description.
      Request setRequired(boolean required)
      Set whether or not if this request body is required.
      Request setSchema(com.ibm.broker.rest.schema.Schema schema)
      Set the Schema for this request.
      Request setSchema(com.ibm.broker.rest.schema.SchemaType schemaType, java.lang.String schema)
      Set the schema for this request.
    • Method Detail

      • getDescription

        java.lang.String getDescription()
        Get the request description
        Returns:
        the request description as a String.
      • setDescription

        Request setDescription(java.lang.String description)
        Set the request description.
        Returns:
        the request object.
      • isRequired

        boolean isRequired()
        Determine whether or not if this request body is required.
        Returns:
        true if the request body is required. false otherwise.
      • setRequired

        Request setRequired(boolean required)
                     throws ApiException
        Set whether or not if this request body is required.
        Parameters:
        required - true if the request body is required, false otherwise.
        Returns:
        this request.
        Throws:
        ApiException
      • getSchemaAsString

        java.lang.String getSchemaAsString(com.ibm.broker.rest.schema.SchemaType schemaType)
        Get the schema for this request as a string.
        Parameters:
        schemaType - the type of the schema to retrieve, for example JSON Schema.
        Returns:
        the schema for this request as a string, or null if no schema is available.
      • getSchema

        com.ibm.broker.rest.schema.Schema getSchema()
                                             throws ApiException
        Get the Schema for this request.
        Returns:
        the schema for this request as a Schema object, or null if no schema is available.
        Throws:
        ApiException
      • setSchema

        Request setSchema(com.ibm.broker.rest.schema.SchemaType schemaType,
                          java.lang.String schema)
                   throws ApiException
        Set the schema for this request.
        Parameters:
        schemaType - the type of the schema to set, for example JSON Schema.
        schema - the schema as a string.
        Returns:
        this request.
        Throws:
        ApiException - if the schema could not be changed.
      • setSchema

        Request setSchema(com.ibm.broker.rest.schema.Schema schema)
        Set the Schema for this request.
        Parameters:
        schema - the desired Schema.
        Returns:
        this request object.