Package io.github.cdklabs.projen.circleci

Class PipelineParameter.Builder

java.lang.Object

io.github.cdklabs.projen.circleci.PipelineParameter.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<PipelineParameter>

Enclosing interface:

PipelineParameter

@Stability(Experimental)
public static final class PipelineParameter.Builder
extends Object
implements software.amazon.jsii.Builder<PipelineParameter>

A builder for PipelineParameter

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PipelineParameter	build()	Builds the configured instance.
PipelineParameter.Builder	defaultValue(Boolean defaultValue)	Sets the value of PipelineParameter.getDefaultValue()
PipelineParameter.Builder	defaultValue(Number defaultValue)	Sets the value of PipelineParameter.getDefaultValue()
PipelineParameter.Builder	defaultValue(String defaultValue)	Sets the value of PipelineParameter.getDefaultValue()
PipelineParameter.Builder	description(String description)	Sets the value of PipelineParameter.getDescription()
PipelineParameter.Builder	type(PipelineParameterType type)	Sets the value of PipelineParameter.getType()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

type

@Stability(Experimental)
public PipelineParameter.Builder type(PipelineParameterType type)

Sets the value of PipelineParameter.getType()

Parameters:

type - The parameter type, required. This parameter is required.

Returns:

this

defaultValue

@Stability(Experimental)
public PipelineParameter.Builder defaultValue(String defaultValue)

Sets the value of PipelineParameter.getDefaultValue()

Parameters:

defaultValue - The default value for the parameter. If not present, the parameter is implied to be required.

Returns:

this

defaultValue

@Stability(Experimental)
public PipelineParameter.Builder defaultValue(Number defaultValue)

Sets the value of PipelineParameter.getDefaultValue()

Parameters:

defaultValue - The default value for the parameter. If not present, the parameter is implied to be required.

Returns:

this

defaultValue

@Stability(Experimental)
public PipelineParameter.Builder defaultValue(Boolean defaultValue)

Sets the value of PipelineParameter.getDefaultValue()

Parameters:

defaultValue - The default value for the parameter. If not present, the parameter is implied to be required.

Returns:

this

description

@Stability(Experimental)
public PipelineParameter.Builder description(String description)

Sets the value of PipelineParameter.getDescription()

Parameters:

description - Used to generate documentation for your orb.

Returns:

this

build

@Stability(Experimental)
public PipelineParameter build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<PipelineParameter>

Returns:

a new instance of PipelineParameter

Throws:

NullPointerException - if any required attribute was not provided