Class MicrovmImageHooks

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

Configuration for hooks invoked during MicroVM image build events such as ready and validate.

See Also:

  • Method Details

    • ready

      public final HookState ready()

      The path of the hook invoked when the MicroVM image build is ready.

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

      Returns:
      The path of the hook invoked when the MicroVM image build is ready.
      See Also:

    • readyAsString

      public final String readyAsString()

      The path of the hook invoked when the MicroVM image build is ready.

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

      Returns:
      The path of the hook invoked when the MicroVM image build is ready.
      See Also:

    • readyTimeoutInSeconds

      public final Integer readyTimeoutInSeconds()

      The maximum time in seconds for the ready hook to complete.

      Returns:
      The maximum time in seconds for the ready hook to complete.

    • validate

      public final HookState validate()

      The path of the hook invoked to validate the MicroVM image build.

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

      Returns:
      The path of the hook invoked to validate the MicroVM image build.
      See Also:

    • validateAsString

      public final String validateAsString()

      The path of the hook invoked to validate the MicroVM image build.

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

      Returns:
      The path of the hook invoked to validate the MicroVM image build.
      See Also:

    • validateTimeoutInSeconds

      public final Integer validateTimeoutInSeconds()

      The maximum time in seconds for the validate hook to complete.

      Returns:
      The maximum time in seconds for the validate hook to complete.

    • toBuilder

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

    • builder

      public static MicrovmImageHooks.Builder builder()

    • serializableBuilderClass

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