@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class FieldTypeDetails extends Object implements Serializable, Cloneable, StructuredPojo
Contains details regarding the supported field type and the operators that can be applied for filtering.
Constructor and Description |
---|
FieldTypeDetails() |
Modifier and Type | Method and Description |
---|---|
FieldTypeDetails |
clone() |
boolean |
equals(Object obj) |
Range |
getFieldLengthRange()
This is the allowable length range for this field's value.
|
String |
getFieldType()
The type of field, such as string, integer, date, and so on.
|
Range |
getFieldValueRange()
The range of values this field can hold.
|
List<String> |
getFilterOperators()
The list of operators supported by a field.
|
String |
getSupportedDateFormat()
The date format that the field supports.
|
List<String> |
getSupportedValues()
The list of values that a field can contain.
|
String |
getValueRegexPattern()
The regular expression pattern for the field name.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setFieldLengthRange(Range fieldLengthRange)
This is the allowable length range for this field's value.
|
void |
setFieldType(String fieldType)
The type of field, such as string, integer, date, and so on.
|
void |
setFieldValueRange(Range fieldValueRange)
The range of values this field can hold.
|
void |
setFilterOperators(Collection<String> filterOperators)
The list of operators supported by a field.
|
void |
setSupportedDateFormat(String supportedDateFormat)
The date format that the field supports.
|
void |
setSupportedValues(Collection<String> supportedValues)
The list of values that a field can contain.
|
void |
setValueRegexPattern(String valueRegexPattern)
The regular expression pattern for the field name.
|
String |
toString()
Returns a string representation of this object.
|
FieldTypeDetails |
withFieldLengthRange(Range fieldLengthRange)
This is the allowable length range for this field's value.
|
FieldTypeDetails |
withFieldType(String fieldType)
The type of field, such as string, integer, date, and so on.
|
FieldTypeDetails |
withFieldValueRange(Range fieldValueRange)
The range of values this field can hold.
|
FieldTypeDetails |
withFilterOperators(Collection<String> filterOperators)
The list of operators supported by a field.
|
FieldTypeDetails |
withFilterOperators(Operator... filterOperators)
The list of operators supported by a field.
|
FieldTypeDetails |
withFilterOperators(String... filterOperators)
The list of operators supported by a field.
|
FieldTypeDetails |
withSupportedDateFormat(String supportedDateFormat)
The date format that the field supports.
|
FieldTypeDetails |
withSupportedValues(Collection<String> supportedValues)
The list of values that a field can contain.
|
FieldTypeDetails |
withSupportedValues(String... supportedValues)
The list of values that a field can contain.
|
FieldTypeDetails |
withValueRegexPattern(String valueRegexPattern)
The regular expression pattern for the field name.
|
public void setFieldType(String fieldType)
The type of field, such as string, integer, date, and so on.
fieldType
- The type of field, such as string, integer, date, and so on.public String getFieldType()
The type of field, such as string, integer, date, and so on.
public FieldTypeDetails withFieldType(String fieldType)
The type of field, such as string, integer, date, and so on.
fieldType
- The type of field, such as string, integer, date, and so on.public List<String> getFilterOperators()
The list of operators supported by a field.
Operator
public void setFilterOperators(Collection<String> filterOperators)
The list of operators supported by a field.
filterOperators
- The list of operators supported by a field.Operator
public FieldTypeDetails withFilterOperators(String... filterOperators)
The list of operators supported by a field.
NOTE: This method appends the values to the existing list (if any). Use
setFilterOperators(java.util.Collection)
or withFilterOperators(java.util.Collection)
if you
want to override the existing values.
filterOperators
- The list of operators supported by a field.Operator
public FieldTypeDetails withFilterOperators(Collection<String> filterOperators)
The list of operators supported by a field.
filterOperators
- The list of operators supported by a field.Operator
public FieldTypeDetails withFilterOperators(Operator... filterOperators)
The list of operators supported by a field.
filterOperators
- The list of operators supported by a field.Operator
public List<String> getSupportedValues()
The list of values that a field can contain. For example, a Boolean fieldType
can have two values:
"true" and "false".
fieldType
can have two
values: "true" and "false".public void setSupportedValues(Collection<String> supportedValues)
The list of values that a field can contain. For example, a Boolean fieldType
can have two values:
"true" and "false".
supportedValues
- The list of values that a field can contain. For example, a Boolean fieldType
can have two
values: "true" and "false".public FieldTypeDetails withSupportedValues(String... supportedValues)
The list of values that a field can contain. For example, a Boolean fieldType
can have two values:
"true" and "false".
NOTE: This method appends the values to the existing list (if any). Use
setSupportedValues(java.util.Collection)
or withSupportedValues(java.util.Collection)
if you
want to override the existing values.
supportedValues
- The list of values that a field can contain. For example, a Boolean fieldType
can have two
values: "true" and "false".public FieldTypeDetails withSupportedValues(Collection<String> supportedValues)
The list of values that a field can contain. For example, a Boolean fieldType
can have two values:
"true" and "false".
supportedValues
- The list of values that a field can contain. For example, a Boolean fieldType
can have two
values: "true" and "false".public void setValueRegexPattern(String valueRegexPattern)
The regular expression pattern for the field name.
valueRegexPattern
- The regular expression pattern for the field name.public String getValueRegexPattern()
The regular expression pattern for the field name.
public FieldTypeDetails withValueRegexPattern(String valueRegexPattern)
The regular expression pattern for the field name.
valueRegexPattern
- The regular expression pattern for the field name.public void setSupportedDateFormat(String supportedDateFormat)
The date format that the field supports.
supportedDateFormat
- The date format that the field supports.public String getSupportedDateFormat()
The date format that the field supports.
public FieldTypeDetails withSupportedDateFormat(String supportedDateFormat)
The date format that the field supports.
supportedDateFormat
- The date format that the field supports.public void setFieldValueRange(Range fieldValueRange)
The range of values this field can hold.
fieldValueRange
- The range of values this field can hold.public Range getFieldValueRange()
The range of values this field can hold.
public FieldTypeDetails withFieldValueRange(Range fieldValueRange)
The range of values this field can hold.
fieldValueRange
- The range of values this field can hold.public void setFieldLengthRange(Range fieldLengthRange)
This is the allowable length range for this field's value.
fieldLengthRange
- This is the allowable length range for this field's value.public Range getFieldLengthRange()
This is the allowable length range for this field's value.
public FieldTypeDetails withFieldLengthRange(Range fieldLengthRange)
This is the allowable length range for this field's value.
fieldLengthRange
- This is the allowable length range for this field's value.public String toString()
toString
in class Object
Object.toString()
public FieldTypeDetails clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.