Interface CommandParameter.Builder

All Superinterfaces:

Buildable, CopyableBuilder<CommandParameter.Builder,CommandParameter>, SdkBuilder<CommandParameter.Builder,CommandParameter>, SdkPojo

Enclosing class:

CommandParameter

@Mutable
@NotThreadSafe
public static interface CommandParameter.Builder
extends SdkPojo, CopyableBuilder<CommandParameter.Builder,CommandParameter>

Method Summary

Modifier and Type	Method	Description
default CommandParameter.Builder	defaultValue(Consumer<CommandParameterValue.Builder> defaultValue)	The default value used to describe the command.
CommandParameter.Builder	defaultValue(CommandParameterValue defaultValue)	The default value used to describe the command.
CommandParameter.Builder	description(String description)	The description of the command parameter.
CommandParameter.Builder	name(String name)	The name of a specific parameter used in a command and command execution.
CommandParameter.Builder	type(String type)	The type of the command parameter.
CommandParameter.Builder	type(CommandParameterType type)	The type of the command parameter.
default CommandParameter.Builder	value(Consumer<CommandParameterValue.Builder> value)	Parameter value that overrides the default value, if set.
CommandParameter.Builder	value(CommandParameterValue value)	Parameter value that overrides the default value, if set.
CommandParameter.Builder	valueConditions(Collection<CommandParameterValueCondition> valueConditions)	The list of conditions that a command parameter value must satisfy to create a command execution.
CommandParameter.Builder	valueConditions(Consumer<CommandParameterValueCondition.Builder>... valueConditions)	The list of conditions that a command parameter value must satisfy to create a command execution.
CommandParameter.Builder	valueConditions(CommandParameterValueCondition... valueConditions)	The list of conditions that a command parameter value must satisfy to create a command execution.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

name

CommandParameter.Builder name(String name)

The name of a specific parameter used in a command and command execution.

Parameters:

name - The name of a specific parameter used in a command and command execution.

Returns:

Returns a reference to this object so that method calls can be chained together.

type

CommandParameter.Builder type(String type)

The type of the command parameter.

Parameters:

type - The type of the command parameter.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• CommandParameterType
• CommandParameterType

type

CommandParameter.Builder type(CommandParameterType type)

The type of the command parameter.

Parameters:

type - The type of the command parameter.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• CommandParameterType
• CommandParameterType

value

CommandParameter.Builder value(CommandParameterValue value)

Parameter value that overrides the default value, if set.

Parameters:

value - Parameter value that overrides the default value, if set.

Returns:

Returns a reference to this object so that method calls can be chained together.

value

default CommandParameter.Builder value(Consumer<CommandParameterValue.Builder> value)

Parameter value that overrides the default value, if set.

This is a convenience method that creates an instance of the CommandParameterValue.Builder avoiding the need to create one manually via CommandParameterValue.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to value(CommandParameterValue).

Parameters:

value - a consumer that will call methods on CommandParameterValue.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• value(CommandParameterValue)

defaultValue

CommandParameter.Builder defaultValue(CommandParameterValue defaultValue)

The default value used to describe the command. This is the value assumed by the parameter if no other value is assigned to it.

Parameters:

defaultValue - The default value used to describe the command. This is the value assumed by the parameter if no other value is assigned to it.

Returns:

Returns a reference to this object so that method calls can be chained together.

defaultValue

default CommandParameter.Builder defaultValue(Consumer<CommandParameterValue.Builder> defaultValue)

The default value used to describe the command. This is the value assumed by the parameter if no other value is assigned to it.

This is a convenience method that creates an instance of the CommandParameterValue.Builder avoiding the need to create one manually via CommandParameterValue.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to defaultValue(CommandParameterValue).

Parameters:

defaultValue - a consumer that will call methods on CommandParameterValue.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• defaultValue(CommandParameterValue)

valueConditions

CommandParameter.Builder valueConditions(Collection<CommandParameterValueCondition> valueConditions)

The list of conditions that a command parameter value must satisfy to create a command execution.

Parameters:

valueConditions - The list of conditions that a command parameter value must satisfy to create a command execution.

Returns:

Returns a reference to this object so that method calls can be chained together.

valueConditions

CommandParameter.Builder valueConditions(CommandParameterValueCondition... valueConditions)

The list of conditions that a command parameter value must satisfy to create a command execution.

Parameters:

valueConditions - The list of conditions that a command parameter value must satisfy to create a command execution.

Returns:

Returns a reference to this object so that method calls can be chained together.

valueConditions

CommandParameter.Builder valueConditions(Consumer<CommandParameterValueCondition.Builder>... valueConditions)

The list of conditions that a command parameter value must satisfy to create a command execution.

This is a convenience method that creates an instance of the CommandParameterValueCondition.Builder avoiding the need to create one manually via CommandParameterValueCondition.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to valueConditions(List<CommandParameterValueCondition>).

Parameters:

valueConditions - a consumer that will call methods on CommandParameterValueCondition.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• valueConditions(java.util.Collection<CommandParameterValueCondition>)

description

CommandParameter.Builder description(String description)

The description of the command parameter.

Parameters:

description - The description of the command parameter.

Returns:

Returns a reference to this object so that method calls can be chained together.