Class UpdateCampaignAssetResponse
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<UpdateCampaignAssetResponse.Builder,UpdateCampaignAssetResponse>
Output for UpdateCampaignAsset.
A minimal acknowledgment, not an echo. Read GetCampaignAsset for the applied values (FieldValues).
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal List<ActivationIssue> What must be fixed on this asset before it can be activated.builder()final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse.final booleanFor responses, this returns true if the service returned a value for the ActivationIssues property.final inthashCode()final Stringid()The asset identifier.static Class<? extends UpdateCampaignAssetResponse.Builder> final CampaignAssetStatestate()The asset's state, unchanged.final StringThe asset's state, unchanged.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.Methods inherited from class software.amazon.awssdk.services.partnercentralmarketing.model.PartnerCentralMarketingResponse
responseMetadataMethods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponseMethods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
id
-
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,
statewill returnCampaignAssetState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstateAsString().- 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
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,
statewill returnCampaignAssetState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstateAsString().- 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 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
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.
StartCampaignAssetActivationTaskrefuses 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 inFieldId. Fix it withUpdateCampaignAsset, then read this list again.Besides the issues computed from the asset's content, the list carries what the last activation found:
CONTENT_REJECTEDandPARTNER_IMAGE_REJECTEDwhen moderation refused a field. Editing that field removes its issue. ACONTENT_REJECTEDwithout aFieldIdmeans 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.
StartCampaignAssetActivationTaskrefuses 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 inFieldId. Fix it withUpdateCampaignAsset, then read this list again.Besides the issues computed from the asset's content, the list carries what the last activation found:
CONTENT_REJECTEDandPARTNER_IMAGE_REJECTEDwhen moderation refused a field. Editing that field removes its issue. ACONTENT_REJECTEDwithout aFieldIdmeans 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:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<UpdateCampaignAssetResponse.Builder,UpdateCampaignAssetResponse> - Specified by:
toBuilderin classAwsResponse- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCodein classAwsResponse
-
equals
- Overrides:
equalsin classAwsResponse
-
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:SdkResponseUsed to retrieve the value of a field from any class that extendsSdkResponse. 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, theSdkResponse.getValueForField(String, Class)method will again be available.- Overrides:
getValueForFieldin classSdkResponse- 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.
-