Class FieldTypeDetails
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<FieldTypeDetails.Builder,
FieldTypeDetails>
Contains details regarding the supported field type and the operators that can be applied for filtering.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic FieldTypeDetails.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Range
This is the allowable length range for this field's value.final String
The type of field, such as string, integer, date, and so on.final Range
The range of values this field can hold.The list of operators supported by a field.The list of operators supported by a field.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the FilterOperators property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the SupportedValues property.static Class
<? extends FieldTypeDetails.Builder> final String
The date format that the field supports.The list of values that a field can contain.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
The regular expression pattern for the field name.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
fieldType
The type of field, such as string, integer, date, and so on.
- Returns:
- The type of field, such as string, integer, date, and so on.
-
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.- Returns:
- The list of operators supported by a field.
-
hasFilterOperators
public final boolean hasFilterOperators()For responses, this returns true if the service returned a value for the FilterOperators property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
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.- Returns:
- The list of operators supported by a field.
-
hasSupportedValues
public final boolean hasSupportedValues()For responses, this returns true if the service returned a value for the SupportedValues property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
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.- Returns:
- The list of values that a field can contain. For example, a Boolean
fieldType
can have two values: "true" and "false".
-
valueRegexPattern
The regular expression pattern for the field name.
- Returns:
- The regular expression pattern for the field name.
-
supportedDateFormat
The date format that the field supports.
- Returns:
- The date format that the field supports.
-
fieldValueRange
The range of values this field can hold.
- Returns:
- The range of values this field can hold.
-
fieldLengthRange
This is the allowable length range for this field's value.
- Returns:
- This is the allowable length range for this field's value.
-
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 interfaceToCopyableBuilder<FieldTypeDetails.Builder,
FieldTypeDetails> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-