Class MachineImage

java.lang.Object
co.yellowdog.platform.model.MachineImage
All Implemented Interfaces:
Identified, Named, Serializable
public class MachineImage extends Object implements Identified, Named, Serializable
Describes a machine software image, its capabilities and where it is available.
See Also:

  • Constructor Details

  • Method Details

    • builder

      public static MachineImage.Builder builder()

    • toBuilder

      public MachineImage.Builder toBuilder()

    • getId

      public String getId()
      Description copied from interface: Identified
      Returns the ID
      Specified by:
      getId in interface Identified
      Returns:
      the ID

    • getName

      public String getName()
      The machine image name
      Specified by:
      getName in interface Named
      Returns:
      the machine image name

    • getCreatedTime

      public Instant getCreatedTime()
      The date and time when this machine image record was first created. NB: This may not be indicative of the time the actual image was created.
      Returns:
      the date and time when this machine image record was first created

    • getProvider

      public CloudProvider getProvider()
      The compute provider in whose system the image is registered.
      Returns:
      the compute provider in whose system the image is registered

    • getRegions

      public List<@NotBlank String> getRegions()
      The regions in which the image is registered. If null or empty then the image is assumed to be available in all regions.
      Returns:
      the regions in which the image is registered

    • getProviderImageId

      public String getProviderImageId()
      The ID for the image in the compute provider's system.
      Returns:
      the ID for the image in the compute provider's system

    • getOsType

      public ImageOsType getOsType()
      The image operating system type
      Returns:
      the image operating system type

    • getSupportedInstanceTypes

      public List<@NotBlank String> getSupportedInstanceTypes()
      The instance types that can be used with the image in the cloud provider's system. If null or empty then the image is assumed to compatible with any instance type.
      Returns:
      the instance types that can be used with the image

    • getMetadata

      public Map<@MapKey String,String> getMetadata()
      A map of user-definable key-value pairs to hold extra metadata properties related to the machine image.
      Returns:
      a map of user-definable metadata properties

    • setId

      public void setId(String id)

    • setName

      public void setName(String name)
      The machine image name
      Parameters:
      name - the machine image name

    • setCreatedTime

      public void setCreatedTime(Instant createdTime)
      The date and time when this machine image record was first created. NB: This may not be indicative of the time the actual image was created.
      Parameters:
      createdTime - This should not be set outside of the YellowDog Images service.

    • setProvider

      public void setProvider(CloudProvider provider)
      The compute provider in whose system the image is registered.
      Parameters:
      provider - the compute provider in whose system the image is registered

    • setRegions

      public void setRegions(List<@NotBlank String> regions)
      The regions in which the image is registered. If null or empty then the image is assumed to be available in all regions.
      Parameters:
      regions - the region in which the image is registered

    • setProviderImageId

      public void setProviderImageId(String providerImageId)
      The ID for the image in the compute provider's system.
      Parameters:
      providerImageId - the ID for the image in the compute provider's system

    • setOsType

      public void setOsType(ImageOsType osType)
      The image operating system type
      Parameters:
      osType - the image operating system type

    • setSupportedInstanceTypes

      public void setSupportedInstanceTypes(List<@NotBlank String> supportedInstanceTypes)
      The instance types that can be used with the image in the cloud provider's system. If null or empty then the image is assumed to compatible with any instance type.
      Parameters:
      supportedInstanceTypes - the instance types that can be used with the image

    • setMetadata

      public void setMetadata(Map<@MapKey String,String> metadata)
      A map of user-definable key-value pairs to hold extra metadata properties related to the machine image.
      Parameters:
      metadata - a map of user-definable metadata properties

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object