Class CampaignSummary
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<CampaignSummary.Builder,CampaignSummary>
Summary representation of a campaign for list operations.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal Stringarn()The campaign ARN.static CampaignSummary.Builderbuilder()final StringThe campaign identifier.final InstantCreation timestamp.final StringendOn()The last day of the campaign's run window.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) final inthashCode()final AssetLanguagelanguage()The language the campaign's assets are written and typeset in.final StringThe language the campaign's assets are written and typeset in.final Stringname()The display name.static Class<? extends CampaignSummary.Builder> final StringstartOn()The first day of the campaign's run window.final CampaignStatestate()The campaign's state, derived on every read fromEndOnand its assets.final StringThe campaign's state, derived on every read fromEndOnand its assets.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.final InstantLast update timestamp.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
campaignId
-
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
-
state
The campaign's state, derived on every read from
EndOnand its assets. SeeCampaignState.If the service returns an enum value that is not available in the current SDK version,
statewill returnCampaignState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstateAsString().- Returns:
- The campaign's state, derived on every read from
EndOnand its assets. SeeCampaignState. - See Also:
-
stateAsString
The campaign's state, derived on every read from
EndOnand its assets. SeeCampaignState.If the service returns an enum value that is not available in the current SDK version,
statewill returnCampaignState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstateAsString().- Returns:
- The campaign's state, derived on every read from
EndOnand its assets. SeeCampaignState. - See Also:
-
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,
languagewill returnAssetLanguage.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromlanguageAsString().- Returns:
- The language the campaign's assets are written and typeset in. See
Campaign$Language. - See Also:
-
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,
languagewill returnAssetLanguage.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromlanguageAsString().- Returns:
- The language the campaign's assets are written and typeset in. See
Campaign$Language. - See Also:
-
startOn
The first day of the campaign's run window.
- Returns:
- The first day of the campaign's run window.
-
endOn
The last day of the campaign's run window.
- Returns:
- The last day of the campaign's run window.
-
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
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
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<CampaignSummary.Builder,CampaignSummary> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
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
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-