Class Mapping

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

A structure that contains the details of a mapping relationship, which can be either to a framework or to a common control.

See Also:

  • Method Details

    • framework

      public final FrameworkMappingDetails framework()

      The framework mapping details when the mapping type relates to a compliance framework.

      Returns:
      The framework mapping details when the mapping type relates to a compliance framework.

    • commonControl

      public final CommonControlMappingDetails commonControl()

      The common control mapping details when the mapping type relates to a common control.

      Returns:
      The common control mapping details when the mapping type relates to a common control.

    • relatedControl

      public final RelatedControlMappingDetails relatedControl()

      Returns information about controls that are related to the specified control.

      Returns:
      Returns information about controls that are related to the specified control.

    • toBuilder

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

    • builder

      public static Mapping.Builder builder()

    • serializableBuilderClass

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

    • fromFramework

      public static Mapping fromFramework(FrameworkMappingDetails framework)
      Create an instance of this class with framework() initialized to the given value.

      The framework mapping details when the mapping type relates to a compliance framework.

      Parameters:
      framework - The framework mapping details when the mapping type relates to a compliance framework.

    • fromFramework

      public static Mapping fromFramework(Consumer<FrameworkMappingDetails.Builder> framework)
      Create an instance of this class with framework() initialized to the given value.

      The framework mapping details when the mapping type relates to a compliance framework.

      Parameters:
      framework - The framework mapping details when the mapping type relates to a compliance framework.

    • fromCommonControl

      public static Mapping fromCommonControl(CommonControlMappingDetails commonControl)
      Create an instance of this class with commonControl() initialized to the given value.

      The common control mapping details when the mapping type relates to a common control.

      Parameters:
      commonControl - The common control mapping details when the mapping type relates to a common control.

    • fromCommonControl

      public static Mapping fromCommonControl(Consumer<CommonControlMappingDetails.Builder> commonControl)
      Create an instance of this class with commonControl() initialized to the given value.

      The common control mapping details when the mapping type relates to a common control.

      Parameters:
      commonControl - The common control mapping details when the mapping type relates to a common control.

    • fromRelatedControl

      public static Mapping fromRelatedControl(RelatedControlMappingDetails relatedControl)
      Create an instance of this class with relatedControl() initialized to the given value.

      Returns information about controls that are related to the specified control.

      Parameters:
      relatedControl - Returns information about controls that are related to the specified control.

    • fromRelatedControl

      public static Mapping fromRelatedControl(Consumer<RelatedControlMappingDetails.Builder> relatedControl)
      Create an instance of this class with relatedControl() initialized to the given value.

      Returns information about controls that are related to the specified control.

      Parameters:
      relatedControl - Returns information about controls that are related to the specified control.

    • type

      public Mapping.Type type()
      Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be Mapping.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be Mapping.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

    • 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.