Class ShiftTemplate

Template specifying rules for generating shifts. A shift is a unit of work that specifies a start time, end time, and may contain events (e.g. lunch, breaks etc.). Shifts will be assigned to specific dates in the response.

Inheritance
object
ShiftTemplate
Implements
Inherited Members
Namespace: Google.Apis.CCAIPlatform.v1alpha1.Data
Assembly: Google.Apis.CCAIPlatform.v1alpha1.dll
Syntax
public class ShiftTemplate : IDirectResponseSchema

Properties

AssignableEmployeeIds

Optional. A list of specific employee IDs that can be assigned to shifts generated by this template. If this field is present, there will be EmployeeSchedules in the response for which the EmployeeSchedule.employee_id field is set to one of the IDs in this list. The number of employee schedules with an assigned employee ID will be between minimum_employee_count and maximum_employee_count. If this field is empty, between minimum_employee_count and maximum_employee_count employees can be assigned to shifts generated by this template and the employee schedules won't have an assigned employee ID. Currently, only one assignable employee ID is supported.

Declaration
[JsonProperty("assignableEmployeeIds")]
public virtual IList<string> AssignableEmployeeIds { get; set; }
Property Value
Type Description
IList<string>

DaysOffCountPerWeek

Fixed number of days off per week. An employee has a given day off if they are not assigned to a shift that starts on that day. A week is 7 days and begins on Sunday.

Declaration
[JsonProperty("daysOffCountPerWeek")]
public virtual int? DaysOffCountPerWeek { get; set; }
Property Value
Type Description
int?

DaysOffDates

Fixed dates when shifts from this template should not be generated.

Declaration
[JsonProperty("daysOffDates")]
public virtual DateList DaysOffDates { get; set; }
Property Value
Type Description
DateList

DurationMinutes

Required. Fixed duration of a shift generated by this template.

Declaration
[JsonProperty("durationMinutes")]
public virtual int? DurationMinutes { get; set; }
Property Value
Type Description
int?

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

EarliestStartTime

Required. Earliest time in the day that a shift can start. This value is specified with hours and minutes; seconds and nanos are ignored.

Declaration
[JsonProperty("earliestStartTime")]
public virtual TimeOfDay EarliestStartTime { get; set; }
Property Value
Type Description
TimeOfDay

EventTemplates

Optional. Rules for generating events for each shift. Exactly one event will be included in each shift for each EventTemplate specified.

Declaration
[JsonProperty("eventTemplates")]
public virtual IList<EventTemplate> EventTemplates { get; set; }
Property Value
Type Description
IList<EventTemplate>

Id

Required. Unique ID of this template.

Declaration
[JsonProperty("id")]
public virtual string Id { get; set; }
Property Value
Type Description
string

LatestStartTime

Required. Latest time in the day that a shift can start. This value is specified with hours and minutes; seconds and nanos are ignored. If this value is less than the earliest_start_time, it may imply an overnight shift.

Declaration
[JsonProperty("latestStartTime")]
public virtual TimeOfDay LatestStartTime { get; set; }
Property Value
Type Description
TimeOfDay

MaximumEmployeeCount

Required. Maximum number of employees that can be assigned to all shifts generated by this template on working days.

Declaration
[JsonProperty("maximumEmployeeCount")]
public virtual int? MaximumEmployeeCount { get; set; }
Property Value
Type Description
int?

MinimumEmployeeCount

Optional. Minimum number of employees that can be assigned to all shifts generated by this template on working days.

Declaration
[JsonProperty("minimumEmployeeCount")]
public virtual int? MinimumEmployeeCount { get; set; }
Property Value
Type Description
int?

MinimumIntereventGapMinutes

Optional. Minimum minutes between the end of one event and the start of the next.

Declaration
[JsonProperty("minimumIntereventGapMinutes")]
public virtual int? MinimumIntereventGapMinutes { get; set; }
Property Value
Type Description
int?

StartTimeIncrementMinutes

Optional. The time increment (in minutes) used to generate the set of possible start times between earliest_start_time and latest_start_time. For example, if the earliest start time is 8:00, the latest start time is 8:30, and the start time increment is 10 minutes, then all possible start times for this shift template are: 8:00, 8:10, 8:20, and 8:30.

Declaration
[JsonProperty("startTimeIncrementMinutes")]
public virtual int? StartTimeIncrementMinutes { get; set; }
Property Value
Type Description
int?

Implements