Class IdNamespaceSummary

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

A summary of ID namespaces.

See Also:

  • Method Details

    • idNamespaceName

      public final String idNamespaceName()

      The name of the ID namespace.

      Returns:
      The name of the ID namespace.

    • idNamespaceArn

      public final String idNamespaceArn()

      The Amazon Resource Name (ARN) of the ID namespace.

      Returns:
      The Amazon Resource Name (ARN) of the ID namespace.

    • description

      public final String description()

      The description of the ID namespace.

      Returns:
      The description of the ID namespace.

    • hasIdMappingWorkflowProperties

      public final boolean hasIdMappingWorkflowProperties()
      For responses, this returns true if the service returned a value for the IdMappingWorkflowProperties property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

    • idMappingWorkflowProperties

      public final List<IdNamespaceIdMappingWorkflowMetadata> idMappingWorkflowProperties()

      An object which defines any additional configurations required by the ID mapping workflow.

      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 hasIdMappingWorkflowProperties() method.

      Returns:
      An object which defines any additional configurations required by the ID mapping workflow.

    • type

      public final IdNamespaceType type()

      The type of ID namespace. There are two types: SOURCE and TARGET.

      The SOURCE contains configurations for sourceId data that will be processed in an ID mapping workflow.

      The TARGET contains a configuration of targetId which all sourceIds will resolve to.

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

      Returns:
      The type of ID namespace. There are two types: SOURCE and TARGET.

      The SOURCE contains configurations for sourceId data that will be processed in an ID mapping workflow.

      The TARGET contains a configuration of targetId which all sourceIds will resolve to.

      See Also:

    • typeAsString

      public final String typeAsString()

      The type of ID namespace. There are two types: SOURCE and TARGET.

      The SOURCE contains configurations for sourceId data that will be processed in an ID mapping workflow.

      The TARGET contains a configuration of targetId which all sourceIds will resolve to.

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

      Returns:
      The type of ID namespace. There are two types: SOURCE and TARGET.

      The SOURCE contains configurations for sourceId data that will be processed in an ID mapping workflow.

      The TARGET contains a configuration of targetId which all sourceIds will resolve to.

      See Also:

    • createdAt

      public final Instant createdAt()

      The timestamp of when the ID namespace was created.

      Returns:
      The timestamp of when the ID namespace was created.

    • updatedAt

      public final Instant updatedAt()

      The timestamp of when the ID namespace was last updated.

      Returns:
      The timestamp of when the ID namespace was last updated.

    • toBuilder

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

    • builder

      public static IdNamespaceSummary.Builder builder()

    • serializableBuilderClass

      public static Class<? extends IdNamespaceSummary.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.