Package com.onshape.api.responses

Class MetadataGetMetadataResponseProperties

java.lang.Object

com.onshape.api.types.AbstractResponseObject

com.onshape.api.responses.MetadataGetMetadataResponseProperties

public final class MetadataGetMetadataResponseProperties
extends AbstractResponseObject

Object used in calls to getMetadata API endpoint. © 2018-Present Onshape Inc.

Field Summary

Fields

Modifier and Type	Field	Description
Map	defaultValue	Default value of the property as defined in the schema, JSON type of the field corresponds to the type of the property type in the schema
Boolean	editable	True if the property is editable in current context
String	Name	Name
String	propertyId	Metadata schema propertyId
Boolean	required	True if property value is required
String	schemaId	Metadata schema object Id
Map	validator	Property validation information as defined in the schema
Map	value	Property value, JSON type of the field corresponds to the type of the property type in the schema
String	valueType	Schema property type, one of STRING, BOOL, INT, DOUBLE, DATE, ENUM, OBJECT

Constructor Summary

Constructors

Constructor	Description
MetadataGetMetadataResponseProperties()

Method Summary

Modifier and Type	Method	Description
Map	getDefaultValue()	Get Default value of the property as defined in the schema, JSON type of the field corresponds to the type of the property type in the schema
Boolean	getEditable()	Get True if the property is editable in current context
String	getName()	Get Name
String	getPropertyId()	Get Metadata schema propertyId
Boolean	getRequired()	Get True if property value is required
String	getSchemaId()	Get Metadata schema object Id
Map	getValidator()	Get Property validation information as defined in the schema
Map	getValue()	Get Property value, JSON type of the field corresponds to the type of the property type in the schema
String	getValueType()	Get Schema property type, one of STRING, BOOL, INT, DOUBLE, DATE, ENUM, OBJECT
String	toString()

Methods inherited from class com.onshape.api.types.AbstractResponseObject

getOtherProperties

Methods inherited from class java.lang.Object

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

Field Detail

Name

public String Name

Name

schemaId

public String schemaId

Metadata schema object Id

propertyId

public String propertyId

Metadata schema propertyId

valueType

public String valueType

Schema property type, one of STRING, BOOL, INT, DOUBLE, DATE, ENUM, OBJECT

editable

public Boolean editable

True if the property is editable in current context

required

public Boolean required

True if property value is required

defaultValue

public Map defaultValue

Default value of the property as defined in the schema, JSON type of the field corresponds to the type of the property type in the schema

value

public Map value

Property value, JSON type of the field corresponds to the type of the property type in the schema

validator

public Map validator

Property validation information as defined in the schema

Constructor Detail

MetadataGetMetadataResponseProperties

public MetadataGetMetadataResponseProperties()

Method Detail

getName

public final String getName()

Get Name

Returns:

Name

getSchemaId

public final String getSchemaId()

Get Metadata schema object Id

Returns:

Metadata schema object Id

getPropertyId

public final String getPropertyId()

Get Metadata schema propertyId

Returns:

Metadata schema propertyId

getValueType

public final String getValueType()

Get Schema property type, one of STRING, BOOL, INT, DOUBLE, DATE, ENUM, OBJECT

Returns:

Schema property type, one of STRING, BOOL, INT, DOUBLE, DATE, ENUM, OBJECT

getEditable

public final Boolean getEditable()

Get True if the property is editable in current context

Returns:

True if the property is editable in current context

getRequired

public final Boolean getRequired()

Get True if property value is required

Returns:

True if property value is required

getDefaultValue

public final Map getDefaultValue()

Get Default value of the property as defined in the schema, JSON type of the field corresponds to the type of the property type in the schema

Returns:

Default value of the property as defined in the schema, JSON type of the field corresponds to the type of the property type in the schema

getValue

public final Map getValue()

Get Property value, JSON type of the field corresponds to the type of the property type in the schema

Returns:

Property value, JSON type of the field corresponds to the type of the property type in the schema

getValidator

public final Map getValidator()

Get Property validation information as defined in the schema

Returns:

Property validation information as defined in the schema

toString

public String toString()

Overrides:

toString in class Object