org.sagebionetworks.bridge.rest.model

Class UploadSchema

java.lang.Object

org.sagebionetworks.bridge.rest.model.UploadSchema

@Generated(value="io.swagger.codegen.languages.JavaClientCodegen",
           date="2022-11-05T00:31:27.098Z")
public class UploadSchema
extends Object

Represents the expected fields and types for a data upload. This is used to validate incoming uploads and to export data to Synapse. See [Bridge Upload Data Format](/articles/study_design/upload_data_format.html) for more details about uploads.

Constructor Summary

Constructors

Constructor and Description
UploadSchema()

Method Summary

Modifier and Type	Method and Description
UploadSchema	addFieldDefinitionsItem(UploadFieldDefinition fieldDefinitionsItem)
UploadSchema	deleted(Boolean deleted)
boolean	equals(Object o)
UploadSchema	fieldDefinitions(List<UploadFieldDefinition> fieldDefinitions)
String	getAppId() **Only available through worker APIs.** The identifier of the app from which this schema was retrieved.
List<UploadFieldDefinition>	getFieldDefinitions() Get fieldDefinitions
Map<String,Integer>	getMaxAppVersions() A map of operating system names to minimum app versions.
Map<String,Integer>	getMinAppVersions() A map of operating system names to minimum app versions.
String	getModuleId() Module ID, if this schema was imported from a shared module.
Integer	getModuleVersion() Module version, if this schema was imported from a shared module.
String	getName() User-friendly schema name.
Long	getRevision() Revision number of the schema, used to distinguish versions of the same data format.
String	getSchemaId() Unique identifier for the schema.
UploadSchemaType	getSchemaType() Get schemaType
DateTime	getSurveyCreatedOn() If this schema is created from a survey, this is the createdOn timestamp (in ISO 8601 format) of the survey it represents.
String	getSurveyGuid() If this schema is created from a survey, this is the GUID of the survey it represents.
String	getType() UploadSchema
Long	getVersion() The optimistic locking version of the survey.
int	hashCode()
Boolean	isDeleted() Get deleted
UploadSchema	maxAppVersions(Map<String,Integer> maxAppVersions)
UploadSchema	minAppVersions(Map<String,Integer> minAppVersions)
UploadSchema	moduleId(String moduleId)
UploadSchema	moduleVersion(Integer moduleVersion)
UploadSchema	name(String name)
UploadSchema	putMaxAppVersionsItem(String key, Integer maxAppVersionsItem)
UploadSchema	putMinAppVersionsItem(String key, Integer minAppVersionsItem)
UploadSchema	revision(Long revision)
UploadSchema	schemaId(String schemaId)
UploadSchema	schemaType(UploadSchemaType schemaType)
void	setDeleted(Boolean deleted)
void	setFieldDefinitions(List<UploadFieldDefinition> fieldDefinitions)
void	setMaxAppVersions(Map<String,Integer> maxAppVersions)
void	setMinAppVersions(Map<String,Integer> minAppVersions)
void	setModuleId(String moduleId)
void	setModuleVersion(Integer moduleVersion)
void	setName(String name)
void	setRevision(Long revision)
void	setSchemaId(String schemaId)
void	setSchemaType(UploadSchemaType schemaType)
void	setSurveyCreatedOn(DateTime surveyCreatedOn)
void	setSurveyGuid(String surveyGuid)
void	setVersion(Long version)
UploadSchema	surveyCreatedOn(DateTime surveyCreatedOn)
UploadSchema	surveyGuid(String surveyGuid)
String	toString()
UploadSchema	version(Long version)

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UploadSchema

public UploadSchema()

Method Detail

maxAppVersions

public UploadSchema maxAppVersions(Map<String,Integer> maxAppVersions)

putMaxAppVersionsItem

public UploadSchema putMaxAppVersionsItem(String key,
                                          Integer maxAppVersionsItem)

getMaxAppVersions

public Map<String,Integer> getMaxAppVersions()

A map of operating system names to minimum app versions. The user must send a `User-Agent` header in a prescribed format, that declares the app version to be equal to or less than this version number, in order to match.

Returns:

maxAppVersions

setMaxAppVersions

public void setMaxAppVersions(Map<String,Integer> maxAppVersions)

minAppVersions

public UploadSchema minAppVersions(Map<String,Integer> minAppVersions)

putMinAppVersionsItem

public UploadSchema putMinAppVersionsItem(String key,
                                          Integer minAppVersionsItem)

getMinAppVersions

public Map<String,Integer> getMinAppVersions()

A map of operating system names to minimum app versions. The user must send a `User-Agent` header in a prescribed format, that declares the app version to be equal to or greater than this version number, in order to match.

Returns:

minAppVersions

setMinAppVersions

public void setMinAppVersions(Map<String,Integer> minAppVersions)

moduleId

public UploadSchema moduleId(String moduleId)

getModuleId

public String getModuleId()

Module ID, if this schema was imported from a shared module.

Returns:

moduleId

setModuleId

public void setModuleId(String moduleId)

moduleVersion

public UploadSchema moduleVersion(Integer moduleVersion)

getModuleVersion

public Integer getModuleVersion()

Module version, if this schema was imported from a shared module.

Returns:

moduleVersion

setModuleVersion

public void setModuleVersion(Integer moduleVersion)

name

public UploadSchema name(String name)

getName

public String getName()

User-friendly schema name.

Returns:

name

setName

public void setName(String name)

revision

public UploadSchema revision(Long revision)

getRevision

public Long getRevision()

Revision number of the schema, used to distinguish versions of the same data format. This should be blank when creating a schema, and it should be passed back to the server when updating. If the schema revision cannot be updated in a backwards-compatible fashion, the server will throw an exception. You will need to increment the revision number and create a new revision of the schema.

Returns:

revision

setRevision

public void setRevision(Long revision)

schemaId

public UploadSchema schemaId(String schemaId)

getSchemaId

public String getSchemaId()

Unique identifier for the schema.

Returns:

schemaId

setSchemaId

public void setSchemaId(String schemaId)

surveyGuid

public UploadSchema surveyGuid(String surveyGuid)

getSurveyGuid

public String getSurveyGuid()

If this schema is created from a survey, this is the GUID of the survey it represents.

Returns:

surveyGuid

setSurveyGuid

public void setSurveyGuid(String surveyGuid)

getAppId

public String getAppId()

**Only available through worker APIs.** The identifier of the app from which this schema was retrieved.

Returns:

appId

surveyCreatedOn

public UploadSchema surveyCreatedOn(DateTime surveyCreatedOn)

getSurveyCreatedOn

public DateTime getSurveyCreatedOn()

If this schema is created from a survey, this is the createdOn timestamp (in ISO 8601 format) of the survey it represents.

Returns:

surveyCreatedOn

setSurveyCreatedOn

public void setSurveyCreatedOn(DateTime surveyCreatedOn)

schemaType

public UploadSchema schemaType(UploadSchemaType schemaType)

getSchemaType

public UploadSchemaType getSchemaType()

Get schemaType

Returns:

schemaType

setSchemaType

public void setSchemaType(UploadSchemaType schemaType)

deleted

public UploadSchema deleted(Boolean deleted)

isDeleted

public Boolean isDeleted()

Get deleted

Returns:

deleted

setDeleted

public void setDeleted(Boolean deleted)

version

public UploadSchema version(Long version)

getVersion

public Long getVersion()

The optimistic locking version of the survey. This value must be submitted as part of the next update of the model. If it does not match the value on the server, a 409 error (Conflict) will prevent the update from occurring.

Returns:

version

setVersion

public void setVersion(Long version)

fieldDefinitions

public UploadSchema fieldDefinitions(List<UploadFieldDefinition> fieldDefinitions)

addFieldDefinitionsItem

public UploadSchema addFieldDefinitionsItem(UploadFieldDefinition fieldDefinitionsItem)

getFieldDefinitions

public List<UploadFieldDefinition> getFieldDefinitions()

Get fieldDefinitions

Returns:

fieldDefinitions

setFieldDefinitions

public void setFieldDefinitions(List<UploadFieldDefinition> fieldDefinitions)

getType

public String getType()

UploadSchema

Returns:

type

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