com.ibm.broker.rest

Interface Parameter



  • public interface Parameter
    An interface that describes a parameter in an API. A parameter has a name, type (such as path or query string), description, and whether or not that parameter is required.
    Since:
    IBM Integration Bus v10
    • Method Detail

      • getName

        java.lang.String getName()
        Get the name of this parameter, for example "customerId".
        Returns:
        the name of this parameter.
      • setName

        Parameter setName(java.lang.String name)
                   throws ApiException
        Set the name of this parameter, for example "customerId".
        Parameters:
        name - the new name of this parameter.
        Returns:
        this parameter.
        Throws:
        ApiException - if the name could not be changed.
      • getOperation

        Operation getOperation()
        Get the Operation that owns this parameter.
        Returns:
        the owning Operation.
      • getType

        ParameterType getType()
        Get the type of this parameter, for example "QUERY".
        Returns:
        the type of this parameter.
      • setType

        Parameter setType(ParameterType type)
                   throws ApiException
        Set the type of this parameter, for example "FORM".
        Parameters:
        type - the new type of this parameter.
        Returns:
        this parameter.
        Throws:
        ApiException - if the type could not be changed.
      • getFormat

        java.lang.String getFormat()
        Get the format of this parameter, for example "int32".
        Returns:
        the format of this parameter.
      • setFormat

        Parameter setFormat(java.lang.String format)
                     throws ApiException
        Set the format of this parameter, for example "float".
        Parameters:
        format - the new format of this parameter.
        Returns:
        this parameter.
        Throws:
        ApiException - if the format could not be changed.
      • isRequired

        boolean isRequired()
        Determine whether or not this parameter is required.
        Returns:
        true if this parameter is required, false if not.
      • setRequired

        Parameter setRequired(boolean required)
                       throws ApiException
        Specify whether or not his parameter is required.
        Parameters:
        required - true if this parameter is required, false if it is optional.
        Returns:
        this parameter.
        Throws:
        ApiException - if the flag could not be changed.
      • getDescription

        java.lang.String getDescription()
        Get a description of this parameter. The description is optional.
        Returns:
        the description of this parameter, null if no description is specified.
      • setDescription

        Parameter setDescription(java.lang.String description)
                          throws ApiException
        Set the description of this parameter. The description is optional.
        Parameters:
        description - the new description of this parameter.
        Returns:
        this parameter.
        Throws:
        ApiException - if the description could not be changed.
      • getDataType

        DataType getDataType()
        Get the data type of this parameter, for example "string".
        Returns:
        the data type of this parameter.
      • setDataType

        Parameter setDataType(DataType type)
                       throws ApiException
        Set the data type of this parameter, for example "boolean".
        Parameters:
        type - the new data type of this parameter.
        Returns:
        this parameter.
        Throws:
        ApiException - if the type could not be changed.