Class SearchProductsAsAdminRequest

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

@Generated("software.amazon.awssdk:codegen") public final class SearchProductsAsAdminRequest extends ServiceCatalogRequest implements ToCopyableBuilder<SearchProductsAsAdminRequest.Builder,SearchProductsAsAdminRequest>
  • Method Details

    • acceptLanguage

      public final String acceptLanguage()

      The language code.

      • jp - Japanese

      • zh - Chinese

      Returns:
      The language code.

      • jp - Japanese

      • zh - Chinese

    • portfolioId

      public final String portfolioId()

      The portfolio identifier.

      Returns:
      The portfolio identifier.
    • filters

      public final Map<ProductViewFilterBy,List<String>> filters()

      The search filters. If no search filters are specified, the output includes all products to which the administrator has access.

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

      Returns:
      The search filters. If no search filters are specified, the output includes all products to which the administrator has access.
    • hasFilters

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

      public final Map<String,List<String>> filtersAsStrings()

      The search filters. If no search filters are specified, the output includes all products to which the administrator has access.

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

      Returns:
      The search filters. If no search filters are specified, the output includes all products to which the administrator has access.
    • sortBy

      public final ProductViewSortBy sortBy()

      The sort field. If no value is specified, the results are not sorted.

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

      Returns:
      The sort field. If no value is specified, the results are not sorted.
      See Also:
    • sortByAsString

      public final String sortByAsString()

      The sort field. If no value is specified, the results are not sorted.

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

      Returns:
      The sort field. If no value is specified, the results are not sorted.
      See Also:
    • sortOrder

      public final SortOrder sortOrder()

      The sort order. If no value is specified, the results are not sorted.

      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 sort order. If no value is specified, the results are not sorted.
      See Also:
    • sortOrderAsString

      public final String sortOrderAsString()

      The sort order. If no value is specified, the results are not sorted.

      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 sort order. If no value is specified, the results are not sorted.
      See Also:
    • pageToken

      public final String pageToken()

      The page token for the next set of results. To retrieve the first set of results, use null.

      Returns:
      The page token for the next set of results. To retrieve the first set of results, use null.
    • pageSize

      public final Integer pageSize()

      The maximum number of items to return with this call.

      Returns:
      The maximum number of items to return with this call.
    • productSource

      public final ProductSource productSource()

      Access level of the source of the product.

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

      Returns:
      Access level of the source of the product.
      See Also:
    • productSourceAsString

      public final String productSourceAsString()

      Access level of the source of the product.

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

      Returns:
      Access level of the source of the product.
      See Also:
    • 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<SearchProductsAsAdminRequest.Builder,SearchProductsAsAdminRequest>
      Specified by:
      toBuilder in class ServiceCatalogRequest
      Returns:
      a builder for type T
    • builder

      public static SearchProductsAsAdminRequest.Builder builder()
    • serializableBuilderClass

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