Class FindDomainsRequest
- Object
-
- PagedRequest
-
- CursorPagedRequest
-
- FindDomainsRequest
-
- All Implemented Interfaces:
Serializable
public class FindDomainsRequest extends CursorPagedRequest
The search criteria for domains.Only parameters that are specified in this request and have not
null
values are used for filtering. All other parameters are ignored.The returned domains satisfy all constraints that are specified in this search criteria.
By default a result containing 1000 domains is returned.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
FindDomainsRequest.Builder
-
Field Summary
-
Fields inherited from class PagedRequest
countLimit, limit, offset
-
-
Constructor Summary
Constructors Constructor Description FindDomainsRequest()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static FindDomainsRequest.Builder
builder()
protected boolean
canEqual(Object other)
boolean
equals(Object o)
UUID
getCommunityId()
The ID of the community to find the domains in.String
getName()
The name of the domain to search for.MatchMode
getNameMatchMode()
The match mode used to comparename
.UUID
getTypeId()
The ID of the domain type to search for.int
hashCode()
boolean
isExcludeMeta()
The exclude meta flag.boolean
isIncludeSubCommunities()
The include sub-communities flag.void
setCommunityId(UUID communityId)
The ID of the community to find the domains in.void
setExcludeMeta(boolean excludeMeta)
The exclude meta flag.void
setIncludeSubCommunities(boolean includeSubCommunities)
The include sub-communities flag.void
setName(String name)
The name of the domain to search for.void
setNameMatchMode(MatchMode nameMatchMode)
The match mode used to comparename
.void
setTypeId(UUID typeId)
The ID of the domain type to search for.String
toString()
-
Methods inherited from class CursorPagedRequest
getCountLimit, getCursor, getOffset, setCountLimit, setCursor, setOffset
-
Methods inherited from class PagedRequest
getLimit, isPagingActive, setLimit
-
-
-
-
Method Detail
-
builder
public static FindDomainsRequest.Builder builder()
-
getName
public String getName()
The name of the domain to search for.
-
getNameMatchMode
public MatchMode getNameMatchMode()
The match mode used to comparename
. If the match mode isEXACT
the search is case-sensitive, otherwise the search is case-insensitive. Defaults toANYWHERE
.
-
isExcludeMeta
public boolean isExcludeMeta()
The exclude meta flag. If this is set to true then the meta domains will not be returned (meta domains are i.e. domains not created manually by the user). Defaults totrue
.
-
getCommunityId
public UUID getCommunityId()
The ID of the community to find the domains in.
-
getTypeId
public UUID getTypeId()
The ID of the domain type to search for. Returned domains are of this type.
-
isIncludeSubCommunities
public boolean isIncludeSubCommunities()
The include sub-communities flag. When set to true, sub-communities (of the community indicated via thecommunityId
parameter) will be searched in. Defaults tofalse
.
-
setName
public void setName(String name)
The name of the domain to search for.
-
setNameMatchMode
public void setNameMatchMode(MatchMode nameMatchMode)
The match mode used to comparename
. If the match mode isEXACT
the search is case-sensitive, otherwise the search is case-insensitive. Defaults toANYWHERE
.
-
setExcludeMeta
public void setExcludeMeta(boolean excludeMeta)
The exclude meta flag. If this is set to true then the meta domains will not be returned (meta domains are i.e. domains not created manually by the user). Defaults totrue
.
-
setCommunityId
public void setCommunityId(UUID communityId)
The ID of the community to find the domains in.
-
setTypeId
public void setTypeId(UUID typeId)
The ID of the domain type to search for. Returned domains are of this type.
-
setIncludeSubCommunities
public void setIncludeSubCommunities(boolean includeSubCommunities)
The include sub-communities flag. When set to true, sub-communities (of the community indicated via thecommunityId
parameter) will be searched in. Defaults tofalse
.
-
equals
public boolean equals(Object o)
- Overrides:
equals
in classCursorPagedRequest
-
canEqual
protected boolean canEqual(Object other)
- Overrides:
canEqual
in classCursorPagedRequest
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classCursorPagedRequest
-
toString
public String toString()
- Overrides:
toString
in classCursorPagedRequest
-
-