Component (AWS Java SDK :: Services :: Imagebuilder 2.17.262 API)

java.lang.Object
- software.amazon.awssdk.services.imagebuilder.model.Component

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<Component.Builder,Component>

@Generated(value="software.amazon.awssdk:codegen")
public final class Component
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Component.Builder,Component>

A detailed view of a component.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Component.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Component.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`arn()` The Amazon Resource Name (ARN) of the component.
`static Component.Builder`	`builder()`
`String`	`changeDescription()` The change description of the component.
`String`	`data()` Component data contains the YAML document content for the component.
`String`	`dateCreated()` The date that the component was created.
`String`	`description()` The description of the component.
`Boolean`	`encrypted()` The encryption status of the component.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasParameters()` For responses, this returns true if the service returned a value for the Parameters property.
`boolean`	`hasSupportedOsVersions()` For responses, this returns true if the service returned a value for the SupportedOsVersions property.
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`String`	`kmsKeyId()` The KMS key identifier used to encrypt the component.
`String`	`name()` The name of the component.
`String`	`owner()` The owner of the component.
`List<ComponentParameterDetail>`	`parameters()` Contains parameter details for each of the parameters that are defined for the component.
`Platform`	`platform()` The platform of the component.
`String`	`platformAsString()` The platform of the component.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Component.Builder>`	`serializableBuilderClass()`
`ComponentState`	`state()` Describes the current status of the component.
`List<String>`	`supportedOsVersions()` The operating system (OS) version supported by the component.
`Map<String,String>`	`tags()` The tags associated with the component.
`Component.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`ComponentType`	`type()` The type of the component denotes whether the component is used to build the image or only to test it.
`String`	`typeAsString()` The type of the component denotes whether the component is used to build the image or only to test it.
`String`	`version()` The version of the component.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - arn
```
public final String arn()
```
    The Amazon Resource Name (ARN) of the component.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the component.
  - name
```
public final String name()
```
    The name of the component.
    
    Returns:
    
    The name of the component.
  - version
```
public final String version()
```
    The version of the component.
    
    Returns:
    
    The version of the component.
  - description
```
public final String description()
```
    The description of the component.
    
    Returns:
    
    The description of the component.
  - changeDescription
```
public final String changeDescription()
```
    The change description of the component.
    
    Returns:
    
    The change description of the component.
  - type
```
public final ComponentType type()
```
    The type of the component denotes whether the component is used to build the image or only to test it.
    
    If the service returns an enum value that is not available in the current SDK version, type will return ComponentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    The type of the component denotes whether the component is used to build the image or only to test it.
    
    See Also:
    
    ComponentType
  - typeAsString
```
public final String typeAsString()
```
    The type of the component denotes whether the component is used to build the image or only to test it.
    
    If the service returns an enum value that is not available in the current SDK version, type will return ComponentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    The type of the component denotes whether the component is used to build the image or only to test it.
    
    See Also:
    
    ComponentType
  - platform
```
public final Platform platform()
```
    The platform of the component.
    
    If the service returns an enum value that is not available in the current SDK version, platform will return Platform.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from platformAsString().
    
    Returns:
    
    The platform of the component.
    
    See Also:
    
    Platform
  - platformAsString
```
public final String platformAsString()
```
    The platform of the component.
    
    If the service returns an enum value that is not available in the current SDK version, platform will return Platform.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from platformAsString().
    
    Returns:
    
    The platform of the component.
    
    See Also:
    
    Platform
  - hasSupportedOsVersions
```
public final boolean hasSupportedOsVersions()
```
    For responses, this returns true if the service returned a value for the SupportedOsVersions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - supportedOsVersions
```
public final List<String> supportedOsVersions()
```
    The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the base image OS version during image recipe creation.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSupportedOsVersions() method.
    
    Returns:
    
    The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the base image OS version during image recipe creation.
  - state
```
public final ComponentState state()
```
    Describes the current status of the component. This is used for components that are no longer active.
    
    Returns:
    
    Describes the current status of the component. This is used for components that are no longer active.
  - hasParameters
```
public final boolean hasParameters()
```
    For responses, this returns true if the service returned a value for the Parameters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - parameters
```
public final List<ComponentParameterDetail> parameters()
```
    Contains parameter details for each of the parameters that are defined for the component.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasParameters() method.
    
    Returns:
    
    Contains parameter details for each of the parameters that are defined for the component.
  - owner
```
public final String owner()
```
    The owner of the component.
    
    Returns:
    
    The owner of the component.
  - data
```
public final String data()
```
    Component data contains the YAML document content for the component.
    
    Returns:
    
    Component data contains the YAML document content for the component.
  - kmsKeyId
```
public final String kmsKeyId()
```
    The KMS key identifier used to encrypt the component.
    
    Returns:
    
    The KMS key identifier used to encrypt the component.
  - encrypted
```
public final Boolean encrypted()
```
    The encryption status of the component.
    
    Returns:
    
    The encryption status of the component.
  - dateCreated
```
public final String dateCreated()
```
    The date that the component was created.
    
    Returns:
    
    The date that the component was created.
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - tags
```
public final Map<String,String> tags()
```
    The tags associated with the component.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.
    
    Returns:
    
    The tags associated with the component.
  - toBuilder
```
public Component.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Component.Builder,Component>
  - builder
```
public static Component.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Component.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class Component

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

arn

name

version

description

changeDescription

type

typeAsString

platform

platformAsString

hasSupportedOsVersions

supportedOsVersions

state

hasParameters

parameters

owner

data

kmsKeyId

encrypted

dateCreated

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields