Class FacetAttributeDefinition
- java.lang.Object
-
- software.amazon.awssdk.services.clouddirectory.model.FacetAttributeDefinition
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<FacetAttributeDefinition.Builder,FacetAttributeDefinition>
@Generated("software.amazon.awssdk:codegen") public final class FacetAttributeDefinition extends Object implements SdkPojo, Serializable, ToCopyableBuilder<FacetAttributeDefinition.Builder,FacetAttributeDefinition>
A facet attribute definition. See Attribute References for more information.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceFacetAttributeDefinition.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static FacetAttributeDefinition.Builderbuilder()TypedAttributeValuedefaultValue()The default value of the attribute (if configured).booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasRules()For responses, this returns true if the service returned a value for the Rules property.BooleanisImmutable()Whether the attribute is mutable or not.Map<String,Rule>rules()Validation rules attached to the attribute definition.List<SdkField<?>>sdkFields()static Class<? extends FacetAttributeDefinition.Builder>serializableBuilderClass()FacetAttributeDefinition.BuildertoBuilder()StringtoString()Returns a string representation of this object.FacetAttributeTypetype()The type of the attribute.StringtypeAsString()The type of the attribute.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
type
public final FacetAttributeType type()
The type of the attribute.
If the service returns an enum value that is not available in the current SDK version,
typewill returnFacetAttributeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtypeAsString().- Returns:
- The type of the attribute.
- See Also:
FacetAttributeType
-
typeAsString
public final String typeAsString()
The type of the attribute.
If the service returns an enum value that is not available in the current SDK version,
typewill returnFacetAttributeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtypeAsString().- Returns:
- The type of the attribute.
- See Also:
FacetAttributeType
-
defaultValue
public final TypedAttributeValue defaultValue()
The default value of the attribute (if configured).
- Returns:
- The default value of the attribute (if configured).
-
isImmutable
public final Boolean isImmutable()
Whether the attribute is mutable or not.
- Returns:
- Whether the attribute is mutable or not.
-
hasRules
public final boolean hasRules()
For responses, this returns true if the service returned a value for the Rules 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.
-
rules
public final Map<String,Rule> rules()
Validation rules attached to the attribute definition.
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
hasRules()method.- Returns:
- Validation rules attached to the attribute definition.
-
toBuilder
public FacetAttributeDefinition.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<FacetAttributeDefinition.Builder,FacetAttributeDefinition>
-
builder
public static FacetAttributeDefinition.Builder builder()
-
serializableBuilderClass
public static Class<? extends FacetAttributeDefinition.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-