CanaryScheduleInput (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.synthetics.model.CanaryScheduleInput

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CanaryScheduleInput
extends Object
implements Serializable, Cloneable, StructuredPojo
```
This structure specifies how often a canary is to make runs and the date and time when it should stop making runs.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

CanaryScheduleInput()

Constructors
Constructor and Description
`CanaryScheduleInput()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CanaryScheduleInput`	`clone()`
`boolean`	`equals(Object obj)`
`Long`	`getDurationInSeconds()` How long, in seconds, for the canary to continue making regular runs according to the schedule in the `Expression` value.
`String`	`getExpression()` A rate expression that defines how often the canary is to run.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDurationInSeconds(Long durationInSeconds)` How long, in seconds, for the canary to continue making regular runs according to the schedule in the `Expression` value.
`void`	`setExpression(String expression)` A rate expression that defines how often the canary is to run.
`String`	`toString()` Returns a string representation of this object.
`CanaryScheduleInput`	`withDurationInSeconds(Long durationInSeconds)` How long, in seconds, for the canary to continue making regular runs according to the schedule in the `Expression` value.
`CanaryScheduleInput`	`withExpression(String expression)` A rate expression that defines how often the canary is to run.

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

- Constructor Detail
  - CanaryScheduleInput
```
public CanaryScheduleInput()
```
- Method Detail
  - setExpression
```
public void setExpression(String expression)
```
    A rate expression that defines how often the canary is to run. The syntax is rate(number unit). unit can be minute, minutes, or hour.
    
    For example, rate(1 minute) runs the canary once a minute, rate(10 minutes) runs it once every 10 minutes, and rate(1 hour) runs it once every hour. You can specify a frequency between rate(1 minute) and rate(1 hour).
    
    Specifying rate(0 minute) or rate(0 hour) is a special value that causes the canary to run only once when it is started.
    
    Parameters:
    
    expression - A rate expression that defines how often the canary is to run. The syntax is rate(number unit). unit can be minute, minutes, or hour.
    
    For example, rate(1 minute) runs the canary once a minute, rate(10 minutes) runs it once every 10 minutes, and rate(1 hour) runs it once every hour. You can specify a frequency between rate(1 minute) and rate(1 hour).
    
    Specifying rate(0 minute) or rate(0 hour) is a special value that causes the canary to run only once when it is started.
  - getExpression
```
public String getExpression()
```
    A rate expression that defines how often the canary is to run. The syntax is rate(number unit). unit can be minute, minutes, or hour.
    
    For example, rate(1 minute) runs the canary once a minute, rate(10 minutes) runs it once every 10 minutes, and rate(1 hour) runs it once every hour. You can specify a frequency between rate(1 minute) and rate(1 hour).
    
    Specifying rate(0 minute) or rate(0 hour) is a special value that causes the canary to run only once when it is started.
    
    Returns:
    
    A rate expression that defines how often the canary is to run. The syntax is rate(number unit). unit can be minute, minutes, or hour.
    
    For example, rate(1 minute) runs the canary once a minute, rate(10 minutes) runs it once every 10 minutes, and rate(1 hour) runs it once every hour. You can specify a frequency between rate(1 minute) and rate(1 hour).
    
    Specifying rate(0 minute) or rate(0 hour) is a special value that causes the canary to run only once when it is started.
  - withExpression
```
public CanaryScheduleInput withExpression(String expression)
```
    A rate expression that defines how often the canary is to run. The syntax is rate(number unit). unit can be minute, minutes, or hour.
    
    For example, rate(1 minute) runs the canary once a minute, rate(10 minutes) runs it once every 10 minutes, and rate(1 hour) runs it once every hour. You can specify a frequency between rate(1 minute) and rate(1 hour).
    
    Specifying rate(0 minute) or rate(0 hour) is a special value that causes the canary to run only once when it is started.
    
    Parameters:
    
    expression - A rate expression that defines how often the canary is to run. The syntax is rate(number unit). unit can be minute, minutes, or hour.
    
    For example, rate(1 minute) runs the canary once a minute, rate(10 minutes) runs it once every 10 minutes, and rate(1 hour) runs it once every hour. You can specify a frequency between rate(1 minute) and rate(1 hour).
    
    Specifying rate(0 minute) or rate(0 hour) is a special value that causes the canary to run only once when it is started.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDurationInSeconds
```
public void setDurationInSeconds(Long durationInSeconds)
```
    How long, in seconds, for the canary to continue making regular runs according to the schedule in the Expression value. If you specify 0, the canary continues making runs until you stop it. If you omit this field, the default of 0 is used.
    
    Parameters:
    
    durationInSeconds - How long, in seconds, for the canary to continue making regular runs according to the schedule in the Expression value. If you specify 0, the canary continues making runs until you stop it. If you omit this field, the default of 0 is used.
  - getDurationInSeconds
```
public Long getDurationInSeconds()
```
    How long, in seconds, for the canary to continue making regular runs according to the schedule in the Expression value. If you specify 0, the canary continues making runs until you stop it. If you omit this field, the default of 0 is used.
    
    Returns:
    
    How long, in seconds, for the canary to continue making regular runs according to the schedule in the Expression value. If you specify 0, the canary continues making runs until you stop it. If you omit this field, the default of 0 is used.
  - withDurationInSeconds
```
public CanaryScheduleInput withDurationInSeconds(Long durationInSeconds)
```
    How long, in seconds, for the canary to continue making regular runs according to the schedule in the Expression value. If you specify 0, the canary continues making runs until you stop it. If you omit this field, the default of 0 is used.
    
    Parameters:
    
    durationInSeconds - How long, in seconds, for the canary to continue making regular runs according to the schedule in the Expression value. If you specify 0, the canary continues making runs until you stop it. If you omit this field, the default of 0 is used.
    
    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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    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 CanaryScheduleInput clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class CanaryScheduleInput

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CanaryScheduleInput

Method Detail

setExpression

getExpression

withExpression

setDurationInSeconds

getDurationInSeconds

withDurationInSeconds

toString

equals

hashCode

clone

marshall