ParameterContractArgs

data class ParameterContractArgs(val defaultValue: Output<String>? = null, val description: Output<String>? = null, val examples: Output<Map<String, ParameterExampleContractArgs>>? = null, val name: Output<String>, val required: Output<Boolean>? = null, val schemaId: Output<String>? = null, val type: Output<String>, val typeName: Output<String>? = null, val values: Output<List<String>>? = null) : ConvertibleToJava<ParameterContractArgs>

Operation parameters details.

Constructors

Link copied to clipboard
constructor(defaultValue: Output<String>? = null, description: Output<String>? = null, examples: Output<Map<String, ParameterExampleContractArgs>>? = null, name: Output<String>, required: Output<Boolean>? = null, schemaId: Output<String>? = null, type: Output<String>, typeName: Output<String>? = null, values: Output<List<String>>? = null)

Properties

Link copied to clipboard
val defaultValue: Output<String>? = null

Default parameter value.

Link copied to clipboard
val description: Output<String>? = null

Parameter description.

Link copied to clipboard

Exampled defined for the parameter.

Link copied to clipboard
val name: Output<String>

Parameter name.

Link copied to clipboard
val required: Output<Boolean>? = null

Specifies whether parameter is required or not.

Link copied to clipboard
val schemaId: Output<String>? = null

Schema identifier.

Link copied to clipboard
val type: Output<String>

Parameter type.

Link copied to clipboard
val typeName: Output<String>? = null

Type name defined by the schema.

Link copied to clipboard
val values: Output<List<String>>? = null

Parameter values.

Functions

Link copied to clipboard
open override fun toJava(): ParameterContractArgs