Package com.onshape.api.requests

Class DocumentsGetDocumentsRequest.Builder

java.lang.Object

com.onshape.api.requests.DocumentsGetDocumentsRequest.Builder

Enclosing class:

DocumentsGetDocumentsRequest

public static final class DocumentsGetDocumentsRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
DocumentsGetDocumentsResponse	call()	Calls getDocuments method, Search for documents
Number	filter()	Get Filter ID, which can be 0: my docs, 1: created, 2: shared, 3: trash, 4: public, 5: recent, 6: by owner, 7: by company, or 9: by team
DocumentsGetDocumentsRequest.Builder	filter(Number value)	Set Filter ID, which can be 0: my docs, 1: created, 2: shared, 3: trash, 4: public, 5: recent, 6: by owner, 7: by company, or 9: by team
Number	limit()	Get Number of results to return per page (max is 20)
DocumentsGetDocumentsRequest.Builder	limit(Number value)	Set Number of results to return per page (max is 20)
Number	offset()	Get Where to begin search results
DocumentsGetDocumentsRequest.Builder	offset(Number value)	Set Where to begin search results
String	owner()	Get Document owner's ID if filter is 6 or 7.
DocumentsGetDocumentsRequest.Builder	owner(String value)	Set Document owner's ID if filter is 6 or 7.
Number	ownerType()	Get Type of owner, which can be 0: user, 1: company, 2: onshape.
DocumentsGetDocumentsRequest.Builder	ownerType(Number value)	Set Type of owner, which can be 0: user, 1: company, 2: onshape.
String	q()	Get Search for documents that contain the given string in the name.
DocumentsGetDocumentsRequest.Builder	q(String value)	Set Search for documents that contain the given string in the name.
String	sortColumn()	Get Column by which to sort search results.
DocumentsGetDocumentsRequest.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
DocumentsGetDocumentsRequest.Builder	sortOrder(String value)	Set Sort order, which can be desc: descending, or asc: ascending

Methods inherited from class java.lang.Object

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

Method Detail

q

public final String q()

Get Search for documents that contain the given string in the name. Search is not case-sensitive.

Returns:

Search for documents that contain the given string in the name. Search is not case-sensitive.

q

public final DocumentsGetDocumentsRequest.Builder q(String value)

Set Search for documents that contain the given string in the name. Search is not case-sensitive.

Parameters:

value - Search for documents that contain the given string in the name. Search is not case-sensitive.

Returns:

the Builder object.

filter

public final Number filter()

Get Filter ID, which can be 0: my docs, 1: created, 2: shared, 3: trash, 4: public, 5: recent, 6: by owner, 7: by company, or 9: by team

Returns:

Filter ID, which can be 0: my docs, 1: created, 2: shared, 3: trash, 4: public, 5: recent, 6: by owner, 7: by company, or 9: by team

filter

public final DocumentsGetDocumentsRequest.Builder filter(Number value)

Set Filter ID, which can be 0: my docs, 1: created, 2: shared, 3: trash, 4: public, 5: recent, 6: by owner, 7: by company, or 9: by team

Parameters:

value - Filter ID, which can be 0: my docs, 1: created, 2: shared, 3: trash, 4: public, 5: recent, 6: by owner, 7: by company, or 9: by team

Returns:

the Builder object.

owner

public final String owner()

Get Document owner's ID if filter is 6 or 7. Team Id if filter is 9

Returns:

Document owner's ID if filter is 6 or 7. Team Id if filter is 9

owner

public final DocumentsGetDocumentsRequest.Builder owner(String value)

Set Document owner's ID if filter is 6 or 7. Team Id if filter is 9

Parameters:

value - Document owner's ID if filter is 6 or 7. Team Id if filter is 9

Returns:

the Builder object.

ownerType

public final Number ownerType()

Get Type of owner, which can be 0: user, 1: company, 2: onshape. If owner is a teamId, leave this unspecified.

Returns:

Type of owner, which can be 0: user, 1: company, 2: onshape. If owner is a teamId, leave this unspecified.

ownerType

public final DocumentsGetDocumentsRequest.Builder ownerType(Number value)

Set Type of owner, which can be 0: user, 1: company, 2: onshape. If owner is a teamId, leave this unspecified.

Parameters:

value - Type of owner, which can be 0: user, 1: company, 2: onshape. If owner is a teamId, leave this unspecified.

Returns:

the Builder object.

sortColumn

public final String sortColumn()

Get Column by which to sort search results. Valid options are name, modifiedAt, createdAt, email, modifiedBy, and promotedAt

Returns:

Column by which to sort search results. Valid options are name, modifiedAt, createdAt, email, modifiedBy, and promotedAt

sortColumn

public final DocumentsGetDocumentsRequest.Builder sortColumn(String value)

Set Column by which to sort search results. Valid options are name, modifiedAt, createdAt, email, modifiedBy, and promotedAt

Parameters:

value - Column by which to sort search results. Valid options are name, modifiedAt, createdAt, email, modifiedBy, and promotedAt

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 DocumentsGetDocumentsRequest.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.

offset

public final Number offset()

Get Where to begin search results

Returns:

Where to begin search results

offset

public final DocumentsGetDocumentsRequest.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 (max is 20)

Returns:

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

limit

public final DocumentsGetDocumentsRequest.Builder limit(Number value)

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

Parameters:

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

Returns:

the Builder object.

call

public final DocumentsGetDocumentsResponse call()
                                         throws OnshapeException

Calls getDocuments method, Search for documents

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error