Class CampaignAssetTemplateField
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<CampaignAssetTemplateField.Builder,CampaignAssetTemplateField>
One slot in an asset template's layout: addressing key, placement, and the field kind carrying its own constraints, placeholder or default.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionbuilder()final CampaignSettingThe campaign setting this field shows, when it shows one: the partner sets it once on the campaign and every asset displays it.final StringThe campaign setting this field shows, when it shows one: the partner sets it once on the campaign and every asset displays it.final StringWhat belongs in this field, in English: its role in the asset and what good content for it is (for example "Headline that names the customer and leads with a source-backed statistic").final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final StringfieldId()The field identifier; matches a {{fieldId}} slot in the layout.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) final inthashCode()final Stringlabel()Human-readable name for the field, for display.final Integerpage()One-based page number, for paginated layouts (print documents).final PartnerProfileFieldThe partner-profile value this field shows, when it shows one: the partner's AWS Partner Central profile supplies it, and every asset of every campaign displays it.final StringThe partner-profile value this field shows, when it shows one: the partner's AWS Partner Central profile supplies it, and every asset of every campaign displays it.final Booleanrequired()Whether the field must be filled before the asset can be activated.final TemplateFieldSectionsection()Layout section the field belongs to.final StringLayout section the field belongs to.static Class<? extends CampaignAssetTemplateField.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 FieldTypetype()The field kind, with that kind's constraints, placeholder or default.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
fieldId
The field identifier; matches a {{fieldId}} slot in the layout.
- Returns:
- The field identifier; matches a {{fieldId}} slot in the layout.
-
label
Human-readable name for the field, for display. Authored in the template policy, never derived from the field id or the source layout's field name: the id is a slug (
Page_2_Title) and is not meant to be shown to a partner. Absent on fields imported before labels existed.- Returns:
- Human-readable name for the field, for display. Authored in the template policy, never derived from the
field id or the source layout's field name: the id is a slug (
Page_2_Title) and is not meant to be shown to a partner. Absent on fields imported before labels existed.
-
description
What belongs in this field, in English: its role in the asset and what good content for it is (for example "Headline that names the customer and leads with a source-backed statistic"). AWS-authored with the template; never written by a partner. Absent when the template carries none, never empty. Pinned onto the asset with the field, so a corrected description reaches assets created after the correction.
- Returns:
- What belongs in this field, in English: its role in the asset and what good content for it is (for example "Headline that names the customer and leads with a source-backed statistic"). AWS-authored with the template; never written by a partner. Absent when the template carries none, never empty. Pinned onto the asset with the field, so a corrected description reaches assets created after the correction.
-
section
Layout section the field belongs to.
If the service returns an enum value that is not available in the current SDK version,
sectionwill returnTemplateFieldSection.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromsectionAsString().- Returns:
- Layout section the field belongs to.
- See Also:
-
sectionAsString
Layout section the field belongs to.
If the service returns an enum value that is not available in the current SDK version,
sectionwill returnTemplateFieldSection.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromsectionAsString().- Returns:
- Layout section the field belongs to.
- See Also:
-
page
One-based page number, for paginated layouts (print documents).
- Returns:
- One-based page number, for paginated layouts (print documents).
-
required
Whether the field must be filled before the asset can be activated. Derived from DG policy — never inherited from an upstream authoring system.
Required for activation, not for saving:
UpdateCampaignAssetaccepts partial content and may clear a required field. An unfilled required field appears in the asset'sActivationIssuesasREQUIRED_FIELD_MISSING, and activation refuses the asset with the same code.A text field is filled only by a non-blank value, and a rich-text field only by a value with non-blank text; a
Placeholdernever fills one. An image field is filled by the partner's image or by the template'sDefaultValue. A field the campaign fills (CampaignSetting) or the partner's profile fills (PartnerProfileField) is never unfilled on the asset.- Returns:
- Whether the field must be filled before the asset can be activated. Derived from DG policy — never
inherited from an upstream authoring system.
Required for activation, not for saving:
UpdateCampaignAssetaccepts partial content and may clear a required field. An unfilled required field appears in the asset'sActivationIssuesasREQUIRED_FIELD_MISSING, and activation refuses the asset with the same code.A text field is filled only by a non-blank value, and a rich-text field only by a value with non-blank text; a
Placeholdernever fills one. An image field is filled by the partner's image or by the template'sDefaultValue. A field the campaign fills (CampaignSetting) or the partner's profile fills (PartnerProfileField) is never unfilled on the asset.
-
type
The field kind, with that kind's constraints, placeholder or default.
- Returns:
- The field kind, with that kind's constraints, placeholder or default.
-
campaignSetting
The campaign setting this field shows, when it shows one: the partner sets it once on the campaign and every asset displays it. Present only on such fields.
A client shows the field as "Set on the campaign", linking to the campaign, rather than as an input.
UpdateCampaignAssetrefuses a value for it withFIELD_SET_ON_CAMPAIGN, and on an asset the field carries no value: read it from the named member ofGetCampaign'sCampaign.If the service returns an enum value that is not available in the current SDK version,
campaignSettingwill returnCampaignSetting.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromcampaignSettingAsString().- Returns:
- The campaign setting this field shows, when it shows one: the partner sets it once on the campaign and
every asset displays it. Present only on such fields.
A client shows the field as "Set on the campaign", linking to the campaign, rather than as an input.
UpdateCampaignAssetrefuses a value for it withFIELD_SET_ON_CAMPAIGN, and on an asset the field carries no value: read it from the named member ofGetCampaign'sCampaign. - See Also:
-
campaignSettingAsString
The campaign setting this field shows, when it shows one: the partner sets it once on the campaign and every asset displays it. Present only on such fields.
A client shows the field as "Set on the campaign", linking to the campaign, rather than as an input.
UpdateCampaignAssetrefuses a value for it withFIELD_SET_ON_CAMPAIGN, and on an asset the field carries no value: read it from the named member ofGetCampaign'sCampaign.If the service returns an enum value that is not available in the current SDK version,
campaignSettingwill returnCampaignSetting.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromcampaignSettingAsString().- Returns:
- The campaign setting this field shows, when it shows one: the partner sets it once on the campaign and
every asset displays it. Present only on such fields.
A client shows the field as "Set on the campaign", linking to the campaign, rather than as an input.
UpdateCampaignAssetrefuses a value for it withFIELD_SET_ON_CAMPAIGN, and on an asset the field carries no value: read it from the named member ofGetCampaign'sCampaign. - See Also:
-
partnerProfileField
The partner-profile value this field shows, when it shows one: the partner's AWS Partner Central profile supplies it, and every asset of every campaign displays it. Present only on such fields.
A client shows the field as "From your Partner Central profile" rather than as an input.
UpdateCampaignAssetrefuses a value for it withFIELD_FROM_PARTNER_PROFILE. On a read the field carries the partner's resolved value — the logo as its URL, the name and website as text — so a slot renders from this list alone;GetCampaign'sCampaign$PartnerProfilecarries the same three values.If the service returns an enum value that is not available in the current SDK version,
partnerProfileFieldwill returnPartnerProfileField.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frompartnerProfileFieldAsString().- Returns:
- The partner-profile value this field shows, when it shows one: the partner's AWS Partner Central profile
supplies it, and every asset of every campaign displays it. Present only on such fields.
A client shows the field as "From your Partner Central profile" rather than as an input.
UpdateCampaignAssetrefuses a value for it withFIELD_FROM_PARTNER_PROFILE. On a read the field carries the partner's resolved value — the logo as its URL, the name and website as text — so a slot renders from this list alone;GetCampaign'sCampaign$PartnerProfilecarries the same three values. - See Also:
-
partnerProfileFieldAsString
The partner-profile value this field shows, when it shows one: the partner's AWS Partner Central profile supplies it, and every asset of every campaign displays it. Present only on such fields.
A client shows the field as "From your Partner Central profile" rather than as an input.
UpdateCampaignAssetrefuses a value for it withFIELD_FROM_PARTNER_PROFILE. On a read the field carries the partner's resolved value — the logo as its URL, the name and website as text — so a slot renders from this list alone;GetCampaign'sCampaign$PartnerProfilecarries the same three values.If the service returns an enum value that is not available in the current SDK version,
partnerProfileFieldwill returnPartnerProfileField.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frompartnerProfileFieldAsString().- Returns:
- The partner-profile value this field shows, when it shows one: the partner's AWS Partner Central profile
supplies it, and every asset of every campaign displays it. Present only on such fields.
A client shows the field as "From your Partner Central profile" rather than as an input.
UpdateCampaignAssetrefuses a value for it withFIELD_FROM_PARTNER_PROFILE. On a read the field carries the partner's resolved value — the logo as its URL, the name and website as text — so a slot renders from this list alone;GetCampaign'sCampaign$PartnerProfilecarries the same three values. - 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<CampaignAssetTemplateField.Builder,CampaignAssetTemplateField> - 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.
-