Interface PipelineParameter
-
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
PipelineParameter.Jsii$Proxy
@Generated(value="jsii-pacmak/1.96.0 (build 921e240)", date="2024-03-28T21:16:43.061Z") @Stability(Experimental) public interface PipelineParameter extends software.amazon.jsii.JsiiSerializable
(experimental) Parameters are declared by name under a job, command, or executor.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static classPipelineParameter.BuilderA builder forPipelineParameterstatic classPipelineParameter.Jsii$ProxyAn implementation forPipelineParameter
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description static PipelineParameter.Builderbuilder()default ObjectgetDefaultValue()(experimental) The default value for the parameter.default StringgetDescription()(experimental) Used to generate documentation for your orb.PipelineParameterTypegetType()(experimental) The parameter type, required.
-
-
-
Method Detail
-
getType
@Stability(Experimental) @NotNull PipelineParameterType getType()
(experimental) The parameter type, required.
-
getDefaultValue
@Stability(Experimental) @Nullable default Object getDefaultValue()
(experimental) The default value for the parameter.If not present, the parameter is implied to be required.
-
getDescription
@Stability(Experimental) @Nullable default String getDescription()
(experimental) Used to generate documentation for your orb.
-
builder
@Stability(Experimental) static PipelineParameter.Builder builder()
- Returns:
- a
PipelineParameter.BuilderofPipelineParameter
-
-