Class NodeLifecycleScript

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

A script to run during a compute node lifecycle stage.

See Also:

  • Method Details

    • name

      public final String name()

      A unique name for the script. The name can be up to 64 characters long. Valid characters are letters, numbers, spaces, underscores (_), and hyphens (-). The first character must be a letter or a number.

      Returns:
      A unique name for the script. The name can be up to 64 characters long. Valid characters are letters, numbers, spaces, underscores (_), and hyphens (-). The first character must be a letter or a number.

    • scriptSource

      public final ScriptSource scriptSource()

      The source location and integrity information for the script.

      Returns:
      The source location and integrity information for the script.

    • hasArguments

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

    • arguments

      public final List<String> arguments()

      The command-line arguments to pass to the script. You can specify up to 20 arguments, and each argument can be up to 256 characters long.

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

      Returns:
      The command-line arguments to pass to the script. You can specify up to 20 arguments, and each argument can be up to 256 characters long.

    • onError

      public final OnError onError()

      The behavior when the script fails. The default value is TERMINATE. Valid values:

      • TERMINATE – Terminates the compute node.

      • STOP_SEQUENCE – Stops running subsequent scripts in the sequence but doesn't terminate the compute node.

      • CONTINUE – Ignores the error and continues running the next script.

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

      Returns:
      The behavior when the script fails. The default value is TERMINATE. Valid values:

      • TERMINATE – Terminates the compute node.

      • STOP_SEQUENCE – Stops running subsequent scripts in the sequence but doesn't terminate the compute node.

      • CONTINUE – Ignores the error and continues running the next script.

      See Also:

    • onErrorAsString

      public final String onErrorAsString()

      The behavior when the script fails. The default value is TERMINATE. Valid values:

      • TERMINATE – Terminates the compute node.

      • STOP_SEQUENCE – Stops running subsequent scripts in the sequence but doesn't terminate the compute node.

      • CONTINUE – Ignores the error and continues running the next script.

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

      Returns:
      The behavior when the script fails. The default value is TERMINATE. Valid values:

      • TERMINATE – Terminates the compute node.

      • STOP_SEQUENCE – Stops running subsequent scripts in the sequence but doesn't terminate the compute node.

      • CONTINUE – Ignores the error and continues running the next script.

      See Also:

    • executionPolicy

      public final ExecutionPolicy executionPolicy()

      The policy that determines when the script runs. The default value is FIRST_BOOT_ONLY. Valid values:

      • FIRST_BOOT_ONLY – Runs the script only the first time the compute node boots.

      • EVERY_BOOT – Runs the script every time the compute node boots, including reboots.

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

      Returns:
      The policy that determines when the script runs. The default value is FIRST_BOOT_ONLY. Valid values:

      • FIRST_BOOT_ONLY – Runs the script only the first time the compute node boots.

      • EVERY_BOOT – Runs the script every time the compute node boots, including reboots.

      See Also:

    • executionPolicyAsString

      public final String executionPolicyAsString()

      The policy that determines when the script runs. The default value is FIRST_BOOT_ONLY. Valid values:

      • FIRST_BOOT_ONLY – Runs the script only the first time the compute node boots.

      • EVERY_BOOT – Runs the script every time the compute node boots, including reboots.

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

      Returns:
      The policy that determines when the script runs. The default value is FIRST_BOOT_ONLY. Valid values:

      • FIRST_BOOT_ONLY – Runs the script only the first time the compute node boots.

      • EVERY_BOOT – Runs the script every time the compute node boots, including reboots.

      See Also:

    • toBuilder

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

    • builder

      public static NodeLifecycleScript.Builder builder()

    • serializableBuilderClass

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