Class BrandProfileAttributeInput

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

Specifies an attribute to create for a brand profile.

See Also:

  • Method Details

    • attributeName

      public final String attributeName()

      The name of the brand profile attribute. The name is unique within a brand profile.

      Returns:
      The name of the brand profile attribute. The name is unique within a brand profile.

    • attributeType

      public final BrandProfileAttributeType attributeType()

      The type of the attribute. TEXT stores an inline value. IMAGE and DOCUMENT store binary media that you upload.

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

      Returns:
      The type of the attribute. TEXT stores an inline value. IMAGE and DOCUMENT store binary media that you upload.
      See Also:

    • attributeTypeAsString

      public final String attributeTypeAsString()

      The type of the attribute. TEXT stores an inline value. IMAGE and DOCUMENT store binary media that you upload.

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

      Returns:
      The type of the attribute. TEXT stores an inline value. IMAGE and DOCUMENT store binary media that you upload.
      See Also:

    • attributeValue

      public final String attributeValue()

      The text value for the attribute. This value applies to attributes of type TEXT. For attributes of type IMAGE or DOCUMENT, provide the media through the attachment body instead.

      Returns:
      The text value for the attribute. This value applies to attributes of type TEXT. For attributes of type IMAGE or DOCUMENT, provide the media through the attachment body instead.

    • attachmentBody

      public final SdkBytes attachmentBody()

      The binary content for an attribute of type IMAGE or DOCUMENT. The content is base64-encoded when it is sent over the wire.

      Returns:
      The binary content for an attribute of type IMAGE or DOCUMENT. The content is base64-encoded when it is sent over the wire.

    • description

      public final String description()

      A description of the attribute.

      Returns:
      A description of the attribute.

    • category

      public final String category()

      The category of the attribute.

      Returns:
      The category of the attribute.

    • toBuilder

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

    • builder

      public static BrandProfileAttributeInput.Builder builder()

    • serializableBuilderClass

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