Class GetCampaignAssetExportTaskRequest

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

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

Input for GetCampaignAssetExportTask.

Takes the catalog, the owning campaign, and the export task identifier. The campaign identifier is required so the operation can be authorized on the task's owning campaign/{CampaignId}: the task is addressable by its id within the caller's partition, but the campaign is not derivable from the task id alone at authorization time.

  • Method Details

    • catalog

      public final Catalog catalog()

      The catalog (AWS or Sandbox).

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

      Returns:
      The catalog (AWS or Sandbox).
      See Also:
    • catalogAsString

      public final String catalogAsString()

      The catalog (AWS or Sandbox).

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

      Returns:
      The catalog (AWS or Sandbox).
      See Also:
    • campaignIdentifier

      public final String campaignIdentifier()

      The campaign that owns the export task. Accepts the campaign id or ARN. Required so the read is authorized on campaign/{CampaignId}; the task must belong to this campaign or the request resolves to not-found.

      Returns:
      The campaign that owns the export task. Accepts the campaign id or ARN. Required so the read is authorized on campaign/{CampaignId}; the task must belong to this campaign or the request resolves to not-found.
    • campaignAssetExportTaskIdentifier

      public final String campaignAssetExportTaskIdentifier()

      The export task to retrieve: the Id StartCampaignAssetExportTask returned (etsk-…).

      An id only. An export task has no ARN: none is returned, recorded or authorized on (the read authorizes on its campaign), so there is no ARN to accept (DG-063 D-35).

      Returns:
      The export task to retrieve: the Id StartCampaignAssetExportTask returned ( etsk-…).

      An id only. An export task has no ARN: none is returned, recorded or authorized on (the read authorizes on its campaign), so there is no ARN to accept (DG-063 D-35).

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

    • serializableBuilderClass

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

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

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest
    • 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: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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 SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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.