Package com.onshape.api.requests

Class MetadataGetMetadataSchemaPropertiesRequest.Builder

java.lang.Object

com.onshape.api.requests.MetadataGetMetadataSchemaPropertiesRequest.Builder

Enclosing class:

MetadataGetMetadataSchemaPropertiesRequest

public static final class MetadataGetMetadataSchemaPropertiesRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
Boolean	activeOnly()	Get If true, only active properties for this particular schema or ownerId will be returned.
MetadataGetMetadataSchemaPropertiesRequest.Builder	activeOnly(Boolean value)	Set If true, only active properties for this particular schema or ownerId will be returned.
MetadataGetMetadataSchemaPropertiesResponse	call()	Calls getMetadataSchemaProperties method, Get metadata properties
String	documentId()	Get ID of the document the schema is associated with.
MetadataGetMetadataSchemaPropertiesRequest.Builder	documentId(String value)	Set ID of the document the schema is associated with.
Number	limit()	Get Number of results to return per page (max is 20)
MetadataGetMetadataSchemaPropertiesRequest.Builder	limit(Number value)	Set Number of results to return per page (max is 20)
Number	objectType()	Get Metadata object type.
MetadataGetMetadataSchemaPropertiesRequest.Builder	objectType(Number value)	Set Metadata object type.
Number	offset()	Get Where to begin search results
MetadataGetMetadataSchemaPropertiesRequest.Builder	offset(Number value)	Set Where to begin search results
String	ownerId()	Get Schema owner ID.
MetadataGetMetadataSchemaPropertiesRequest.Builder	ownerId(String value)	Set Schema owner ID.
Number	ownerType()	Get Schema owner type must be 1 company.
MetadataGetMetadataSchemaPropertiesRequest.Builder	ownerType(Number value)	Set Schema owner type must be 1 company.
String	schemaId()	Get Metadata schema ID.
MetadataGetMetadataSchemaPropertiesRequest.Builder	schemaId(String value)	Set Metadata schema ID.
Boolean	strict()	Get If true, only properties for this particular schema or ownerId will be returned.
MetadataGetMetadataSchemaPropertiesRequest.Builder	strict(Boolean value)	Set If true, only properties for this particular schema or ownerId will be returned.

Methods inherited from class java.lang.Object

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

Method Detail

schemaId

public final String schemaId()

Get Metadata schema ID. Must be specified if ownerId is blank.

Returns:

Metadata schema ID. Must be specified if ownerId is blank.

schemaId

public final MetadataGetMetadataSchemaPropertiesRequest.Builder schemaId(String value)

Set Metadata schema ID. Must be specified if ownerId is blank.

Parameters:

value - Metadata schema ID. Must be specified if ownerId is blank.

Returns:

the Builder object.

ownerId

public final String ownerId()

Get Schema owner ID. Must be specified if schemaId is blank.

Returns:

Schema owner ID. Must be specified if schemaId is blank.

ownerId

public final MetadataGetMetadataSchemaPropertiesRequest.Builder ownerId(String value)

Set Schema owner ID. Must be specified if schemaId is blank.

Parameters:

value - Schema owner ID. Must be specified if schemaId is blank.

Returns:

the Builder object.

ownerType

public final Number ownerType()

Get Schema owner type must be 1 company. Should only be specified if ownerId is specified.

Returns:

Schema owner type must be 1 company. Should only be specified if ownerId is specified.

ownerType

public final MetadataGetMetadataSchemaPropertiesRequest.Builder ownerType(Number value)

Set Schema owner type must be 1 company. Should only be specified if ownerId is specified.

Parameters:

value - Schema owner type must be 1 company. Should only be specified if ownerId is specified.

Returns:

the Builder object.

objectType

public final Number objectType()

Get Metadata object type. Should only be specified if ownerId is specified. If schemaId is specified, this parameter is ignored. If null, properties for all types will be returned. If specified, must be one of the following: 0:GLOBAL, 1:DOCUMENT, 2:PART, 3:ASSEMBLY, 4:DRAWING, 5:PART_STUDIO, 6: BLOB_ELEMENT, 7:APP_ELEMENT, 8:VERSION, 9:WORKSPACE If false, properties will be returned with full detail, including property configs.

Returns:

Metadata object type. Should only be specified if ownerId is specified. If schemaId is specified, this parameter is ignored. If null, properties for all types will be returned. If specified, must be one of the following: 0:GLOBAL, 1:DOCUMENT, 2:PART, 3:ASSEMBLY, 4:DRAWING, 5:PART_STUDIO, 6: BLOB_ELEMENT, 7:APP_ELEMENT, 8:VERSION, 9:WORKSPACE If false, properties will be returned with full detail, including property configs.

objectType

public final MetadataGetMetadataSchemaPropertiesRequest.Builder objectType(Number value)

Set Metadata object type. Should only be specified if ownerId is specified. If schemaId is specified, this parameter is ignored. If null, properties for all types will be returned. If specified, must be one of the following: 0:GLOBAL, 1:DOCUMENT, 2:PART, 3:ASSEMBLY, 4:DRAWING, 5:PART_STUDIO, 6: BLOB_ELEMENT, 7:APP_ELEMENT, 8:VERSION, 9:WORKSPACE If false, properties will be returned with full detail, including property configs.

Parameters:

value - Metadata object type. Should only be specified if ownerId is specified. If schemaId is specified, this parameter is ignored. If null, properties for all types will be returned. If specified, must be one of the following: 0:GLOBAL, 1:DOCUMENT, 2:PART, 3:ASSEMBLY, 4:DRAWING, 5:PART_STUDIO, 6: BLOB_ELEMENT, 7:APP_ELEMENT, 8:VERSION, 9:WORKSPACE If false, properties will be returned with full detail, including property configs.

Returns:

the Builder object.

strict

public final Boolean strict()

Get If true, only properties for this particular schema or ownerId will be returned. If false, all inherited properties will be returned.

Returns:

If true, only properties for this particular schema or ownerId will be returned. If false, all inherited properties will be returned.

strict

public final MetadataGetMetadataSchemaPropertiesRequest.Builder strict(Boolean value)

Set If true, only properties for this particular schema or ownerId will be returned. If false, all inherited properties will be returned.

Parameters:

value - If true, only properties for this particular schema or ownerId will be returned. If false, all inherited properties will be returned.

Returns:

the Builder object.

activeOnly

public final Boolean activeOnly()

Get If true, only active properties for this particular schema or ownerId will be returned. If false, all properties will be returned.

Returns:

If true, only active properties for this particular schema or ownerId will be returned. If false, all properties will be returned.

activeOnly

public final MetadataGetMetadataSchemaPropertiesRequest.Builder activeOnly(Boolean value)

Set If true, only active properties for this particular schema or ownerId will be returned. If false, all properties will be returned.

Parameters:

value - If true, only active properties for this particular schema or ownerId will be returned. If false, all properties will be returned.

Returns:

the Builder object.

documentId

public final String documentId()

Get ID of the document the schema is associated with.

Returns:

ID of the document the schema is associated with.

documentId

public final MetadataGetMetadataSchemaPropertiesRequest.Builder documentId(String value)

Set ID of the document the schema is associated with.

Parameters:

value - ID of the document the schema is associated with.

Returns:

the Builder object.

offset

public final Number offset()

Get Where to begin search results

Returns:

Where to begin search results

offset

public final MetadataGetMetadataSchemaPropertiesRequest.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 MetadataGetMetadataSchemaPropertiesRequest.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 MetadataGetMetadataSchemaPropertiesResponse call()
                                                       throws OnshapeException

Calls getMetadataSchemaProperties method, Get metadata properties

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error