Class UpdateCampaignAssetResponse

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

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

Output for UpdateCampaignAsset.

A minimal acknowledgment, not an echo. Read GetCampaignAsset for the applied values (FieldValues).

  • Method Details

    • id

      public final String id()

      The asset identifier.

      Returns:
      The asset identifier.
    • state

      public final CampaignAssetState state()

      The asset's state, unchanged.

      An update never moves it, so a live asset stays ACTIVE while its edited values take effect for the next activation. There is no edit-outcome member: a 200 means every submitted value applied, and every failure is a refusal on the call itself (DG-040 Decision 11).

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

      Returns:
      The asset's state, unchanged.

      An update never moves it, so a live asset stays ACTIVE while its edited values take effect for the next activation. There is no edit-outcome member: a 200 means every submitted value applied, and every failure is a refusal on the call itself (DG-040 Decision 11).

      See Also:
    • stateAsString

      public final String stateAsString()

      The asset's state, unchanged.

      An update never moves it, so a live asset stays ACTIVE while its edited values take effect for the next activation. There is no edit-outcome member: a 200 means every submitted value applied, and every failure is a refusal on the call itself (DG-040 Decision 11).

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

      Returns:
      The asset's state, unchanged.

      An update never moves it, so a live asset stays ACTIVE while its edited values take effect for the next activation. There is no edit-outcome member: a 200 means every submitted value applied, and every failure is a refusal on the call itself (DG-040 Decision 11).

      See Also:
    • 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 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.
    • activationIssues

      public final List<ActivationIssue> activationIssues()

      What must be fixed on this asset before it can be activated. Empty when the asset is ready.

      Issues don't block saving: an asset can be saved incomplete and fixed over several updates. StartCampaignAssetActivationTask refuses an asset that still has issues: an issue blocks activation when only an edit to the asset can change the outcome. Most issues name the field to fix in FieldId. Fix it with UpdateCampaignAsset, then read this list again.

      Besides the issues computed from the asset's content, the list carries what the last activation found: CONTENT_REJECTED and PARTNER_IMAGE_REJECTED when moderation refused a field. Editing that field removes its issue. A CONTENT_REJECTED without a FieldId means the text was refused as a whole; editing any text field removes it.

      Problems with the campaign's own settings, such as a missing recipient list, and with the partner's profile, such as a missing logo, are reported on Campaign.ActivationIssues, not here.

      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:
      What must be fixed on this asset before it can be activated. Empty when the asset is ready.

      Issues don't block saving: an asset can be saved incomplete and fixed over several updates. StartCampaignAssetActivationTask refuses an asset that still has issues: an issue blocks activation when only an edit to the asset can change the outcome. Most issues name the field to fix in FieldId. Fix it with UpdateCampaignAsset, then read this list again.

      Besides the issues computed from the asset's content, the list carries what the last activation found: CONTENT_REJECTED and PARTNER_IMAGE_REJECTED when moderation refused a field. Editing that field removes its issue. A CONTENT_REJECTED without a FieldId means the text was refused as a whole; editing any text field removes it.

      Problems with the campaign's own settings, such as a missing recipient list, and with the partner's profile, such as a missing logo, are reported on Campaign.ActivationIssues, not here.

    • 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<UpdateCampaignAssetResponse.Builder,UpdateCampaignAssetResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T
    • builder

      public static UpdateCampaignAssetResponse.Builder builder()
    • serializableBuilderClass

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

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

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse
    • 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: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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.