ScheduledInstanceRecurrenceRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.ec2.model.ScheduledInstanceRecurrenceRequest

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ScheduledInstanceRecurrenceRequest
extends Object
implements Serializable, Cloneable

Describes the recurring schedule for a Scheduled Instance.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ScheduledInstanceRecurrenceRequest()

Constructors
Constructor and Description
`ScheduledInstanceRecurrenceRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ScheduledInstanceRecurrenceRequest`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getFrequency()` The frequency (`Daily`, `Weekly`, or `Monthly`).
`Integer`	`getInterval()` The interval quantity.
`List<Integer>`	`getOccurrenceDays()` The days.
`Boolean`	`getOccurrenceRelativeToEnd()` Indicates whether the occurrence is relative to the end of the specified week or month.
`String`	`getOccurrenceUnit()` The unit for `OccurrenceDays` (`DayOfWeek` or `DayOfMonth`).
`int`	`hashCode()`
`Boolean`	`isOccurrenceRelativeToEnd()` Indicates whether the occurrence is relative to the end of the specified week or month.
`void`	`setFrequency(String frequency)` The frequency (`Daily`, `Weekly`, or `Monthly`).
`void`	`setInterval(Integer interval)` The interval quantity.
`void`	`setOccurrenceDays(Collection<Integer> occurrenceDays)` The days.
`void`	`setOccurrenceRelativeToEnd(Boolean occurrenceRelativeToEnd)` Indicates whether the occurrence is relative to the end of the specified week or month.
`void`	`setOccurrenceUnit(String occurrenceUnit)` The unit for `OccurrenceDays` (`DayOfWeek` or `DayOfMonth`).
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`ScheduledInstanceRecurrenceRequest`	`withFrequency(String frequency)` The frequency (`Daily`, `Weekly`, or `Monthly`).
`ScheduledInstanceRecurrenceRequest`	`withInterval(Integer interval)` The interval quantity.
`ScheduledInstanceRecurrenceRequest`	`withOccurrenceDays(Collection<Integer> occurrenceDays)` The days.
`ScheduledInstanceRecurrenceRequest`	`withOccurrenceDays(Integer... occurrenceDays)` The days.
`ScheduledInstanceRecurrenceRequest`	`withOccurrenceRelativeToEnd(Boolean occurrenceRelativeToEnd)` Indicates whether the occurrence is relative to the end of the specified week or month.
`ScheduledInstanceRecurrenceRequest`	`withOccurrenceUnit(String occurrenceUnit)` The unit for `OccurrenceDays` (`DayOfWeek` or `DayOfMonth`).

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ScheduledInstanceRecurrenceRequest
```
public ScheduledInstanceRecurrenceRequest()
```
- Method Detail
  - setFrequency
```
public void setFrequency(String frequency)
```
    The frequency (Daily, Weekly, or Monthly).
    
    Parameters:
    
    frequency - The frequency (Daily, Weekly, or Monthly).
  - getFrequency
```
public String getFrequency()
```
    The frequency (Daily, Weekly, or Monthly).
    
    Returns:
    
    The frequency (Daily, Weekly, or Monthly).
  - withFrequency
```
public ScheduledInstanceRecurrenceRequest withFrequency(String frequency)
```
    The frequency (Daily, Weekly, or Monthly).
    
    Parameters:
    
    frequency - The frequency (Daily, Weekly, or Monthly).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInterval
```
public void setInterval(Integer interval)
```
    The interval quantity. The interval unit depends on the value of Frequency. For example, every 2 weeks or every 2 months.
    
    Parameters:
    
    interval - The interval quantity. The interval unit depends on the value of Frequency. For example, every 2 weeks or every 2 months.
  - getInterval
```
public Integer getInterval()
```
    The interval quantity. The interval unit depends on the value of Frequency. For example, every 2 weeks or every 2 months.
    
    Returns:
    
    The interval quantity. The interval unit depends on the value of Frequency. For example, every 2 weeks or every 2 months.
  - withInterval
```
public ScheduledInstanceRecurrenceRequest withInterval(Integer interval)
```
    The interval quantity. The interval unit depends on the value of Frequency. For example, every 2 weeks or every 2 months.
    
    Parameters:
    
    interval - The interval quantity. The interval unit depends on the value of Frequency. For example, every 2 weeks or every 2 months.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getOccurrenceDays
```
public List<Integer> getOccurrenceDays()
```
    The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday). You can't specify this value with a daily schedule. If the occurrence is relative to the end of the month, you can specify only a single day.
    
    Returns:
    
    The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday). You can't specify this value with a daily schedule. If the occurrence is relative to the end of the month, you can specify only a single day.
  - setOccurrenceDays
```
public void setOccurrenceDays(Collection<Integer> occurrenceDays)
```
    The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday). You can't specify this value with a daily schedule. If the occurrence is relative to the end of the month, you can specify only a single day.
    
    Parameters:
    
    occurrenceDays - The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday). You can't specify this value with a daily schedule. If the occurrence is relative to the end of the month, you can specify only a single day.
  - withOccurrenceDays
```
public ScheduledInstanceRecurrenceRequest withOccurrenceDays(Integer... occurrenceDays)
```
    The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday). You can't specify this value with a daily schedule. If the occurrence is relative to the end of the month, you can specify only a single day.
    
    NOTE: This method appends the values to the existing list (if any). Use setOccurrenceDays(java.util.Collection) or withOccurrenceDays(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    occurrenceDays - The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday). You can't specify this value with a daily schedule. If the occurrence is relative to the end of the month, you can specify only a single day.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withOccurrenceDays
```
public ScheduledInstanceRecurrenceRequest withOccurrenceDays(Collection<Integer> occurrenceDays)
```
    The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday). You can't specify this value with a daily schedule. If the occurrence is relative to the end of the month, you can specify only a single day.
    
    Parameters:
    
    occurrenceDays - The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday). You can't specify this value with a daily schedule. If the occurrence is relative to the end of the month, you can specify only a single day.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOccurrenceRelativeToEnd
```
public void setOccurrenceRelativeToEnd(Boolean occurrenceRelativeToEnd)
```
    Indicates whether the occurrence is relative to the end of the specified week or month. You can't specify this value with a daily schedule.
    
    Parameters:
    
    occurrenceRelativeToEnd - Indicates whether the occurrence is relative to the end of the specified week or month. You can't specify this value with a daily schedule.
  - getOccurrenceRelativeToEnd
```
public Boolean getOccurrenceRelativeToEnd()
```
    Indicates whether the occurrence is relative to the end of the specified week or month. You can't specify this value with a daily schedule.
    
    Returns:
    
    Indicates whether the occurrence is relative to the end of the specified week or month. You can't specify this value with a daily schedule.
  - withOccurrenceRelativeToEnd
```
public ScheduledInstanceRecurrenceRequest withOccurrenceRelativeToEnd(Boolean occurrenceRelativeToEnd)
```
    Indicates whether the occurrence is relative to the end of the specified week or month. You can't specify this value with a daily schedule.
    
    Parameters:
    
    occurrenceRelativeToEnd - Indicates whether the occurrence is relative to the end of the specified week or month. You can't specify this value with a daily schedule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isOccurrenceRelativeToEnd
```
public Boolean isOccurrenceRelativeToEnd()
```
    Indicates whether the occurrence is relative to the end of the specified week or month. You can't specify this value with a daily schedule.
    
    Returns:
    
    Indicates whether the occurrence is relative to the end of the specified week or month. You can't specify this value with a daily schedule.
  - setOccurrenceUnit
```
public void setOccurrenceUnit(String occurrenceUnit)
```
    The unit for OccurrenceDays (DayOfWeek or DayOfMonth). This value is required for a monthly schedule. You can't specify DayOfWeek with a weekly schedule. You can't specify this value with a daily schedule.
    
    Parameters:
    
    occurrenceUnit - The unit for OccurrenceDays (DayOfWeek or DayOfMonth). This value is required for a monthly schedule. You can't specify DayOfWeek with a weekly schedule. You can't specify this value with a daily schedule.
  - getOccurrenceUnit
```
public String getOccurrenceUnit()
```
    The unit for OccurrenceDays (DayOfWeek or DayOfMonth). This value is required for a monthly schedule. You can't specify DayOfWeek with a weekly schedule. You can't specify this value with a daily schedule.
    
    Returns:
    
    The unit for OccurrenceDays (DayOfWeek or DayOfMonth). This value is required for a monthly schedule. You can't specify DayOfWeek with a weekly schedule. You can't specify this value with a daily schedule.
  - withOccurrenceUnit
```
public ScheduledInstanceRecurrenceRequest withOccurrenceUnit(String occurrenceUnit)
```
    The unit for OccurrenceDays (DayOfWeek or DayOfMonth). This value is required for a monthly schedule. You can't specify DayOfWeek with a weekly schedule. You can't specify this value with a daily schedule.
    
    Parameters:
    
    occurrenceUnit - The unit for OccurrenceDays (DayOfWeek or DayOfMonth). This value is required for a monthly schedule. You can't specify DayOfWeek with a weekly schedule. You can't specify this value with a daily schedule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ScheduledInstanceRecurrenceRequest clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class ScheduledInstanceRecurrenceRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ScheduledInstanceRecurrenceRequest

Method Detail

setFrequency

getFrequency

withFrequency

setInterval

getInterval

withInterval

getOccurrenceDays

setOccurrenceDays

withOccurrenceDays

withOccurrenceDays

setOccurrenceRelativeToEnd

getOccurrenceRelativeToEnd

withOccurrenceRelativeToEnd

isOccurrenceRelativeToEnd

setOccurrenceUnit

getOccurrenceUnit

withOccurrenceUnit

toString

equals

hashCode

clone