Class CampaignAssetSummary
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<CampaignAssetSummary.Builder,CampaignAssetSummary>
Summary representation of an asset for list operations.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionstatic CampaignAssetSummary.Builderbuilder()final CampaignAssetCategorycategory()The asset category.final StringThe asset category.final DeliveryStatusWhether the platform has delivered the asset.final StringWhether the platform has delivered the asset.final CampaignAssetStateReasonWhy delivery failed.final StringWhy delivery failed.final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final FileFormatConcrete file format of the finished artifact.final StringConcrete file format of the finished artifact.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) final inthashCode()final Stringid()The asset identifier.final AttemptStatusHow the last hand-over to the delivery platform ended.final StringHow the last hand-over to the delivery platform ended.final StringDOCUMENT only: the words a page uses for this document, such as "eBook".final Stringname()The display name.final InstantThe send time, present only whenSendModeisSCHEDULED.final SendModesendMode()When this asset sends, as chosen with UpdateCampaignAsset.final StringWhen this asset sends, as chosen with UpdateCampaignAsset.static Class<? extends CampaignAssetSummary.Builder> final PlatformSOCIAL_POST only: the platform the post goes to.final StringSOCIAL_POST only: the platform the post goes to.final StringThe asset template this asset was created from.final InstantWhen the asset first went live, set once.final CampaignAssetStatestate()Where the asset sits in its lifecycle.final StringWhere the asset sits in its lifecycle.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.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
id
-
category
The asset category.
If the service returns an enum value that is not available in the current SDK version,
categorywill returnCampaignAssetCategory.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromcategoryAsString().- Returns:
- The asset category.
- See Also:
-
categoryAsString
The asset category.
If the service returns an enum value that is not available in the current SDK version,
categorywill returnCampaignAssetCategory.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromcategoryAsString().- Returns:
- The asset category.
- See Also:
-
name
-
linkLabel
DOCUMENT only: the words a page uses for this document, such as "eBook". A client listing the candidates for an
AssetLinkfield 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
AssetLinkfield reads it here, so a preview can update on pick without a fetch.
-
state
Where the asset sits in its lifecycle.
If the service returns an enum value that is not available in the current SDK version,
statewill returnCampaignAssetState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstateAsString().- Returns:
- Where the asset sits in its lifecycle.
- See Also:
-
stateAsString
Where the asset sits in its lifecycle.
If the service returns an enum value that is not available in the current SDK version,
statewill returnCampaignAssetState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstateAsString().- Returns:
- Where the asset sits in its lifecycle.
- See Also:
-
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,
lastActivationStatuswill returnAttemptStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromlastActivationStatusAsString().- Returns:
- How the last hand-over to the delivery platform ended. Absent before the first activation.
- See Also:
-
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,
lastActivationStatuswill returnAttemptStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromlastActivationStatusAsString().- Returns:
- How the last hand-over to the delivery platform ended. Absent before the first activation.
- See Also:
-
deliveryStatus
Whether the platform has delivered the asset.
If the service returns an enum value that is not available in the current SDK version,
deliveryStatuswill returnDeliveryStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromdeliveryStatusAsString().- Returns:
- Whether the platform has delivered the asset.
- See Also:
-
deliveryStatusAsString
Whether the platform has delivered the asset.
If the service returns an enum value that is not available in the current SDK version,
deliveryStatuswill returnDeliveryStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromdeliveryStatusAsString().- Returns:
- Whether the platform has delivered the asset.
- See Also:
-
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,
deliveryStatusReasonwill returnCampaignAssetStateReason.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromdeliveryStatusReasonAsString().- 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
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,
deliveryStatusReasonwill returnCampaignAssetStateReason.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromdeliveryStatusReasonAsString().- 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
The asset template this asset was created from. The same value
CampaignAsset.SourceAssetTemplateIdreports, and absent when it is.- Returns:
- The asset template this asset was created from. The same value
CampaignAsset.SourceAssetTemplateIdreports, and absent when it is.
-
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,
socialPlatformwill returnPlatform.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromsocialPlatformAsString().- 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
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
Concrete file format of the finished artifact.
If the service returns an enum value that is not available in the current SDK version,
fileFormatwill returnFileFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromfileFormatAsString().- Returns:
- Concrete file format of the finished artifact.
- See Also:
-
fileFormatAsString
Concrete file format of the finished artifact.
If the service returns an enum value that is not available in the current SDK version,
fileFormatwill returnFileFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromfileFormatAsString().- Returns:
- Concrete file format of the finished artifact.
- See Also:
-
sendMode
When this asset sends, as chosen with UpdateCampaignAsset.
EMAILandSOCIAL_POSTonly — the two categories whose delivery platform holds a schedule of its own. Absent until chosen, and then the asset reportsSEND_MODE_MISSING.If the service returns an enum value that is not available in the current SDK version,
sendModewill returnSendMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromsendModeAsString().- Returns:
- When this asset sends, as chosen with UpdateCampaignAsset.
EMAILandSOCIAL_POSTonly — the two categories whose delivery platform holds a schedule of its own. Absent until chosen, and then the asset reportsSEND_MODE_MISSING. - See Also:
-
sendModeAsString
When this asset sends, as chosen with UpdateCampaignAsset.
EMAILandSOCIAL_POSTonly — the two categories whose delivery platform holds a schedule of its own. Absent until chosen, and then the asset reportsSEND_MODE_MISSING.If the service returns an enum value that is not available in the current SDK version,
sendModewill returnSendMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromsendModeAsString().- Returns:
- When this asset sends, as chosen with UpdateCampaignAsset.
EMAILandSOCIAL_POSTonly — the two categories whose delivery platform holds a schedule of its own. Absent until chosen, and then the asset reportsSEND_MODE_MISSING. - See Also:
-
scheduledSendAt
The send time, present only when
SendModeisSCHEDULED. 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
SendModeisSCHEDULED. It reaches the delivery platform at the asset's next activation.Was
scheduleDate: UtcDate; retyped with the write member of the same name.
-
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<CampaignAssetSummary.Builder,CampaignAssetSummary> - 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.
-
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,
socialPlatformwill returnPlatform.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromsocialPlatformAsString().Platform