CategoryFilterInput (Magento GraphQL data models and query builders 9.1.0-magento242ee API)

java.lang.Object
- com.adobe.cq.commerce.magento.graphql.CategoryFilterInput

All Implemented Interfaces:

Serializable
```
public class CategoryFilterInput
extends Object
implements Serializable
```
CategoryFilterInput defines the filters to be used in the search. A filter contains at least one attribute, a comparison operator, and the value that is being searched for.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

CategoryFilterInput()

Constructors
Constructor and Description
`CategoryFilterInput()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`appendTo(StringBuilder _queryBuilder)`
`FilterEqualTypeInput`	`getCategoryUid()` Filter by the unique category ID for a `CategoryInterface` object.
`Input<FilterEqualTypeInput>`	`getCategoryUidInput()` Filter by the unique category ID for a `CategoryInterface` object.
`FilterEqualTypeInput`	`getIds()` Deprecated: use 'category_uid' to filter uniquely identifiers of categories.
`Input<FilterEqualTypeInput>`	`getIdsInput()` Deprecated: use 'category_uid' to filter uniquely identifiers of categories.
`FilterMatchTypeInput`	`getName()` Filter by the display name of the category.
`Input<FilterMatchTypeInput>`	`getNameInput()` Filter by the display name of the category.
`FilterEqualTypeInput`	`getParentCategoryUid()` Filter by the unique parent category ID for a `CategoryInterface` object.
`Input<FilterEqualTypeInput>`	`getParentCategoryUidInput()` Filter by the unique parent category ID for a `CategoryInterface` object.
`FilterEqualTypeInput`	`getParentId()` Filter by the unique parent category ID for a `CategoryInterface` object.
`Input<FilterEqualTypeInput>`	`getParentIdInput()` Filter by the unique parent category ID for a `CategoryInterface` object.
`FilterEqualTypeInput`	`getUrlKey()` Filter by the part of the URL that identifies the category.
`Input<FilterEqualTypeInput>`	`getUrlKeyInput()` Filter by the part of the URL that identifies the category.
`FilterEqualTypeInput`	`getUrlPath()` Filter by the URL path for the category.
`Input<FilterEqualTypeInput>`	`getUrlPathInput()` Filter by the URL path for the category.
`CategoryFilterInput`	`setCategoryUid(FilterEqualTypeInput categoryUid)` Filter by the unique category ID for a `CategoryInterface` object.
`CategoryFilterInput`	`setCategoryUidInput(Input<FilterEqualTypeInput> categoryUid)` Filter by the unique category ID for a `CategoryInterface` object.
`CategoryFilterInput`	`setCustomFilter(String name, Serializable filterInput)` Set custom filter.
`CategoryFilterInput`	`setIds(FilterEqualTypeInput ids)` Deprecated: use 'category_uid' to filter uniquely identifiers of categories.
`CategoryFilterInput`	`setIdsInput(Input<FilterEqualTypeInput> ids)` Deprecated: use 'category_uid' to filter uniquely identifiers of categories.
`CategoryFilterInput`	`setName(FilterMatchTypeInput name)` Filter by the display name of the category.
`CategoryFilterInput`	`setNameInput(Input<FilterMatchTypeInput> name)` Filter by the display name of the category.
`CategoryFilterInput`	`setParentCategoryUid(FilterEqualTypeInput parentCategoryUid)` Filter by the unique parent category ID for a `CategoryInterface` object.
`CategoryFilterInput`	`setParentCategoryUidInput(Input<FilterEqualTypeInput> parentCategoryUid)` Filter by the unique parent category ID for a `CategoryInterface` object.
`CategoryFilterInput`	`setParentId(FilterEqualTypeInput parentId)` Filter by the unique parent category ID for a `CategoryInterface` object.
`CategoryFilterInput`	`setParentIdInput(Input<FilterEqualTypeInput> parentId)` Filter by the unique parent category ID for a `CategoryInterface` object.
`CategoryFilterInput`	`setUrlKey(FilterEqualTypeInput urlKey)` Filter by the part of the URL that identifies the category.
`CategoryFilterInput`	`setUrlKeyInput(Input<FilterEqualTypeInput> urlKey)` Filter by the part of the URL that identifies the category.
`CategoryFilterInput`	`setUrlPath(FilterEqualTypeInput urlPath)` Filter by the URL path for the category.
`CategoryFilterInput`	`setUrlPathInput(Input<FilterEqualTypeInput> urlPath)` Filter by the URL path for the category.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CategoryFilterInput
```
public CategoryFilterInput()
```
- Method Detail
  - getCategoryUid
```
public FilterEqualTypeInput getCategoryUid()
```
    Filter by the unique category ID for a `CategoryInterface` object.
  - getCategoryUidInput
```
public Input<FilterEqualTypeInput> getCategoryUidInput()
```
    Filter by the unique category ID for a `CategoryInterface` object.
  - setCategoryUid
```
public CategoryFilterInput setCategoryUid(FilterEqualTypeInput categoryUid)
```
    Filter by the unique category ID for a `CategoryInterface` object.
  - setCategoryUidInput
```
public CategoryFilterInput setCategoryUidInput(Input<FilterEqualTypeInput> categoryUid)
```
    Filter by the unique category ID for a `CategoryInterface` object.
  - getIds
```
public FilterEqualTypeInput getIds()
```
    Deprecated: use 'category_uid' to filter uniquely identifiers of categories.
  - getIdsInput
```
public Input<FilterEqualTypeInput> getIdsInput()
```
    Deprecated: use 'category_uid' to filter uniquely identifiers of categories.
  - setIds
```
public CategoryFilterInput setIds(FilterEqualTypeInput ids)
```
    Deprecated: use 'category_uid' to filter uniquely identifiers of categories.
  - setIdsInput
```
public CategoryFilterInput setIdsInput(Input<FilterEqualTypeInput> ids)
```
    Deprecated: use 'category_uid' to filter uniquely identifiers of categories.
  - getName
```
public FilterMatchTypeInput getName()
```
    Filter by the display name of the category.
  - getNameInput
```
public Input<FilterMatchTypeInput> getNameInput()
```
    Filter by the display name of the category.
  - setName
```
public CategoryFilterInput setName(FilterMatchTypeInput name)
```
    Filter by the display name of the category.
  - setNameInput
```
public CategoryFilterInput setNameInput(Input<FilterMatchTypeInput> name)
```
    Filter by the display name of the category.
  - getParentCategoryUid
```
public FilterEqualTypeInput getParentCategoryUid()
```
    Filter by the unique parent category ID for a `CategoryInterface` object.
  - getParentCategoryUidInput
```
public Input<FilterEqualTypeInput> getParentCategoryUidInput()
```
    Filter by the unique parent category ID for a `CategoryInterface` object.
  - setParentCategoryUid
```
public CategoryFilterInput setParentCategoryUid(FilterEqualTypeInput parentCategoryUid)
```
    Filter by the unique parent category ID for a `CategoryInterface` object.
  - setParentCategoryUidInput
```
public CategoryFilterInput setParentCategoryUidInput(Input<FilterEqualTypeInput> parentCategoryUid)
```
    Filter by the unique parent category ID for a `CategoryInterface` object.
  - getParentId
```
public FilterEqualTypeInput getParentId()
```
    Filter by the unique parent category ID for a `CategoryInterface` object.
  - getParentIdInput
```
public Input<FilterEqualTypeInput> getParentIdInput()
```
    Filter by the unique parent category ID for a `CategoryInterface` object.
  - setParentId
```
public CategoryFilterInput setParentId(FilterEqualTypeInput parentId)
```
    Filter by the unique parent category ID for a `CategoryInterface` object.
  - setParentIdInput
```
public CategoryFilterInput setParentIdInput(Input<FilterEqualTypeInput> parentId)
```
    Filter by the unique parent category ID for a `CategoryInterface` object.
  - getUrlKey
```
public FilterEqualTypeInput getUrlKey()
```
    Filter by the part of the URL that identifies the category.
  - getUrlKeyInput
```
public Input<FilterEqualTypeInput> getUrlKeyInput()
```
    Filter by the part of the URL that identifies the category.
  - setUrlKey
```
public CategoryFilterInput setUrlKey(FilterEqualTypeInput urlKey)
```
    Filter by the part of the URL that identifies the category.
  - setUrlKeyInput
```
public CategoryFilterInput setUrlKeyInput(Input<FilterEqualTypeInput> urlKey)
```
    Filter by the part of the URL that identifies the category.
  - getUrlPath
```
public FilterEqualTypeInput getUrlPath()
```
    Filter by the URL path for the category.
  - getUrlPathInput
```
public Input<FilterEqualTypeInput> getUrlPathInput()
```
    Filter by the URL path for the category.
  - setUrlPath
```
public CategoryFilterInput setUrlPath(FilterEqualTypeInput urlPath)
```
    Filter by the URL path for the category.
  - setUrlPathInput
```
public CategoryFilterInput setUrlPathInput(Input<FilterEqualTypeInput> urlPath)
```
    Filter by the URL path for the category.
  - setCustomFilter
```
public CategoryFilterInput setCustomFilter(String name,
                                           Serializable filterInput)
```
    Set custom filter.
  - appendTo
```
public void appendTo(StringBuilder _queryBuilder)
```

Class CategoryFilterInput

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CategoryFilterInput

Method Detail

getCategoryUid

getCategoryUidInput

setCategoryUid

setCategoryUidInput

getIds

getIdsInput

setIds

setIdsInput

getName

getNameInput

setName

setNameInput

getParentCategoryUid

getParentCategoryUidInput

setParentCategoryUid

setParentCategoryUidInput

getParentId

getParentIdInput

setParentId

setParentIdInput

getUrlKey

getUrlKeyInput

setUrlKey

setUrlKeyInput

getUrlPath

getUrlPathInput

setUrlPath

setUrlPathInput

setCustomFilter

appendTo