Component (AWS SDK for Java

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()` The data of 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)` Indicates whether some other object is "equal to" this one by SDK fields.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasSupportedOsVersions()` Returns true if the SupportedOsVersions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasTags()` Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`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.
`Platform`	`platform()` The platform of the component.
`String`	`platformAsString()` The platform of the component.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Component.Builder>`	`serializableBuilderClass()`
`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()` Take this object and create a builder that contains all of the current property values of this object.
`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
getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - arn
```
public String arn()
```
    The Amazon Resource Name (ARN) of the component.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the component.
  - name
```
public String name()
```
    The name of the component.
    
    Returns:
    
    The name of the component.
  - version
```
public String version()
```
    The version of the component.
    
    Returns:
    
    The version of the component.
  - description
```
public String description()
```
    The description of the component.
    
    Returns:
    
    The description of the component.
  - changeDescription
```
public String changeDescription()
```
    The change description of the component.
    
    Returns:
    
    The change description of the component.
  - type
```
public 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 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 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 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 boolean hasSupportedOsVersions()
```
    Returns true if the SupportedOsVersions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - supportedOsVersions
```
public 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 parent image OS version during image recipe creation.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasSupportedOsVersions() to see if a value was sent in this field.
    
    Returns:
    
    The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the parent image OS version during image recipe creation.
  - owner
```
public String owner()
```
    The owner of the component.
    
    Returns:
    
    The owner of the component.
  - data
```
public String data()
```
    The data of the component.
    
    Returns:
    
    The data of the component.
  - kmsKeyId
```
public String kmsKeyId()
```
    The KMS key identifier used to encrypt the component.
    
    Returns:
    
    The KMS key identifier used to encrypt the component.
  - encrypted
```
public Boolean encrypted()
```
    The encryption status of the component.
    
    Returns:
    
    The encryption status of the component.
  - dateCreated
```
public String dateCreated()
```
    The date that the component was created.
    
    Returns:
    
    The date that the component was created.
  - hasTags
```
public boolean hasTags()
```
    Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - tags
```
public Map<String,String> tags()
```
    The tags associated with the component.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasTags() to see if a value was sent in this field.
    
    Returns:
    
    The tags associated with the component.
  - toBuilder
```
public Component.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Component.Builder,Component>
    
    Returns:
    
    a builder for type T
  - builder
```
public static Component.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Component.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Description copied from interface: SdkPojo
    
    Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.
    If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.
    
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
    
    Parameters:
    
    obj - the object to be compared with
    
    Returns:
    
    true if the other object equals to this object by sdk fields, false otherwise.
  - toString
```
public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

AWS SDK for Java API Reference - 2.15.16

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

owner

data

kmsKeyId

encrypted

dateCreated

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

Copyright © 2020 Amazon Web Services, Inc. All Rights Reserved.