Class ListMarketplaceRevenueShareAllocationsRequest

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.ListMarketplaceRevenueShareAllocationsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ListMarketplaceRevenueShareAllocationsRequest.Builder,ListMarketplaceRevenueShareAllocationsRequest>
@Generated("software.amazon.awssdk:codegen") public final class ListMarketplaceRevenueShareAllocationsRequest extends PartnerCentralRevenueMeasurementRequest implements ToCopyableBuilder<ListMarketplaceRevenueShareAllocationsRequest.Builder,ListMarketplaceRevenueShareAllocationsRequest>

  • Method Details

    • catalog

      public final CatalogName catalog()

      The catalog containing the allocations.

      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 containing the allocations.
      See Also:

    • catalogAsString

      public final String catalogAsString()

      The catalog containing the allocations.

      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 containing the allocations.
      See Also:

    • productId

      public final String productId()

      The AWS Marketplace product identifier for the parent revenue share.

      Returns:
      The AWS Marketplace product identifier for the parent revenue share.

    • status

      public final AllocationStatus status()

      Filter by allocation status.

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

      Returns:
      Filter by allocation status.
      See Also:

    • statusAsString

      public final String statusAsString()

      Filter by allocation status.

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

      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).

    • sortBy

      public final MarketplaceRevenueShareAllocationSortField sortBy()

      The field to sort marketplace revenue share allocations by.

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

      Returns:
      The field to sort marketplace revenue share allocations by.
      See Also:

    • sortByAsString

      public final String sortByAsString()

      The field to sort marketplace revenue share allocations by.

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

      Returns:
      The field to sort marketplace revenue share allocations by.
      See Also:

    • sortOrder

      public final SortOrder sortOrder()

      The direction to sort results. Defaults to DESCENDING.

      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:
      The direction to sort results. Defaults to DESCENDING.
      See Also:

    • sortOrderAsString

      public final String sortOrderAsString()

      The direction to sort results. Defaults to DESCENDING.

      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:
      The direction to sort results. Defaults to DESCENDING.
      See Also:

    • maxResults

      public final Integer maxResults()

      Maximum number of results per page.

      Returns:
      Maximum number of results per page.

    • nextToken

      public final String nextToken()

      Pagination token from a previous response.

      Returns:
      Pagination token from a previous response.

    • marketplaceRevenueShareRevision

      public final String marketplaceRevenueShareRevision()

      Optional share revision for historical list. Returns allocations as they existed at this revision.

      Returns:
      Optional share revision for historical list. Returns allocations as they existed at this revision.

    • toBuilder

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

    • builder

      public static ListMarketplaceRevenueShareAllocationsRequest.Builder builder()

    • serializableBuilderClass

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