org.sagebionetworks.bridge.rest.model

Class StudyBurst

java.lang.Object

org.sagebionetworks.bridge.rest.model.StudyBurst

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

The description of a repeating burst of events, against which a study can schedule repeating sets of activities. A study burst is triggered by an `originEventId`, it then occurs at an `interval` period of time after that event for a specific number of `occurrences`. For example, a study burst of \"foo\" that is triggered by the `timeline_retrieved` event, with an interval of \"P1W\" and an occurrence of 3 would generate three events: `study_burst:foo:01` (a week after the `timeline_retrieved` event), `study_burst:foo:02` (two weeks after `timeline_retrieved` event), and `study_burst:foo:03` (three weeks after the `timeline_retrieved` event).

Constructor Summary

Constructors

Constructor and Description
StudyBurst()

Method Summary

Modifier and Type	Method and Description
StudyBurst	delay(String delay)
boolean	equals(Object o)
String	getDelay() ISO 8601 duration between the origin event timestamp and the first burst in the study burst sequence (days or weeks)
String	getIdentifier() Identifier for the study burst.
String	getInterval() ISO 8601 duration between the burst event timestamps in days or weeks
Integer	getOccurrences() The number of timestamps that should be generated with the `originEventId` occurs.
String	getOriginEventId() The event ID that will trigger the generation of a set of study burst events
String	getType() StudyBurst
ActivityEventUpdateType	getUpdateType() Get updateType
int	hashCode()
StudyBurst	identifier(String identifier)
StudyBurst	interval(String interval)
StudyBurst	occurrences(Integer occurrences)
StudyBurst	originEventId(String originEventId)
void	setDelay(String delay)
void	setIdentifier(String identifier)
void	setInterval(String interval)
void	setOccurrences(Integer occurrences)
void	setOriginEventId(String originEventId)
void	setUpdateType(ActivityEventUpdateType updateType)
String	toString()
StudyBurst	updateType(ActivityEventUpdateType updateType)

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StudyBurst

public StudyBurst()

Method Detail

identifier

public StudyBurst identifier(String identifier)

getIdentifier

public String getIdentifier()

Identifier for the study burst. May contain any characters except a colon.

Returns:

identifier

setIdentifier

public void setIdentifier(String identifier)

originEventId

public StudyBurst originEventId(String originEventId)

getOriginEventId

public String getOriginEventId()

The event ID that will trigger the generation of a set of study burst events

Returns:

originEventId

setOriginEventId

public void setOriginEventId(String originEventId)

delay

public StudyBurst delay(String delay)

getDelay

public String getDelay()

ISO 8601 duration between the origin event timestamp and the first burst in the study burst sequence (days or weeks)

Returns:

delay

setDelay

public void setDelay(String delay)

interval

public StudyBurst interval(String interval)

getInterval

public String getInterval()

ISO 8601 duration between the burst event timestamps in days or weeks

Returns:

interval

setInterval

public void setInterval(String interval)

occurrences

public StudyBurst occurrences(Integer occurrences)

getOccurrences

public Integer getOccurrences()

The number of timestamps that should be generated with the `originEventId` occurs.

Returns:

occurrences

setOccurrences

public void setOccurrences(Integer occurrences)

updateType

public StudyBurst updateType(ActivityEventUpdateType updateType)

getUpdateType

public ActivityEventUpdateType getUpdateType()

Get updateType

Returns:

updateType

setUpdateType

public void setUpdateType(ActivityEventUpdateType updateType)

getType

public String getType()

StudyBurst

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