Package com.symphony.bdk.gen.api.model

Class V3RoomSearchResults

java.lang.Object

com.symphony.bdk.gen.api.model.V3RoomSearchResults

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-02-05T16:35:22.048360567Z[Etc/UTC]")
public class V3RoomSearchResults
extends Object

A list of search results and counts per search parameter.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_COUNT
static final String	JSON_PROPERTY_FACETED_MATCH_COUNT
static final String	JSON_PROPERTY_LIMIT
static final String	JSON_PROPERTY_QUERY
static final String	JSON_PROPERTY_ROOMS
static final String	JSON_PROPERTY_SKIP

Constructor Summary

Constructors

Constructor	Description
V3RoomSearchResults()

Method Summary

Modifier and Type	Method	Description
V3RoomSearchResults	addFacetedMatchCountItem(FacetedMatchCount facetedMatchCountItem)
V3RoomSearchResults	addRoomsItem(V3RoomDetail roomsItem)
V3RoomSearchResults	count(Long count)
boolean	equals(Object o)	Return true if this V3RoomSearchResults object is equal to o.
V3RoomSearchResults	facetedMatchCount(List<FacetedMatchCount> facetedMatchCount)
Long	getCount()	The total number of rooms matched by the search.
List<FacetedMatchCount>	getFacetedMatchCount()	Detailed counts of matched rooms per search criterion.
Integer	getLimit()	The number of returned results.
V2RoomSearchCriteria	getQuery()	Get query
List<V3RoomDetail>	getRooms()	A list of rooms matched by the query.
Integer	getSkip()	The number of skipped results.
int	hashCode()
V3RoomSearchResults	limit(Integer limit)
V3RoomSearchResults	query(V2RoomSearchCriteria query)
V3RoomSearchResults	rooms(List<V3RoomDetail> rooms)
void	setCount(Long count)
void	setFacetedMatchCount(List<FacetedMatchCount> facetedMatchCount)
void	setLimit(Integer limit)
void	setQuery(V2RoomSearchCriteria query)
void	setRooms(List<V3RoomDetail> rooms)
void	setSkip(Integer skip)
V3RoomSearchResults	skip(Integer skip)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

JSON_PROPERTY_COUNT

public static final String JSON_PROPERTY_COUNT

See Also:

• Constant Field Values

JSON_PROPERTY_SKIP

public static final String JSON_PROPERTY_SKIP

See Also:

• Constant Field Values

JSON_PROPERTY_LIMIT

public static final String JSON_PROPERTY_LIMIT

See Also:

• Constant Field Values

JSON_PROPERTY_QUERY

public static final String JSON_PROPERTY_QUERY

See Also:

• Constant Field Values

JSON_PROPERTY_ROOMS

public static final String JSON_PROPERTY_ROOMS

See Also:

• Constant Field Values

JSON_PROPERTY_FACETED_MATCH_COUNT

public static final String JSON_PROPERTY_FACETED_MATCH_COUNT

See Also:

• Constant Field Values

Constructor Details

V3RoomSearchResults

public V3RoomSearchResults()

Method Details

count

public V3RoomSearchResults count(Long count)

getCount

@Nullable
public Long getCount()

The total number of rooms matched by the search.

Returns:

count

setCount

public void setCount(Long count)

skip

public V3RoomSearchResults skip(Integer skip)

getSkip

@Nullable
public Integer getSkip()

The number of skipped results.

Returns:

skip

setSkip

public void setSkip(Integer skip)

limit

public V3RoomSearchResults limit(Integer limit)

getLimit

@Nullable
public Integer getLimit()

The number of returned results.

Returns:

limit

setLimit

public void setLimit(Integer limit)

query

public V3RoomSearchResults query(V2RoomSearchCriteria query)

getQuery

@Nullable
public V2RoomSearchCriteria getQuery()

Get query

Returns:

query

setQuery

public void setQuery(V2RoomSearchCriteria query)

rooms

public V3RoomSearchResults rooms(List<V3RoomDetail> rooms)

addRoomsItem

public V3RoomSearchResults addRoomsItem(V3RoomDetail roomsItem)

getRooms

@Nullable
public List<V3RoomDetail> getRooms()

A list of rooms matched by the query.

Returns:

rooms

setRooms

public void setRooms(List<V3RoomDetail> rooms)

facetedMatchCount

public V3RoomSearchResults facetedMatchCount(List<FacetedMatchCount> facetedMatchCount)

addFacetedMatchCountItem

public V3RoomSearchResults addFacetedMatchCountItem(FacetedMatchCount facetedMatchCountItem)

getFacetedMatchCount

@Nullable
public List<FacetedMatchCount> getFacetedMatchCount()

Detailed counts of matched rooms per search criterion.

Returns:

facetedMatchCount

setFacetedMatchCount

public void setFacetedMatchCount(List<FacetedMatchCount> facetedMatchCount)

equals

public boolean equals(Object o)

Return true if this V3RoomSearchResults object is equal to o.

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object