Class ListCampaignsRequest

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

@Generated("software.amazon.awssdk:codegen") public final class ListCampaignsRequest extends PartnerCentralMarketingRequest implements 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.

  • 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:
    • 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 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.
    • campaignIdentifiers

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

      public final String name()

      Only campaigns whose name contains this, compared case-insensitively.

      Returns:
      Only campaigns whose name contains this, compared case-insensitively.
    • states

      public final List<CampaignState> 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 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.
    • statesAsStrings

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

      public final CampaignSort sort()

      The order of the results. Default: CREATED_AT, DESCENDING.

      Returns:
      The order of the results. Default: CREATED_AT, DESCENDING.
    • maxResults

      public final Integer maxResults()

      Maximum results per page.

      Returns:
      Maximum results per page.
    • nextToken

      public final String nextToken()

      Pagination token. Bound to the filters and sort it was issued for: a request that changes CampaignIdentifiers, Name, States or Sort between pages is refused with ValidationException. MaxResults may change.

      Returns:
      Pagination token. Bound to the filters and sort it was issued for: a request that changes CampaignIdentifiers, Name, States or Sort between pages is refused with ValidationException. MaxResults may change.
    • toBuilder

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

      public static ListCampaignsRequest.Builder builder()
    • serializableBuilderClass

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