Package com.onshape.api.requests

Class MetadataCategoryCreateCategoryRequest.Builder

java.lang.Object

com.onshape.api.requests.MetadataCategoryCreateCategoryRequest.Builder

Enclosing class:

MetadataCategoryCreateCategoryRequest

public static final class MetadataCategoryCreateCategoryRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
MetadataCategoryCreateCategoryResponse	call()	Calls createCategory method, Create metadata category
String	description()	Get Category description
MetadataCategoryCreateCategoryRequest.Builder	description(String value)	Set Category description
String[]	memberCategoryIds()	Get List of ids of the categories this category will be member of
MetadataCategoryCreateCategoryRequest.Builder	memberCategoryIds(String[] value)	Set List of ids of the categories this category will be member of
String	name()	Get Category name
MetadataCategoryCreateCategoryRequest.Builder	name(String value)	Set Category name
Number	objectType()	Get Metadata object type, which can be: 0:GLOBAL, 1:DOCUMENT, 2:PART, 3:ASSEMBLY, 4:DRAWING, 5:PART_STUDIO, 6: BLOB_ELEMENT, 7:APP_ELEMENT, 8:VERSION, 9:WORKSPACE
MetadataCategoryCreateCategoryRequest.Builder	objectType(Number value)	Set Metadata object type, which can be: 0:GLOBAL, 1:DOCUMENT, 2:PART, 3:ASSEMBLY, 4:DRAWING, 5:PART_STUDIO, 6: BLOB_ELEMENT, 7:APP_ELEMENT, 8:VERSION, 9:WORKSPACE
Number[]	objectTypes()	Get List of metadata object types this category will be applicable for picking
MetadataCategoryCreateCategoryRequest.Builder	objectTypes(Number[] value)	Set List of metadata object types this category will be applicable for picking
String	ownerId()	Get CompanyId that will own the category
MetadataCategoryCreateCategoryRequest.Builder	ownerId(String value)	Set CompanyId that will own the category
Number	ownerType()	Get Owner type, which can be: 1:company
MetadataCategoryCreateCategoryRequest.Builder	ownerType(Number value)	Set Owner type, which can be: 1:company
Number	publishState()	Get Category publish state, which can be: 0: PENDING, 1: ACTIVE, 2: INACTIVE
MetadataCategoryCreateCategoryRequest.Builder	publishState(Number value)	Set Category publish state, which can be: 0: PENDING, 1: ACTIVE, 2: INACTIVE

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 Category name

Returns:

Category name

name

public final MetadataCategoryCreateCategoryRequest.Builder name(String value)

Set Category name

Parameters:

value - Category name

Returns:

the Builder object.

description

public final String description()

Get Category description

Returns:

Category description

description

public final MetadataCategoryCreateCategoryRequest.Builder description(String value)

Set Category description

Parameters:

value - Category description

Returns:

the Builder object.

ownerId

public final String ownerId()

Get CompanyId that will own the category

Returns:

CompanyId that will own the category

ownerId

public final MetadataCategoryCreateCategoryRequest.Builder ownerId(String value)

Set CompanyId that will own the category

Parameters:

value - CompanyId that will own the category

Returns:

the Builder object.

ownerType

public final Number ownerType()

Get Owner type, which can be: 1:company

Returns:

Owner type, which can be: 1:company

ownerType

public final MetadataCategoryCreateCategoryRequest.Builder ownerType(Number value)

Set Owner type, which can be: 1:company

Parameters:

value - Owner type, which can be: 1:company

Returns:

the Builder object.

objectType

public final Number objectType()

Get Metadata object type, which can be: 0:GLOBAL, 1:DOCUMENT, 2:PART, 3:ASSEMBLY, 4:DRAWING, 5:PART_STUDIO, 6: BLOB_ELEMENT, 7:APP_ELEMENT, 8:VERSION, 9:WORKSPACE

Returns:

Metadata object type, which can be: 0:GLOBAL, 1:DOCUMENT, 2:PART, 3:ASSEMBLY, 4:DRAWING, 5:PART_STUDIO, 6: BLOB_ELEMENT, 7:APP_ELEMENT, 8:VERSION, 9:WORKSPACE

objectType

public final MetadataCategoryCreateCategoryRequest.Builder objectType(Number value)

Set Metadata object type, which can be: 0:GLOBAL, 1:DOCUMENT, 2:PART, 3:ASSEMBLY, 4:DRAWING, 5:PART_STUDIO, 6: BLOB_ELEMENT, 7:APP_ELEMENT, 8:VERSION, 9:WORKSPACE

Parameters:

value - Metadata object type, which can be: 0:GLOBAL, 1:DOCUMENT, 2:PART, 3:ASSEMBLY, 4:DRAWING, 5:PART_STUDIO, 6: BLOB_ELEMENT, 7:APP_ELEMENT, 8:VERSION, 9:WORKSPACE

Returns:

the Builder object.

objectTypes

public final Number[] objectTypes()

Get List of metadata object types this category will be applicable for picking

Returns:

List of metadata object types this category will be applicable for picking

objectTypes

public final MetadataCategoryCreateCategoryRequest.Builder objectTypes(Number[] value)

Set List of metadata object types this category will be applicable for picking

Parameters:

value - List of metadata object types this category will be applicable for picking

Returns:

the Builder object.

memberCategoryIds

public final String[] memberCategoryIds()

Get List of ids of the categories this category will be member of

Returns:

List of ids of the categories this category will be member of

memberCategoryIds

public final MetadataCategoryCreateCategoryRequest.Builder memberCategoryIds(String[] value)

Set List of ids of the categories this category will be member of

Parameters:

value - List of ids of the categories this category will be member of

Returns:

the Builder object.

publishState

public final Number publishState()

Get Category publish state, which can be: 0: PENDING, 1: ACTIVE, 2: INACTIVE

Returns:

Category publish state, which can be: 0: PENDING, 1: ACTIVE, 2: INACTIVE

publishState

public final MetadataCategoryCreateCategoryRequest.Builder publishState(Number value)

Set Category publish state, which can be: 0: PENDING, 1: ACTIVE, 2: INACTIVE

Parameters:

value - Category publish state, which can be: 0: PENDING, 1: ACTIVE, 2: INACTIVE

Returns:

the Builder object.

call

public final MetadataCategoryCreateCategoryResponse call()
                                                  throws OnshapeException

Calls createCategory method, Create metadata category

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error