Class GetCampaignAssetActivationTaskResponse

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

@Generated("software.amazon.awssdk:codegen") public final class GetCampaignAssetActivationTaskResponse extends PartnerCentralMarketingResponse implements ToCopyableBuilder<GetCampaignAssetActivationTaskResponse.Builder,GetCampaignAssetActivationTaskResponse>

Output for GetCampaignAssetActivationTask: the campaign's most recent task.

  • Method Details

    • campaignId

      public final String campaignId()

      The campaign's id. Canonical: because CampaignIdentifier accepts an id or an ARN, echoing this tells a caller who passed an ARN what the id is. The task's own id is TaskId.

      Returns:
      The campaign's id. Canonical: because CampaignIdentifier accepts an id or an ARN, echoing this tells a caller who passed an ARN what the id is. The task's own id is TaskId.
    • taskId

      public final String 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

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

      Returns:
      The task's status over every asset it names, refused ones included: one refused and one succeeded is PARTIAL_FAILURE.
      See Also:
    • taskStatusAsString

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

      Returns:
      The task's status over every asset it names, refused ones included: one refused and one succeeded is PARTIAL_FAILURE.
      See Also:
    • startedAt

      public final Instant startedAt()

      When the task was created.

      Returns:
      When the task was created.
    • endedAt

      public final Instant 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 the isEmpty() 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

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

    • serializableBuilderClass

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