Package com.adobe.aco.model

Class FeedMetadata

  • @Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           comments="Generator version: 7.4.0")
public class FeedMetadata
extends Object
    Metadata information for a product attribute.

    • Constructor Detail

      • FeedMetadata

        public FeedMetadata()

    • Method Detail

      • getCode

        @Nonnull
public String getCode()
        Attribute code
        Returns:
        code

      • setCode

        public void setCode​(String code)

      • getSource

        @Nonnull
public Source getSource()
        Get source
        Returns:
        source

      • setSource

        public void setSource​(Source source)

      • getVisibleIn

        @Nullable
public List<FeedMetadata.VisibleInEnum> getVisibleIn()
        Determines how the attribute is used on the storefront. * `PRODUCT_DETAIL`: Product attribute is visible on the Product Detail Page. * `PRODUCT_LISTING`: Product attribute is visible on Product Listing Page. * `SEARCH_RESULTS`: Product attribute is visible on Search Results Page. * `PRODUCT_COMPARE`: Product attribute is visible on Product Compare Page.
        Returns:
        visibleIn

      • getLabel

        @Nonnull
public String getLabel()
        Label for the attribute that is displayed in user interfaces.
        Returns:
        label

      • setLabel

        public void setLabel​(String label)

      • getFilterable

        @Nullable
public Boolean getFilterable()
        Indicates whether the attribute can be used to filter products.
        Returns:
        filterable

      • setFilterable

        public void setFilterable​(Boolean filterable)

      • getSortable

        @Nullable
public Boolean getSortable()
        Indicates whether the attribute can be used to sort products.
        Returns:
        sortable

      • setSortable

        public void setSortable​(Boolean sortable)

      • getSearchable

        @Nullable
public Boolean getSearchable()
        Indicates whether the attribute value can be used in search queries to filter results.
        Returns:
        searchable

      • setSearchable

        public void setSearchable​(Boolean searchable)

      • getSearchWeight

        @Nullable
public Float getSearchWeight()
        The weight associated with a searchable attribute. Attributes with a greater weight are returned before attributes with a lower weight.
        Returns:
        searchWeight

      • setSearchWeight

        public void setSearchWeight​(Float searchWeight)

      • getSearchTypes

        @Nullable
public List<FeedMetadata.SearchTypesEnum> getSearchTypes()
        Search types associated with this attribute, for example: `autocomplete`, `starts_with`, and so on.
        Returns:
        searchTypes

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • validateJsonElement

        public static void validateJsonElement​(com.google.gson.JsonElement jsonElement)
                                throws IOException
        Validates the JSON Element and throws an exception if issues found
        Parameters:
        jsonElement - JSON Element
        Throws:
        IOException - if the JSON Element is invalid with respect to FeedMetadata

      • fromJson

        public static FeedMetadata fromJson​(String jsonString)
                             throws IOException
        Create an instance of FeedMetadata given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of FeedMetadata
        Throws:
        IOException - if the JSON string is invalid with respect to FeedMetadata

      • toJson

        public String toJson()
        Convert an instance of FeedMetadata to an JSON string
        Returns:
        JSON string