Package com.onshape.api.requests

Class MetadataCategoryGetPropertiesRequest.Builder

java.lang.Object

com.onshape.api.requests.MetadataCategoryGetPropertiesRequest.Builder

Enclosing class:

MetadataCategoryGetPropertiesRequest

public static final class MetadataCategoryGetPropertiesRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
Boolean	activeOnly()	Get If true, only active properties for the specified categories will be returned.
MetadataCategoryGetPropertiesRequest.Builder	activeOnly(Boolean value)	Set If true, only active properties for the specified categories will be returned.
MetadataCategoryGetPropertiesResponse	call(String ownerId, Number ownerType)	Calls getProperties method, Get metadata properties
String	documentId()	Get ID of the document in context to validate permissions.
MetadataCategoryGetPropertiesRequest.Builder	documentId(String value)	Set ID of the document in context to validate permissions.
Boolean	includeOnshape()	Get Flag whether to include or exclude Onshape properties
MetadataCategoryGetPropertiesRequest.Builder	includeOnshape(Boolean value)	Set Flag whether to include or exclude Onshape properties
Number	limit()	Get Number of results to return per page (max is 200)
MetadataCategoryGetPropertiesRequest.Builder	limit(Number value)	Set Number of results to return per page (max is 200)
Number	offset()	Get Where to begin search results
MetadataCategoryGetPropertiesRequest.Builder	offset(Number value)	Set Where to begin search results

Methods inherited from class java.lang.Object

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

Method Detail

documentId

public final String documentId()

Get ID of the document in context to validate permissions.

Returns:

ID of the document in context to validate permissions.

documentId

public final MetadataCategoryGetPropertiesRequest.Builder documentId(String value)

Set ID of the document in context to validate permissions.

Parameters:

value - ID of the document in context to validate permissions.

Returns:

the Builder object.

activeOnly

public final Boolean activeOnly()

Get If true, only active properties for the specified categories will be returned. If false, all properties will be returned.

Returns:

If true, only active properties for the specified categories will be returned. If false, all properties will be returned.

activeOnly

public final MetadataCategoryGetPropertiesRequest.Builder activeOnly(Boolean value)

Set If true, only active properties for the specified categories will be returned. If false, all properties will be returned.

Parameters:

value - If true, only active properties for the specified categories will be returned. If false, all properties will be returned.

Returns:

the Builder object.

includeOnshape

public final Boolean includeOnshape()

Get Flag whether to include or exclude Onshape properties

Returns:

Flag whether to include or exclude Onshape properties

includeOnshape

public final MetadataCategoryGetPropertiesRequest.Builder includeOnshape(Boolean value)

Set Flag whether to include or exclude Onshape properties

Parameters:

value - Flag whether to include or exclude Onshape properties

Returns:

the Builder object.

offset

public final Number offset()

Get Where to begin search results

Returns:

Where to begin search results

offset

public final MetadataCategoryGetPropertiesRequest.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 200)

Returns:

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

limit

public final MetadataCategoryGetPropertiesRequest.Builder limit(Number value)

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

Parameters:

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

Returns:

the Builder object.

call

public final MetadataCategoryGetPropertiesResponse call(String ownerId,
                                                        Number ownerType)
                                                 throws OnshapeException

Calls getProperties method, Get metadata properties

Parameters:

ownerId - Owner ID. Must be specified. (Default: null)

ownerType - Schema owner type must be 1 company which is the default. (Default: null)

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error