Interface ComponentDeploymentSpecification.Builder

All Superinterfaces:

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

Enclosing class:

ComponentDeploymentSpecification

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

Method Summary

Modifier and Type	Method	Description
ComponentDeploymentSpecification.Builder	componentVersion(String componentVersion)	The version of the component.
default ComponentDeploymentSpecification.Builder	configurationUpdate(Consumer<ComponentConfigurationUpdate.Builder> configurationUpdate)	The configuration updates to deploy for the component.
ComponentDeploymentSpecification.Builder	configurationUpdate(ComponentConfigurationUpdate configurationUpdate)	The configuration updates to deploy for the component.
default ComponentDeploymentSpecification.Builder	runWith(Consumer<ComponentRunWith.Builder> runWith)	The system user and group that the IoT Greengrass Core software uses to run component processes on the core device.
ComponentDeploymentSpecification.Builder	runWith(ComponentRunWith runWith)	The system user and group that the IoT Greengrass Core software uses to run component processes on the core device.

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

componentVersion

ComponentDeploymentSpecification.Builder componentVersion(String componentVersion)

The version of the component.

Parameters:

componentVersion - The version of the component.

Returns:

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

configurationUpdate

ComponentDeploymentSpecification.Builder configurationUpdate(ComponentConfigurationUpdate configurationUpdate)

The configuration updates to deploy for the component. You can define reset updates and merge updates. A reset updates the keys that you specify to the default configuration for the component. A merge updates the core device's component configuration with the keys and values that you specify. The IoT Greengrass Core software applies reset updates before it applies merge updates. For more information, see Update component configurations in the IoT Greengrass V2 Developer Guide.

Parameters:

configurationUpdate - The configuration updates to deploy for the component. You can define reset updates and merge updates. A reset updates the keys that you specify to the default configuration for the component. A merge updates the core device's component configuration with the keys and values that you specify. The IoT Greengrass Core software applies reset updates before it applies merge updates. For more information, see Update component configurations in the IoT Greengrass V2 Developer Guide.

Returns:

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

configurationUpdate

default ComponentDeploymentSpecification.Builder configurationUpdate(Consumer<ComponentConfigurationUpdate.Builder> configurationUpdate)

The configuration updates to deploy for the component. You can define reset updates and merge updates. A reset updates the keys that you specify to the default configuration for the component. A merge updates the core device's component configuration with the keys and values that you specify. The IoT Greengrass Core software applies reset updates before it applies merge updates. For more information, see Update component configurations in the IoT Greengrass V2 Developer Guide.

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

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

Parameters:

configurationUpdate - a consumer that will call methods on ComponentConfigurationUpdate.Builder

Returns:

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

See Also:

• configurationUpdate(ComponentConfigurationUpdate)

runWith

ComponentDeploymentSpecification.Builder runWith(ComponentRunWith runWith)

The system user and group that the IoT Greengrass Core software uses to run component processes on the core device. If you omit this parameter, the IoT Greengrass Core software uses the system user and group that you configure for the core device. For more information, see Configure the user and group that run components in the IoT Greengrass V2 Developer Guide.

Parameters:

runWith - The system user and group that the IoT Greengrass Core software uses to run component processes on the core device. If you omit this parameter, the IoT Greengrass Core software uses the system user and group that you configure for the core device. For more information, see Configure the user and group that run components in the IoT Greengrass V2 Developer Guide.

Returns:

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

runWith

default ComponentDeploymentSpecification.Builder runWith(Consumer<ComponentRunWith.Builder> runWith)

The system user and group that the IoT Greengrass Core software uses to run component processes on the core device. If you omit this parameter, the IoT Greengrass Core software uses the system user and group that you configure for the core device. For more information, see Configure the user and group that run components in the IoT Greengrass V2 Developer Guide.

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

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

Parameters:

runWith - a consumer that will call methods on ComponentRunWith.Builder

Returns:

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

See Also:

• runWith(ComponentRunWith)