Class Component

java.lang.Object
software.amazon.awssdk.services.imagebuilder.model.Component
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Component.Builder,Component>
@Generated("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:

  • Method Details

    • 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()

      Describes what change has been made in this version of the component, or what makes this version different from other versions of the component.

      Returns:
      Describes what change has been made in this version of the component, or what makes this version different from other versions of the component.

    • type

      public final ComponentType type()

      The component type specifies whether Image Builder uses the component 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 component type specifies whether Image Builder uses the component to build the image or only to test it.
      See Also:

    • typeAsString

      public final String typeAsString()

      The component type specifies whether Image Builder uses the component 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 component type specifies whether Image Builder uses the component to build the image or only to test it.
      See Also:

    • platform

      public final Platform platform()

      The operating system 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 operating system platform of the component.
      See Also:

    • platformAsString

      public final String platformAsString()

      The operating system 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 operating system platform of the component.
      See Also:

    • 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, Image Builder performs a prefix match 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, Image Builder performs a prefix match against the base image OS version during image recipe creation.

    • state

      public final ComponentState state()

      Describes the current status of the component.

      Returns:
      Describes the current status of the component.

    • 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 the component document 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 the component document 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 Image Builder created the component.

      Returns:
      The date that Image Builder created the component.

    • 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 that apply to 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 that apply to the component.

    • publisher

      public final String publisher()

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

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

    • obfuscate

      public final Boolean obfuscate()

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

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

    • hasProductCodes

      public final boolean hasProductCodes()
      For responses, this returns true if the service returned a value for the ProductCodes 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.

    • productCodes

      public final List<ProductCodeListItem> productCodes()

      Contains product codes that are used for billing purposes for Amazon Web Services Marketplace components.

      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 hasProductCodes() method.

      Returns:
      Contains product codes that are used for billing purposes for Amazon Web Services Marketplace components.

    • 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 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)
      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 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.