Class Facet

java.lang.Object
software.amazon.awssdk.services.clouddirectory.model.Facet
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Facet.Builder,Facet>
@Generated("software.amazon.awssdk:codegen") public final class Facet extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Facet.Builder,Facet>

A structure that contains Name, ARN, Attributes, Rules, and ObjectTypes. See Facets for more information.

See Also:

  • Method Details

    • name

      public final String name()

      The name of the Facet.

      Returns:
      The name of the Facet.

    • objectType

      public final ObjectType objectType()

      The object type that is associated with the facet. See CreateFacetRequest$ObjectType for more details.

      If the service returns an enum value that is not available in the current SDK version, objectType will return ObjectType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from objectTypeAsString().

      Returns:
      The object type that is associated with the facet. See CreateFacetRequest$ObjectType for more details.
      See Also:

    • objectTypeAsString

      public final String objectTypeAsString()

      The object type that is associated with the facet. See CreateFacetRequest$ObjectType for more details.

      If the service returns an enum value that is not available in the current SDK version, objectType will return ObjectType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from objectTypeAsString().

      Returns:
      The object type that is associated with the facet. See CreateFacetRequest$ObjectType for more details.
      See Also:

    • facetStyle

      public final FacetStyle facetStyle()

      There are two different styles that you can define on any given facet, Static and Dynamic. For static facets, all attributes must be defined in the schema. For dynamic facets, attributes can be defined during data plane operations.

      If the service returns an enum value that is not available in the current SDK version, facetStyle will return FacetStyle.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from facetStyleAsString().

      Returns:
      There are two different styles that you can define on any given facet, Static and Dynamic. For static facets, all attributes must be defined in the schema. For dynamic facets, attributes can be defined during data plane operations.
      See Also:

    • facetStyleAsString

      public final String facetStyleAsString()

      There are two different styles that you can define on any given facet, Static and Dynamic. For static facets, all attributes must be defined in the schema. For dynamic facets, attributes can be defined during data plane operations.

      If the service returns an enum value that is not available in the current SDK version, facetStyle will return FacetStyle.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from facetStyleAsString().

      Returns:
      There are two different styles that you can define on any given facet, Static and Dynamic. For static facets, all attributes must be defined in the schema. For dynamic facets, attributes can be defined during data plane operations.
      See Also:

    • toBuilder

      public Facet.Builder 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 interface ToCopyableBuilder<Facet.Builder,Facet>
      Returns:
      a builder for type T

    • builder

      public static Facet.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Facet.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.