Package com.mypurecloud.sdk.v2.model

Class BuScheduleRun

java.lang.Object
com.mypurecloud.sdk.v2.model.BuScheduleRun
All Implemented Interfaces:
Serializable
public class BuScheduleRun extends Object implements Serializable
BuScheduleRun
See Also:

  • Constructor Details

    • BuScheduleRun

      public BuScheduleRun()

    • BuScheduleRun

      public BuScheduleRun(Boolean initWithEmptyList)

  • Method Details

    • id

      public BuScheduleRun id(String id)
      The globally unique identifier for the object.

    • getId

      public String getId()

    • setId

      public void setId(String id)

    • schedulerRunId

      public BuScheduleRun schedulerRunId(String schedulerRunId)
      The scheduler run ID. Reference this value for support

    • getSchedulerRunId

      public String getSchedulerRunId()

    • setSchedulerRunId

      public void setSchedulerRunId(String schedulerRunId)

    • intradayRescheduling

      public BuScheduleRun intradayRescheduling(Boolean intradayRescheduling)
      Whether this is an intraday rescheduling run

    • getIntradayRescheduling

      public Boolean getIntradayRescheduling()

    • setIntradayRescheduling

      public void setIntradayRescheduling(Boolean intradayRescheduling)

    • state

      public BuScheduleRun state(BuScheduleRun.StateEnum state)
      The state of the generation run

    • getState

      public BuScheduleRun.StateEnum getState()

    • setState

      public void setState(BuScheduleRun.StateEnum state)

    • weekCount

      public BuScheduleRun weekCount(Integer weekCount)
      The number of weeks spanned by the schedule

    • getWeekCount

      public Integer getWeekCount()

    • setWeekCount

      public void setWeekCount(Integer weekCount)

    • percentComplete

      public BuScheduleRun percentComplete(Double percentComplete)
      Percent completion of the schedule run

    • getPercentComplete

      public Double getPercentComplete()

    • setPercentComplete

      public void setPercentComplete(Double percentComplete)

    • targetWeek

      public BuScheduleRun targetWeek(LocalDate targetWeek)
      The start date of the target week. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd

    • getTargetWeek

      public LocalDate getTargetWeek()

    • setTargetWeek

      public void setTargetWeek(LocalDate targetWeek)

    • schedule

      public BuScheduleRun schedule(BuScheduleReference schedule)
      The generated schedule. Null unless the schedule run is complete

    • getSchedule

      public BuScheduleReference getSchedule()

    • setSchedule

      public void setSchedule(BuScheduleReference schedule)

    • scheduleDescription

      public BuScheduleRun scheduleDescription(String scheduleDescription)
      The description of the generated schedule

    • getScheduleDescription

      public String getScheduleDescription()

    • setScheduleDescription

      public void setScheduleDescription(String scheduleDescription)

    • schedulingStartTime

      public BuScheduleRun schedulingStartTime(Date schedulingStartTime)
      When the schedule generation run started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

    • getSchedulingStartTime

      public Date getSchedulingStartTime()

    • setSchedulingStartTime

      public void setSchedulingStartTime(Date schedulingStartTime)

    • schedulingStartedBy

      public BuScheduleRun schedulingStartedBy(UserReference schedulingStartedBy)
      The user who started the scheduling run

    • getSchedulingStartedBy

      public UserReference getSchedulingStartedBy()

    • setSchedulingStartedBy

      public void setSchedulingStartedBy(UserReference schedulingStartedBy)

    • schedulingCanceledBy

      public BuScheduleRun schedulingCanceledBy(UserReference schedulingCanceledBy)
      The user who canceled the scheduling run, if applicable

    • getSchedulingCanceledBy

      public UserReference getSchedulingCanceledBy()

    • setSchedulingCanceledBy

      public void setSchedulingCanceledBy(UserReference schedulingCanceledBy)

    • schedulingCompletedTime

      public BuScheduleRun schedulingCompletedTime(Date schedulingCompletedTime)
      When the scheduling run was completed, if applicable. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

    • getSchedulingCompletedTime

      public Date getSchedulingCompletedTime()

    • setSchedulingCompletedTime

      public void setSchedulingCompletedTime(Date schedulingCompletedTime)

    • messageCount

      public BuScheduleRun messageCount(Integer messageCount)
      The number of schedule generation messages for this schedule generation run

    • getMessageCount

      public Integer getMessageCount()

    • setMessageCount

      public void setMessageCount(Integer messageCount)

    • messageSeverityCounts

      public BuScheduleRun messageSeverityCounts(List<SchedulerMessageSeverityCount> messageSeverityCounts)
      The list of schedule generation message counts by severity for this schedule generation run

    • getMessageSeverityCounts

      public List<SchedulerMessageSeverityCount> getMessageSeverityCounts()

    • setMessageSeverityCounts

      public void setMessageSeverityCounts(List<SchedulerMessageSeverityCount> messageSeverityCounts)

    • reschedulingOptions

      public BuScheduleRun reschedulingOptions(ReschedulingOptionsRunResponse reschedulingOptions)
      Rescheduling options for this run. Null unless intradayRescheduling is true

    • getReschedulingOptions

      public ReschedulingOptionsRunResponse getReschedulingOptions()

    • setReschedulingOptions

      public void setReschedulingOptions(ReschedulingOptionsRunResponse reschedulingOptions)

    • reschedulingResultExpiration

      public BuScheduleRun reschedulingResultExpiration(Date reschedulingResultExpiration)
      When the reschedule result will expire. Null unless intradayRescheduling is true. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

    • getReschedulingResultExpiration

      public Date getReschedulingResultExpiration()

    • setReschedulingResultExpiration

      public void setReschedulingResultExpiration(Date reschedulingResultExpiration)

    • getSelfUri

      public String getSelfUri()

    • 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