Package com.onshape.api.requests

Class DocumentsSearchRequest.Builder

java.lang.Object

com.onshape.api.requests.DocumentsSearchRequest.Builder

Enclosing class:

DocumentsSearchRequest

public static final class DocumentsSearchRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
DocumentsSearchResponse	call()	Calls search method, Returns document search results
Number	documentFilterOrdinal()	Get Document filter ID (e.g., MY_DOCS, ALL)
DocumentsSearchRequest.Builder	documentFilterOrdinal(Number value)	Set Document filter ID (e.g., MY_DOCS, ALL)
Number	limit()	Get Number of results to return per page (default and max is 20)
DocumentsSearchRequest.Builder	limit(Number value)	Set Number of results to return per page (default and max is 20)
Boolean	luceneSyntax()	Get If set to true the 'rawQuery' is considered as a query in Lucene format and passed to ElasticSearch w/o parsing.
DocumentsSearchRequest.Builder	luceneSyntax(Boolean value)	Set If set to true the 'rawQuery' is considered as a query in Lucene format and passed to ElasticSearch w/o parsing.
Number	offset()	Get Where to begin search results
DocumentsSearchRequest.Builder	offset(Number value)	Set Where to begin search results
String	ownerId()	Get Relevant for certain values of documentFilterOrdinal
DocumentsSearchRequest.Builder	ownerId(String value)	Set Relevant for certain values of documentFilterOrdinal
String	rawQuery()	Get name:value search terms (value may be a list, in quotes) If empty, equivalent to a "wildcard" search.
DocumentsSearchRequest.Builder	rawQuery(String value)	Set name:value search terms (value may be a list, in quotes) If empty, equivalent to a "wildcard" search.
String	sortColumn()	Get Column by which to sort search results.
DocumentsSearchRequest.Builder	sortColumn(String value)	Set Column by which to sort search results.
String	sortOrder()	Get Sort order, which can be 'desc' (descending) or 'asc' (ascending)
DocumentsSearchRequest.Builder	sortOrder(String value)	Set Sort order, which can be 'desc' (descending) or 'asc' (ascending)
String	type()	Get Search domain: documents, element type, parts, or "all"
DocumentsSearchRequest.Builder	type(String value)	Set Search domain: documents, element type, parts, or "all"

Methods inherited from class java.lang.Object

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

Method Detail

type

public final String type()

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

Returns:

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

type

public final DocumentsSearchRequest.Builder type(String value)

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

Parameters:

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

Returns:

the Builder object.

documentFilterOrdinal

public final Number documentFilterOrdinal()

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

Returns:

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

documentFilterOrdinal

public final DocumentsSearchRequest.Builder documentFilterOrdinal(Number value)

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

Parameters:

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

Returns:

the Builder object.

ownerId

public final String ownerId()

Get Relevant for certain values of documentFilterOrdinal

Returns:

Relevant for certain values of documentFilterOrdinal

ownerId

public final DocumentsSearchRequest.Builder ownerId(String value)

Set Relevant for certain values of documentFilterOrdinal

Parameters:

value - Relevant for certain values of documentFilterOrdinal

Returns:

the Builder object.

rawQuery

public final String rawQuery()

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.

rawQuery

public final DocumentsSearchRequest.Builder rawQuery(String value)

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

Parameters:

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

Returns:

the Builder object.

offset

public final Number offset()

Get Where to begin search results

Returns:

Where to begin search results

offset

public final DocumentsSearchRequest.Builder offset(Number value)

Set Where to begin search results

Parameters:

value - Where to begin search results

Returns:

the Builder object.

limit

public final Number limit()

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)

limit

public final DocumentsSearchRequest.Builder limit(Number value)

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

Parameters:

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

Returns:

the Builder object.

sortColumn

public final String sortColumn()

Get Column by which to sort search results.

Returns:

Column by which to sort search results.

sortColumn

public final DocumentsSearchRequest.Builder sortColumn(String value)

Set Column by which to sort search results.

Parameters:

value - Column by which to sort search results.

Returns:

the Builder object.

sortOrder

public final String sortOrder()

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

Returns:

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

sortOrder

public final DocumentsSearchRequest.Builder sortOrder(String value)

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

Parameters:

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

Returns:

the Builder object.

luceneSyntax

public final Boolean luceneSyntax()

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.

luceneSyntax

public final DocumentsSearchRequest.Builder luceneSyntax(Boolean value)

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

Parameters:

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

Returns:

the Builder object.

call

public final DocumentsSearchResponse call()
                                   throws OnshapeException

Calls search method, Returns document search results

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error