Package com.onshape.api.requests

Class ProjectsGetProjectsRequest.Builder

java.lang.Object

com.onshape.api.requests.ProjectsGetProjectsRequest.Builder

Enclosing class:

ProjectsGetProjectsRequest

public static final class ProjectsGetProjectsRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
ProjectsGetProjectsResponse	call()	Calls getProjects method, Returns info about all the projects defined in the session's enterprise company.
Number	limit()	Get Page size, number of the items returned will not exceed this value
ProjectsGetProjectsRequest.Builder	limit(Number value)	Set Page size, number of the items returned will not exceed this value
Number	offset()	Get Page offset
ProjectsGetProjectsRequest.Builder	offset(Number value)	Set Page offset
String	sortOrder()	Get The sort order by date created.
ProjectsGetProjectsRequest.Builder	sortOrder(String value)	Set The sort order by date created.

Methods inherited from class java.lang.Object

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

Method Detail

sortOrder

public final String sortOrder()

Get The sort order by date created.

Returns:

The sort order by date created.

sortOrder

public final ProjectsGetProjectsRequest.Builder sortOrder(String value)

Set The sort order by date created.

Parameters:

value - The sort order by date created.

Returns:

the Builder object.

offset

public final Number offset()

Get Page offset

Returns:

Page offset

offset

public final ProjectsGetProjectsRequest.Builder offset(Number value)

Set Page offset

Parameters:

value - Page offset

Returns:

the Builder object.

limit

public final Number limit()

Get Page size, number of the items returned will not exceed this value

Returns:

Page size, number of the items returned will not exceed this value

limit

public final ProjectsGetProjectsRequest.Builder limit(Number value)

Set Page size, number of the items returned will not exceed this value

Parameters:

value - Page size, number of the items returned will not exceed this value

Returns:

the Builder object.

call

public final ProjectsGetProjectsResponse call()
                                       throws OnshapeException

Calls getProjects method, Returns info about all the projects defined in the session's enterprise company. Enterprise only.

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error