Share via


ScheduleInner Class

public final class ScheduleInner
extends Resource

A schedule.

Constructor Summary

Constructor Description
ScheduleInner()

Creates an instance of ScheduleInner class.

Method Summary

Modifier and Type Method and Description
OffsetDateTime createdDate()

Get the createdDate property: The creation date of the schedule.

DayDetails dailyRecurrence()

Get the dailyRecurrence property: If the schedule will occur once each day of the week, specify the daily recurrence.

static ScheduleInner fromJson(JsonReader jsonReader)

Reads an instance of ScheduleInner from the JsonReader.

HourDetails hourlyRecurrence()

Get the hourlyRecurrence property: If the schedule will occur multiple times a day, specify the hourly recurrence.

String id()

Get the id property: Fully qualified resource Id for the resource.

String name()

Get the name property: The name of the resource.

NotificationSettings notificationSettings()

Get the notificationSettings property: Notification settings.

String provisioningState()

Get the provisioningState property: The provisioning status of the resource.

EnableStatus status()

Get the status property: The status of the schedule (i.e.

String targetResourceId()

Get the targetResourceId property: The resource ID to which the schedule belongs.

String taskType()

Get the taskType property: The task type of the schedule (e.g.

String timeZoneId()

Get the timeZoneId property: The time zone ID (e.g.

JsonWriter toJson(JsonWriter jsonWriter)
String type()

Get the type property: The type of the resource.

String uniqueIdentifier()

Get the uniqueIdentifier property: The unique immutable identifier of a resource (Guid).

void validate()

Validates the instance.

WeekDetails weeklyRecurrence()

Get the weeklyRecurrence property: If the schedule will occur only some days of the week, specify the weekly recurrence.

ScheduleInner withDailyRecurrence(DayDetails dailyRecurrence)

Set the dailyRecurrence property: If the schedule will occur once each day of the week, specify the daily recurrence.

ScheduleInner withHourlyRecurrence(HourDetails hourlyRecurrence)

Set the hourlyRecurrence property: If the schedule will occur multiple times a day, specify the hourly recurrence.

ScheduleInner withLocation(String location)
ScheduleInner withNotificationSettings(NotificationSettings notificationSettings)

Set the notificationSettings property: Notification settings.

ScheduleInner withStatus(EnableStatus status)

Set the status property: The status of the schedule (i.e.

ScheduleInner withTags(Map<String,String> tags)
ScheduleInner withTargetResourceId(String targetResourceId)

Set the targetResourceId property: The resource ID to which the schedule belongs.

ScheduleInner withTaskType(String taskType)

Set the taskType property: The task type of the schedule (e.g.

ScheduleInner withTimeZoneId(String timeZoneId)

Set the timeZoneId property: The time zone ID (e.g.

ScheduleInner withWeeklyRecurrence(WeekDetails weeklyRecurrence)

Set the weeklyRecurrence property: If the schedule will occur only some days of the week, specify the weekly recurrence.

Methods inherited from ProxyResource

Methods inherited from Resource

Methods inherited from java.lang.Object

Constructor Details

ScheduleInner

public ScheduleInner()

Creates an instance of ScheduleInner class.

Method Details

createdDate

public OffsetDateTime createdDate()

Get the createdDate property: The creation date of the schedule.

Returns:

the createdDate value.

dailyRecurrence

public DayDetails dailyRecurrence()

Get the dailyRecurrence property: If the schedule will occur once each day of the week, specify the daily recurrence.

Returns:

the dailyRecurrence value.

fromJson

public static ScheduleInner fromJson(JsonReader jsonReader)

Reads an instance of ScheduleInner from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of ScheduleInner if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

hourlyRecurrence

public HourDetails hourlyRecurrence()

Get the hourlyRecurrence property: If the schedule will occur multiple times a day, specify the hourly recurrence.

Returns:

the hourlyRecurrence value.

id

public String id()

Get the id property: Fully qualified resource Id for the resource.

Overrides:

ScheduleInner.id()

Returns:

the id value.

name

public String name()

Get the name property: The name of the resource.

Overrides:

ScheduleInner.name()

Returns:

the name value.

notificationSettings

public NotificationSettings notificationSettings()

Get the notificationSettings property: Notification settings.

Returns:

the notificationSettings value.

provisioningState

public String provisioningState()

Get the provisioningState property: The provisioning status of the resource.

Returns:

the provisioningState value.

status

public EnableStatus status()

Get the status property: The status of the schedule (i.e. Enabled, Disabled).

Returns:

the status value.

targetResourceId

public String targetResourceId()

Get the targetResourceId property: The resource ID to which the schedule belongs.

Returns:

the targetResourceId value.

taskType

public String taskType()

Get the taskType property: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart).

Returns:

the taskType value.

timeZoneId

public String timeZoneId()

Get the timeZoneId property: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md).

Returns:

the timeZoneId value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

ScheduleInner.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

type

public String type()

Get the type property: The type of the resource.

Overrides:

ScheduleInner.type()

Returns:

the type value.

uniqueIdentifier

public String uniqueIdentifier()

Get the uniqueIdentifier property: The unique immutable identifier of a resource (Guid).

Returns:

the uniqueIdentifier value.

validate

public void validate()

Validates the instance.

weeklyRecurrence

public WeekDetails weeklyRecurrence()

Get the weeklyRecurrence property: If the schedule will occur only some days of the week, specify the weekly recurrence.

Returns:

the weeklyRecurrence value.

withDailyRecurrence

public ScheduleInner withDailyRecurrence(DayDetails dailyRecurrence)

Set the dailyRecurrence property: If the schedule will occur once each day of the week, specify the daily recurrence.

Parameters:

dailyRecurrence - the dailyRecurrence value to set.

Returns:

the ScheduleInner object itself.

withHourlyRecurrence

public ScheduleInner withHourlyRecurrence(HourDetails hourlyRecurrence)

Set the hourlyRecurrence property: If the schedule will occur multiple times a day, specify the hourly recurrence.

Parameters:

hourlyRecurrence - the hourlyRecurrence value to set.

Returns:

the ScheduleInner object itself.

withLocation

public ScheduleInner withLocation(String location)

Overrides:

ScheduleInner.withLocation(String location)

Parameters:

location

withNotificationSettings

public ScheduleInner withNotificationSettings(NotificationSettings notificationSettings)

Set the notificationSettings property: Notification settings.

Parameters:

notificationSettings - the notificationSettings value to set.

Returns:

the ScheduleInner object itself.

withStatus

public ScheduleInner withStatus(EnableStatus status)

Set the status property: The status of the schedule (i.e. Enabled, Disabled).

Parameters:

status - the status value to set.

Returns:

the ScheduleInner object itself.

withTags

public ScheduleInner withTags(Map<String,String> tags)

Overrides:

ScheduleInner.withTags(Map<String,String> tags)

Parameters:

tags

withTargetResourceId

public ScheduleInner withTargetResourceId(String targetResourceId)

Set the targetResourceId property: The resource ID to which the schedule belongs.

Parameters:

targetResourceId - the targetResourceId value to set.

Returns:

the ScheduleInner object itself.

withTaskType

public ScheduleInner withTaskType(String taskType)

Set the taskType property: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart).

Parameters:

taskType - the taskType value to set.

Returns:

the ScheduleInner object itself.

withTimeZoneId

public ScheduleInner withTimeZoneId(String timeZoneId)

Set the timeZoneId property: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md).

Parameters:

timeZoneId - the timeZoneId value to set.

Returns:

the ScheduleInner object itself.

withWeeklyRecurrence

public ScheduleInner withWeeklyRecurrence(WeekDetails weeklyRecurrence)

Set the weeklyRecurrence property: If the schedule will occur only some days of the week, specify the weekly recurrence.

Parameters:

weeklyRecurrence - the weeklyRecurrence value to set.

Returns:

the ScheduleInner object itself.

Applies to