Package io.github.primelib.webmethodsapigateway4j.model

Klasse FormParameter

java.lang.Object
io.github.primelib.webmethodsapigateway4j.model.FormParameter
@Generated("io.github.primelib.primecodegen.javafeign.JavaFeignGenerator") public class FormParameter extends Object
FormParameter

  • Felddetails

    • __enum

      protected List<String> __enum

    • allowEmptyValue

      protected 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

    • allowReserved

      protected 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

    • content

      protected 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

    • _default

      protected String _default

    • deprecated

      protected 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

    • description

      protected String description
      A brief description of the parameter. This could contain examples of use

    • examples

      protected 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

    • explode

      protected 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

    • extendedExample

      protected 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

    • get$ref

      protected String get$ref
      The available paths and operations for the API

    • in

      protected String in
      The location of the parameter. Possible values are "query", "header", "path" or "cookie"

    • name

      protected String name
      The name of the parameter. Parameter names are case sensitive

    • parameterSchema

      protected ParameterSchema parameterSchema

    • required

      protected 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

    • style

      protected 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

    • vendorExtensions

      protected Map<String,Object> vendorExtensions

    • xpath

      protected Xpath xpath

  • Konstruktordetails

    • FormParameter

      public FormParameter(Consumer<FormParameter> spec)
      Constructs a validated instance of FormParameter.
      Parameter:
      spec - the specification to process

    • FormParameter

      @Internal public FormParameter(List<String> __enum, Boolean allowEmptyValue, Boolean allowReserved, Map<String,MediaType> content, String _default, Boolean deprecated, String description, Map<String,Example> examples, Boolean explode, Object extendedExample, String get$ref, String in, String name, ParameterSchema parameterSchema, Boolean required, FormParameter.StyleEnum style, Map<String,Object> vendorExtensions, Xpath xpath)
      Constructs a validated instance of FormParameter.

      NOTE: This constructor is not considered stable and may change if the model is updated. Consider using FormParameter(Consumer) instead.

      Parameter:
      __enum - __enum
      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
      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
      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
      _default - _default
      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
      description - A brief description of the parameter. This could contain examples of use
      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
      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
      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
      get$ref - The available paths and operations for the API
      in - The location of the parameter. Possible values are "query", "header", "path" or "cookie"
      name - The name of the parameter. Parameter names are case sensitive
      parameterSchema - parameterSchema
      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
      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
      vendorExtensions - vendorExtensions
      xpath - xpath

    • FormParameter

      protected FormParameter()

  • Methodendetails

    • builder

      public static FormParameter.FormParameterBuilder builder()

    • __enum

      public List<String> __enum()

    • allowEmptyValue

      public 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

    • allowReserved

      public 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

    • content

      public 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

    • _default

      public String _default()

    • deprecated

      public 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

    • description

      public String description()
      A brief description of the parameter. This could contain examples of use

    • examples

      public 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

    • explode

      public 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

    • extendedExample

      public 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

    • get$ref

      public String get$ref()
      The available paths and operations for the API

    • in

      public String in()
      The location of the parameter. Possible values are "query", "header", "path" or "cookie"

    • name

      public String name()
      The name of the parameter. Parameter names are case sensitive

    • parameterSchema

      public ParameterSchema parameterSchema()

    • required

      public 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

    • style

      public 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

    • vendorExtensions

      public Map<String,Object> vendorExtensions()

    • xpath

      public Xpath xpath()

    • __enum

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

    • allowEmptyValue

      public FormParameter 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 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 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 _default(String _default)
      Gibt zurück:
      this.

    • deprecated

      public FormParameter 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 description(String description)
      A brief description of the parameter. This could contain examples of use
      Gibt zurück:
      this.

    • examples

      public FormParameter 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 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 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 get$ref(String get$ref)
      The available paths and operations for the API
      Gibt zurück:
      this.

    • in

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

    • name

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

    • parameterSchema

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

    • required

      public FormParameter 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 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 vendorExtensions(Map<String,Object> vendorExtensions)
      Gibt zurück:
      this.

    • xpath

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

    • equals

      public boolean equals(Object o)
      Setzt außer Kraft:
      equals in Klasse Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Setzt außer Kraft:
      hashCode in Klasse Object

    • toString

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