Class ParameterConstraints

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

The constraints that the administrator has put on the parameter.

See Also:

  • Method Details

    • hasAllowedValues

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

    • allowedValues

      public final List<String> allowedValues()

      The values that the administrator has allowed for the parameter.

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

      Returns:
      The values that the administrator has allowed for the parameter.

    • allowedPattern

      public final String allowedPattern()

      A regular expression that represents the patterns that allow for String types. The pattern must match the entire parameter value provided.

      Returns:
      A regular expression that represents the patterns that allow for String types. The pattern must match the entire parameter value provided.

    • constraintDescription

      public final String constraintDescription()

      A string that explains a constraint when the constraint is violated. For example, without a constraint description, a parameter that has an allowed pattern of [A-Za-z0-9]+ displays the following error message when the user specifies an invalid value:

      Malformed input-Parameter MyParameter must match pattern [A-Za-z0-9]+

      By adding a constraint description, such as must only contain letters (uppercase and lowercase) and numbers, you can display the following customized error message:

      Malformed input-Parameter MyParameter must only contain uppercase and lowercase letters and numbers.

      Returns:
      A string that explains a constraint when the constraint is violated. For example, without a constraint description, a parameter that has an allowed pattern of [A-Za-z0-9]+ displays the following error message when the user specifies an invalid value:

      Malformed input-Parameter MyParameter must match pattern [A-Za-z0-9]+

      By adding a constraint description, such as must only contain letters (uppercase and lowercase) and numbers, you can display the following customized error message:

      Malformed input-Parameter MyParameter must only contain uppercase and lowercase letters and numbers.

    • maxLength

      public final String maxLength()

      An integer value that determines the largest number of characters you want to allow for String types.

      Returns:
      An integer value that determines the largest number of characters you want to allow for String types.

    • minLength

      public final String minLength()

      An integer value that determines the smallest number of characters you want to allow for String types.

      Returns:
      An integer value that determines the smallest number of characters you want to allow for String types.

    • maxValue

      public final String maxValue()

      A numeric value that determines the largest numeric value you want to allow for Number types.

      Returns:
      A numeric value that determines the largest numeric value you want to allow for Number types.

    • minValue

      public final String minValue()

      A numeric value that determines the smallest numeric value you want to allow for Number types.

      Returns:
      A numeric value that determines the smallest numeric value you want to allow for Number types.

    • toBuilder

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

    • builder

      public static ParameterConstraints.Builder builder()

    • serializableBuilderClass

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