Class GetCampaignAssetExportTaskRequest
- All Implemented Interfaces:
SdkPojo,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.
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionbuilder()final StringThe export task to retrieve: theIdStartCampaignAssetExportTask returned (etsk-…).final StringThe campaign that owns the export task.final Catalogcatalog()The catalog (AWS or Sandbox).final StringThe catalog (AWS or Sandbox).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 extendsSdkRequest.final inthashCode()static Class<? extends GetCampaignAssetExportTaskRequest.Builder> 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.awscore.AwsRequest
overrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
catalog
The catalog (AWS or Sandbox).
If the service returns an enum value that is not available in the current SDK version,
catalogwill returnCatalog.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromcatalogAsString().- Returns:
- The catalog (AWS or Sandbox).
- See Also:
-
catalogAsString
The catalog (AWS or Sandbox).
If the service returns an enum value that is not available in the current SDK version,
catalogwill returnCatalog.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromcatalogAsString().- Returns:
- The catalog (AWS or Sandbox).
- See Also:
-
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
The export task to retrieve: the
IdStartCampaignAssetExportTask 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
IdStartCampaignAssetExportTask 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:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<GetCampaignAssetExportTaskRequest.Builder,GetCampaignAssetExportTaskRequest> - Specified by:
toBuilderin classPartnerCentralMarketingRequest- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCodein classAwsRequest
-
equals
- Overrides:
equalsin classAwsRequest
-
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:SdkRequestUsed to retrieve the value of a field from any class that extendsSdkRequest. 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, theSdkRequest.getValueForField(String, Class)method will again be available.- Overrides:
getValueForFieldin classSdkRequest- 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.
-