Package io.github.primelib.webmethodsapigateway4j.model

Klasse FormParameter.FormParameterBuilder

java.lang.Object
io.github.primelib.webmethodsapigateway4j.model.FormParameter.FormParameterBuilder
Umschließende Klasse:
FormParameter
public static class FormParameter.FormParameterBuilder extends Object

  • Methodendetails

    • __enum

      public FormParameter.FormParameterBuilder __enum(List<String> __enum)
      Gibt zurück:
      this.

    • allowEmptyValue

      public FormParameter.FormParameterBuilder allowEmptyValue(Boolean allowEmptyValue)
      Sets the ability to pass empty-valued parameters. This is valid only for query parameters and allows sending a parameter with an empty value
      Gibt zurück:
      this.

    • allowReserved

      public FormParameter.FormParameterBuilder allowReserved(Boolean allowReserved)
      Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. This property only applies to parameters with an in value of query. The default value is false
      Gibt zurück:
      this.

    • content

      public FormParameter.FormParameterBuilder content(Map<String,MediaType> content)
      A map containing the representations for the parameter. The key is the media type and the value describes it. The map MUST only contain one entry
      Gibt zurück:
      this.

    • _default

      public FormParameter.FormParameterBuilder _default(String _default)
      Gibt zurück:
      this.

    • deprecated

      public FormParameter.FormParameterBuilder deprecated(Boolean deprecated)
      Determines whether this parameter is mandatory. If the parameter location is "path", this property is REQUIRED and its value MUST be true. Otherwise, the property MAY be included and its default value is false
      Gibt zurück:
      this.

    • description

      public FormParameter.FormParameterBuilder description(String description)
      A brief description of the parameter. This could contain examples of use
      Gibt zurück:
      this.

    • examples

      public FormParameter.FormParameterBuilder examples(Map<String,Example> examples)
      Examples of the media type. Each example SHOULD contain a value in the correct format as specified in the parameter encoding. The examples field is mutually exclusive of the example field. Furthermore, if referencing a schema which contains an example, the examples value SHALL override the example provided by the schema
      Gibt zurück:
      this.

    • explode

      public FormParameter.FormParameterBuilder explode(Boolean explode)
      When this is true, parameter values of type array or object generate separate parameters for each value of the array or key-value pair of the map. For other types of parameters this property has no effect. When style is form, the default value is true. For all other styles, the default value is false
      Gibt zurück:
      this.

    • extendedExample

      public FormParameter.FormParameterBuilder extendedExample(Object extendedExample)
      Example of the media type. The example SHOULD match the specified schema and encoding properties if present. The example field is mutually exclusive of the examples field. Furthermore, if referencing a schema which contains an example, the example value SHALL override the example provided by the schema. To represent examples of media types that cannot naturally be represented in JSON or YAML, a string value can contain the example with escaping where necessary
      Gibt zurück:
      this.

    • get$ref

      public FormParameter.FormParameterBuilder get$ref(String get$ref)
      The available paths and operations for the API
      Gibt zurück:
      this.

    • in

      public FormParameter.FormParameterBuilder in(String in)
      The location of the parameter. Possible values are "query", "header", "path" or "cookie"
      Gibt zurück:
      this.

    • name

      public FormParameter.FormParameterBuilder name(String name)
      The name of the parameter. Parameter names are case sensitive
      Gibt zurück:
      this.

    • parameterSchema

      public FormParameter.FormParameterBuilder parameterSchema(ParameterSchema parameterSchema)
      Gibt zurück:
      this.

    • required

      public FormParameter.FormParameterBuilder required(Boolean required)
      Determines whether this parameter is mandatory. If the parameter location is "path", this property is REQUIRED and its value MUST be true. Otherwise, the property MAY be included and its default value is false
      Gibt zurück:
      this.

    • style

      public FormParameter.FormParameterBuilder style(FormParameter.StyleEnum style)
      Describes how the parameter value will be serialized depending on the type of the parameter value. Default values (based on value of in): for query - form; for path - simple; for header - simple; for cookie - form
      Gibt zurück:
      this.

    • vendorExtensions

      public FormParameter.FormParameterBuilder vendorExtensions(Map<String,Object> vendorExtensions)
      Gibt zurück:
      this.

    • xpath

      public FormParameter.FormParameterBuilder xpath(Xpath xpath)
      Gibt zurück:
      this.

    • build

      public FormParameter build()

    • toString

      public String toString()
      Setzt außer Kraft:
      toString in Klasse Object