UploadFieldDefinition (REST Client 0.25.15 API)

java.lang.Object
- org.sagebionetworks.bridge.rest.model.UploadFieldDefinition

```
@Generated(value="io.swagger.codegen.languages.JavaClientCodegen",
           date="2022-11-05T00:31:27.098Z")
public class UploadFieldDefinition
extends Object
```
Note: For legacy reasons, this is the only model object returned from the API that does not have a type property reflecting the implementation structure of the JSON. Instead, the type attribute is of the type [UploadFieldType](#UploadFieldType).

Constructor Summary

Constructors
Constructor and Description

UploadFieldDefinition()

Constructors
Constructor and Description
`UploadFieldDefinition()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`UploadFieldDefinition`	`addMultiChoiceAnswerListItem(String multiChoiceAnswerListItem)`
`UploadFieldDefinition`	`allowOtherChoices(Boolean allowOtherChoices)`
`boolean`	`equals(Object o)`
`UploadFieldDefinition`	`fileExtension(String fileExtension)`
`String`	`getFileExtension()` Used for ATTACHMENT_V2 types.
`Integer`	`getMaxLength()` Used for STRING, SINGLE_CHOICE, and INLINE_JSON_BLOB types.
`String`	`getMimeType()` Used for ATTACHMENT_V2 types.
`List<String>`	`getMultiChoiceAnswerList()` Used for MULTI_CHOICE types.
`String`	`getName()` Field name.
`UploadFieldType`	`getType()` Get type
`int`	`hashCode()`
`Boolean`	`isAllowOtherChoices()` Used for MULTI_CHOICE.
`Boolean`	`isRequired()` Whether this field is required.
`Boolean`	`isUnboundedText()` True if this field is a text-field with unbounded length.
`UploadFieldDefinition`	`maxLength(Integer maxLength)`
`UploadFieldDefinition`	`mimeType(String mimeType)`
`UploadFieldDefinition`	`multiChoiceAnswerList(List<String> multiChoiceAnswerList)`
`UploadFieldDefinition`	`name(String name)`
`UploadFieldDefinition`	`required(Boolean required)`
`void`	`setAllowOtherChoices(Boolean allowOtherChoices)`
`void`	`setFileExtension(String fileExtension)`
`void`	`setMaxLength(Integer maxLength)`
`void`	`setMimeType(String mimeType)`
`void`	`setMultiChoiceAnswerList(List<String> multiChoiceAnswerList)`
`void`	`setName(String name)`
`void`	`setRequired(Boolean required)`
`void`	`setType(UploadFieldType type)`
`void`	`setUnboundedText(Boolean unboundedText)`
`String`	`toString()`
`UploadFieldDefinition`	`type(UploadFieldType type)`
`UploadFieldDefinition`	`unboundedText(Boolean unboundedText)`

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - UploadFieldDefinition
```
public UploadFieldDefinition()
```
- Method Detail
  - name
```
public UploadFieldDefinition name(String name)
```
  - getName
```
public String getName()
```
    Field name. A schema cannot contain fields with the same name.
    
    Returns:
    
    name
  - setName
```
public void setName(String name)
```
  - required
```
public UploadFieldDefinition required(Boolean required)
```
  - isRequired
```
public Boolean isRequired()
```
    Whether this field is required.
    
    Returns:
    
    required
  - setRequired
```
public void setRequired(Boolean required)
```
  - type
```
public UploadFieldDefinition type(UploadFieldType type)
```
  - getType
```
public UploadFieldType getType()
```
    Get type
    
    Returns:
    
    type
  - setType
```
public void setType(UploadFieldType type)
```
  - allowOtherChoices
```
public UploadFieldDefinition allowOtherChoices(Boolean allowOtherChoices)
```
  - isAllowOtherChoices
```
public Boolean isAllowOtherChoices()
```
    Used for MULTI_CHOICE. True if the multi-choice field allows an \"other\" answer with user freeform text. This tells BridgeEX to reserve an \"other\" column for this field. Can be null, so that the number of field parameters doesn't explode.
    
    Returns:
    
    allowOtherChoices
  - setAllowOtherChoices
```
public void setAllowOtherChoices(Boolean allowOtherChoices)
```
  - fileExtension
```
public UploadFieldDefinition fileExtension(String fileExtension)
```
  - getFileExtension
```
public String getFileExtension()
```
    Used for ATTACHMENT_V2 types. Used as a hint by BridgeEX to preserve the file extension as a quality-of-life improvement. Includes the period. Examples: \".json\", \".csv\". Optional, defaults to \".tmp\".
    
    Returns:
    
    fileExtension
  - setFileExtension
```
public void setFileExtension(String fileExtension)
```
  - mimeType
```
public UploadFieldDefinition mimeType(String mimeType)
```
  - getMimeType
```
public String getMimeType()
```
    Used for ATTACHMENT_V2 types. Used as a hint by BridgeEX to mark a Synapse file handle with the correct MIME type as a quality-of-life improvement. Optional, defaults to \"application/octet-stream\".
    
    Returns:
    
    mimeType
  - setMimeType
```
public void setMimeType(String mimeType)
```
  - maxLength
```
public UploadFieldDefinition maxLength(Integer maxLength)
```
  - getMaxLength
```
public Integer getMaxLength()
```
    Used for STRING, SINGLE_CHOICE, and INLINE_JSON_BLOB types. This is a hint for BridgeEX to create a Synapse column with the right width. If not specified, Bridge will use the default max length of 100 (if applicable).
    
    Returns:
    
    maxLength
  - setMaxLength
```
public void setMaxLength(Integer maxLength)
```
  - multiChoiceAnswerList
```
public UploadFieldDefinition multiChoiceAnswerList(List<String> multiChoiceAnswerList)
```
  - addMultiChoiceAnswerListItem
```
public UploadFieldDefinition addMultiChoiceAnswerListItem(String multiChoiceAnswerListItem)
```
  - getMultiChoiceAnswerList
```
public List<String> getMultiChoiceAnswerList()
```
    Used for MULTI_CHOICE types. This lists all valid answers for this field. It is used by BridgeEX to create the Synapse table columns for MULTI_CHOICE fields. This is a list because order matters, in terms of Synapse column order. Must be specified if the field type is a MULTI_CHOICE. For schemas generated from surveys, this list will be the \"value\" in the survey question option, or the \"label\" if value is not specified.
    
    Returns:
    
    multiChoiceAnswerList
  - setMultiChoiceAnswerList
```
public void setMultiChoiceAnswerList(List<String> multiChoiceAnswerList)
```
  - unboundedText
```
public UploadFieldDefinition unboundedText(Boolean unboundedText)
```
  - isUnboundedText
```
public Boolean isUnboundedText()
```
    True if this field is a text-field with unbounded length. (Only applies to fields that are serialized as text, such as INLINE_JSON_BLOB, SINGLE_CHOICE, or STRING. Can be null, so that the number of field parameters doesn't explode. This flag takes precedence over the maxLength value.
    
    Returns:
    
    unboundedText
  - setUnboundedText
```
public void setUnboundedText(Boolean unboundedText)
```
  - 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

Class UploadFieldDefinition

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UploadFieldDefinition

Method Detail

name

getName

setName

required

isRequired

setRequired

type

getType

setType

allowOtherChoices

isAllowOtherChoices

setAllowOtherChoices

fileExtension

getFileExtension

setFileExtension

mimeType

getMimeType

setMimeType

maxLength

getMaxLength

setMaxLength

multiChoiceAnswerList

addMultiChoiceAnswerListItem

getMultiChoiceAnswerList

setMultiChoiceAnswerList

unboundedText

isUnboundedText

setUnboundedText

equals

hashCode

toString