@Generated(value="software.amazon.awssdk:codegen") public final class FieldTypeDetails extends Object implements SdkPojo, Serializable, ToCopyableBuilder<FieldTypeDetails.Builder,FieldTypeDetails>
Contains details regarding the supported field type and the operators that can be applied for filtering.
| Modifier and Type | Class and Description |
|---|---|
static interface |
FieldTypeDetails.Builder |
| Modifier and Type | Method and Description |
|---|---|
static FieldTypeDetails.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
Range |
fieldLengthRange()
This is the allowable length range for this field's value.
|
String |
fieldType()
The type of field, such as string, integer, date, and so on.
|
Range |
fieldValueRange()
The range of values this field can hold.
|
List<Operator> |
filterOperators()
The list of operators supported by a field.
|
List<String> |
filterOperatorsAsStrings()
The list of operators supported by a field.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasFilterOperators()
For responses, this returns true if the service returned a value for the FilterOperators property.
|
int |
hashCode() |
boolean |
hasSupportedValues()
For responses, this returns true if the service returned a value for the SupportedValues property.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends FieldTypeDetails.Builder> |
serializableBuilderClass() |
String |
supportedDateFormat()
The date format that the field supports.
|
List<String> |
supportedValues()
The list of values that a field can contain.
|
FieldTypeDetails.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
String |
valueRegexPattern()
The regular expression pattern for the field name.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String fieldType()
The type of field, such as string, integer, date, and so on.
public final List<Operator> filterOperators()
The list of operators supported by a field.
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 hasFilterOperators() method.
public final boolean hasFilterOperators()
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.public final List<String> filterOperatorsAsStrings()
The list of operators supported by a field.
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 hasFilterOperators() method.
public final boolean hasSupportedValues()
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.public final List<String> supportedValues()
The list of values that a field can contain. For example, a Boolean fieldType can have two values:
"true" and "false".
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 hasSupportedValues() method.
fieldType can have two
values: "true" and "false".public final String valueRegexPattern()
The regular expression pattern for the field name.
public final String supportedDateFormat()
The date format that the field supports.
public final Range fieldValueRange()
The range of values this field can hold.
public final Range fieldLengthRange()
This is the allowable length range for this field's value.
public FieldTypeDetails.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<FieldTypeDetails.Builder,FieldTypeDetails>public static FieldTypeDetails.Builder builder()
public static Class<? extends FieldTypeDetails.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
Copyright © 2022. All rights reserved.