Class DeactivateCampaignAssetResponse

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

@Generated("software.amazon.awssdk:codegen") public final class DeactivateCampaignAssetResponse extends PartnerCentralMarketingResponse implements 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.

  • Method Details

    • id

      public final String id()

      The asset identifier.

      Returns:
      The asset identifier.
    • state

      public final CampaignAssetState 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, state will return CampaignAssetState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

      Returns:
      The asset's lifecycle position — INACTIVE once the stop is confirmed.
      See Also:
    • stateAsString

      public final String 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, state will return CampaignAssetState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

      Returns:
      The asset's lifecycle position — INACTIVE once the stop is confirmed.
      See Also:
    • lastActivationStatus

      public final AttemptStatus 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, lastActivationStatus will return AttemptStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from lastActivationStatusAsString().

      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

      public final String 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, lastActivationStatus will return AttemptStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from lastActivationStatusAsString().

      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

      public final CampaignAssetStateReason 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, stateReason will return CampaignAssetStateReason.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateReasonAsString().

      Returns:
      Why the asset sits where it does. Present when LastActivationStatus is FAILED, or on a deliberate INACTIVE.
      See Also:
    • stateReasonAsString

      public final String 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, stateReason will return CampaignAssetStateReason.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateReasonAsString().

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

      public static DeactivateCampaignAssetResponse.Builder builder()
    • serializableBuilderClass

      public static Class<? extends DeactivateCampaignAssetResponse.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.