Class CampaignSummary

java.lang.Object
software.amazon.awssdk.services.partnercentralmarketing.model.CampaignSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<CampaignSummary.Builder,CampaignSummary>

@Generated("software.amazon.awssdk:codegen") public final class CampaignSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CampaignSummary.Builder,CampaignSummary>

Summary representation of a campaign for list operations.

See Also:
  • Method Details

    • campaignId

      public final String campaignId()

      The campaign identifier.

      Returns:
      The campaign identifier.
    • arn

      public final String arn()

      The campaign ARN. Present on the summary so a caller can tag a campaign straight from a list result without a GetCampaign per row — the same reason the audit timestamps are here.

      Returns:
      The campaign ARN. Present on the summary so a caller can tag a campaign straight from a list result without a GetCampaign per row — the same reason the audit timestamps are here.
    • name

      public final String name()

      The display name.

      Returns:
      The display name.
    • state

      public final CampaignState state()

      The campaign's state, derived on every read from EndOn and its assets. See CampaignState.

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

      Returns:
      The campaign's state, derived on every read from EndOn and its assets. See CampaignState.
      See Also:
    • stateAsString

      public final String stateAsString()

      The campaign's state, derived on every read from EndOn and its assets. See CampaignState.

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

      Returns:
      The campaign's state, derived on every read from EndOn and its assets. See CampaignState.
      See Also:
    • language

      public final AssetLanguage language()

      The language the campaign's assets are written and typeset in. See Campaign$Language.

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

      Returns:
      The language the campaign's assets are written and typeset in. See Campaign$Language.
      See Also:
    • languageAsString

      public final String languageAsString()

      The language the campaign's assets are written and typeset in. See Campaign$Language.

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

      Returns:
      The language the campaign's assets are written and typeset in. See Campaign$Language.
      See Also:
    • startOn

      public final String startOn()

      The first day of the campaign's run window.

      Returns:
      The first day of the campaign's run window.
    • endOn

      public final String endOn()

      The last day of the campaign's run window.

      Returns:
      The last day of the campaign's run window.
    • createdAt

      public final Instant createdAt()

      Creation timestamp. Present on the summary so a caller can order a list by recency without reading each campaign in full.

      Returns:
      Creation timestamp. Present on the summary so a caller can order a list by recency without reading each campaign in full.
    • updatedAt

      public final Instant updatedAt()

      Last update timestamp. Present on the summary for the same reason as CreatedAt.

      Returns:
      Last update timestamp. Present on the summary for the same reason as CreatedAt.
    • toBuilder

      public CampaignSummary.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<CampaignSummary.Builder,CampaignSummary>
      Returns:
      a builder for type T
    • builder

      public static CampaignSummary.Builder builder()
    • serializableBuilderClass

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

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

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object
    • 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)
    • 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.