Interface UpdatePackageVersionRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<UpdatePackageVersionRequest.Builder,UpdatePackageVersionRequest>, IotRequest.Builder, SdkBuilder<UpdatePackageVersionRequest.Builder,UpdatePackageVersionRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

UpdatePackageVersionRequest

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

Method Summary

Modifier and Type	Method	Description
UpdatePackageVersionRequest.Builder	action(String action)	The status that the package version should be assigned.
UpdatePackageVersionRequest.Builder	action(PackageVersionAction action)	The status that the package version should be assigned.
default UpdatePackageVersionRequest.Builder	artifact(Consumer<PackageVersionArtifact.Builder> artifact)	The various components that make up a software package version.
UpdatePackageVersionRequest.Builder	artifact(PackageVersionArtifact artifact)	The various components that make up a software package version.
UpdatePackageVersionRequest.Builder	attributes(Map<String,String> attributes)	Metadata that can be used to define a package version’s configuration.
UpdatePackageVersionRequest.Builder	clientToken(String clientToken)	A unique case-sensitive identifier that you can provide to ensure the idempotency of the request.
UpdatePackageVersionRequest.Builder	description(String description)	The package version description.
UpdatePackageVersionRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
UpdatePackageVersionRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
UpdatePackageVersionRequest.Builder	packageName(String packageName)	The name of the associated software package.
UpdatePackageVersionRequest.Builder	recipe(String recipe)	The inline job document associated with a software package version used for a quick job deployment.
UpdatePackageVersionRequest.Builder	versionName(String versionName)	The name of the target package version.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

copy

Methods inherited from interface software.amazon.awssdk.services.iot.model.IotRequest.Builder

build

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

packageName

UpdatePackageVersionRequest.Builder packageName(String packageName)

The name of the associated software package.

Parameters:

packageName - The name of the associated software package.

Returns:

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

versionName

UpdatePackageVersionRequest.Builder versionName(String versionName)

The name of the target package version.

Parameters:

versionName - The name of the target package version.

Returns:

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

description

UpdatePackageVersionRequest.Builder description(String description)

The package version description.

Parameters:

description - The package version description.

Returns:

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

attributes

UpdatePackageVersionRequest.Builder attributes(Map<String,String> attributes)

Metadata that can be used to define a package version’s configuration. For example, the Amazon S3 file location, configuration options that are being sent to the device or fleet.

Note: Attributes can be updated only when the package version is in a draft state.

The combined size of all the attributes on a package version is limited to 3KB.

Parameters:

attributes - Metadata that can be used to define a package version’s configuration. For example, the Amazon S3 file location, configuration options that are being sent to the device or fleet.

Note: Attributes can be updated only when the package version is in a draft state.

The combined size of all the attributes on a package version is limited to 3KB.

Returns:

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

artifact

UpdatePackageVersionRequest.Builder artifact(PackageVersionArtifact artifact)

The various components that make up a software package version.

Parameters:

artifact - The various components that make up a software package version.

Returns:

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

artifact

default UpdatePackageVersionRequest.Builder artifact(Consumer<PackageVersionArtifact.Builder> artifact)

The various components that make up a software package version.

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

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

Parameters:

artifact - a consumer that will call methods on PackageVersionArtifact.Builder

Returns:

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

See Also:

• artifact(PackageVersionArtifact)

action

UpdatePackageVersionRequest.Builder action(String action)

The status that the package version should be assigned. For more information, see Package version lifecycle.

Parameters:

action - The status that the package version should be assigned. For more information, see Package version lifecycle.

Returns:

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

See Also:

• PackageVersionAction
• PackageVersionAction

action

UpdatePackageVersionRequest.Builder action(PackageVersionAction action)

The status that the package version should be assigned. For more information, see Package version lifecycle.

Parameters:

action - The status that the package version should be assigned. For more information, see Package version lifecycle.

Returns:

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

See Also:

• PackageVersionAction
• PackageVersionAction

recipe

UpdatePackageVersionRequest.Builder recipe(String recipe)

The inline job document associated with a software package version used for a quick job deployment.

Parameters:

recipe - The inline job document associated with a software package version used for a quick job deployment.

Returns:

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

clientToken

UpdatePackageVersionRequest.Builder clientToken(String clientToken)

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

Parameters:

clientToken - A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

Returns:

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

overrideConfiguration

UpdatePackageVersionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

UpdatePackageVersionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.