Schedule Interface

Package:

com.azure.resourcemanager.devtestlabs.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-devtestlabs:1.0.0-beta.2

public interface Schedule

An immutable client-side representation of Schedule.

Method Summary

Modifier and Type	Method and Description
abstract OffsetDateTime	createdDate() Gets the createdDate property: The creation date of the schedule.
abstract DayDetails	dailyRecurrence() Gets the dailyRecurrence property: If the schedule will occur once each day of the week, specify the daily recurrence.
abstract void	execute() Execute a schedule.
abstract void	execute(Context context) Execute a schedule.
abstract HourDetails	hourlyRecurrence() Gets the hourlyRecurrence property: If the schedule will occur multiple times a day, specify the hourly recurrence.
abstract String	id() Gets the id property: Fully qualified resource Id for the resource.
abstract ScheduleInner	innerModel() Gets the inner com.azure.resourcemanager.devtestlabs.fluent.models.ScheduleInner object.
abstract String	location() Gets the location property: The geo-location where the resource lives.
abstract String	name() Gets the name property: The name of the resource.
abstract NotificationSettings	notificationSettings() Gets the notificationSettings property: Notification settings.
abstract String	provisioningState() Gets the provisioningState property: The provisioning status of the resource.
abstract Schedule	refresh() Refreshes the resource to sync with Azure.
abstract Schedule	refresh(Context context) Refreshes the resource to sync with Azure.
abstract Region	region() Gets the region of the resource.
abstract String	regionName() Gets the name of the resource region.
abstract String	resourceGroupName() Gets the name of the resource group.
abstract void	retarget(RetargetScheduleProperties retargetScheduleProperties) Updates a schedule's target resource Id.
abstract void	retarget(RetargetScheduleProperties retargetScheduleProperties, Context context) Updates a schedule's target resource Id.
abstract EnableStatus	status() Gets the status property: The status of the schedule (i.e.
abstract Map<String,String>	tags() Gets the tags property: Resource tags.
abstract String	targetResourceId() Gets the targetResourceId property: The resource ID to which the schedule belongs.
abstract String	taskType() Gets the taskType property: The task type of the schedule (e.g.
abstract String	timeZoneId() Gets the timeZoneId property: The time zone ID (e.g.
abstract String	type() Gets the type property: The type of the resource.
abstract String	uniqueIdentifier() Gets the uniqueIdentifier property: The unique immutable identifier of a resource (Guid).
abstract Update	update() Begins update for the Schedule resource.
abstract WeekDetails	weeklyRecurrence() Gets the weeklyRecurrence property: If the schedule will occur only some days of the week, specify the weekly recurrence.

Method Details

createdDate

public abstract OffsetDateTime createdDate()

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

Returns:

the createdDate value.

dailyRecurrence

public abstract 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.

execute

public abstract void execute()

Execute a schedule. This operation can take a while to complete.

execute

public abstract void execute(Context context)

Execute a schedule. This operation can take a while to complete.

Parameters:

context - The context to associate with this operation.

hourlyRecurrence

public abstract HourDetails hourlyRecurrence()

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

Returns:

the hourlyRecurrence value.

id

public abstract String id()

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

Returns:

the id value.

innerModel

public abstract ScheduleInner innerModel()

Gets the inner com.azure.resourcemanager.devtestlabs.fluent.models.ScheduleInner object.

Returns:

the inner object.

location

public abstract String location()

Gets the location property: The geo-location where the resource lives.

Returns:

the location value.

name

public abstract String name()

Gets the name property: The name of the resource.

Returns:

the name value.

notificationSettings

public abstract NotificationSettings notificationSettings()

Gets the notificationSettings property: Notification settings.

Returns:

the notificationSettings value.

provisioningState

public abstract String provisioningState()

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

Returns:

the provisioningState value.

refresh

public abstract Schedule refresh()

Refreshes the resource to sync with Azure.

Returns:

the refreshed resource.

refresh

public abstract Schedule refresh(Context context)

Refreshes the resource to sync with Azure.

Parameters:

context - The context to associate with this operation.

Returns:

the refreshed resource.

region

public abstract Region region()

Gets the region of the resource.

Returns:

the region of the resource.

regionName

public abstract String regionName()

Gets the name of the resource region.

Returns:

the name of the resource region.

resourceGroupName

public abstract String resourceGroupName()

Gets the name of the resource group.

Returns:

the name of the resource group.

retarget

public abstract void retarget(RetargetScheduleProperties retargetScheduleProperties)

Updates a schedule's target resource Id. This operation can take a while to complete.

Parameters:

retargetScheduleProperties - Properties for retargeting a virtual machine schedule.

retarget

public abstract void retarget(RetargetScheduleProperties retargetScheduleProperties, 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.

status

public abstract EnableStatus status()

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

Returns:

the status value.

tags

public abstract Map tags()

Gets the tags property: Resource tags.

Returns:

the tags value.

targetResourceId

public abstract String targetResourceId()

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

Returns:

the targetResourceId value.

taskType

public abstract String taskType()

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

Returns:

the taskType value.

timeZoneId

public abstract String timeZoneId()

Gets the timeZoneId property: The time zone ID (e.g. Pacific Standard time).

Returns:

the timeZoneId value.

type

public abstract String type()

Gets the type property: The type of the resource.

Returns:

the type value.

uniqueIdentifier

public abstract String uniqueIdentifier()

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

Returns:

the uniqueIdentifier value.

update

public abstract Schedule.Update update()

Begins update for the Schedule resource.

Returns:

the stage of resource update.

weeklyRecurrence

public abstract 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.