Class MicrovmImageVersionSummary

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

Contains summary information about a version of a MicroVM image.

See Also:

  • Method Details

    • baseImageArn

      public final String baseImageArn()

      The ARN of the base MicroVM image used.

      Returns:
      The ARN of the base MicroVM image used.

    • baseImageVersion

      public final String baseImageVersion()

      The specific version of the base MicroVM image.

      Returns:
      The specific version of the base MicroVM image.

    • buildRoleArn

      public final String buildRoleArn()

      The ARN of the IAM build role.

      Returns:
      The ARN of the IAM build role.

    • description

      public final String description()

      The description of the version.

      Returns:
      The description of the version.

    • codeArtifact

      public final CodeArtifact codeArtifact()

      The code artifact for this version.

      Returns:
      The code artifact for this version.

    • logging

      public final Logging logging()

      The logging configuration for this version.

      Returns:
      The logging configuration for this version.

    • hasEgressNetworkConnectors

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

    • egressNetworkConnectors

      public final List<String> egressNetworkConnectors()

      The list of egress network connectors available to the MicroVM at runtime.

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

      Returns:
      The list of egress network connectors available to the MicroVM at runtime.

    • hasCpuConfigurations

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

    • cpuConfigurations

      public final List<CpuConfiguration> cpuConfigurations()

      The list of supported CPU configurations for the MicroVM.

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

      Returns:
      The list of supported CPU configurations for the MicroVM.

    • hasResources

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

    • resources

      public final List<Resources> resources()

      The resource requirements for the MicroVM.

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

      Returns:
      The resource requirements for the MicroVM.

    • additionalOsCapabilities

      public final List<Capability> additionalOsCapabilities()

      Additional OS capabilities granted to the MicroVM runtime environment.

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

      Returns:
      Additional OS capabilities granted to the MicroVM runtime environment.

    • hasAdditionalOsCapabilities

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

    • additionalOsCapabilitiesAsStrings

      public final List<String> additionalOsCapabilitiesAsStrings()

      Additional OS capabilities granted to the MicroVM runtime environment.

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

      Returns:
      Additional OS capabilities granted to the MicroVM runtime environment.

    • hooks

      public final Hooks hooks()
      Returns the value of the Hooks property for this object.
      Returns:
      The value of the Hooks property for this object.

    • hasEnvironmentVariables

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

    • environmentVariables

      public final Map<String,String> environmentVariables()

      Environment variables set in the MicroVM runtime environment.

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

      Returns:
      Environment variables set in the MicroVM runtime environment.

    • imageArn

      public final String imageArn()

      The ARN of the MicroVM image.

      Returns:
      The ARN of the MicroVM image.

    • imageVersion

      public final String imageVersion()

      The version of the MicroVM image.

      Returns:
      The version of the MicroVM image.

    • state

      public final MicrovmImageVersionState state()

      The current state of the version.

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

      Returns:
      The current state of the version.
      See Also:

    • stateAsString

      public final String stateAsString()

      The current state of the version.

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

      Returns:
      The current state of the version.
      See Also:

    • status

      public final MicrovmImageVersionStatus status()

      The availability status of the version: ACTIVE (can be used by RunMicrovm) or INACTIVE (blocked from launching new MicroVMs).

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

      Returns:
      The availability status of the version: ACTIVE (can be used by RunMicrovm) or INACTIVE (blocked from launching new MicroVMs).
      See Also:

    • statusAsString

      public final String statusAsString()

      The availability status of the version: ACTIVE (can be used by RunMicrovm) or INACTIVE (blocked from launching new MicroVMs).

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

      Returns:
      The availability status of the version: ACTIVE (can be used by RunMicrovm) or INACTIVE (blocked from launching new MicroVMs).
      See Also:

    • createdAt

      public final Instant createdAt()

      The timestamp when the version was created.

      Returns:
      The timestamp when the version was created.

    • updatedAt

      public final Instant updatedAt()

      The timestamp when the version was last updated.

      Returns:
      The timestamp when the version was last updated.

    • stateReason

      public final String stateReason()

      The reason for the current state. For example, one or more builds failed.

      Returns:
      The reason for the current state. For example, one or more builds failed.

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

      Key-value pairs associated with the version.

      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:
      Key-value pairs associated with the version.

    • toBuilder

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

    • builder

      public static MicrovmImageVersionSummary.Builder builder()

    • serializableBuilderClass

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