CanaryScheduleOutput (AWS Java SDK for Synthetics 1.12.328 API)

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CanaryScheduleOutput
extends Object
implements Serializable, Cloneable, StructuredPojo
```
How long, in seconds, for the canary to continue making regular runs according to the schedule in the Expression value.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

CanaryScheduleOutput()

Constructors
Constructor and Description
`CanaryScheduleOutput()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CanaryScheduleOutput`	`clone()`
`boolean`	`equals(Object obj)`
`Long`	`getDurationInSeconds()` How long, in seconds, for the canary to continue making regular runs after it was created.
`String`	`getExpression()` A `rate` expression or a `cron` expression that defines how often the canary is to run.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setDurationInSeconds(Long durationInSeconds)` How long, in seconds, for the canary to continue making regular runs after it was created.
`void`	`setExpression(String expression)` A `rate` expression or a `cron` expression that defines how often the canary is to run.
`String`	`toString()` Returns a string representation of this object.
`CanaryScheduleOutput`	`withDurationInSeconds(Long durationInSeconds)` How long, in seconds, for the canary to continue making regular runs after it was created.
`CanaryScheduleOutput`	`withExpression(String expression)` A `rate` expression or a `cron` expression that defines how often the canary is to run.

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

- Constructor Detail
  - CanaryScheduleOutput
```
public CanaryScheduleOutput()
```
- Method Detail
  - setExpression
```
public void setExpression(String expression)
```
    A rate expression or a cron expression that defines how often the canary is to run.
    
    For a rate expression, 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.
    
    Use cron(expression) to specify a cron expression. For information about the syntax for cron expressions, see Scheduling canary runs using cron.
    
    Parameters:
    
    expression - A rate expression or a cron expression that defines how often the canary is to run.
    
    For a rate expression, 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.
    
    Use cron(expression) to specify a cron expression. For information about the syntax for cron expressions, see Scheduling canary runs using cron.
  - getExpression
```
public String getExpression()
```
    A rate expression or a cron expression that defines how often the canary is to run.
    
    For a rate expression, 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.
    
    Use cron(expression) to specify a cron expression. For information about the syntax for cron expressions, see Scheduling canary runs using cron.
    
    Returns:
    
    A rate expression or a cron expression that defines how often the canary is to run.
    
    For a rate expression, 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.
    
    Use cron(expression) to specify a cron expression. For information about the syntax for cron expressions, see Scheduling canary runs using cron.
  - withExpression
```
public CanaryScheduleOutput withExpression(String expression)
```
    A rate expression or a cron expression that defines how often the canary is to run.
    
    For a rate expression, 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.
    
    Use cron(expression) to specify a cron expression. For information about the syntax for cron expressions, see Scheduling canary runs using cron.
    
    Parameters:
    
    expression - A rate expression or a cron expression that defines how often the canary is to run.
    
    For a rate expression, 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.
    
    Use cron(expression) to specify a cron expression. For information about the syntax for cron expressions, see Scheduling canary runs using cron.
    
    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 after it was created. The runs are performed according to the schedule in the Expression value.
    
    Parameters:
    
    durationInSeconds - How long, in seconds, for the canary to continue making regular runs after it was created. The runs are performed according to the schedule in the Expression value.
  - getDurationInSeconds
```
public Long getDurationInSeconds()
```
    How long, in seconds, for the canary to continue making regular runs after it was created. The runs are performed according to the schedule in the Expression value.
    
    Returns:
    
    How long, in seconds, for the canary to continue making regular runs after it was created. The runs are performed according to the schedule in the Expression value.
  - withDurationInSeconds
```
public CanaryScheduleOutput withDurationInSeconds(Long durationInSeconds)
```
    How long, in seconds, for the canary to continue making regular runs after it was created. The runs are performed according to the schedule in the Expression value.
    
    Parameters:
    
    durationInSeconds - How long, in seconds, for the canary to continue making regular runs after it was created. The runs are performed according to the schedule in the Expression value.
    
    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 CanaryScheduleOutput clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class CanaryScheduleOutput

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CanaryScheduleOutput

Method Detail

setExpression

getExpression

withExpression

setDurationInSeconds

getDurationInSeconds

withDurationInSeconds

toString

equals

hashCode

clone

marshall