Class CampaignAssetTemplateField

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

@Generated("software.amazon.awssdk:codegen") public final class CampaignAssetTemplateField extends Object implements SdkPojo, Serializable, 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:
  • Method Details

    • fieldId

      public final String fieldId()

      The field identifier; matches a {{fieldId}} slot in the layout.

      Returns:
      The field identifier; matches a {{fieldId}} slot in the layout.
    • label

      public final String 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

      public final String 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

      public final TemplateFieldSection section()

      Layout section the field belongs to.

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

      Returns:
      Layout section the field belongs to.
      See Also:
    • sectionAsString

      public final String sectionAsString()

      Layout section the field belongs to.

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

      Returns:
      Layout section the field belongs to.
      See Also:
    • page

      public final Integer page()

      One-based page number, for paginated layouts (print documents).

      Returns:
      One-based page number, for paginated layouts (print documents).
    • required

      public final Boolean 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: UpdateCampaignAsset accepts partial content and may clear a required field. An unfilled required field appears in the asset's ActivationIssues as REQUIRED_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 Placeholder never fills one. An image field is filled by the partner's image or by the template's DefaultValue. 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: UpdateCampaignAsset accepts partial content and may clear a required field. An unfilled required field appears in the asset's ActivationIssues as REQUIRED_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 Placeholder never fills one. An image field is filled by the partner's image or by the template's DefaultValue. A field the campaign fills (CampaignSetting) or the partner's profile fills (PartnerProfileField) is never unfilled on the asset.

    • type

      public final FieldType 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

      public final CampaignSetting 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. UpdateCampaignAsset refuses a value for it with FIELD_SET_ON_CAMPAIGN, and on an asset the field carries no value: read it from the named member of GetCampaign's Campaign.

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

      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. UpdateCampaignAsset refuses a value for it with FIELD_SET_ON_CAMPAIGN, and on an asset the field carries no value: read it from the named member of GetCampaign's Campaign.

      See Also:
    • campaignSettingAsString

      public final String 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. UpdateCampaignAsset refuses a value for it with FIELD_SET_ON_CAMPAIGN, and on an asset the field carries no value: read it from the named member of GetCampaign's Campaign.

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

      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. UpdateCampaignAsset refuses a value for it with FIELD_SET_ON_CAMPAIGN, and on an asset the field carries no value: read it from the named member of GetCampaign's Campaign.

      See Also:
    • partnerProfileField

      public final PartnerProfileField 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. UpdateCampaignAsset refuses a value for it with FIELD_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's Campaign$PartnerProfile carries the same three values.

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

      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. UpdateCampaignAsset refuses a value for it with FIELD_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's Campaign$PartnerProfile carries the same three values.

      See Also:
    • partnerProfileFieldAsString

      public final String 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. UpdateCampaignAsset refuses a value for it with FIELD_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's Campaign$PartnerProfile carries the same three values.

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

      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. UpdateCampaignAsset refuses a value for it with FIELD_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's Campaign$PartnerProfile carries the same three values.

      See Also:
    • 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<CampaignAssetTemplateField.Builder,CampaignAssetTemplateField>
      Returns:
      a builder for type T
    • builder

      public static CampaignAssetTemplateField.Builder builder()
    • serializableBuilderClass

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