Class JobParameter

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

The details of job parameters.

See Also:

  • Method Details

    • intValue

      public final String intValue()

      A signed integer represented as a string.

      Returns:
      A signed integer represented as a string.

    • floatValue

      public final String floatValue()

      A double precision IEEE-754 floating point number represented as a string.

      Returns:
      A double precision IEEE-754 floating point number represented as a string.

    • string

      public final String string()

      A UTF-8 string.

      Returns:
      A UTF-8 string.

    • path

      public final String path()

      A file system path represented as a string.

      Returns:
      A file system path represented as a string.

    • bool

      public final String bool()

      A boolean value represented as a string. Accepted values are true, false, yes, no, on, off, 1, and 0, case-insensitive.

      Returns:
      A boolean value represented as a string. Accepted values are true, false, yes, no, on, off, 1, and 0, case-insensitive.

    • rangeExpr

      public final String rangeExpr()

      An Open Job Description range expression represented as a string, such as 1-10:2.

      Returns:
      An Open Job Description range expression represented as a string, such as 1-10:2.

    • hasStringList

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

    • stringList

      public final List<String> stringList()

      A list of UTF-8 strings.

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

      Returns:
      A list of UTF-8 strings.

    • hasPathList

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

    • pathList

      public final List<String> pathList()

      A list of file system paths, each represented as a string.

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

      Returns:
      A list of file system paths, each represented as a string.

    • hasIntList

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

    • intList

      public final List<String> intList()

      A list of signed integers, each represented as a string.

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

      Returns:
      A list of signed integers, each represented as a string.

    • hasFloatList

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

    • floatList

      public final List<String> floatList()

      A list of double precision IEEE-754 floating point numbers, each represented as a string.

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

      Returns:
      A list of double precision IEEE-754 floating point numbers, each represented as a string.

    • hasBoolList

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

    • boolList

      public final List<String> boolList()

      A list of boolean values, each represented as a string.

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

      Returns:
      A list of boolean values, each represented as a string.

    • hasIntListList

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

    • intListList

      public final List<List<String>> intListList()

      A list of lists of signed integers, each represented as a string.

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

      Returns:
      A list of lists of signed integers, each represented as a string.

    • toBuilder

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

    • builder

      public static JobParameter.Builder builder()

    • serializableBuilderClass

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

    • fromIntValue

      public static JobParameter fromIntValue(String intValue)
      Create an instance of this class with intValue() initialized to the given value.

      A signed integer represented as a string.

      Parameters:
      intValue - A signed integer represented as a string.

    • fromFloatValue

      public static JobParameter fromFloatValue(String floatValue)
      Create an instance of this class with floatValue() initialized to the given value.

      A double precision IEEE-754 floating point number represented as a string.

      Parameters:
      floatValue - A double precision IEEE-754 floating point number represented as a string.

    • fromString

      public static JobParameter fromString(String string)
      Create an instance of this class with string() initialized to the given value.

      A UTF-8 string.

      Parameters:
      string - A UTF-8 string.

    • fromPath

      public static JobParameter fromPath(String path)
      Create an instance of this class with path() initialized to the given value.

      A file system path represented as a string.

      Parameters:
      path - A file system path represented as a string.

    • fromBool

      public static JobParameter fromBool(String bool)
      Create an instance of this class with bool() initialized to the given value.

      A boolean value represented as a string. Accepted values are true, false, yes, no, on, off, 1, and 0, case-insensitive.

      Parameters:
      bool - A boolean value represented as a string. Accepted values are true, false, yes, no, on, off, 1, and 0, case-insensitive.

    • fromRangeExpr

      public static JobParameter fromRangeExpr(String rangeExpr)
      Create an instance of this class with rangeExpr() initialized to the given value.

      An Open Job Description range expression represented as a string, such as 1-10:2.

      Parameters:
      rangeExpr - An Open Job Description range expression represented as a string, such as 1-10:2.

    • fromStringList

      public static JobParameter fromStringList(List<String> stringList)
      Create an instance of this class with stringList() initialized to the given value.

      A list of UTF-8 strings.

      Parameters:
      stringList - A list of UTF-8 strings.

    • fromPathList

      public static JobParameter fromPathList(List<String> pathList)
      Create an instance of this class with pathList() initialized to the given value.

      A list of file system paths, each represented as a string.

      Parameters:
      pathList - A list of file system paths, each represented as a string.

    • fromIntList

      public static JobParameter fromIntList(List<String> intList)
      Create an instance of this class with intList() initialized to the given value.

      A list of signed integers, each represented as a string.

      Parameters:
      intList - A list of signed integers, each represented as a string.

    • fromFloatList

      public static JobParameter fromFloatList(List<String> floatList)
      Create an instance of this class with floatList() initialized to the given value.

      A list of double precision IEEE-754 floating point numbers, each represented as a string.

      Parameters:
      floatList - A list of double precision IEEE-754 floating point numbers, each represented as a string.

    • fromBoolList

      public static JobParameter fromBoolList(List<String> boolList)
      Create an instance of this class with boolList() initialized to the given value.

      A list of boolean values, each represented as a string.

      Parameters:
      boolList - A list of boolean values, each represented as a string.

    • fromIntListList

      public static JobParameter fromIntListList(List<List<String>> intListList)
      Create an instance of this class with intListList() initialized to the given value.

      A list of lists of signed integers, each represented as a string.

      Parameters:
      intListList - A list of lists of signed integers, each represented as a string.

    • type

      public JobParameter.Type type()
      Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be JobParameter.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be JobParameter.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

    • 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.