Class ContainerRecipeSummary

java.lang.Object
software.amazon.awssdk.services.imagebuilder.model.ContainerRecipeSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ContainerRecipeSummary.Builder,ContainerRecipeSummary>
@Generated("software.amazon.awssdk:codegen") public final class ContainerRecipeSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ContainerRecipeSummary.Builder,ContainerRecipeSummary>

A summary of a container recipe

See Also:

  • Method Details

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the container recipe.

      Returns:
      The Amazon Resource Name (ARN) of the container recipe.

    • containerType

      public final ContainerType containerType()

      Specifies the type of container, such as "Docker".

      If the service returns an enum value that is not available in the current SDK version, containerType will return ContainerType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from containerTypeAsString().

      Returns:
      Specifies the type of container, such as "Docker".
      See Also:

    • containerTypeAsString

      public final String containerTypeAsString()

      Specifies the type of container, such as "Docker".

      If the service returns an enum value that is not available in the current SDK version, containerType will return ContainerType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from containerTypeAsString().

      Returns:
      Specifies the type of container, such as "Docker".
      See Also:

    • name

      public final String name()

      The name of the container recipe.

      Returns:
      The name of the container recipe.

    • platform

      public final Platform platform()

      The system platform for the container, such as Windows or Linux.

      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 system platform for the container, such as Windows or Linux.
      See Also:

    • platformAsString

      public final String platformAsString()

      The system platform for the container, such as Windows or Linux.

      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 system platform for the container, such as Windows or Linux.
      See Also:

    • owner

      public final String owner()

      The owner of the container recipe.

      Returns:
      The owner of the container recipe.

    • parentImage

      public final String parentImage()

      The base image for the container recipe.

      Returns:
      The base image for the container recipe.

    • dateCreated

      public final String dateCreated()

      The date when this container recipe was created.

      Returns:
      The date when this container recipe was created.

    • instanceImage

      public final String instanceImage()

      The base image for a container build and test instance. This can contain an AMI ID or it can specify an Amazon Web Services Systems Manager (SSM) Parameter Store Parameter, prefixed by ssm:, followed by the parameter name or ARN.

      If not specified, Image Builder uses the appropriate ECS-optimized AMI as a base image.

      Returns:
      The base image for a container build and test instance. This can contain an AMI ID or it can specify an Amazon Web Services Systems Manager (SSM) Parameter Store Parameter, prefixed by ssm:, followed by the parameter name or ARN.

      If not specified, Image Builder uses the appropriate ECS-optimized AMI as a base image.

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

      Tags that are attached to the container recipe.

      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:
      Tags that are attached to the container recipe.

    • toBuilder

      public ContainerRecipeSummary.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<ContainerRecipeSummary.Builder,ContainerRecipeSummary>
      Returns:
      a builder for type T

    • builder

      public static ContainerRecipeSummary.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ContainerRecipeSummary.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.