com.box.sdkgen.managers.metadatataxonomies

Class GetMetadataTaxonomyNodesQueryParams

Object

GetMetadataTaxonomyNodesQueryParams

public class GetMetadataTaxonomyNodesQueryParams
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GetMetadataTaxonomyNodesQueryParams.Builder

Field Summary

Fields

Modifier and Type	Field and Description
List<String>	ancestor Node identifier of any ancestor node.
Boolean	includeTotalResultCount When set to `true` this provides the total number of nodes that matched the query.
List<Long>	level Filters results by taxonomy level.
Long	limit The maximum number of items to return per page.
String	marker Defines the position marker at which to begin returning results.
List<String>	parent Node identifier of a direct parent node.
String	query Query text to search for the taxonomy nodes.

Constructor Summary

Constructors

Modifier	Constructor and Description
	GetMetadataTaxonomyNodesQueryParams()
protected	GetMetadataTaxonomyNodesQueryParams(GetMetadataTaxonomyNodesQueryParams.Builder builder)

Method Summary

Modifier and Type	Method and Description
List<String>	getAncestor()
Boolean	getIncludeTotalResultCount()
List<Long>	getLevel()
Long	getLimit()
String	getMarker()
List<String>	getParent()
String	getQuery()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

level

public List<Long> level

Filters results by taxonomy level. Multiple values can be provided. Results include nodes that match any of the specified values.

parent

public List<String> parent

Node identifier of a direct parent node. Multiple values can be provided. Results include nodes that match any of the specified values.

ancestor

public List<String> ancestor

Node identifier of any ancestor node. Multiple values can be provided. Results include nodes that match any of the specified values.

query

public String query

Query text to search for the taxonomy nodes.

includeTotalResultCount

public Boolean includeTotalResultCount

When set to `true` this provides the total number of nodes that matched the query. The response will compute counts of up to 10,000 elements. Defaults to `false`.

marker

public String marker

Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.

This requires `usemarker` to be set to `true`.

limit

public Long limit

The maximum number of items to return per page.

Constructor Detail

GetMetadataTaxonomyNodesQueryParams

public GetMetadataTaxonomyNodesQueryParams()

GetMetadataTaxonomyNodesQueryParams

protected GetMetadataTaxonomyNodesQueryParams(GetMetadataTaxonomyNodesQueryParams.Builder builder)

Method Detail

getLevel

public List<Long> getLevel()

getParent

public List<String> getParent()

getAncestor

public List<String> getAncestor()

getQuery

public String getQuery()

getIncludeTotalResultCount

public Boolean getIncludeTotalResultCount()

getMarker

public String getMarker()

getLimit

public Long getLimit()