Enum CampaignState
java.lang.Object
java.lang.Enum<CampaignState>
software.amazon.awssdk.services.partnercentralmarketing.model.CampaignState
- All Implemented Interfaces:
Serializable,Comparable<CampaignState>
A campaign's state, derived on every read from its EndOn and its assets:
COMPLETEDonce the UTC date is afterEndOn(so a campaign ending today completes at the next UTC midnight). A campaign with noEndOnnever completes, and cannot activate until it has one;- otherwise
ACTIVEwhen any of its assets isACTIVE; - otherwise
DRAFT, including a campaign with no assets.
A summary of the assets, not a lifecycle: nothing transitions it, it is never stored, and it gates no operation by
itself: the refusal on a completed campaign (CAMPAIGN_COMPLETED) reads the same EndOn.
Otherwise whether an asset can be edited, activated or deleted depends on that asset. So a scheduled email counts as
ACTIVE once armed, before it sends; a campaign stays DRAFT during its first activation;
deactivating its only active email or social post returns it to DRAFT; and a COMPLETED
campaign can still have live landing pages.
-
Enum Constant Summary
Enum Constants -
Method Summary
Modifier and TypeMethodDescriptionstatic CampaignStateUse this in place of valueOf to convert the raw string returned by the service into the enum value.static Set<CampaignState> toString()static CampaignStateReturns the enum constant of this type with the specified name.static CampaignState[]values()Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
DRAFT
-
ACTIVE
-
COMPLETED
-
UNKNOWN_TO_SDK_VERSION
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException- if this enum type has no constant with the specified nameNullPointerException- if the argument is null
-
toString
- Overrides:
toStringin classEnum<CampaignState>
-
fromValue
Use this in place of valueOf to convert the raw string returned by the service into the enum value.- Parameters:
value- real value- Returns:
- CampaignState corresponding to the value
-
knownValues
Use this in place ofvalues()to return aSetof all values known to the SDK. This will return all known enum values exceptUNKNOWN_TO_SDK_VERSION.- Returns:
- a
Setof knownCampaignStates
-