Package io.github.primelib.webmethodsapigateway4j.model

Klasse ParameterSchema

java.lang.Object
io.github.primelib.webmethodsapigateway4j.model.ParameterSchema
Bekannte direkte Unterklassen:
ArraySchema, BooleanSchema, ComposedSchema, GatewaySchema, ObjectSchema
@Generated("io.github.primelib.primecodegen.javafeign.JavaFeignGenerator") public class ParameterSchema extends Object
ParameterSchema

  • Felddetails

    • additionalProperties

      protected ParameterSchema additionalProperties

    • additionalPropertiesAsBoolean

      protected Boolean additionalPropertiesAsBoolean

    • _default

      protected Object _default
      The default value represents what would be assumed by the consumer of the input as the value of the schema if one is not provided. Unlike JSON Schema, the value MUST conform to the defined type for the Schema Object defined at the same level. For example, if type is string, then default can be "foo" but cannot be 1

    • deprecated

      protected Boolean deprecated
      Specifies that a schema is deprecated and SHOULD be transitioned out of usage. Default value is false

    • description

      protected String description
      Provide a more lengthy explanation about the purpose of the data described by the schema

    • _enum

      protected List<Object> _enum

    • example

      protected Object example
      A free-form property to include an example of an instance for this schema. To represent examples that cannot be naturally represented in JSON or YAML, a string value can be used to contain the example with escaping where necessary

    • exclusiveMaximum

      protected Boolean exclusiveMaximum
      Indicate whether maximum are exclusive of the value

    • exclusiveMinimum

      protected Boolean exclusiveMinimum
      Indicate whether minimum are exclusive of the value

    • externalDocs

      protected ExternalDocs externalDocs

    • format

      protected String format
      The format keyword allows for basic semantic validation on certain kinds of string values that are commonly used

    • get$ref

      protected String get$ref

    • maxItems

      protected Integer maxItems
      The maximum length of the array can be specified

    • maxLength

      protected Integer maxLength
      The maximum length of a string can be constrained using the minLength

    • maxProperties

      protected Integer maxProperties
      The maximum number of properties on an object can be restricted

    • maximum

      protected BigDecimal maximum
      Upper limit in the ranges of numbers, (or exclusiveMinimum and exclusiveMaximum for expressing exclusive range)

    • minItems

      protected Integer minItems
      The minimum length of the array can be specified

    • minLength

      protected Integer minLength
      The minimum length of a string can be constrained using the minLength

    • minProperties

      protected Integer minProperties
      The minimum number of properties on an object can be restricted

    • minimum

      protected BigDecimal minimum
      Lower limit in the ranges of numbers

    • multipleOf

      protected BigDecimal multipleOf
      Numbers can be restricted to a multiple of a given number, using the multipleOf keyword. It may be set to any positive number.

    • name

      protected String name
      User defined name for the property

    • not

      protected ParameterSchema not

    • nullable

      protected Boolean nullable
      Allows sending a null value for the defined schema. Default value is false

    • pattern

      protected String pattern
      The pattern keyword is used to restrict a string to a particular regular expression. The regular expression syntax is the one defined in JavaScript (ECMA 262 specifically)

    • properties

      protected Map<String,ParameterSchema> properties
      The properties (key-value pairs) on an object are defined using the properties keyword. The value of properties is an object, where each key is the name of a property and each value is of type schema used to validate that property

    • readOnly

      protected Boolean readOnly
      Relevant only for Schema "properties" definitions. Declares the property as "read only". This means that it MAY be sent as part of a response but SHOULD NOT be sent as part of the request. If the property is marked as readOnly being true and is in the required list, the required will take effect on the response only. A property MUST NOT be marked as both readOnly and writeOnly being true. Default value is false

    • required

      protected List<String> required
      By default, the properties defined by the properties keyword are not required. However, one can provide a list of required properties using the required keyword. The required keyword takes an array of zero or more strings. Each of these strings must be unique.

    • title

      protected String title
      User defined title for the property

    • type

      protected String type
      It specifies the data type for a schema

    • uniqueItems

      protected Boolean uniqueItems
      A schema can ensure that each of the items in an array is unique. Simply set the uniqueItems keyword to true

    • vendorExtensions

      protected Map<String,Object> vendorExtensions

    • writeOnly

      protected Boolean writeOnly
      Relevant only for Schema "properties" definitions. Declares the property as "write only". Therefore, it MAY be sent as part of a request but SHOULD NOT be sent as part of the response. If the property is marked as writeOnly being true and is in the required list, the required will take effect on the request only. A property MUST NOT be marked as both readOnly and writeOnly being true. Default value is false

    • xml

      protected Xml xml

  • Konstruktordetails

    • ParameterSchema

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

    • ParameterSchema

      @Internal public ParameterSchema(ParameterSchema additionalProperties, Boolean additionalPropertiesAsBoolean, Object _default, Boolean deprecated, String description, List<Object> _enum, Object example, Boolean exclusiveMaximum, Boolean exclusiveMinimum, ExternalDocs externalDocs, String format, String get$ref, Integer maxItems, Integer maxLength, Integer maxProperties, BigDecimal maximum, Integer minItems, Integer minLength, Integer minProperties, BigDecimal minimum, BigDecimal multipleOf, String name, ParameterSchema not, Boolean nullable, String pattern, Map<String,ParameterSchema> properties, Boolean readOnly, List<String> required, String title, String type, Boolean uniqueItems, Map<String,Object> vendorExtensions, Boolean writeOnly, Xml xml)
      Constructs a validated instance of ParameterSchema.

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

      Parameter:
      additionalProperties - additionalProperties
      additionalPropertiesAsBoolean - additionalPropertiesAsBoolean
      _default - The default value represents what would be assumed by the consumer of the input as the value of the schema if one is not provided. Unlike JSON Schema, the value MUST conform to the defined type for the Schema Object defined at the same level. For example, if type is string, then default can be "foo" but cannot be 1
      deprecated - Specifies that a schema is deprecated and SHOULD be transitioned out of usage. Default value is false
      description - Provide a more lengthy explanation about the purpose of the data described by the schema
      _enum - _enum
      example - A free-form property to include an example of an instance for this schema. To represent examples that cannot be naturally represented in JSON or YAML, a string value can be used to contain the example with escaping where necessary
      exclusiveMaximum - Indicate whether maximum are exclusive of the value
      exclusiveMinimum - Indicate whether minimum are exclusive of the value
      externalDocs - externalDocs
      format - The format keyword allows for basic semantic validation on certain kinds of string values that are commonly used
      get$ref - get$ref
      maxItems - The maximum length of the array can be specified
      maxLength - The maximum length of a string can be constrained using the minLength
      maxProperties - The maximum number of properties on an object can be restricted
      maximum - Upper limit in the ranges of numbers, (or exclusiveMinimum and exclusiveMaximum for expressing exclusive range)
      minItems - The minimum length of the array can be specified
      minLength - The minimum length of a string can be constrained using the minLength
      minProperties - The minimum number of properties on an object can be restricted
      minimum - Lower limit in the ranges of numbers
      multipleOf - Numbers can be restricted to a multiple of a given number, using the multipleOf keyword. It may be set to any positive number.
      name - User defined name for the property
      not - not
      nullable - Allows sending a null value for the defined schema. Default value is false
      pattern - The pattern keyword is used to restrict a string to a particular regular expression. The regular expression syntax is the one defined in JavaScript (ECMA 262 specifically)
      properties - The properties (key-value pairs) on an object are defined using the properties keyword. The value of properties is an object, where each key is the name of a property and each value is of type schema used to validate that property
      readOnly - Relevant only for Schema "properties" definitions. Declares the property as "read only". This means that it MAY be sent as part of a response but SHOULD NOT be sent as part of the request. If the property is marked as readOnly being true and is in the required list, the required will take effect on the response only. A property MUST NOT be marked as both readOnly and writeOnly being true. Default value is false
      required - By default, the properties defined by the properties keyword are not required. However, one can provide a list of required properties using the required keyword. The required keyword takes an array of zero or more strings. Each of these strings must be unique.
      title - User defined title for the property
      type - It specifies the data type for a schema
      uniqueItems - A schema can ensure that each of the items in an array is unique. Simply set the uniqueItems keyword to true
      vendorExtensions - vendorExtensions
      writeOnly - Relevant only for Schema "properties" definitions. Declares the property as "write only". Therefore, it MAY be sent as part of a request but SHOULD NOT be sent as part of the response. If the property is marked as writeOnly being true and is in the required list, the required will take effect on the request only. A property MUST NOT be marked as both readOnly and writeOnly being true. Default value is false
      xml - xml

    • ParameterSchema

      protected ParameterSchema()

  • Methodendetails

    • builder

      public static ParameterSchema.ParameterSchemaBuilder builder()

    • additionalProperties

      public ParameterSchema additionalProperties()

    • additionalPropertiesAsBoolean

      public Boolean additionalPropertiesAsBoolean()

    • _default

      public Object _default()
      The default value represents what would be assumed by the consumer of the input as the value of the schema if one is not provided. Unlike JSON Schema, the value MUST conform to the defined type for the Schema Object defined at the same level. For example, if type is string, then default can be "foo" but cannot be 1

    • deprecated

      public Boolean deprecated()
      Specifies that a schema is deprecated and SHOULD be transitioned out of usage. Default value is false

    • description

      public String description()
      Provide a more lengthy explanation about the purpose of the data described by the schema

    • _enum

      public List<Object> _enum()

    • example

      public Object example()
      A free-form property to include an example of an instance for this schema. To represent examples that cannot be naturally represented in JSON or YAML, a string value can be used to contain the example with escaping where necessary

    • exclusiveMaximum

      public Boolean exclusiveMaximum()
      Indicate whether maximum are exclusive of the value

    • exclusiveMinimum

      public Boolean exclusiveMinimum()
      Indicate whether minimum are exclusive of the value

    • externalDocs

      public ExternalDocs externalDocs()

    • format

      public String format()
      The format keyword allows for basic semantic validation on certain kinds of string values that are commonly used

    • get$ref

      public String get$ref()

    • maxItems

      public Integer maxItems()
      The maximum length of the array can be specified

    • maxLength

      public Integer maxLength()
      The maximum length of a string can be constrained using the minLength

    • maxProperties

      public Integer maxProperties()
      The maximum number of properties on an object can be restricted

    • maximum

      public BigDecimal maximum()
      Upper limit in the ranges of numbers, (or exclusiveMinimum and exclusiveMaximum for expressing exclusive range)

    • minItems

      public Integer minItems()
      The minimum length of the array can be specified

    • minLength

      public Integer minLength()
      The minimum length of a string can be constrained using the minLength

    • minProperties

      public Integer minProperties()
      The minimum number of properties on an object can be restricted

    • minimum

      public BigDecimal minimum()
      Lower limit in the ranges of numbers

    • multipleOf

      public BigDecimal multipleOf()
      Numbers can be restricted to a multiple of a given number, using the multipleOf keyword. It may be set to any positive number.

    • name

      public String name()
      User defined name for the property

    • not

      public ParameterSchema not()

    • nullable

      public Boolean nullable()
      Allows sending a null value for the defined schema. Default value is false

    • pattern

      public String pattern()
      The pattern keyword is used to restrict a string to a particular regular expression. The regular expression syntax is the one defined in JavaScript (ECMA 262 specifically)

    • properties

      public Map<String,ParameterSchema> properties()
      The properties (key-value pairs) on an object are defined using the properties keyword. The value of properties is an object, where each key is the name of a property and each value is of type schema used to validate that property

    • readOnly

      public Boolean readOnly()
      Relevant only for Schema "properties" definitions. Declares the property as "read only". This means that it MAY be sent as part of a response but SHOULD NOT be sent as part of the request. If the property is marked as readOnly being true and is in the required list, the required will take effect on the response only. A property MUST NOT be marked as both readOnly and writeOnly being true. Default value is false

    • required

      public List<String> required()
      By default, the properties defined by the properties keyword are not required. However, one can provide a list of required properties using the required keyword. The required keyword takes an array of zero or more strings. Each of these strings must be unique.

    • title

      public String title()
      User defined title for the property

    • type

      public String type()
      It specifies the data type for a schema

    • uniqueItems

      public Boolean uniqueItems()
      A schema can ensure that each of the items in an array is unique. Simply set the uniqueItems keyword to true

    • vendorExtensions

      public Map<String,Object> vendorExtensions()

    • writeOnly

      public Boolean writeOnly()
      Relevant only for Schema "properties" definitions. Declares the property as "write only". Therefore, it MAY be sent as part of a request but SHOULD NOT be sent as part of the response. If the property is marked as writeOnly being true and is in the required list, the required will take effect on the request only. A property MUST NOT be marked as both readOnly and writeOnly being true. Default value is false

    • xml

      public Xml xml()

    • additionalProperties

      public ParameterSchema additionalProperties(ParameterSchema additionalProperties)
      Gibt zurück:
      this.

    • additionalPropertiesAsBoolean

      public ParameterSchema additionalPropertiesAsBoolean(Boolean additionalPropertiesAsBoolean)
      Gibt zurück:
      this.

    • _default

      public ParameterSchema _default(Object _default)
      The default value represents what would be assumed by the consumer of the input as the value of the schema if one is not provided. Unlike JSON Schema, the value MUST conform to the defined type for the Schema Object defined at the same level. For example, if type is string, then default can be "foo" but cannot be 1
      Gibt zurück:
      this.

    • deprecated

      public ParameterSchema deprecated(Boolean deprecated)
      Specifies that a schema is deprecated and SHOULD be transitioned out of usage. Default value is false
      Gibt zurück:
      this.

    • description

      public ParameterSchema description(String description)
      Provide a more lengthy explanation about the purpose of the data described by the schema
      Gibt zurück:
      this.

    • _enum

      public ParameterSchema _enum(List<Object> _enum)
      Gibt zurück:
      this.

    • example

      public ParameterSchema example(Object example)
      A free-form property to include an example of an instance for this schema. To represent examples that cannot be naturally represented in JSON or YAML, a string value can be used to contain the example with escaping where necessary
      Gibt zurück:
      this.

    • exclusiveMaximum

      public ParameterSchema exclusiveMaximum(Boolean exclusiveMaximum)
      Indicate whether maximum are exclusive of the value
      Gibt zurück:
      this.

    • exclusiveMinimum

      public ParameterSchema exclusiveMinimum(Boolean exclusiveMinimum)
      Indicate whether minimum are exclusive of the value
      Gibt zurück:
      this.

    • externalDocs

      public ParameterSchema externalDocs(ExternalDocs externalDocs)
      Gibt zurück:
      this.

    • format

      public ParameterSchema format(String format)
      The format keyword allows for basic semantic validation on certain kinds of string values that are commonly used
      Gibt zurück:
      this.

    • get$ref

      public ParameterSchema get$ref(String get$ref)
      Gibt zurück:
      this.

    • maxItems

      public ParameterSchema maxItems(Integer maxItems)
      The maximum length of the array can be specified
      Gibt zurück:
      this.

    • maxLength

      public ParameterSchema maxLength(Integer maxLength)
      The maximum length of a string can be constrained using the minLength
      Gibt zurück:
      this.

    • maxProperties

      public ParameterSchema maxProperties(Integer maxProperties)
      The maximum number of properties on an object can be restricted
      Gibt zurück:
      this.

    • maximum

      public ParameterSchema maximum(BigDecimal maximum)
      Upper limit in the ranges of numbers, (or exclusiveMinimum and exclusiveMaximum for expressing exclusive range)
      Gibt zurück:
      this.

    • minItems

      public ParameterSchema minItems(Integer minItems)
      The minimum length of the array can be specified
      Gibt zurück:
      this.

    • minLength

      public ParameterSchema minLength(Integer minLength)
      The minimum length of a string can be constrained using the minLength
      Gibt zurück:
      this.

    • minProperties

      public ParameterSchema minProperties(Integer minProperties)
      The minimum number of properties on an object can be restricted
      Gibt zurück:
      this.

    • minimum

      public ParameterSchema minimum(BigDecimal minimum)
      Lower limit in the ranges of numbers
      Gibt zurück:
      this.

    • multipleOf

      public ParameterSchema multipleOf(BigDecimal multipleOf)
      Numbers can be restricted to a multiple of a given number, using the multipleOf keyword. It may be set to any positive number.
      Gibt zurück:
      this.

    • name

      public ParameterSchema name(String name)
      User defined name for the property
      Gibt zurück:
      this.

    • not

      public ParameterSchema not(ParameterSchema not)
      Gibt zurück:
      this.

    • nullable

      public ParameterSchema nullable(Boolean nullable)
      Allows sending a null value for the defined schema. Default value is false
      Gibt zurück:
      this.

    • pattern

      public ParameterSchema pattern(String pattern)
      The pattern keyword is used to restrict a string to a particular regular expression. The regular expression syntax is the one defined in JavaScript (ECMA 262 specifically)
      Gibt zurück:
      this.

    • properties

      public ParameterSchema properties(Map<String,ParameterSchema> properties)
      The properties (key-value pairs) on an object are defined using the properties keyword. The value of properties is an object, where each key is the name of a property and each value is of type schema used to validate that property
      Gibt zurück:
      this.

    • readOnly

      public ParameterSchema readOnly(Boolean readOnly)
      Relevant only for Schema "properties" definitions. Declares the property as "read only". This means that it MAY be sent as part of a response but SHOULD NOT be sent as part of the request. If the property is marked as readOnly being true and is in the required list, the required will take effect on the response only. A property MUST NOT be marked as both readOnly and writeOnly being true. Default value is false
      Gibt zurück:
      this.

    • required

      public ParameterSchema required(List<String> required)
      By default, the properties defined by the properties keyword are not required. However, one can provide a list of required properties using the required keyword. The required keyword takes an array of zero or more strings. Each of these strings must be unique.
      Gibt zurück:
      this.

    • title

      public ParameterSchema title(String title)
      User defined title for the property
      Gibt zurück:
      this.

    • type

      public ParameterSchema type(String type)
      It specifies the data type for a schema
      Gibt zurück:
      this.

    • uniqueItems

      public ParameterSchema uniqueItems(Boolean uniqueItems)
      A schema can ensure that each of the items in an array is unique. Simply set the uniqueItems keyword to true
      Gibt zurück:
      this.

    • vendorExtensions

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

    • writeOnly

      public ParameterSchema writeOnly(Boolean writeOnly)
      Relevant only for Schema "properties" definitions. Declares the property as "write only". Therefore, it MAY be sent as part of a request but SHOULD NOT be sent as part of the response. If the property is marked as writeOnly being true and is in the required list, the required will take effect on the request only. A property MUST NOT be marked as both readOnly and writeOnly being true. Default value is false
      Gibt zurück:
      this.

    • xml

      public ParameterSchema xml(Xml xml)
      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