Class LayoutPreview
- All Implemented Interfaces:
Serializable,SdkPojo,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:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionstatic LayoutPreview.Builderbuilder()final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final LayoutFormatformat()The format of the referenced object.final StringThe format of the referenced object.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) final inthashCode()final LayoutPageTypepageType()Which page of a multi-page layout this is.final StringWhich page of a multi-page layout this is.static Class<? extends LayoutPreview.Builder> Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.final Stringurl()A stable URL serving the object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
format
The format of the referenced object.
If the service returns an enum value that is not available in the current SDK version,
formatwill returnLayoutFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromformatAsString().- Returns:
- The format of the referenced object.
- See Also:
-
formatAsString
The format of the referenced object.
If the service returns an enum value that is not available in the current SDK version,
formatwill returnLayoutFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromformatAsString().- Returns:
- The format of the referenced object.
- See Also:
-
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
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,
pageTypewill returnLayoutPageType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frompageTypeAsString().- 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
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,
pageTypewill returnLayoutPageType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frompageTypeAsString().- 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
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<LayoutPreview.Builder,LayoutPreview> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin interfaceSdkPojo- Parameters:
obj- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-