java.lang.Object
- io.fabric8.openshift.api.model.Parameter

All Implemented Interfaces:

io.fabric8.kubernetes.api.builder.Editable<ParameterBuilder>, io.fabric8.kubernetes.api.model.KubernetesResource, Serializable
```
@Generated("io.fabric8.kubernetes.schema.generator.model.ModelGenerator")
public class Parameter
extends Object
implements io.fabric8.kubernetes.api.builder.Editable<ParameterBuilder>, io.fabric8.kubernetes.api.model.KubernetesResource
```
Parameter defines a name/value variable that is to be processed during the Template to Config transformation.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor	Description
`Parameter()`	No args constructor for use in serialization
`Parameter(String description, String displayName, String from, String generate, String name, Boolean required, String value)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ParameterBuilder`	`edit()`
`Map<String,Object>`	`getAdditionalProperties()`
`String`	`getDescription()`	description of a parameter.
`String`	`getDisplayName()`	Optional: The name that will show in UI instead of parameter 'Name'
`String`	`getFrom()`	from is an input value for the generator.
`String`	`getGenerate()`	generate specifies the generator to be used to generate random string from an input value specified by From field.
`String`	`getName()`	name must be set and it can be referenced in Template Items using ${PARAMETER_NAME}.
`Boolean`	`getRequired()`	Optional: Indicates the parameter must have a value.
`String`	`getValue()`	value holds the Parameter data.
`void`	`setAdditionalProperties(Map<String,Object> additionalProperties)`
`void`	`setAdditionalProperty(String name, Object value)`
`void`	`setDescription(String description)`	description of a parameter.
`void`	`setDisplayName(String displayName)`	Optional: The name that will show in UI instead of parameter 'Name'
`void`	`setFrom(String from)`	from is an input value for the generator.
`void`	`setGenerate(String generate)`	generate specifies the generator to be used to generate random string from an input value specified by From field.
`void`	`setName(String name)`	name must be set and it can be referenced in Template Items using ${PARAMETER_NAME}.
`void`	`setRequired(Boolean required)`	Optional: Indicates the parameter must have a value.
`void`	`setValue(String value)`	value holds the Parameter data.
`ParameterBuilder`	`toBuilder()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Parameter
```
public Parameter()
```
    No args constructor for use in serialization
  - Parameter
```
public Parameter(String description,
                 String displayName,
                 String from,
                 String generate,
                 String name,
                 Boolean required,
                 String value)
```
- Method Detail
  - getDescription
```
public String getDescription()
```
    description of a parameter. Optional.
  - setDescription
```
public void setDescription(String description)
```
    description of a parameter. Optional.
  - getDisplayName
```
public String getDisplayName()
```
    Optional: The name that will show in UI instead of parameter 'Name'
  - setDisplayName
```
public void setDisplayName(String displayName)
```
    Optional: The name that will show in UI instead of parameter 'Name'
  - getFrom
```
public String getFrom()
```
    from is an input value for the generator. Optional.
  - setFrom
```
public void setFrom(String from)
```
    from is an input value for the generator. Optional.
  - getGenerate
```
public String getGenerate()
```
    generate specifies the generator to be used to generate random string from an input value specified by From field. The result string is stored into Value field. If empty, no generator is being used, leaving the result Value untouched. Optional.
    
    The only supported generator is "expression", which accepts a "from" value in the form of a simple regular expression containing the range expression "[a-zA-Z0-9]", and the length expression "a{length}".
    
    Examples:
    
    from | value ----------------------------- "test[0-9]{1}x" | "test7x" "[0-1]{8}" | "01001100" "0x[A-F0-9]{4}" | "0xB3AF" "[a-zA-Z0-9]{8}" | "hW4yQU5i"
  - setGenerate
```
public void setGenerate(String generate)
```
    generate specifies the generator to be used to generate random string from an input value specified by From field. The result string is stored into Value field. If empty, no generator is being used, leaving the result Value untouched. Optional.
    
    The only supported generator is "expression", which accepts a "from" value in the form of a simple regular expression containing the range expression "[a-zA-Z0-9]", and the length expression "a{length}".
    
    Examples:
    
    from | value ----------------------------- "test[0-9]{1}x" | "test7x" "[0-1]{8}" | "01001100" "0x[A-F0-9]{4}" | "0xB3AF" "[a-zA-Z0-9]{8}" | "hW4yQU5i"
  - getName
```
public String getName()
```
    name must be set and it can be referenced in Template Items using ${PARAMETER_NAME}. Required.
  - setName
```
public void setName(String name)
```
    name must be set and it can be referenced in Template Items using ${PARAMETER_NAME}. Required.
  - getRequired
```
public Boolean getRequired()
```
    Optional: Indicates the parameter must have a value. Defaults to false.
  - setRequired
```
public void setRequired(Boolean required)
```
    Optional: Indicates the parameter must have a value. Defaults to false.
  - getValue
```
public String getValue()
```
    value holds the Parameter data. If specified, the generator will be ignored. The value replaces all occurrences of the Parameter ${Name} expression during the Template to Config transformation. Optional.
  - setValue
```
public void setValue(String value)
```
    value holds the Parameter data. If specified, the generator will be ignored. The value replaces all occurrences of the Parameter ${Name} expression during the Template to Config transformation. Optional.
  - edit
```
public ParameterBuilder edit()
```
    Specified by:
    
    edit in interface io.fabric8.kubernetes.api.builder.Editable<ParameterBuilder>
  - toBuilder
```
public ParameterBuilder toBuilder()
```
  - getAdditionalProperties
```
public Map<String,Object> getAdditionalProperties()
```
  - setAdditionalProperty
```
public void setAdditionalProperty(String name,
                                  Object value)
```
  - setAdditionalProperties
```
public void setAdditionalProperties(Map<String,Object> additionalProperties)
```

Class Parameter

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Parameter

Parameter

Method Detail

getDescription

setDescription

getDisplayName

setDisplayName

getFrom

setFrom

getGenerate

setGenerate

getName

setName

getRequired

setRequired

getValue

setValue

edit

toBuilder

getAdditionalProperties

setAdditionalProperty

setAdditionalProperties