Class Campaign
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<Campaign.Builder,Campaign>
A marketing campaign resource.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal List<ActivationIssue> Campaign settings that must be set before the assets listed in each issue can be activated.final Stringarn()The campaign ARN.static Campaign.Builderbuilder()final StringThe campaign identifier.final StringThe campaign template this campaign draws its assets from.final InstantCreation timestamp.final EmailTargetDetailThe attached recipient list — metadata only.The engagement groups set byCreateCampaign/UpdateCampaign.final StringendOn()The last day of the campaign's run window.final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final MonetaryValueWhat the partner expects the campaign to cost.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) final booleanFor responses, this returns true if the service returned a value for the ActivationIssues property.final booleanFor responses, this returns true if the service returned a value for the EmailTargetEngagementGroupIds property.final inthashCode()final booleanFor responses, this returns true if the service returned a value for the SocialConnections property.final AssetLanguagelanguage()The language the campaign's assets are written and typeset in: its template'sLanguageCode, set at create.final StringThe language the campaign's assets are written and typeset in: its template'sLanguageCode, set at create.final Stringname()The display name.final StringThe partner's postal address.final PartnerBadgeDetailThe partner's badge.final PartnerProfileBrandingThe partner's branding — display name, website and logo — from their AWS Partner Central profile, rendered onto every asset of this campaign.final StringThe URL of the partner's privacy policy.final StringThe address the campaign's emails are sent from.static Class<? extends Campaign.Builder> The account the campaign's social posts publish from, per platform, as set byUpdateCampaign.The account the campaign's social posts publish from, per platform, as set byUpdateCampaign.final StringstartOn()The first day of the campaign's run window.final CampaignStatestate()The campaign's state, derived on every read fromEndOnand its assets.final StringThe campaign's state, derived on every read fromEndOnand its assets.final TargetAudienceTarget audience configuration.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.final MonetaryValueThe campaign's total budget.final InstantLast update timestamp.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
campaignId
-
arn
-
name
-
state
The campaign's state, derived on every read from
EndOnand its assets. SeeCampaignState.If the service returns an enum value that is not available in the current SDK version,
statewill returnCampaignState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstateAsString().- Returns:
- The campaign's state, derived on every read from
EndOnand its assets. SeeCampaignState. - See Also:
-
stateAsString
The campaign's state, derived on every read from
EndOnand its assets. SeeCampaignState.If the service returns an enum value that is not available in the current SDK version,
statewill returnCampaignState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstateAsString().- Returns:
- The campaign's state, derived on every read from
EndOnand its assets. SeeCampaignState. - See Also:
-
campaignTemplateId
The campaign template this campaign draws its assets from. Set at create, immutable.
- Returns:
- The campaign template this campaign draws its assets from. Set at create, immutable.
-
language
The language the campaign's assets are written and typeset in: its template's
LanguageCode, set at create. To work in another language, create the campaign from that language's template.If the service returns an enum value that is not available in the current SDK version,
languagewill returnAssetLanguage.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromlanguageAsString().- Returns:
- The language the campaign's assets are written and typeset in: its template's
LanguageCode, set at create. To work in another language, create the campaign from that language's template. - See Also:
-
languageAsString
The language the campaign's assets are written and typeset in: its template's
LanguageCode, set at create. To work in another language, create the campaign from that language's template.If the service returns an enum value that is not available in the current SDK version,
languagewill returnAssetLanguage.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromlanguageAsString().- Returns:
- The language the campaign's assets are written and typeset in: its template's
LanguageCode, set at create. To work in another language, create the campaign from that language's template. - See Also:
-
partnerProfile
The partner's branding — display name, website and logo — from their AWS Partner Central profile, rendered onto every asset of this campaign. Read-only here: the partner edits it in Partner Central, and the next activation or export uses the change. Absent only when the partner has no profile.
- Returns:
- The partner's branding — display name, website and logo — from their AWS Partner Central profile, rendered onto every asset of this campaign. Read-only here: the partner edits it in Partner Central, and the next activation or export uses the change. Absent only when the partner has no profile.
-
senderEmail
The address the campaign's emails are sent from. Absent until one is set.
- Returns:
- The address the campaign's emails are sent from. Absent until one is set.
-
privacyPolicyUrl
The URL of the partner's privacy policy. Absent until one is set.
- Returns:
- The URL of the partner's privacy policy. Absent until one is set.
-
partnerAddress
The partner's postal address. Absent until one is set.
- Returns:
- The partner's postal address. Absent until one is set.
-
partnerBadge
The partner's badge. Absent until one is set, and every badge slot shows the Standalone AWS Partner badge while the partner's primary AWS Partner path is at stage Validated or Differentiated. Below that, no badge is shown.
- Returns:
- The partner's badge. Absent until one is set, and every badge slot shows the Standalone AWS Partner badge while the partner's primary AWS Partner path is at stage Validated or Differentiated. Below that, no badge is shown.
-
emailTarget
The attached recipient list — metadata only. There is no read path for the addresses.
- Returns:
- The attached recipient list — metadata only. There is no read path for the addresses.
-
hasEmailTargetEngagementGroupIds
public final boolean hasEmailTargetEngagementGroupIds()For responses, this returns true if the service returned a value for the EmailTargetEngagementGroupIds property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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. -
emailTargetEngagementGroupIds
The engagement groups set by
CreateCampaign/UpdateCampaign. Absent until set. Resolved to recipients at Start, where the stage can.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
hasEmailTargetEngagementGroupIds()method.- Returns:
- The engagement groups set by
CreateCampaign/UpdateCampaign. Absent until set. Resolved to recipients at Start, where the stage can.
-
hasSocialConnections
public final boolean hasSocialConnections()For responses, this returns true if the service returned a value for the SocialConnections property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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. -
socialConnectionsAsStrings
The account the campaign's social posts publish from, per platform, as set by
UpdateCampaign. Absent until one is set.Needed only for a platform where you hold two or more connections. With none set, a post uses your one connection on its platform, and fails `SOCIAL_CONNECTION_NOT_CHOSEN` when you hold several. A choice that no longer names a connection on its platform fails `SOCIAL_CONNECTION_MISSING`. Join with `ListSocialConnections` for each connection's status.
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
hasSocialConnections()method.- Returns:
- The account the campaign's social posts publish from, per platform, as set by
UpdateCampaign. Absent until one is set.
-
estimatedBudget
What the partner expects the campaign to cost.
- Returns:
- What the partner expects the campaign to cost.
-
totalBudget
The campaign's total budget.
- Returns:
- The campaign's total budget.
-
targetAudience
Target audience configuration.
- Returns:
- Target audience configuration.
-
startOn
The first day of the campaign's run window.
- Returns:
- The first day of the campaign's run window.
-
endOn
The last day of the campaign's run window.
- Returns:
- The last day of the campaign's run window.
-
createdAt
-
updatedAt
-
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 theisEmpty()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
Campaign settings that must be set before the assets listed in each issue can be activated. Empty when nothing is missing.
Each issue names the setting in
CampaignSetting— set it withUpdateCampaign— or the profile value inPartnerProfileField— set it in Partner Central — and the assets it blocks inAffectedAssetIds.StartCampaignAssetActivationTaskrefuses withValidationException(CAMPAIGN_INCOMPLETE) while a requested asset is affected.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:
- Campaign settings that must be set before the assets listed in each issue can be activated. Empty when
nothing is missing.
Each issue names the setting in
CampaignSetting— set it withUpdateCampaign— or the profile value inPartnerProfileField— set it in Partner Central — and the assets it blocks inAffectedAssetIds.StartCampaignAssetActivationTaskrefuses withValidationException(CAMPAIGN_INCOMPLETE) while a requested asset is affected.
-
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<Campaign.Builder,Campaign> - 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.
-
socialConnections
The account the campaign's social posts publish from, per platform, as set by
UpdateCampaign. Absent until one is set.Needed only for a platform where you hold two or more connections. With none set, a post uses your one connection on its platform, and fails `SOCIAL_CONNECTION_NOT_CHOSEN` when you hold several. A choice that no longer names a connection on its platform fails `SOCIAL_CONNECTION_MISSING`. Join with `ListSocialConnections` for each connection's status.
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
hasSocialConnections()method.UpdateCampaign. Absent until one is set.