Class GetCampaignAssetActivationTaskResponse
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<GetCampaignAssetActivationTaskResponse.Builder,GetCampaignAssetActivationTaskResponse>
Output for GetCampaignAssetActivationTask: the campaign's most recent task.
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionassets()One entry per asset the request named, in the order named.builder()final StringThe campaign's id.final InstantendedAt()When the task reached a terminal status.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 Assets property.final inthashCode()static Class<? extends GetCampaignAssetActivationTaskResponse.Builder> final InstantWhen the task was created.final StringtaskId()Opaque correlation value for the task.The task's status over every asset it names, refused ones included: one refused and one succeeded is PARTIAL_FAILURE.final StringThe task's status over every asset it names, refused ones included: one refused and one succeeded is PARTIAL_FAILURE.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
-
campaignId
The campaign's id. Canonical: because
CampaignIdentifieraccepts an id or an ARN, echoing this tells a caller who passed an ARN what the id is. The task's own id isTaskId.- Returns:
- The campaign's id. Canonical: because
CampaignIdentifieraccepts an id or an ARN, echoing this tells a caller who passed an ARN what the id is. The task's own id isTaskId.
-
taskId
Opaque correlation value for the task. Echoed so a caller can tell the task it started from a later one that superseded it. Never an input: the campaign is what addresses a task, because a campaign has at most one.
- Returns:
- Opaque correlation value for the task. Echoed so a caller can tell the task it started from a later one that superseded it. Never an input: the campaign is what addresses a task, because a campaign has at most one.
-
taskStatus
The task's status over every asset it names, refused ones included: one refused and one succeeded is PARTIAL_FAILURE.
If the service returns an enum value that is not available in the current SDK version,
taskStatuswill returnCampaignAssetActivationTaskStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtaskStatusAsString().- Returns:
- The task's status over every asset it names, refused ones included: one refused and one succeeded is PARTIAL_FAILURE.
- See Also:
-
taskStatusAsString
The task's status over every asset it names, refused ones included: one refused and one succeeded is PARTIAL_FAILURE.
If the service returns an enum value that is not available in the current SDK version,
taskStatuswill returnCampaignAssetActivationTaskStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtaskStatusAsString().- Returns:
- The task's status over every asset it names, refused ones included: one refused and one succeeded is PARTIAL_FAILURE.
- See Also:
-
startedAt
-
endedAt
When the task reached a terminal status. Absent while IN_PROGRESS.
- Returns:
- When the task reached a terminal status. Absent while IN_PROGRESS.
-
hasAssets
public final boolean hasAssets()For responses, this returns true if the service returned a value for the Assets 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. -
assets
One entry per asset the request named, in the order named. An asset refused up front is FAILED from the first response, with its reason.
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
hasAssets()method.- Returns:
- One entry per asset the request named, in the order named. An asset refused up front is FAILED from the first response, with its reason.
-
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<GetCampaignAssetActivationTaskResponse.Builder,GetCampaignAssetActivationTaskResponse> - Specified by:
toBuilderin classAwsResponse- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends GetCampaignAssetActivationTaskResponse.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.
-