@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class ParameterConstraints extends Object implements Serializable, Cloneable, StructuredPojo
The constraints that the administrator has put on the parameter.
Constructor and Description |
---|
ParameterConstraints() |
Modifier and Type | Method and Description |
---|---|
ParameterConstraints |
clone() |
boolean |
equals(Object obj) |
String |
getAllowedPattern()
A regular expression that represents the patterns that allow for
String types. |
List<String> |
getAllowedValues()
The values that the administrator has allowed for the parameter.
|
String |
getConstraintDescription()
A string that explains a constraint when the constraint is violated.
|
String |
getMaxLength()
An integer value that determines the largest number of characters you want to allow for
String
types. |
String |
getMaxValue()
A numeric value that determines the largest numeric value you want to allow for
Number types. |
String |
getMinLength()
An integer value that determines the smallest number of characters you want to allow for
String
types. |
String |
getMinValue()
A numeric value that determines the smallest numeric value you want to allow for
Number types. |
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setAllowedPattern(String allowedPattern)
A regular expression that represents the patterns that allow for
String types. |
void |
setAllowedValues(Collection<String> allowedValues)
The values that the administrator has allowed for the parameter.
|
void |
setConstraintDescription(String constraintDescription)
A string that explains a constraint when the constraint is violated.
|
void |
setMaxLength(String maxLength)
An integer value that determines the largest number of characters you want to allow for
String
types. |
void |
setMaxValue(String maxValue)
A numeric value that determines the largest numeric value you want to allow for
Number types. |
void |
setMinLength(String minLength)
An integer value that determines the smallest number of characters you want to allow for
String
types. |
void |
setMinValue(String minValue)
A numeric value that determines the smallest numeric value you want to allow for
Number types. |
String |
toString()
Returns a string representation of this object.
|
ParameterConstraints |
withAllowedPattern(String allowedPattern)
A regular expression that represents the patterns that allow for
String types. |
ParameterConstraints |
withAllowedValues(Collection<String> allowedValues)
The values that the administrator has allowed for the parameter.
|
ParameterConstraints |
withAllowedValues(String... allowedValues)
The values that the administrator has allowed for the parameter.
|
ParameterConstraints |
withConstraintDescription(String constraintDescription)
A string that explains a constraint when the constraint is violated.
|
ParameterConstraints |
withMaxLength(String maxLength)
An integer value that determines the largest number of characters you want to allow for
String
types. |
ParameterConstraints |
withMaxValue(String maxValue)
A numeric value that determines the largest numeric value you want to allow for
Number types. |
ParameterConstraints |
withMinLength(String minLength)
An integer value that determines the smallest number of characters you want to allow for
String
types. |
ParameterConstraints |
withMinValue(String minValue)
A numeric value that determines the smallest numeric value you want to allow for
Number types. |
public List<String> getAllowedValues()
The values that the administrator has allowed for the parameter.
public void setAllowedValues(Collection<String> allowedValues)
The values that the administrator has allowed for the parameter.
allowedValues
- The values that the administrator has allowed for the parameter.public ParameterConstraints withAllowedValues(String... allowedValues)
The values that the administrator has allowed for the parameter.
NOTE: This method appends the values to the existing list (if any). Use
setAllowedValues(java.util.Collection)
or withAllowedValues(java.util.Collection)
if you want
to override the existing values.
allowedValues
- The values that the administrator has allowed for the parameter.public ParameterConstraints withAllowedValues(Collection<String> allowedValues)
The values that the administrator has allowed for the parameter.
allowedValues
- The values that the administrator has allowed for the parameter.public void setAllowedPattern(String allowedPattern)
A regular expression that represents the patterns that allow for String
types. The pattern must
match the entire parameter value provided.
allowedPattern
- A regular expression that represents the patterns that allow for String
types. The pattern
must match the entire parameter value provided.public String getAllowedPattern()
A regular expression that represents the patterns that allow for String
types. The pattern must
match the entire parameter value provided.
String
types. The pattern
must match the entire parameter value provided.public ParameterConstraints withAllowedPattern(String allowedPattern)
A regular expression that represents the patterns that allow for String
types. The pattern must
match the entire parameter value provided.
allowedPattern
- A regular expression that represents the patterns that allow for String
types. The pattern
must match the entire parameter value provided.public void setConstraintDescription(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.
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.
public String getConstraintDescription()
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.
[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.
public ParameterConstraints withConstraintDescription(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.
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.
public void setMaxLength(String maxLength)
An integer value that determines the largest number of characters you want to allow for String
types.
maxLength
- An integer value that determines the largest number of characters you want to allow for
String
types.public String getMaxLength()
An integer value that determines the largest number of characters you want to allow for String
types.
String
types.public ParameterConstraints withMaxLength(String maxLength)
An integer value that determines the largest number of characters you want to allow for String
types.
maxLength
- An integer value that determines the largest number of characters you want to allow for
String
types.public void setMinLength(String minLength)
An integer value that determines the smallest number of characters you want to allow for String
types.
minLength
- An integer value that determines the smallest number of characters you want to allow for
String
types.public String getMinLength()
An integer value that determines the smallest number of characters you want to allow for String
types.
String
types.public ParameterConstraints withMinLength(String minLength)
An integer value that determines the smallest number of characters you want to allow for String
types.
minLength
- An integer value that determines the smallest number of characters you want to allow for
String
types.public void setMaxValue(String maxValue)
A numeric value that determines the largest numeric value you want to allow for Number
types.
maxValue
- A numeric value that determines the largest numeric value you want to allow for Number
types.public String getMaxValue()
A numeric value that determines the largest numeric value you want to allow for Number
types.
Number
types.public ParameterConstraints withMaxValue(String maxValue)
A numeric value that determines the largest numeric value you want to allow for Number
types.
maxValue
- A numeric value that determines the largest numeric value you want to allow for Number
types.public void setMinValue(String minValue)
A numeric value that determines the smallest numeric value you want to allow for Number
types.
minValue
- A numeric value that determines the smallest numeric value you want to allow for Number
types.public String getMinValue()
A numeric value that determines the smallest numeric value you want to allow for Number
types.
Number
types.public ParameterConstraints withMinValue(String minValue)
A numeric value that determines the smallest numeric value you want to allow for Number
types.
minValue
- A numeric value that determines the smallest numeric value you want to allow for Number
types.public String toString()
toString
in class Object
Object.toString()
public ParameterConstraints clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.