Class CampaignAssetSummary

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

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

Summary representation of an asset for list operations.

See Also:
  • Method Details

    • id

      public final String id()

      The asset identifier.

      Returns:
      The asset 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". A client listing the candidates for an AssetLink field reads it here, so a preview can update on pick without a fetch.

      Returns:
      DOCUMENT only: the words a page uses for this document, such as "eBook". A client listing the candidates for an AssetLink field reads it here, so a preview can update on pick without a fetch.
    • state

      public final CampaignAssetState state()

      Where the asset sits in its lifecycle.

      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:
      Where the asset sits in its lifecycle.
      See Also:
    • stateAsString

      public final String stateAsString()

      Where the asset sits in its lifecycle.

      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:
      Where the asset sits in its lifecycle.
      See Also:
    • lastActivationStatus

      public final AttemptStatus lastActivationStatus()

      How the last hand-over to the delivery platform ended. Absent before the first activation.

      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 last hand-over to the delivery platform ended. Absent before the first activation.
      See Also:
    • lastActivationStatusAsString

      public final String lastActivationStatusAsString()

      How the last hand-over to the delivery platform ended. Absent before the first activation.

      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 last hand-over to the delivery platform ended. Absent before the first activation.
      See Also:
    • deliveryStatus

      public final DeliveryStatus deliveryStatus()

      Whether the platform has delivered the asset.

      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:
      Whether the platform has delivered the asset.
      See Also:
    • deliveryStatusAsString

      public final String deliveryStatusAsString()

      Whether the platform has delivered the asset.

      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:
      Whether the platform has delivered the asset.
      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 same value CampaignAsset.SourceAssetTemplateId reports, and absent when it is.

      Returns:
      The asset template this asset was created from. The same value CampaignAsset.SourceAssetTemplateId reports, and absent when it is.
    • socialPlatform

      public final Platform socialPlatform()

      SOCIAL_POST only: the platform the post goes to. Join it with ListSocialConnections' status for that platform to show a post that cannot activate (a connection missing, EXPIRED or PAGE_REQUIRED) before Start is pressed.

      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. Join it with ListSocialConnections' status for that platform to show a post that cannot activate (a connection missing, EXPIRED or PAGE_REQUIRED) before Start is pressed.
      See Also:
    • socialPlatformAsString

      public final String socialPlatformAsString()

      SOCIAL_POST only: the platform the post goes to. Join it with ListSocialConnections' status for that platform to show a post that cannot activate (a connection missing, EXPIRED or PAGE_REQUIRED) before Start is pressed.

      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. Join it with ListSocialConnections' status for that platform to show a post that cannot activate (a connection missing, EXPIRED or PAGE_REQUIRED) before Start is pressed.
      See Also:
    • startedAt

      public final Instant startedAt()

      When the asset first went live, set once. Absent if it never has.

      Returns:
      When the asset first went live, set once. Absent if it never has.
    • fileFormat

      public final FileFormat fileFormat()

      Concrete file format of the finished artifact.

      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.
      See Also:
    • fileFormatAsString

      public final String fileFormatAsString()

      Concrete file format of the finished artifact.

      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.
      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.

    • toBuilder

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

      public static CampaignAssetSummary.Builder builder()
    • serializableBuilderClass

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