MetadataCategoryUpdatePropertyRequest.Builder (api-client 1.137.27923.860f36b32a5a API)

java.lang.Object
- com.onshape.api.requests.MetadataCategoryUpdatePropertyRequest.Builder

Enclosing class:: MetadataCategoryUpdatePropertyRequest

public static final class MetadataCategoryUpdatePropertyRequest.Builder
extends Object

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String[]`	`addToCategoryIds()`	Get List of IDs of the categories to associate this property with
`MetadataCategoryUpdatePropertyRequest.Builder`	`addToCategoryIds(String[] value)`	Set List of IDs of the categories to associate this property with
`String`	`blobMimeType()`	Get Blob mime type if valueType == BLOB (7)
`MetadataCategoryUpdatePropertyRequest.Builder`	`blobMimeType(String value)`	Set Blob mime type if valueType == BLOB (7)
`MetadataCategoryUpdatePropertyResponse`	`call(String pid, String Requesting)`	Calls updateProperty method, Update metadata property and associate or disassociate with/from categories
`MetadataCategoryUpdatePropertyRequestCategoryPropertyConfigParams`	`categoryPropertyConfigParams()`	Get Additional information about property
`MetadataCategoryUpdatePropertyRequest.Builder`	`categoryPropertyConfigParams(MetadataCategoryUpdatePropertyRequestCategoryPropertyConfigParams value)`	Set Additional information about property
`String`	`description()`	Get Property description
`MetadataCategoryUpdatePropertyRequest.Builder`	`description(String value)`	Set Property description
`Boolean`	`editableInMicroversion()`	Get True if this property can be edited in a Microversion
`MetadataCategoryUpdatePropertyRequest.Builder`	`editableInMicroversion(Boolean value)`	Set True if this property can be edited in a Microversion
`Boolean`	`editableInVersion()`	Get True if this property can be edited in a Version
`MetadataCategoryUpdatePropertyRequest.Builder`	`editableInVersion(Boolean value)`	Set True if this property can be edited in a Version
`Boolean`	`isArray()`	Get True if property is an array type
`MetadataCategoryUpdatePropertyRequest.Builder`	`isArray(Boolean value)`	Set True if property is an array type
`String`	`name()`	Get Property name
`MetadataCategoryUpdatePropertyRequest.Builder`	`name(String value)`	Set Property name
`String`	`objectDefName()`	Get Object type name if valueType == OBJECT (6)
`MetadataCategoryUpdatePropertyRequest.Builder`	`objectDefName(String value)`	Set Object type name if valueType == OBJECT (6)
`String`	`ownerId()`	Get Property owner ID
`MetadataCategoryUpdatePropertyRequest.Builder`	`ownerId(String value)`	Set Property owner ID
`Number`	`ownerType()`	Get Property owner type, which can be: 1:company
`MetadataCategoryUpdatePropertyRequest.Builder`	`ownerType(Number value)`	Set Property owner type, which can be: 1:company
`String[]`	`removeFromCategoryIds()`	Get List of IDs of the categories to dis-associate this property from
`MetadataCategoryUpdatePropertyRequest.Builder`	`removeFromCategoryIds(String[] value)`	Set List of IDs of the categories to dis-associate this property from
`Number`	`valueType()`	Get Value type of property, which can be: 0:STRING, 1:BOOL, 2:INT, 3:DOUBLE, 4:DATE, 5:ENUM, 6:OBJECT, 7:BLOB, 8:USER
`MetadataCategoryUpdatePropertyRequest.Builder`	`valueType(Number value)`	Set Value type of property, which can be: 0:STRING, 1:BOOL, 2:INT, 3:DOUBLE, 4:DATE, 5:ENUM, 6:OBJECT, 7:BLOB, 8:USER

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - name
```
public final String name()
```
    Get Property name
    
    Returns:
    
    Property name
  - name
```
public final MetadataCategoryUpdatePropertyRequest.Builder name(String value)
```
    Set Property name
    
    Parameters:
    
    value - Property name
    
    Returns:
    
    the Builder object.
  - description
```
public final String description()
```
    Get Property description
    
    Returns:
    
    Property description
  - description
```
public final MetadataCategoryUpdatePropertyRequest.Builder description(String value)
```
    Set Property description
    
    Parameters:
    
    value - Property description
    
    Returns:
    
    the Builder object.
  - ownerId
```
public final String ownerId()
```
    Get Property owner ID
    
    Returns:
    
    Property owner ID
  - ownerId
```
public final MetadataCategoryUpdatePropertyRequest.Builder ownerId(String value)
```
    Set Property owner ID
    
    Parameters:
    
    value - Property owner ID
    
    Returns:
    
    the Builder object.
  - ownerType
```
public final Number ownerType()
```
    Get Property owner type, which can be: 1:company
    
    Returns:
    
    Property owner type, which can be: 1:company
  - ownerType
```
public final MetadataCategoryUpdatePropertyRequest.Builder ownerType(Number value)
```
    Set Property owner type, which can be: 1:company
    
    Parameters:
    
    value - Property owner type, which can be: 1:company
    
    Returns:
    
    the Builder object.
  - valueType
```
public final Number valueType()
```
    Get Value type of property, which can be: 0:STRING, 1:BOOL, 2:INT, 3:DOUBLE, 4:DATE, 5:ENUM, 6:OBJECT, 7:BLOB, 8:USER
    
    Returns:
    
    Value type of property, which can be: 0:STRING, 1:BOOL, 2:INT, 3:DOUBLE, 4:DATE, 5:ENUM, 6:OBJECT, 7:BLOB, 8:USER
  - valueType
```
public final MetadataCategoryUpdatePropertyRequest.Builder valueType(Number value)
```
    Set Value type of property, which can be: 0:STRING, 1:BOOL, 2:INT, 3:DOUBLE, 4:DATE, 5:ENUM, 6:OBJECT, 7:BLOB, 8:USER
    
    Parameters:
    
    value - Value type of property, which can be: 0:STRING, 1:BOOL, 2:INT, 3:DOUBLE, 4:DATE, 5:ENUM, 6:OBJECT, 7:BLOB, 8:USER
    
    Returns:
    
    the Builder object.
  - isArray
```
public final Boolean isArray()
```
    Get True if property is an array type
    
    Returns:
    
    True if property is an array type
  - isArray
```
public final MetadataCategoryUpdatePropertyRequest.Builder isArray(Boolean value)
```
    Set True if property is an array type
    
    Parameters:
    
    value - True if property is an array type
    
    Returns:
    
    the Builder object.
  - objectDefName
```
public final String objectDefName()
```
    Get Object type name if valueType == OBJECT (6)
    
    Returns:
    
    Object type name if valueType == OBJECT (6)
  - objectDefName
```
public final MetadataCategoryUpdatePropertyRequest.Builder objectDefName(String value)
```
    Set Object type name if valueType == OBJECT (6)
    
    Parameters:
    
    value - Object type name if valueType == OBJECT (6)
    
    Returns:
    
    the Builder object.
  - blobMimeType
```
public final String blobMimeType()
```
    Get Blob mime type if valueType == BLOB (7)
    
    Returns:
    
    Blob mime type if valueType == BLOB (7)
  - blobMimeType
```
public final MetadataCategoryUpdatePropertyRequest.Builder blobMimeType(String value)
```
    Set Blob mime type if valueType == BLOB (7)
    
    Parameters:
    
    value - Blob mime type if valueType == BLOB (7)
    
    Returns:
    
    the Builder object.
  - editableInVersion
```
public final Boolean editableInVersion()
```
    Get True if this property can be edited in a Version
    
    Returns:
    
    True if this property can be edited in a Version
  - editableInVersion
```
public final MetadataCategoryUpdatePropertyRequest.Builder editableInVersion(Boolean value)
```
    Set True if this property can be edited in a Version
    
    Parameters:
    
    value - True if this property can be edited in a Version
    
    Returns:
    
    the Builder object.
  - editableInMicroversion
```
public final Boolean editableInMicroversion()
```
    Get True if this property can be edited in a Microversion
    
    Returns:
    
    True if this property can be edited in a Microversion
  - editableInMicroversion
```
public final MetadataCategoryUpdatePropertyRequest.Builder editableInMicroversion(Boolean value)
```
    Set True if this property can be edited in a Microversion
    
    Parameters:
    
    value - True if this property can be edited in a Microversion
    
    Returns:
    
    the Builder object.
  - categoryPropertyConfigParams
```
public final MetadataCategoryUpdatePropertyRequestCategoryPropertyConfigParams categoryPropertyConfigParams()
```
    Get Additional information about property
    
    Returns:
    
    Additional information about property
  - categoryPropertyConfigParams
```
public final MetadataCategoryUpdatePropertyRequest.Builder categoryPropertyConfigParams(MetadataCategoryUpdatePropertyRequestCategoryPropertyConfigParams value)
```
    Set Additional information about property
    
    Parameters:
    
    value - Additional information about property
    
    Returns:
    
    the Builder object.
  - addToCategoryIds
```
public final String[] addToCategoryIds()
```
    Get List of IDs of the categories to associate this property with
    
    Returns:
    
    List of IDs of the categories to associate this property with
  - addToCategoryIds
```
public final MetadataCategoryUpdatePropertyRequest.Builder addToCategoryIds(String[] value)
```
    Set List of IDs of the categories to associate this property with
    
    Parameters:
    
    value - List of IDs of the categories to associate this property with
    
    Returns:
    
    the Builder object.
  - removeFromCategoryIds
```
public final String[] removeFromCategoryIds()
```
    Get List of IDs of the categories to dis-associate this property from
    
    Returns:
    
    List of IDs of the categories to dis-associate this property from
  - removeFromCategoryIds
```
public final MetadataCategoryUpdatePropertyRequest.Builder removeFromCategoryIds(String[] value)
```
    Set List of IDs of the categories to dis-associate this property from
    
    Parameters:
    
    value - List of IDs of the categories to dis-associate this property from
    
    Returns:
    
    the Builder object.
  - call
```
public final MetadataCategoryUpdatePropertyResponse call(String pid,
                                                         String Requesting)
                                                  throws OnshapeException
```
    Calls updateProperty method, Update metadata property and associate or disassociate with/from categories
    
    Parameters:
    
    pid - Property ID
    
    Requesting - owner id, required (Default: null)
    
    Returns:
    
    Response object
    
    Throws:
    
    OnshapeException - On HTTP or serialization error

Class MetadataCategoryUpdatePropertyRequest.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

name

name

description

description

ownerId

ownerId

ownerType

ownerType

valueType

valueType

isArray

isArray

objectDefName

objectDefName

blobMimeType

blobMimeType

editableInVersion

editableInVersion

editableInMicroversion

editableInMicroversion

categoryPropertyConfigParams

categoryPropertyConfigParams

addToCategoryIds

addToCategoryIds

removeFromCategoryIds

removeFromCategoryIds

call