Class UpdateCampaignRequest
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<UpdateCampaignRequest.Builder,UpdateCampaignRequest>
Input for UpdateCampaign operation.
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionbuilder()final StringThe campaign identifier.final Catalogcatalog()The catalog (AWS or Sandbox).final StringThe catalog (AWS or Sandbox).final StringIdempotency token.final FileRefReplaces the campaign's attached recipient list.Engagement groups whose contacts the campaign's emails will also go to (seeCreateCampaign).final StringendOn()The last day of the campaign's run window, inclusive and in UTC.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) Used to retrieve the value of a field from any class that extendsSdkRequest.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 Stringname()The display name.final StringSets or replaces the partner's postal address.final FileRefSets or replaces the partner's badge, checked exactly as onCreateCampaign.final StringSets or replaces the URL of the partner's privacy policy.final StringSets or replaces the address the campaign's emails are sent from.static Class<? extends UpdateCampaignRequest.Builder> Sets the account the campaign's social posts publish from, per platform.Sets the account the campaign's social posts publish from, per platform.final StringstartOn()The first day of the campaign's run window.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.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
catalog
The catalog (AWS or Sandbox).
If the service returns an enum value that is not available in the current SDK version,
catalogwill returnCatalog.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromcatalogAsString().- Returns:
- The catalog (AWS or Sandbox).
- See Also:
-
catalogAsString
The catalog (AWS or Sandbox).
If the service returns an enum value that is not available in the current SDK version,
catalogwill returnCatalog.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromcatalogAsString().- Returns:
- The catalog (AWS or Sandbox).
- See Also:
-
campaignIdentifier
-
name
-
senderEmail
Sets or replaces the address the campaign's emails are sent from. Checked by the same three rules as on
CreateCampaign, with the same codes, but only when it differs, ignoring case, from the stored sender: re-sending the stored one is not checked, andStartCampaignAssetActivationTaskre-checks it before an email activates.Replaces, never clears: like every member of this operation, an omitted value leaves the sender as it was, and there is no way to remove one once set.
- Returns:
- Sets or replaces the address the campaign's emails are sent from. Checked by the same three rules as on
CreateCampaign, with the same codes, but only when it differs, ignoring case, from the stored sender: re-sending the stored one is not checked, andStartCampaignAssetActivationTaskre-checks it before an email activates.
-
privacyPolicyUrl
Sets or replaces the URL of the partner's privacy policy. Replaces, never clears.
- Returns:
- Sets or replaces the URL of the partner's privacy policy. Replaces, never clears.
-
partnerAddress
Sets or replaces the partner's postal address. Replaces, never clears.
- Returns:
- Sets or replaces the partner's postal address. Replaces, never clears.
-
partnerBadge
Sets or replaces the partner's badge, checked exactly as on
CreateCampaign. Replaces, never clears: upload the Standalone AWS Partner badge to show it again. The badge an asset already published keeps showing on it until that asset is activated again.- Returns:
- Sets or replaces the partner's badge, checked exactly as on
CreateCampaign. Replaces, never clears: upload the Standalone AWS Partner badge to show it again. The badge an asset already published keeps showing on it until that asset is activated again.
-
emailTarget
Replaces the campaign's attached recipient list.
The referenced object is copied and pinned again on every call that supplies it, so the pinned copy always reflects the *last* `UpdateCampaign` that named one. Editing the source object in your own bucket without calling this operation again has no effect.
Replaces, never detaches: a partner can swap the list but cannot remove it.
- Returns:
- Replaces the campaign's attached recipient list.
The referenced object is copied and pinned again on every call that supplies it, so the pinned copy always reflects the *last* `UpdateCampaign` that named one. Editing the source object in your own bucket without calling this operation again has no effect.
-
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
Engagement groups whose contacts the campaign's emails will also go to (see
CreateCampaign). Replaces the stored list; never clears it.As on `CreateCampaign`: each group once (`INVALID_VALUE` otherwise), not checked against your groups when saved, and resolved at Start where the stage can (`ENGAGEMENT_GROUPS_UNAVAILABLE` where it can't).
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:
- Engagement groups whose contacts the campaign's emails will also go to (see
CreateCampaign). Replaces the stored list; never clears it.
-
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
Sets the account the campaign's social posts publish from, per platform. Each platform named replaces that platform's choice; a platform not named keeps its own. Replaces, never clears.
Not checked against your connections here: a connection can be deleted at any time, so the activation checks the choice. See `Campaign$SocialConnections`.
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:
- Sets the account the campaign's social posts publish from, per platform. Each platform named replaces that platform's choice; a platform not named keeps its own. Replaces, never clears.
-
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.
-
clientToken
Idempotency token. Accepted and not stored: this is a change-only partial update with last-writer-wins, so re-applying the same call produces the same result and the same response. There is nothing a replay cache would protect.
- Returns:
- Idempotency token. Accepted and not stored: this is a change-only partial update with last-writer-wins, so re-applying the same call produces the same result and the same response. There is nothing a replay cache would protect.
-
startOn
The first day of the campaign's run window. Not after
EndOn(ValidationException,INVALID_VALUE).- Returns:
- The first day of the campaign's run window. Not after
EndOn(ValidationException,INVALID_VALUE).
-
endOn
The last day of the campaign's run window, inclusive and in UTC.
Editable only while the campaign is open, like everything else here: once the stored
EndOnhas passed the campaign is completed and this update is refused (CAMPAIGN_COMPLETED). Refused withValidationException(INVALID_VALUE) when it is in the past, or earlier than the day of a scheduled send on one of the campaign's assets: move or cancel that send first. Setting it to today ends the campaign at the next UTC midnight.- Returns:
- The last day of the campaign's run window, inclusive and in UTC.
Editable only while the campaign is open, like everything else here: once the stored
EndOnhas passed the campaign is completed and this update is refused (CAMPAIGN_COMPLETED). Refused withValidationException(INVALID_VALUE) when it is in the past, or earlier than the day of a scheduled send on one of the campaign's assets: move or cancel that send first. Setting it to today ends the campaign at the next UTC midnight.
-
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<UpdateCampaignRequest.Builder,UpdateCampaignRequest> - Specified by:
toBuilderin classPartnerCentralMarketingRequest- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCodein classAwsRequest
-
equals
- Overrides:
equalsin classAwsRequest
-
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
Description copied from class:SdkRequestUsed to retrieve the value of a field from any class that extendsSdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)method will again be available.- Overrides:
getValueForFieldin classSdkRequest- Parameters:
fieldName- The name of the member to be retrieved.clazz- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-
socialConnections
Sets the account the campaign's social posts publish from, per platform. Each platform named replaces that platform's choice; a platform not named keeps its own. Replaces, never clears.
Not checked against your connections here: a connection can be deleted at any time, so the activation checks the choice. See `Campaign$SocialConnections`.
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.