org.sagebionetworks.bridge.rest.model

Class Exporter3Configuration

java.lang.Object

org.sagebionetworks.bridge.rest.model.Exporter3Configuration

@Generated(value="io.swagger.codegen.languages.JavaClientCodegen",
           date="2023-05-18T04:52:40.966Z")
public class Exporter3Configuration
extends Object

This class holds Exporter 3.0 configuration for a given app.

Constructor Summary

Constructors

Constructor and Description
Exporter3Configuration()

Method Summary

Modifier and Type	Method and Description
Exporter3Configuration	configured(Boolean configured)
Exporter3Configuration	createStudyNotificationTopicArn(String createStudyNotificationTopicArn)
Exporter3Configuration	dataAccessTeamId(Long dataAccessTeamId)
boolean	equals(Object o)
Exporter3Configuration	exportNotificationTopicArn(String exportNotificationTopicArn)
String	getCreateStudyNotificationTopicArn() SNS topic to publish to when a study is initialized in this app.
Long	getDataAccessTeamId() Synapse team ID that is granted read access to exported health data records.
String	getExportNotificationTopicArn() SNS topic to publish to when health data is exported to Synapse.
String	getParticipantVersionDemographicsTableId() The Synapse table to where we exporter Participant Version Demographics.
String	getParticipantVersionDemographicsViewId() The Synapse materialized view which joins the Participant Versions table and the Demographics table.
String	getParticipantVersionTableId() The Synapse table to where we export Participant Versions.
String	getProjectId() The Synapse project to export health data records to.
String	getRawDataFolderId() The Synapse folder to export raw health data to.
Long	getStorageLocationId() The Synapse storage location that represents our External S3 bucket.
String	getType() Exporter3Configuration
int	hashCode()
Boolean	isConfigured() True if all configuration attributes are specified.
Exporter3Configuration	participantVersionDemographicsTableId(String participantVersionDemographicsTableId)
Exporter3Configuration	participantVersionDemographicsViewId(String participantVersionDemographicsViewId)
Exporter3Configuration	participantVersionTableId(String participantVersionTableId)
Exporter3Configuration	projectId(String projectId)
Exporter3Configuration	rawDataFolderId(String rawDataFolderId)
void	setConfigured(Boolean configured)
void	setCreateStudyNotificationTopicArn(String createStudyNotificationTopicArn)
void	setDataAccessTeamId(Long dataAccessTeamId)
void	setExportNotificationTopicArn(String exportNotificationTopicArn)
void	setParticipantVersionDemographicsTableId(String participantVersionDemographicsTableId)
void	setParticipantVersionDemographicsViewId(String participantVersionDemographicsViewId)
void	setParticipantVersionTableId(String participantVersionTableId)
void	setProjectId(String projectId)
void	setRawDataFolderId(String rawDataFolderId)
void	setStorageLocationId(Long storageLocationId)
Exporter3Configuration	storageLocationId(Long storageLocationId)
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Exporter3Configuration

public Exporter3Configuration()

Method Detail

configured

public Exporter3Configuration configured(Boolean configured)

isConfigured

public Boolean isConfigured()

True if all configuration attributes are specified.

Returns:

configured

setConfigured

public void setConfigured(Boolean configured)

createStudyNotificationTopicArn

public Exporter3Configuration createStudyNotificationTopicArn(String createStudyNotificationTopicArn)

getCreateStudyNotificationTopicArn

public String getCreateStudyNotificationTopicArn()

SNS topic to publish to when a study is initialized in this app. (This is not used for study configs.)

Returns:

createStudyNotificationTopicArn

setCreateStudyNotificationTopicArn

public void setCreateStudyNotificationTopicArn(String createStudyNotificationTopicArn)

dataAccessTeamId

public Exporter3Configuration dataAccessTeamId(Long dataAccessTeamId)

getDataAccessTeamId

public Long getDataAccessTeamId()

Synapse team ID that is granted read access to exported health data records.

Returns:

dataAccessTeamId

setDataAccessTeamId

public void setDataAccessTeamId(Long dataAccessTeamId)

exportNotificationTopicArn

public Exporter3Configuration exportNotificationTopicArn(String exportNotificationTopicArn)

getExportNotificationTopicArn

public String getExportNotificationTopicArn()

SNS topic to publish to when health data is exported to Synapse. This can be configured both for app-wide notifications and for study-specific notifications.

Returns:

exportNotificationTopicArn

setExportNotificationTopicArn

public void setExportNotificationTopicArn(String exportNotificationTopicArn)

participantVersionTableId

public Exporter3Configuration participantVersionTableId(String participantVersionTableId)

getParticipantVersionTableId

public String getParticipantVersionTableId()

The Synapse table to where we export Participant Versions.

Returns:

participantVersionTableId

setParticipantVersionTableId

public void setParticipantVersionTableId(String participantVersionTableId)

participantVersionDemographicsTableId

public Exporter3Configuration participantVersionDemographicsTableId(String participantVersionDemographicsTableId)

getParticipantVersionDemographicsTableId

public String getParticipantVersionDemographicsTableId()

The Synapse table to where we exporter Participant Version Demographics.

Returns:

participantVersionDemographicsTableId

setParticipantVersionDemographicsTableId

public void setParticipantVersionDemographicsTableId(String participantVersionDemographicsTableId)

participantVersionDemographicsViewId

public Exporter3Configuration participantVersionDemographicsViewId(String participantVersionDemographicsViewId)

getParticipantVersionDemographicsViewId

public String getParticipantVersionDemographicsViewId()

The Synapse materialized view which joins the Participant Versions table and the Demographics table.

Returns:

participantVersionDemographicsViewId

setParticipantVersionDemographicsViewId

public void setParticipantVersionDemographicsViewId(String participantVersionDemographicsViewId)

projectId

public Exporter3Configuration projectId(String projectId)

getProjectId

public String getProjectId()

The Synapse project to export health data records to. It is recommended (but not required) that this is a different project than the one used for Exporter 2.0.

Returns:

projectId

setProjectId

public void setProjectId(String projectId)

rawDataFolderId

public Exporter3Configuration rawDataFolderId(String rawDataFolderId)

getRawDataFolderId

public String getRawDataFolderId()

The Synapse folder to export raw health data to.

Returns:

rawDataFolderId

setRawDataFolderId

public void setRawDataFolderId(String rawDataFolderId)

storageLocationId

public Exporter3Configuration storageLocationId(Long storageLocationId)

getStorageLocationId

public Long getStorageLocationId()

The Synapse storage location that represents our External S3 bucket. This storage location should be STS-enabled.

Returns:

storageLocationId

setStorageLocationId

public void setStorageLocationId(Long storageLocationId)

getType

public String getType()

Exporter3Configuration

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