Interface Schedule
public interface Schedule
An immutable client-side representation of Schedule.
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic interface
The entirety of the Schedule definition.static interface
The Schedule definition stages.static interface
The template for Schedule update.static interface
The Schedule update stages. -
Method Summary
Modifier and TypeMethodDescriptionGets the createdDate property: The creation date of the schedule.Gets the dailyRecurrence property: If the schedule will occur once each day of the week, specify the daily recurrence.void
execute()
Execute a schedule.void
execute
(com.azure.core.util.Context context) Execute a schedule.Gets the hourlyRecurrence property: If the schedule will occur multiple times a day, specify the hourly recurrence.id()
Gets the id property: Fully qualified resource Id for the resource.Gets the inner com.azure.resourcemanager.devtestlabs.fluent.models.ScheduleInner object.location()
Gets the location property: The geo-location where the resource lives.name()
Gets the name property: The name of the resource.Gets the notificationSettings property: Notification settings.Gets the provisioningState property: The provisioning status of the resource.refresh()
Refreshes the resource to sync with Azure.refresh
(com.azure.core.util.Context context) Refreshes the resource to sync with Azure.com.azure.core.management.Region
region()
Gets the region of the resource.Gets the name of the resource region.Gets the name of the resource group.void
retarget
(RetargetScheduleProperties retargetScheduleProperties) Updates a schedule's target resource Id.void
retarget
(RetargetScheduleProperties retargetScheduleProperties, com.azure.core.util.Context context) Updates a schedule's target resource Id.status()
Gets the status property: The status of the schedule (i.e.tags()
Gets the tags property: Resource tags.Gets the targetResourceId property: The resource ID to which the schedule belongs.taskType()
Gets the taskType property: The task type of the schedule (e.g.Gets the timeZoneId property: The time zone ID (e.g.type()
Gets the type property: The type of the resource.Gets the uniqueIdentifier property: The unique immutable identifier of a resource (Guid).update()
Begins update for the Schedule resource.Gets the weeklyRecurrence property: If the schedule will occur only some days of the week, specify the weekly recurrence.
-
Method Details
-
id
String id()Gets the id property: Fully qualified resource Id for the resource.- Returns:
- the id value.
-
name
String name()Gets the name property: The name of the resource.- Returns:
- the name value.
-
type
String type()Gets the type property: The type of the resource.- Returns:
- the type value.
-
location
String location()Gets the location property: The geo-location where the resource lives.- Returns:
- the location value.
-
tags
Gets the tags property: Resource tags.- Returns:
- the tags value.
-
status
EnableStatus status()Gets the status property: The status of the schedule (i.e. Enabled, Disabled).- Returns:
- the status value.
-
taskType
String taskType()Gets the taskType property: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart).- Returns:
- the taskType value.
-
weeklyRecurrence
WeekDetails weeklyRecurrence()Gets the weeklyRecurrence property: If the schedule will occur only some days of the week, specify the weekly recurrence.- Returns:
- the weeklyRecurrence value.
-
dailyRecurrence
DayDetails dailyRecurrence()Gets the dailyRecurrence property: If the schedule will occur once each day of the week, specify the daily recurrence.- Returns:
- the dailyRecurrence value.
-
hourlyRecurrence
HourDetails hourlyRecurrence()Gets the hourlyRecurrence property: If the schedule will occur multiple times a day, specify the hourly recurrence.- Returns:
- the hourlyRecurrence value.
-
timeZoneId
String timeZoneId()Gets the timeZoneId property: The time zone ID (e.g. Pacific Standard time).- Returns:
- the timeZoneId value.
-
notificationSettings
NotificationSettings notificationSettings()Gets the notificationSettings property: Notification settings.- Returns:
- the notificationSettings value.
-
createdDate
OffsetDateTime createdDate()Gets the createdDate property: The creation date of the schedule.- Returns:
- the createdDate value.
-
targetResourceId
String targetResourceId()Gets the targetResourceId property: The resource ID to which the schedule belongs.- Returns:
- the targetResourceId value.
-
provisioningState
String provisioningState()Gets the provisioningState property: The provisioning status of the resource.- Returns:
- the provisioningState value.
-
uniqueIdentifier
String uniqueIdentifier()Gets the uniqueIdentifier property: The unique immutable identifier of a resource (Guid).- Returns:
- the uniqueIdentifier value.
-
region
com.azure.core.management.Region region()Gets the region of the resource.- Returns:
- the region of the resource.
-
regionName
String regionName()Gets the name of the resource region.- Returns:
- the name of the resource region.
-
resourceGroupName
String resourceGroupName()Gets the name of the resource group.- Returns:
- the name of the resource group.
-
innerModel
ScheduleInner innerModel()Gets the inner com.azure.resourcemanager.devtestlabs.fluent.models.ScheduleInner object.- Returns:
- the inner object.
-
update
Schedule.Update update()Begins update for the Schedule resource.- Returns:
- the stage of resource update.
-
refresh
Schedule refresh()Refreshes the resource to sync with Azure.- Returns:
- the refreshed resource.
-
refresh
Refreshes the resource to sync with Azure.- Parameters:
context
- The context to associate with this operation.- Returns:
- the refreshed resource.
-
execute
void execute()Execute a schedule. This operation can take a while to complete.- Throws:
com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
execute
void execute(com.azure.core.util.Context context) Execute a schedule. This operation can take a while to complete.- Parameters:
context
- The context to associate with this operation.- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
retarget
Updates a schedule's target resource Id. This operation can take a while to complete.- Parameters:
retargetScheduleProperties
- Properties for retargeting a virtual machine schedule.- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
retarget
void retarget(RetargetScheduleProperties retargetScheduleProperties, com.azure.core.util.Context context) Updates a schedule's target resource Id. This operation can take a while to complete.- Parameters:
retargetScheduleProperties
- Properties for retargeting a virtual machine schedule.context
- The context to associate with this operation.- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-