Class CampaignAsset

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

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

A marketing asset resource within a campaign.

See Also:
  • Method Details

    • id

      public final String id()

      The asset identifier.

      Returns:
      The asset identifier.
    • campaignId

      public final String campaignId()

      The campaign identifier.

      Returns:
      The campaign identifier.
    • category

      public final CampaignAssetCategory category()

      The asset category.

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

      Returns:
      The asset category.
      See Also:
    • categoryAsString

      public final String categoryAsString()

      The asset category.

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

      Returns:
      The asset category.
      See Also:
    • name

      public final String name()

      The display name.

      Returns:
      The display name.
    • linkLabel

      public final String linkLabel()

      DOCUMENT only: the words a page uses for this document, such as "eBook". Fill an AssetLink field's LabelFieldId with it when the partner picks this asset.

      Returns:
      DOCUMENT only: the words a page uses for this document, such as "eBook". Fill an AssetLink field's LabelFieldId with it when the partner picks this asset.
    • state

      public final CampaignAssetState state()

      Whether the asset is live.

      Reports current truth only, and nothing else on this shape overrides it. During an initial publication it stays INACTIVE until the delivery platform holds the object; during a re-publication it stays ACTIVE, because the previously published content is still serving.

      A stopped asset and one never started both read INACTIVE; LastActivationStatus tells them apart, because a stop does not change how the last activation went — stopped is INACTIVE with that member SUCCEEDED, never started is INACTIVE with it absent.

      An update never moves this member.

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

      Returns:
      Whether the asset is live.

      Reports current truth only, and nothing else on this shape overrides it. During an initial publication it stays INACTIVE until the delivery platform holds the object; during a re -publication it stays ACTIVE, because the previously published content is still serving.

      A stopped asset and one never started both read INACTIVE; LastActivationStatus tells them apart, because a stop does not change how the last activation went — stopped is INACTIVE with that member SUCCEEDED, never started is INACTIVE with it absent.

      An update never moves this member.

      See Also:
    • stateAsString

      public final String stateAsString()

      Whether the asset is live.

      Reports current truth only, and nothing else on this shape overrides it. During an initial publication it stays INACTIVE until the delivery platform holds the object; during a re-publication it stays ACTIVE, because the previously published content is still serving.

      A stopped asset and one never started both read INACTIVE; LastActivationStatus tells them apart, because a stop does not change how the last activation went — stopped is INACTIVE with that member SUCCEEDED, never started is INACTIVE with it absent.

      An update never moves this member.

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

      Returns:
      Whether the asset is live.

      Reports current truth only, and nothing else on this shape overrides it. During an initial publication it stays INACTIVE until the delivery platform holds the object; during a re -publication it stays ACTIVE, because the previously published content is still serving.

      A stopped asset and one never started both read INACTIVE; LastActivationStatus tells them apart, because a stop does not change how the last activation went — stopped is INACTIVE with that member SUCCEEDED, never started is INACTIVE with it absent.

      An update never moves this member.

      See Also:
    • lastActivationStatus

      public final AttemptStatus lastActivationStatus()

      How the most recent hand-over to the delivery platform ended.

      The hand-over, not the delivery: if DG got the artifact scheduled at the platform this is SUCCEEDED, and whether the platform then delivered is DeliveryStatus. Per category the hand-over point is — email: the mailing armed; social: the create, which is the schedule; landing page: create plus publish-personalisation; document: bytes written.

      Read with State this is what separates a stopped asset (INACTIVE with SUCCEEDED here) from one never activated (INACTIVE with this member absent) — a stop does not change how the last activation went.

      There is no public UNKNOWN. A hand-over whose outcome DG cannot yet determine reports IN_PROGRESS, because a partner's action is identical either way and there is nothing to do with "unknown". Reporting it as FAILED would be the harmful collapse: that reads as safe to retry, and a retry on an at-most-once create publishes a second live object.

      Omitted before the first activation attempt.

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

      Returns:
      How the most recent hand-over to the delivery platform ended.

      The hand-over, not the delivery: if DG got the artifact scheduled at the platform this is SUCCEEDED, and whether the platform then delivered is DeliveryStatus. Per category the hand-over point is — email: the mailing armed; social: the create, which is the schedule; landing page: create plus publish-personalisation; document: bytes written.

      Read with State this is what separates a stopped asset (INACTIVE with SUCCEEDED here) from one never activated (INACTIVE with this member absent) — a stop does not change how the last activation went.

      There is no public UNKNOWN. A hand-over whose outcome DG cannot yet determine reports IN_PROGRESS, because a partner's action is identical either way and there is nothing to do with "unknown". Reporting it as FAILED would be the harmful collapse: that reads as safe to retry, and a retry on an at-most-once create publishes a second live object.

      Omitted before the first activation attempt.

      See Also:
    • lastActivationStatusAsString

      public final String lastActivationStatusAsString()

      How the most recent hand-over to the delivery platform ended.

      The hand-over, not the delivery: if DG got the artifact scheduled at the platform this is SUCCEEDED, and whether the platform then delivered is DeliveryStatus. Per category the hand-over point is — email: the mailing armed; social: the create, which is the schedule; landing page: create plus publish-personalisation; document: bytes written.

      Read with State this is what separates a stopped asset (INACTIVE with SUCCEEDED here) from one never activated (INACTIVE with this member absent) — a stop does not change how the last activation went.

      There is no public UNKNOWN. A hand-over whose outcome DG cannot yet determine reports IN_PROGRESS, because a partner's action is identical either way and there is nothing to do with "unknown". Reporting it as FAILED would be the harmful collapse: that reads as safe to retry, and a retry on an at-most-once create publishes a second live object.

      Omitted before the first activation attempt.

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

      Returns:
      How the most recent hand-over to the delivery platform ended.

      The hand-over, not the delivery: if DG got the artifact scheduled at the platform this is SUCCEEDED, and whether the platform then delivered is DeliveryStatus. Per category the hand-over point is — email: the mailing armed; social: the create, which is the schedule; landing page: create plus publish-personalisation; document: bytes written.

      Read with State this is what separates a stopped asset (INACTIVE with SUCCEEDED here) from one never activated (INACTIVE with this member absent) — a stop does not change how the last activation went.

      There is no public UNKNOWN. A hand-over whose outcome DG cannot yet determine reports IN_PROGRESS, because a partner's action is identical either way and there is nothing to do with "unknown". Reporting it as FAILED would be the harmful collapse: that reads as safe to retry, and a retry on an at-most-once create publishes a second live object.

      Omitted before the first activation attempt.

      See Also:
    • deliveryStatus

      public final DeliveryStatus deliveryStatus()

      What the platform did with the artifact after accepting it.

      EMAIL and SOCIAL_POST only — absent on every other category, which has no delivery event. See the DeliveryStatus docs.

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

      Returns:
      What the platform did with the artifact after accepting it.

      EMAIL and SOCIAL_POST only — absent on every other category, which has no delivery event. See the DeliveryStatus docs.

      See Also:
    • deliveryStatusAsString

      public final String deliveryStatusAsString()

      What the platform did with the artifact after accepting it.

      EMAIL and SOCIAL_POST only — absent on every other category, which has no delivery event. See the DeliveryStatus docs.

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

      Returns:
      What the platform did with the artifact after accepting it.

      EMAIL and SOCIAL_POST only — absent on every other category, which has no delivery event. See the DeliveryStatus docs.

      See Also:
    • deliveryStatusReason

      public final CampaignAssetStateReason deliveryStatusReason()

      Why delivery failed. Present only when DeliveryStatus is FAILED. For an email the platform rejected: SENDER_EMAIL_INVALID, RECIPIENT_LIST_EMPTY, MAILING_CREDITS_EXHAUSTED or RECIPIENT_LIMIT_EXCEEDED. Otherwise DELIVERY_FAILED. A Facebook post refused because its connection has no Page is FAILED with SOCIAL_CONNECTION_PAGE_REQUIRED, and withdrawn: reconnect Facebook with a Page selected. A social post the platform stopped retrying, because it could not publish within 12 hours of its scheduled time, is FAILED with DELIVERY_FAILED. Any other social post that could not be published stays PENDING while it is investigated, and is reported FAILED with DELIVERY_FAILED once it is confirmed it will not go out. Deactivate and activate the asset again to retry.

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

      Returns:
      Why delivery failed. Present only when DeliveryStatus is FAILED. For an email the platform rejected: SENDER_EMAIL_INVALID, RECIPIENT_LIST_EMPTY, MAILING_CREDITS_EXHAUSTED or RECIPIENT_LIMIT_EXCEEDED. Otherwise DELIVERY_FAILED. A Facebook post refused because its connection has no Page is FAILED with SOCIAL_CONNECTION_PAGE_REQUIRED, and withdrawn: reconnect Facebook with a Page selected. A social post the platform stopped retrying, because it could not publish within 12 hours of its scheduled time, is FAILED with DELIVERY_FAILED. Any other social post that could not be published stays PENDING while it is investigated, and is reported FAILED with DELIVERY_FAILED once it is confirmed it will not go out. Deactivate and activate the asset again to retry.
      See Also:
    • deliveryStatusReasonAsString

      public final String deliveryStatusReasonAsString()

      Why delivery failed. Present only when DeliveryStatus is FAILED. For an email the platform rejected: SENDER_EMAIL_INVALID, RECIPIENT_LIST_EMPTY, MAILING_CREDITS_EXHAUSTED or RECIPIENT_LIMIT_EXCEEDED. Otherwise DELIVERY_FAILED. A Facebook post refused because its connection has no Page is FAILED with SOCIAL_CONNECTION_PAGE_REQUIRED, and withdrawn: reconnect Facebook with a Page selected. A social post the platform stopped retrying, because it could not publish within 12 hours of its scheduled time, is FAILED with DELIVERY_FAILED. Any other social post that could not be published stays PENDING while it is investigated, and is reported FAILED with DELIVERY_FAILED once it is confirmed it will not go out. Deactivate and activate the asset again to retry.

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

      Returns:
      Why delivery failed. Present only when DeliveryStatus is FAILED. For an email the platform rejected: SENDER_EMAIL_INVALID, RECIPIENT_LIST_EMPTY, MAILING_CREDITS_EXHAUSTED or RECIPIENT_LIMIT_EXCEEDED. Otherwise DELIVERY_FAILED. A Facebook post refused because its connection has no Page is FAILED with SOCIAL_CONNECTION_PAGE_REQUIRED, and withdrawn: reconnect Facebook with a Page selected. A social post the platform stopped retrying, because it could not publish within 12 hours of its scheduled time, is FAILED with DELIVERY_FAILED. Any other social post that could not be published stays PENDING while it is investigated, and is reported FAILED with DELIVERY_FAILED once it is confirmed it will not go out. Deactivate and activate the asset again to retry.
      See Also:
    • sourceAssetTemplateId

      public final String sourceAssetTemplateId()

      The asset template this asset was created from: the SourceAssetTemplateIdentifier its BatchCreateCampaignAsset entry named, one of GetCampaignTemplate's CampaignTemplate.AssetTemplates[].Id. Set at create and never writable. Absent on an asset created before DG recorded it, which can't be activated either. A campaign holds at most one asset per asset template, so this is how a client matches a campaign's assets to its template's asset templates, for example to create the same assets in another campaign. Names don't identify one: two asset templates can share a name.

      Returns:
      The asset template this asset was created from: the SourceAssetTemplateIdentifier its BatchCreateCampaignAsset entry named, one of GetCampaignTemplate's CampaignTemplate.AssetTemplates[].Id. Set at create and never writable. Absent on an asset created before DG recorded it, which can't be activated either. A campaign holds at most one asset per asset template, so this is how a client matches a campaign's assets to its template's asset templates, for example to create the same assets in another campaign. Names don't identify one: two asset templates can share a name.
    • socialPlatform

      public final Platform socialPlatform()

      SOCIAL_POST only: the platform the post goes to, set from its template and never writable. The same value CampaignAssetSummary.SocialPlatform reports. Absent for every other category.

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

      Returns:
      SOCIAL_POST only: the platform the post goes to, set from its template and never writable. The same value CampaignAssetSummary.SocialPlatform reports. Absent for every other category.
      See Also:
    • socialPlatformAsString

      public final String socialPlatformAsString()

      SOCIAL_POST only: the platform the post goes to, set from its template and never writable. The same value CampaignAssetSummary.SocialPlatform reports. Absent for every other category.

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

      Returns:
      SOCIAL_POST only: the platform the post goes to, set from its template and never writable. The same value CampaignAssetSummary.SocialPlatform reports. Absent for every other category.
      See Also:
    • fileFormat

      public final FileFormat fileFormat()

      Concrete file format of the finished artifact. For DOWNLOAD_ONLY this is the format of the object export copies through verbatim.

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

      Returns:
      Concrete file format of the finished artifact. For DOWNLOAD_ONLY this is the format of the object export copies through verbatim.
      See Also:
    • fileFormatAsString

      public final String fileFormatAsString()

      Concrete file format of the finished artifact. For DOWNLOAD_ONLY this is the format of the object export copies through verbatim.

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

      Returns:
      Concrete file format of the finished artifact. For DOWNLOAD_ONLY this is the format of the object export copies through verbatim.
      See Also:
    • sendMode

      public final SendMode sendMode()

      When this asset sends, as chosen with UpdateCampaignAsset. EMAIL and SOCIAL_POST only — the two categories whose delivery platform holds a schedule of its own. Absent until chosen, and then the asset reports SEND_MODE_MISSING.

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

      Returns:
      When this asset sends, as chosen with UpdateCampaignAsset. EMAIL and SOCIAL_POST only — the two categories whose delivery platform holds a schedule of its own. Absent until chosen, and then the asset reports SEND_MODE_MISSING.
      See Also:
    • sendModeAsString

      public final String sendModeAsString()

      When this asset sends, as chosen with UpdateCampaignAsset. EMAIL and SOCIAL_POST only — the two categories whose delivery platform holds a schedule of its own. Absent until chosen, and then the asset reports SEND_MODE_MISSING.

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

      Returns:
      When this asset sends, as chosen with UpdateCampaignAsset. EMAIL and SOCIAL_POST only — the two categories whose delivery platform holds a schedule of its own. Absent until chosen, and then the asset reports SEND_MODE_MISSING.
      See Also:
    • scheduledSendAt

      public final Instant scheduledSendAt()

      The send time, present only when SendMode is SCHEDULED. It reaches the delivery platform at the asset's next activation.

      Was scheduleDate: UtcDate; retyped with the write member of the same name.

      Returns:
      The send time, present only when SendMode is SCHEDULED. It reaches the delivery platform at the asset's next activation.

      Was scheduleDate: UtcDate; retyped with the write member of the same name.

    • hasFieldValues

      public final boolean hasFieldValues()
      For responses, this returns true if the service returned a value for the FieldValues property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
    • fieldValues

      public final List<CampaignAssetFieldValue> fieldValues()

      The asset's pinned template fields — the field schema copied from the blueprint at instantiation, each paired with the partner's current value. Present on every asset instantiated from a blueprint that offers editable fields, whatever its category (design section 3.1); absent on one whose blueprint offers none.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFieldValues() method.

      Returns:
      The asset's pinned template fields — the field schema copied from the blueprint at instantiation, each paired with the partner's current value. Present on every asset instantiated from a blueprint that offers editable fields, whatever its category (design section 3.1); absent on one whose blueprint offers none.
    • hasLayoutPreviews

      public final boolean hasLayoutPreviews()
      For responses, this returns true if the service returned a value for the LayoutPreviews property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
    • layoutPreviews

      public final List<LayoutPreview> layoutPreviews()

      The asset's AWS-authored layout, as stable public CDN URLs composed from the fileKeys copied off the blueprint at instantiation. Together with FieldValues this makes the asset self-describing: a client renders the edit form and shows the real layout while editing, with no template lookup.

      The stored form is a bare object key and the URL is composed on read. The key is revision-addressed and prior revisions are retained, so the key IS the pin — nothing is copied into the asset bucket, and there is no version parameter to carry (DG-038).

      One entry for every category except LANDING_PAGE, which has two and distinguishes them with PageType.

      On a multi-layout asset, the SELECTED option's pages only (its first option when none is stored); each option's own previews are on layout.options.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasLayoutPreviews() method.

      Returns:
      The asset's AWS-authored layout, as stable public CDN URLs composed from the fileKeys copied off the blueprint at instantiation. Together with FieldValues this makes the asset self-describing: a client renders the edit form and shows the real layout while editing, with no template lookup.

      The stored form is a bare object key and the URL is composed on read. The key is revision-addressed and prior revisions are retained, so the key IS the pin — nothing is copied into the asset bucket, and there is no version parameter to carry (DG-038).

      One entry for every category except LANDING_PAGE, which has two and distinguishes them with PageType.

      On a multi-layout asset, the SELECTED option's pages only (its first option when none is stored); each option's own previews are on layout.options.

    • layout

      public final CampaignAssetLayout layout()

      A multi-layout asset's layout choice (DG-044): the selection once made, and every option the asset was created with. Absent for a single-layout asset.

      FieldValues is always the union of every option's fields, selected or not, so a client can switch layouts without a round trip: each option lists its own FieldIds. The selection drives layout.selected and the top-level LayoutPreviews only.

      Returns:
      A multi-layout asset's layout choice (DG-044): the selection once made, and every option the asset was created with. Absent for a single-layout asset.

      FieldValues is always the union of every option's fields, selected or not, so a client can switch layouts without a round trip: each option lists its own FieldIds. The selection drives layout.selected and the top-level LayoutPreviews only.

    • hasActivationIssues

      public final boolean hasActivationIssues()
      For responses, this returns true if the service returned a value for the ActivationIssues property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
    • activationIssues

      public final List<ActivationIssue> activationIssues()

      What must be fixed on this asset before it can be activated. Empty when the asset is ready.

      Issues don't block saving: an asset can be saved incomplete and fixed over several updates. StartCampaignAssetActivationTask refuses an asset that still has issues: an issue blocks activation when only an edit to the asset can change the outcome. Most issues name the field to fix in FieldId. Fix it with UpdateCampaignAsset, then read this list again.

      Besides the issues computed from the asset's content, the list carries what the last activation found: CONTENT_REJECTED and PARTNER_IMAGE_REJECTED when moderation refused a field. Editing that field removes its issue. A CONTENT_REJECTED without a FieldId means the text was refused as a whole; editing any text field removes it.

      Problems with the campaign's own settings, such as a missing recipient list, and with the partner's profile, such as a missing logo, are reported on Campaign.ActivationIssues, not here.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasActivationIssues() method.

      Returns:
      What must be fixed on this asset before it can be activated. Empty when the asset is ready.

      Issues don't block saving: an asset can be saved incomplete and fixed over several updates. StartCampaignAssetActivationTask refuses an asset that still has issues: an issue blocks activation when only an edit to the asset can change the outcome. Most issues name the field to fix in FieldId. Fix it with UpdateCampaignAsset, then read this list again.

      Besides the issues computed from the asset's content, the list carries what the last activation found: CONTENT_REJECTED and PARTNER_IMAGE_REJECTED when moderation refused a field. Editing that field removes its issue. A CONTENT_REJECTED without a FieldId means the text was refused as a whole; editing any text field removes it.

      Problems with the campaign's own settings, such as a missing recipient list, and with the partner's profile, such as a missing logo, are reported on Campaign.ActivationIssues, not here.

    • publicUrl

      public final String publicUrl()

      The live public address this asset's activation produced.

      A landing page's page URL, read back from the delivery platform at activation and preserved across every convergence; a document's public CDN URL, composed on read from the key the publish wrote. Absent until the asset activates, and absent for EMAIL and SOCIAL_POST, which produce no partner-addressable URL of their own.

      For a landing page this is the entire deliverable — without it a partner has no way to learn where their live page is. A WIDGET landing page reports none: it is embedded rather than standalone, so absence there is expected rather than a fault.

      Returns:
      The live public address this asset's activation produced.

      A landing page's page URL, read back from the delivery platform at activation and preserved across every convergence; a document's public CDN URL, composed on read from the key the publish wrote. Absent until the asset activates, and absent for EMAIL and SOCIAL_POST, which produce no partner-addressable URL of their own.

      For a landing page this is the entire deliverable — without it a partner has no way to learn where their live page is. A WIDGET landing page reports none: it is embedded rather than standalone, so absence there is expected rather than a fault.

    • createdAt

      public final Instant createdAt()

      Creation timestamp.

      Returns:
      Creation timestamp.
    • updatedAt

      public final Instant updatedAt()

      Last update timestamp.

      Returns:
      Last update timestamp.
    • toBuilder

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

      public static CampaignAsset.Builder builder()
    • serializableBuilderClass

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