Package software.amazon.awssdk.services.imagebuilder.model

Interface ComponentSummary.Builder

All Superinterfaces:

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

Enclosing class:

ComponentSummary

public static interface ComponentSummary.Builder
extends SdkPojo, CopyableBuilder<ComponentSummary.Builder,ComponentSummary>

Method Summary

Modifier and Type	Method	Description
ComponentSummary.Builder	arn(String arn)	The Amazon Resource Name (ARN) of the component.
ComponentSummary.Builder	changeDescription(String changeDescription)	The change description for the current version of the component.
ComponentSummary.Builder	dateCreated(String dateCreated)	The original creation date of the component.
ComponentSummary.Builder	description(String description)	The description of the component.
ComponentSummary.Builder	name(String name)	The name of the component.
ComponentSummary.Builder	obfuscate(Boolean obfuscate)	Indicates whether component source is hidden from view in the console, and from component detail results for API, CLI, or SDK operations.
ComponentSummary.Builder	owner(String owner)	The owner of the component.
ComponentSummary.Builder	platform(String platform)	The operating system platform of the component.
ComponentSummary.Builder	platform(Platform platform)	The operating system platform of the component.
ComponentSummary.Builder	publisher(String publisher)	Contains the name of the publisher if this is a third-party component.
default ComponentSummary.Builder	state(Consumer<ComponentState.Builder> state)	Describes the current status of the component.
ComponentSummary.Builder	state(ComponentState state)	Describes the current status of the component.
ComponentSummary.Builder	supportedOsVersions(String... supportedOsVersions)	The operating system (OS) version that the component supports.
ComponentSummary.Builder	supportedOsVersions(Collection<String> supportedOsVersions)	The operating system (OS) version that the component supports.
ComponentSummary.Builder	tags(Map<String,String> tags)	The tags that apply to the component.
ComponentSummary.Builder	type(String type)	The component type specifies whether Image Builder uses the component to build the image or only to test it.
ComponentSummary.Builder	type(ComponentType type)	The component type specifies whether Image Builder uses the component to build the image or only to test it.
ComponentSummary.Builder	version(String version)	The version of the component.

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, sdkFields

Method Detail

arn

ComponentSummary.Builder arn(String arn)

The Amazon Resource Name (ARN) of the component.

Parameters:

arn - The Amazon Resource Name (ARN) of the component.

Returns:

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

name

ComponentSummary.Builder name(String name)

The name of the component.

Parameters:

name - The name of the component.

Returns:

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

version

ComponentSummary.Builder version(String version)

The version of the component.

Parameters:

version - The version of the component.

Returns:

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

platform

ComponentSummary.Builder platform(String platform)

The operating system platform of the component.

Parameters:

platform - The operating system platform of the component.

Returns:

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

See Also:

Platform, Platform

platform

ComponentSummary.Builder platform(Platform platform)

The operating system platform of the component.

Parameters:

platform - The operating system platform of the component.

Returns:

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

See Also:

Platform, Platform

supportedOsVersions

ComponentSummary.Builder supportedOsVersions(Collection<String> supportedOsVersions)

The operating system (OS) version that the component supports. If the OS information is available, Image Builder performs a prefix match against the base image OS version during image recipe creation.

Parameters:

supportedOsVersions - The operating system (OS) version that the component supports. If the OS information is available, Image Builder performs a prefix match against the base image OS version during image recipe creation.

Returns:

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

supportedOsVersions

ComponentSummary.Builder supportedOsVersions(String... supportedOsVersions)

The operating system (OS) version that the component supports. If the OS information is available, Image Builder performs a prefix match against the base image OS version during image recipe creation.

Parameters:

supportedOsVersions - The operating system (OS) version that the component supports. If the OS information is available, Image Builder performs a prefix match against the base image OS version during image recipe creation.

Returns:

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

state

ComponentSummary.Builder state(ComponentState state)

Describes the current status of the component.

Parameters:

state - Describes the current status of the component.

Returns:

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

state

default ComponentSummary.Builder state(Consumer<ComponentState.Builder> state)

Describes the current status of the component.

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

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

Parameters:

state - a consumer that will call methods on ComponentState.Builder

Returns:

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

See Also:

state(ComponentState)

type

ComponentSummary.Builder type(String type)

The component type specifies whether Image Builder uses the component to build the image or only to test it.

Parameters:

type - The component type specifies whether Image Builder uses the component to build the image or only to test it.

Returns:

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

See Also:

ComponentType, ComponentType

type

ComponentSummary.Builder type(ComponentType type)

The component type specifies whether Image Builder uses the component to build the image or only to test it.

Parameters:

type - The component type specifies whether Image Builder uses the component to build the image or only to test it.

Returns:

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

See Also:

ComponentType, ComponentType

owner

ComponentSummary.Builder owner(String owner)

The owner of the component.

Parameters:

owner - The owner of the component.

Returns:

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

description

ComponentSummary.Builder description(String description)

The description of the component.

Parameters:

description - The description of the component.

Returns:

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

changeDescription

ComponentSummary.Builder changeDescription(String changeDescription)

The change description for the current version of the component.

Parameters:

changeDescription - The change description for the current version of the component.

Returns:

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

dateCreated

ComponentSummary.Builder dateCreated(String dateCreated)

The original creation date of the component.

Parameters:

dateCreated - The original creation date of the component.

Returns:

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

tags

ComponentSummary.Builder tags(Map<String,String> tags)

The tags that apply to the component.

Parameters:

tags - The tags that apply to the component.

Returns:

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

publisher

ComponentSummary.Builder publisher(String publisher)

Contains the name of the publisher if this is a third-party component. Otherwise, this property is empty.

Parameters:

publisher - Contains the name of the publisher if this is a third-party component. Otherwise, this property is empty.

Returns:

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

obfuscate

ComponentSummary.Builder obfuscate(Boolean obfuscate)

Indicates whether component source is hidden from view in the console, and from component detail results for API, CLI, or SDK operations.

Parameters:

obfuscate - Indicates whether component source is hidden from view in the console, and from component detail results for API, CLI, or SDK operations.

Returns:

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