Class ListCampaignsRequest
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<ListCampaignsRequest.Builder,ListCampaignsRequest>
Input for ListCampaigns operation.
Filters combine with AND. Results are eventually consistent: a campaign created, renamed or activated a moment ago
can take up to a second to appear with its current values. GetCampaign is strongly consistent.
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionstatic ListCampaignsRequest.Builderbuilder()Only these campaigns, each named by its id or its campaign ARN.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 booleanFor responses, this returns true if the service returned a value for the CampaignIdentifiers property.final inthashCode()final booleanFor responses, this returns true if the service returned a value for the States property.final IntegerMaximum results per page.final Stringname()Only campaigns whose name contains this, compared case-insensitively.final StringPagination token.static Class<? extends ListCampaignsRequest.Builder> final CampaignSortsort()The order of the results.final List<CampaignState> states()Only campaigns in one of these states.Only campaigns in one of these states.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:
-
hasCampaignIdentifiers
public final boolean hasCampaignIdentifiers()For responses, this returns true if the service returned a value for the CampaignIdentifiers 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. -
campaignIdentifiers
Only these campaigns, each named by its id or its campaign ARN. A campaign that does not exist, was deleted, or whose ARN names another account or catalog is left out rather than refused.
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
hasCampaignIdentifiers()method.- Returns:
- Only these campaigns, each named by its id or its campaign ARN. A campaign that does not exist, was deleted, or whose ARN names another account or catalog is left out rather than refused.
-
name
Only campaigns whose name contains this, compared case-insensitively.
- Returns:
- Only campaigns whose name contains this, compared case-insensitively.
-
states
Only campaigns in one of these states.
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
hasStates()method.- Returns:
- Only campaigns in one of these states.
-
hasStates
public final boolean hasStates()For responses, this returns true if the service returned a value for the States 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. -
statesAsStrings
Only campaigns in one of these states.
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
hasStates()method.- Returns:
- Only campaigns in one of these states.
-
sort
The order of the results. Default:
CREATED_AT,DESCENDING.- Returns:
- The order of the results. Default:
CREATED_AT,DESCENDING.
-
maxResults
-
nextToken
Pagination token. Bound to the filters and sort it was issued for: a request that changes
CampaignIdentifiers,Name,StatesorSortbetween pages is refused withValidationException.MaxResultsmay change.- Returns:
- Pagination token. Bound to the filters and sort it was issued for: a request that changes
CampaignIdentifiers,Name,StatesorSortbetween pages is refused withValidationException.MaxResultsmay change.
-
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<ListCampaignsRequest.Builder,ListCampaignsRequest> - 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.
-