Class DeactivateCampaignAssetResponse
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<DeactivateCampaignAssetResponse.Builder,DeactivateCampaignAssetResponse>
Output for DeactivateCampaignAsset.
Synchronous, so the outcome of the stop is this response — there is no lastDeactivationStatus, and its
absence is not an oversight. Activation is asynchronous and its outcome arrives long after the response, which is why
that one has to be persisted where a partner can read it later.
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionbuilder()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 inthashCode()final Stringid()The asset identifier.final AttemptStatusHow the most recent activation attempt ended, which a stop does not change.final StringHow the most recent activation attempt ended, which a stop does not change.static Class<? extends DeactivateCampaignAssetResponse.Builder> final CampaignAssetStatestate()The asset's lifecycle position — INACTIVE once the stop is confirmed.final StringThe asset's lifecycle position — INACTIVE once the stop is confirmed.final CampaignAssetStateReasonWhy the asset sits where it does.final StringWhy the asset sits where it does.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 lifecycle position — INACTIVE once the stop is confirmed.
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 lifecycle position — INACTIVE once the stop is confirmed.
- See Also:
-
stateAsString
The asset's lifecycle position — INACTIVE once the stop is confirmed.
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 lifecycle position — INACTIVE once the stop is confirmed.
- See Also:
-
lastActivationStatus
How the most recent activation attempt ended, which a stop does not change. Read with state, it is what separates a stopped asset (INACTIVE + SUCCEEDED) from one never activated (INACTIVE, this member absent). Omitted until a first activation has been attempted.
If the service returns an enum value that is not available in the current SDK version,
lastActivationStatuswill returnAttemptStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromlastActivationStatusAsString().- Returns:
- How the most recent activation attempt ended, which a stop does not change. Read with state, it is what separates a stopped asset (INACTIVE + SUCCEEDED) from one never activated (INACTIVE, this member absent). Omitted until a first activation has been attempted.
- See Also:
-
lastActivationStatusAsString
How the most recent activation attempt ended, which a stop does not change. Read with state, it is what separates a stopped asset (INACTIVE + SUCCEEDED) from one never activated (INACTIVE, this member absent). Omitted until a first activation has been attempted.
If the service returns an enum value that is not available in the current SDK version,
lastActivationStatuswill returnAttemptStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromlastActivationStatusAsString().- Returns:
- How the most recent activation attempt ended, which a stop does not change. Read with state, it is what separates a stopped asset (INACTIVE + SUCCEEDED) from one never activated (INACTIVE, this member absent). Omitted until a first activation has been attempted.
- See Also:
-
stateReason
Why the asset sits where it does. Present when LastActivationStatus is FAILED, or on a deliberate INACTIVE.
If the service returns an enum value that is not available in the current SDK version,
stateReasonwill returnCampaignAssetStateReason.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstateReasonAsString().- Returns:
- Why the asset sits where it does. Present when LastActivationStatus is FAILED, or on a deliberate INACTIVE.
- See Also:
-
stateReasonAsString
Why the asset sits where it does. Present when LastActivationStatus is FAILED, or on a deliberate INACTIVE.
If the service returns an enum value that is not available in the current SDK version,
stateReasonwill returnCampaignAssetStateReason.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstateReasonAsString().- Returns:
- Why the asset sits where it does. Present when LastActivationStatus is FAILED, or on a deliberate INACTIVE.
- See Also:
-
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<DeactivateCampaignAssetResponse.Builder,DeactivateCampaignAssetResponse> - 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.
-