Class MicrovmHooks

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

Configuration for lifecycle hooks invoked during MicroVM events such as run, resume, suspend, and terminate.

See Also:

  • Method Details

    • run

      public final HookState run()

      The path of the hook invoked when the MicroVM starts running.

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

      Returns:
      The path of the hook invoked when the MicroVM starts running.
      See Also:

    • runAsString

      public final String runAsString()

      The path of the hook invoked when the MicroVM starts running.

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

      Returns:
      The path of the hook invoked when the MicroVM starts running.
      See Also:

    • runTimeoutInSeconds

      public final Integer runTimeoutInSeconds()

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

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

    • resume

      public final HookState resume()

      The path of the hook invoked when the MicroVM resumes from a suspended state.

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

      Returns:
      The path of the hook invoked when the MicroVM resumes from a suspended state.
      See Also:

    • resumeAsString

      public final String resumeAsString()

      The path of the hook invoked when the MicroVM resumes from a suspended state.

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

      Returns:
      The path of the hook invoked when the MicroVM resumes from a suspended state.
      See Also:

    • resumeTimeoutInSeconds

      public final Integer resumeTimeoutInSeconds()

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

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

    • suspend

      public final HookState suspend()

      The path of the hook invoked when the MicroVM is suspended.

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

      Returns:
      The path of the hook invoked when the MicroVM is suspended.
      See Also:

    • suspendAsString

      public final String suspendAsString()

      The path of the hook invoked when the MicroVM is suspended.

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

      Returns:
      The path of the hook invoked when the MicroVM is suspended.
      See Also:

    • suspendTimeoutInSeconds

      public final Integer suspendTimeoutInSeconds()

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

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

    • terminate

      public final HookState terminate()

      The path of the hook invoked when the MicroVM is terminated.

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

      Returns:
      The path of the hook invoked when the MicroVM is terminated.
      See Also:

    • terminateAsString

      public final String terminateAsString()

      The path of the hook invoked when the MicroVM is terminated.

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

      Returns:
      The path of the hook invoked when the MicroVM is terminated.
      See Also:

    • terminateTimeoutInSeconds

      public final Integer terminateTimeoutInSeconds()

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

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

    • toBuilder

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

    • builder

      public static MicrovmHooks.Builder builder()

    • serializableBuilderClass

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