Interface CampaignAssetSummary.Builder
- All Superinterfaces:
Buildable,CopyableBuilder<CampaignAssetSummary.Builder,,CampaignAssetSummary> SdkBuilder<CampaignAssetSummary.Builder,,CampaignAssetSummary> SdkPojo
- Enclosing class:
CampaignAssetSummary
-
Method Summary
Modifier and TypeMethodDescriptionThe asset category.category(CampaignAssetCategory category) The asset category.deliveryStatus(String deliveryStatus) Whether the platform has delivered the asset.deliveryStatus(DeliveryStatus deliveryStatus) Whether the platform has delivered the asset.deliveryStatusReason(String deliveryStatusReason) Why delivery failed.deliveryStatusReason(CampaignAssetStateReason deliveryStatusReason) Why delivery failed.fileFormat(String fileFormat) Concrete file format of the finished artifact.fileFormat(FileFormat fileFormat) Concrete file format of the finished artifact.The asset identifier.lastActivationStatus(String lastActivationStatus) How the last hand-over to the delivery platform ended.lastActivationStatus(AttemptStatus lastActivationStatus) How the last hand-over to the delivery platform ended.DOCUMENT only: the words a page uses for this document, such as "eBook".The display name.scheduledSendAt(Instant scheduledSendAt) The send time, present only whenSendModeisSCHEDULED.When this asset sends, as chosen with UpdateCampaignAsset.When this asset sends, as chosen with UpdateCampaignAsset.socialPlatform(String socialPlatform) SOCIAL_POST only: the platform the post goes to.socialPlatform(Platform socialPlatform) SOCIAL_POST only: the platform the post goes to.sourceAssetTemplateId(String sourceAssetTemplateId) The asset template this asset was created from.When the asset first went live, set once.Where the asset sits in its lifecycle.state(CampaignAssetState state) Where the asset sits in its lifecycle.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copyMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
id
The asset identifier.
- Parameters:
id- The asset identifier.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
category
The asset category.
- Parameters:
category- The asset category.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
category
The asset category.
- Parameters:
category- The asset category.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
name
The display name.
- Parameters:
name- The display name.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Parameters:
linkLabel- DOCUMENT only: the words a page uses for this document, such as "eBook". A client listing the candidates for anAssetLinkfield reads it here, so a preview can update on pick without a fetch.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
state
Where the asset sits in its lifecycle.
- Parameters:
state- Where the asset sits in its lifecycle.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
state
Where the asset sits in its lifecycle.
- Parameters:
state- Where the asset sits in its lifecycle.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
lastActivationStatus
How the last hand-over to the delivery platform ended. Absent before the first activation.
- Parameters:
lastActivationStatus- How the last hand-over to the delivery platform ended. Absent before the first activation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
lastActivationStatus
How the last hand-over to the delivery platform ended. Absent before the first activation.
- Parameters:
lastActivationStatus- How the last hand-over to the delivery platform ended. Absent before the first activation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
deliveryStatus
Whether the platform has delivered the asset.
- Parameters:
deliveryStatus- Whether the platform has delivered the asset.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
deliveryStatus
Whether the platform has delivered the asset.
- Parameters:
deliveryStatus- Whether the platform has delivered the asset.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- 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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- 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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
sourceAssetTemplateId
The asset template this asset was created from. The same value
CampaignAsset.SourceAssetTemplateIdreports, and absent when it is.- Parameters:
sourceAssetTemplateId- The asset template this asset was created from. The same valueCampaignAsset.SourceAssetTemplateIdreports, and absent when it is.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
startedAt
When the asset first went live, set once. Absent if it never has.
- Parameters:
startedAt- When the asset first went live, set once. Absent if it never has.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
fileFormat
Concrete file format of the finished artifact.
- Parameters:
fileFormat- Concrete file format of the finished artifact.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
fileFormat
Concrete file format of the finished artifact.
- Parameters:
fileFormat- Concrete file format of the finished artifact.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- 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.- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- 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.- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- 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.- Parameters:
scheduledSendAt- The send time, present only whenSendModeisSCHEDULED. It reaches the delivery platform at the asset's next activation.Was
scheduleDate: UtcDate; retyped with the write member of the same name.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
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.PlatformPlatform