Class UpdateCampaignRequest

All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateCampaignRequest.Builder,UpdateCampaignRequest>

@Generated("software.amazon.awssdk:codegen") public final class UpdateCampaignRequest extends PartnerCentralMarketingRequest implements ToCopyableBuilder<UpdateCampaignRequest.Builder,UpdateCampaignRequest>

Input for UpdateCampaign operation.

  • Method Details

    • catalog

      public final Catalog catalog()

      The catalog (AWS or Sandbox).

      If the service returns an enum value that is not available in the current SDK version, catalog will return Catalog.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from catalogAsString().

      Returns:
      The catalog (AWS or Sandbox).
      See Also:
    • catalogAsString

      public final String catalogAsString()

      The catalog (AWS or Sandbox).

      If the service returns an enum value that is not available in the current SDK version, catalog will return Catalog.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from catalogAsString().

      Returns:
      The catalog (AWS or Sandbox).
      See Also:
    • campaignIdentifier

      public final String campaignIdentifier()

      The campaign identifier.

      Returns:
      The campaign identifier.
    • name

      public final String name()

      The display name.

      Returns:
      The display name.
    • senderEmail

      public final String 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, and StartCampaignAssetActivationTask re-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, and StartCampaignAssetActivationTask re-checks it before an email activates.

    • privacyPolicyUrl

      public final String 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

      public final String 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

      public final FileRef 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

      public final FileRef 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 the isEmpty() 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

      public final List<String> 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.

    • socialConnections

      public final Map<Platform,List<String>> 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.

      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.

    • 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 the isEmpty() 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

      public final Map<String,List<String>> 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

      public final MonetaryValue estimatedBudget()

      What the partner expects the campaign to cost.

      Returns:
      What the partner expects the campaign to cost.
    • totalBudget

      public final MonetaryValue totalBudget()

      The campaign's total budget.

      Returns:
      The campaign's total budget.
    • targetAudience

      public final TargetAudience targetAudience()

      Target audience configuration.

      Returns:
      Target audience configuration.
    • clientToken

      public final String 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

      public final String 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

      public final String 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 EndOn has passed the campaign is completed and this update is refused (CAMPAIGN_COMPLETED). Refused with ValidationException (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 EndOn has passed the campaign is completed and this update is refused (CAMPAIGN_COMPLETED). Refused with ValidationException (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

      public UpdateCampaignRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<UpdateCampaignRequest.Builder,UpdateCampaignRequest>
      Specified by:
      toBuilder in class PartnerCentralMarketingRequest
      Returns:
      a builder for type T
    • builder

      public static UpdateCampaignRequest.Builder builder()
    • serializableBuilderClass

      public static Class<? extends UpdateCampaignRequest.Builder> serializableBuilderClass()
    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest
    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest
    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.
    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object
    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.
    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.