com.box.sdkgen.managers.metadatatemplates

Class CreateMetadataTemplateRequestBody

Object

NullableFieldTracker

SerializableObject

CreateMetadataTemplateRequestBody

All Implemented Interfaces:

Serializable

public class CreateMetadataTemplateRequestBody
extends SerializableObject

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CreateMetadataTemplateRequestBody.Builder

Field Summary

Fields

Modifier and Type	Field and Description
protected Boolean	copyInstanceOnItemCopy Whether or not to copy any metadata attached to a file or folder when it is copied.
protected String	displayName The display name of the template.
protected List<CreateMetadataTemplateRequestBodyFieldsField>	fields An ordered list of template fields which are part of the template.
protected Boolean	hidden Defines if this template is visible in the Box web app UI, or if it is purely intended for usage through the API.
protected String	scope The scope of the metadata template to create.
protected String	templateKey A unique identifier for the template.

Fields inherited from class NullableFieldTracker

explicitlySetNullableFields

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CreateMetadataTemplateRequestBody(CreateMetadataTemplateRequestBody.Builder builder)
	CreateMetadataTemplateRequestBody(String scope, String displayName)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
Boolean	getCopyInstanceOnItemCopy()
String	getDisplayName()
List<CreateMetadataTemplateRequestBodyFieldsField>	getFields()
Boolean	getHidden()
String	getScope()
String	getTemplateKey()
int	hashCode()
String	toString()

Methods inherited from class SerializableObject

getRawData, setRawData

Methods inherited from class NullableFieldTracker

getExplicitlySetNullableFields, isFieldExplicitlySet, markNullableFieldAsSet, markNullableFieldsAsSet

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

scope

protected final String scope

The scope of the metadata template to create. Applications can only create templates for use within the authenticated user's enterprise.

This value needs to be set to `enterprise`, as `global` scopes can not be created by applications.

templateKey

protected String templateKey

A unique identifier for the template. This identifier needs to be unique across the enterprise for which the metadata template is being created.

When not provided, the API will create a unique `templateKey` based on the value of the `displayName`.

displayName

protected final String displayName

The display name of the template.

hidden

protected Boolean hidden

Defines if this template is visible in the Box web app UI, or if it is purely intended for usage through the API.

fields

protected List<CreateMetadataTemplateRequestBodyFieldsField> fields

An ordered list of template fields which are part of the template. Each field can be a regular text field, date field, number field, as well as a single or multi-select list.

copyInstanceOnItemCopy

protected Boolean copyInstanceOnItemCopy

Whether or not to copy any metadata attached to a file or folder when it is copied. By default, metadata is not copied along with a file or folder when it is copied.

Constructor Detail

CreateMetadataTemplateRequestBody

public CreateMetadataTemplateRequestBody(String scope,
                                         String displayName)

CreateMetadataTemplateRequestBody

protected CreateMetadataTemplateRequestBody(CreateMetadataTemplateRequestBody.Builder builder)

Method Detail

getScope

public String getScope()

getTemplateKey

public String getTemplateKey()

getDisplayName

public String getDisplayName()

getHidden

public Boolean getHidden()

getFields

public List<CreateMetadataTemplateRequestBodyFieldsField> getFields()

getCopyInstanceOnItemCopy

public Boolean getCopyInstanceOnItemCopy()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object