Class BatchCreateCampaignAssetResponse
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<BatchCreateCampaignAssetResponse.Builder,BatchCreateCampaignAssetResponse>
Output for BatchCreateCampaignAsset.
Per-entry, per AWS Batch Operations. Errors is required and is empty rather than absent on a fully
successful call; Successful is the success list the standard makes optional, and DG returns it because a
client otherwise cannot learn the ids that were created.
Status is 200 whenever entries were processed individually -- including when every entry failed, since the batch itself succeeded and the entries did not. A 4xx means the batch could not be attempted as a whole and nothing was written.
A partial batch is a real state and the recovery is to re-send the same entry list: an entry is idempotent by
identity (I-15/I-16), so what landed no-ops and what did not gets created. An already-existing asset is therefore a
Successful row, not an error -- were it an error, a client looping until Errors is empty
would never terminate.
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionbuilder()final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.errors()One entry per blueprint that could not be instantiated.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 Errors property.final inthashCode()final booleanFor responses, this returns true if the service returned a value for the Successful property.static Class<? extends BatchCreateCampaignAssetResponse.Builder> One entry per asset that exists as a result of this call, whether created here or already present.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
-
hasErrors
public final boolean hasErrors()For responses, this returns true if the service returned a value for the Errors 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. -
errors
One entry per blueprint that could not be instantiated. Empty, never absent, when all entries succeeded.
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
hasErrors()method.- Returns:
- One entry per blueprint that could not be instantiated. Empty, never absent, when all entries succeeded.
-
hasSuccessful
public final boolean hasSuccessful()For responses, this returns true if the service returned a value for the Successful 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. -
successful
One entry per asset that exists as a result of this call, whether created here or already present.
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
hasSuccessful()method.- Returns:
- One entry per asset that exists as a result of this call, whether created here or already present.
-
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<BatchCreateCampaignAssetResponse.Builder,BatchCreateCampaignAssetResponse> - Specified by:
toBuilderin classAwsResponse- Returns:
- a builder for type T
-
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.
-