Package com.onshape.api.requests

Class DocumentsSearchRequest

java.lang.Object

com.onshape.api.requests.DocumentsSearchRequest

public final class DocumentsSearchRequest
extends Object

Request object for search API endpoint. © 2018-Present Onshape Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DocumentsSearchRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DocumentsSearchRequest.Builder	builder(Onshape onshape)
Number	getDocumentFilterOrdinal()	Get Document filter ID (e.g., MY_DOCS, ALL)
Number	getLimit()	Get Number of results to return per page (default and max is 20)
Boolean	getLuceneSyntax()	Get If set to true the 'rawQuery' is considered as a query in Lucene format and passed to ElasticSearch w/o parsing.
Number	getOffset()	Get Where to begin search results
String	getOwnerId()	Get Relevant for certain values of documentFilterOrdinal
String	getRawQuery()	Get name:value search terms (value may be a list, in quotes) If empty, equivalent to a "wildcard" search.
String	getSortColumn()	Get Column by which to sort search results.
String	getSortOrder()	Get Sort order, which can be 'desc' (descending) or 'asc' (ascending)
String	getType()	Get Search domain: documents, element type, parts, or "all"
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getType

public final String getType()

Get Search domain: documents, element type, parts, or "all"

Returns:

Search domain: documents, element type, parts, or "all"

getDocumentFilterOrdinal

public final Number getDocumentFilterOrdinal()

Get Document filter ID (e.g., MY_DOCS, ALL)

Returns:

Document filter ID (e.g., MY_DOCS, ALL)

getOwnerId

public final String getOwnerId()

Get Relevant for certain values of documentFilterOrdinal

Returns:

Relevant for certain values of documentFilterOrdinal

getRawQuery

public final String getRawQuery()

Get name:value search terms (value may be a list, in quotes) If empty, equivalent to a "wildcard" search.

Returns:

name:value search terms (value may be a list, in quotes) If empty, equivalent to a "wildcard" search.

getOffset

public final Number getOffset()

Get Where to begin search results

Returns:

Where to begin search results

getLimit

public final Number getLimit()

Get Number of results to return per page (default and max is 20)

Returns:

Number of results to return per page (default and max is 20)

getSortColumn

public final String getSortColumn()

Get Column by which to sort search results.

Returns:

Column by which to sort search results.

getSortOrder

public final String getSortOrder()

Get Sort order, which can be 'desc' (descending) or 'asc' (ascending)

Returns:

Sort order, which can be 'desc' (descending) or 'asc' (ascending)

getLuceneSyntax

public final Boolean getLuceneSyntax()

Get If set to true the 'rawQuery' is considered as a query in Lucene format and passed to ElasticSearch w/o parsing.

Returns:

If set to true the 'rawQuery' is considered as a query in Lucene format and passed to ElasticSearch w/o parsing.

toString

public String toString()

Overrides:

toString in class Object

builder

public static final DocumentsSearchRequest.Builder builder(Onshape onshape)