Class ListRevenueAttributionAllocationsRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.partnercentralrevenuemeasurement.model.PartnerCentralRevenueMeasurementRequest
software.amazon.awssdk.services.partnercentralrevenuemeasurement.model.ListRevenueAttributionAllocationsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ListRevenueAttributionAllocationsRequest.Builder,ListRevenueAttributionAllocationsRequest>
@Generated("software.amazon.awssdk:codegen") public final class ListRevenueAttributionAllocationsRequest extends PartnerCentralRevenueMeasurementRequest implements ToCopyableBuilder<ListRevenueAttributionAllocationsRequest.Builder,ListRevenueAttributionAllocationsRequest>

  • Method Details

    • catalog

      public final CatalogName catalog()

      The catalog that contains the resource.

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

      Returns:
      The catalog that contains the resource.
      See Also:

    • catalogAsString

      public final String catalogAsString()

      The catalog that contains the resource.

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

      Returns:
      The catalog that contains the resource.
      See Also:

    • revenueAttributionIdentifier

      public final String revenueAttributionIdentifier()

      The revenue attribution identifier to query.

      Returns:
      The revenue attribution identifier to query.

    • entityTypeFilters

      public final List<EntityType> entityTypeFilters()

      Filter by deal entity types.

      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 hasEntityTypeFilters() method.

      Returns:
      Filter by deal entity types.

    • hasEntityTypeFilters

      public final boolean hasEntityTypeFilters()
      For responses, this returns true if the service returned a value for the EntityTypeFilters 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.

    • entityTypeFiltersAsStrings

      public final List<String> entityTypeFiltersAsStrings()

      Filter by deal entity types.

      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 hasEntityTypeFilters() method.

      Returns:
      Filter by deal entity types.

    • hasEntityIdentifierFilters

      public final boolean hasEntityIdentifierFilters()
      For responses, this returns true if the service returned a value for the EntityIdentifierFilters 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.

    • entityIdentifierFilters

      public final List<String> entityIdentifierFilters()

      Filter by deal entity identifiers.

      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 hasEntityIdentifierFilters() method.

      Returns:
      Filter by deal entity identifiers.

    • hasCustomerAwsAccountIdFilters

      public final boolean hasCustomerAwsAccountIdFilters()
      For responses, this returns true if the service returned a value for the CustomerAwsAccountIdFilters 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.

    • customerAwsAccountIdFilters

      public final List<String> customerAwsAccountIdFilters()

      Filter by customer AWS account IDs for associated deal entities.

      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 hasCustomerAwsAccountIdFilters() method.

      Returns:
      Filter by customer AWS account IDs for associated deal entities.

    • statusFilter

      public final AllocationStatus statusFilter()

      Filter by allocation status.

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

      Returns:
      Filter by allocation status.
      See Also:

    • statusFilterAsString

      public final String statusFilterAsString()

      Filter by allocation status.

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

      Returns:
      Filter by allocation status.
      See Also:

    • afterEffectiveFrom

      public final String afterEffectiveFrom()

      Inclusive lower bound for EffectiveFrom date filter.

      Returns:
      Inclusive lower bound for EffectiveFrom date filter.

    • beforeEffectiveFrom

      public final String beforeEffectiveFrom()

      Exclusive upper bound for EffectiveFrom date filter (half-open range).

      Returns:
      Exclusive upper bound for EffectiveFrom date filter (half-open range).

    • afterEffectiveUntil

      public final String afterEffectiveUntil()

      Inclusive lower bound for EffectiveUntil date filter.

      Returns:
      Inclusive lower bound for EffectiveUntil date filter.

    • beforeEffectiveUntil

      public final String beforeEffectiveUntil()

      Exclusive upper bound for EffectiveUntil date filter (half-open range).

      Returns:
      Exclusive upper bound for EffectiveUntil date filter (half-open range).

    • sortBy

      public final RevenueAttributionAllocationSortField sortBy()

      Field to sort by.

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

      Returns:
      Field to sort by.
      See Also:

    • sortByAsString

      public final String sortByAsString()

      Field to sort by.

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

      Returns:
      Field to sort by.
      See Also:

    • sortOrder

      public final SortOrder sortOrder()

      Sort direction. Defaults to ASCENDING.

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

      Returns:
      Sort direction. Defaults to ASCENDING.
      See Also:

    • sortOrderAsString

      public final String sortOrderAsString()

      Sort direction. Defaults to ASCENDING.

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

      Returns:
      Sort direction. Defaults to ASCENDING.
      See Also:

    • revenueAttributionRevision

      public final String revenueAttributionRevision()

      Point-in-time revision number to query.

      Returns:
      Point-in-time revision number to query.

    • maxResults

      public final Integer maxResults()

      Maximum results per page.

      Returns:
      Maximum results per page.

    • nextToken

      public final String nextToken()

      Pagination token from previous response.

      Returns:
      Pagination token from previous response.

    • toBuilder

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

    • builder

      public static ListRevenueAttributionAllocationsRequest.Builder builder()

    • serializableBuilderClass

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