Class LayoutPreview

java.lang.Object
software.amazon.awssdk.services.partnercentralmarketing.model.LayoutPreview
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<LayoutPreview.Builder,LayoutPreview>

@Generated("software.amazon.awssdk:codegen") public final class LayoutPreview extends Object implements SdkPojo, Serializable, ToCopyableBuilder<LayoutPreview.Builder,LayoutPreview>

A rendering of an AWS-authored layout skeleton or placeholder image.

The url is a stable, cache-friendly CloudFront URL rather than a presigned GET, because the bytes are AWS marketing content that is already public. The key's random segment is the object's only protection, so the URL is a bearer credential for the object and is withheld entirely while a template is not yet effective — see CampaignTemplate.EffectiveDateBegin.

See Also:
  • Method Details

    • format

      public final LayoutFormat format()

      The format of the referenced object.

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

      Returns:
      The format of the referenced object.
      See Also:
    • formatAsString

      public final String formatAsString()

      The format of the referenced object.

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

      Returns:
      The format of the referenced object.
      See Also:
    • url

      public final String url()

      A stable URL serving the object. Not presigned, so it does not expire.

      Returns:
      A stable URL serving the object. Not presigned, so it does not expire.
    • pageType

      public final LayoutPageType pageType()

      Which page of a multi-page layout this is. Present only for LANDING_PAGE, which genuinely has two layout objects — the page carrying the form, and the confirmation page shown after submit — and absent for every other category, which has one.

      A confirmation page is a second LAYOUT, never a second asset: modelling it as its own asset would give it a lifecycle, an activation and a state it does not have.

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

      Returns:
      Which page of a multi-page layout this is. Present only for LANDING_PAGE, which genuinely has two layout objects — the page carrying the form, and the confirmation page shown after submit — and absent for every other category, which has one.

      A confirmation page is a second LAYOUT, never a second asset: modelling it as its own asset would give it a lifecycle, an activation and a state it does not have.

      See Also:
    • pageTypeAsString

      public final String pageTypeAsString()

      Which page of a multi-page layout this is. Present only for LANDING_PAGE, which genuinely has two layout objects — the page carrying the form, and the confirmation page shown after submit — and absent for every other category, which has one.

      A confirmation page is a second LAYOUT, never a second asset: modelling it as its own asset would give it a lifecycle, an activation and a state it does not have.

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

      Returns:
      Which page of a multi-page layout this is. Present only for LANDING_PAGE, which genuinely has two layout objects — the page carrying the form, and the confirmation page shown after submit — and absent for every other category, which has one.

      A confirmation page is a second LAYOUT, never a second asset: modelling it as its own asset would give it a lifecycle, an activation and a state it does not have.

      See Also:
    • toBuilder

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

      public static LayoutPreview.Builder builder()
    • serializableBuilderClass

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