Package software.amazon.awssdk.services.scheduler.model

Interface GetScheduleResponse.Builder

    • Method Detail

      • actionAfterCompletion

        GetScheduleResponse.Builder actionAfterCompletion​(String actionAfterCompletion)

        Indicates the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the target.

        Parameters:
        actionAfterCompletion - Indicates the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the target.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ActionAfterCompletion, ActionAfterCompletion

      • actionAfterCompletion

        GetScheduleResponse.Builder actionAfterCompletion​(ActionAfterCompletion actionAfterCompletion)

        Indicates the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the target.

        Parameters:
        actionAfterCompletion - Indicates the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the target.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ActionAfterCompletion, ActionAfterCompletion

      • arn

        GetScheduleResponse.Builder arn​(String arn)

        The Amazon Resource Name (ARN) of the schedule.

        Parameters:
        arn - The Amazon Resource Name (ARN) of the schedule.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • creationDate

        GetScheduleResponse.Builder creationDate​(Instant creationDate)

        The time at which the schedule was created.

        Parameters:
        creationDate - The time at which the schedule was created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • description

        GetScheduleResponse.Builder description​(String description)

        The description of the schedule.

        Parameters:
        description - The description of the schedule.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • endDate

        GetScheduleResponse.Builder endDate​(Instant endDate)

        The date, in UTC, before which the schedule can invoke its target. Depending on the schedule's recurrence expression, invocations might stop on, or before, the EndDate you specify. EventBridge Scheduler ignores EndDate for one-time schedules.

        Parameters:
        endDate - The date, in UTC, before which the schedule can invoke its target. Depending on the schedule's recurrence expression, invocations might stop on, or before, the EndDate you specify. EventBridge Scheduler ignores EndDate for one-time schedules.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • flexibleTimeWindow

        GetScheduleResponse.Builder flexibleTimeWindow​(FlexibleTimeWindow flexibleTimeWindow)

        Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.

        Parameters:
        flexibleTimeWindow - Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • groupName

        GetScheduleResponse.Builder groupName​(String groupName)

        The name of the schedule group associated with this schedule.

        Parameters:
        groupName - The name of the schedule group associated with this schedule.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • kmsKeyArn

        GetScheduleResponse.Builder kmsKeyArn​(String kmsKeyArn)

        The ARN for a customer managed KMS Key that is be used to encrypt and decrypt your data.

        Parameters:
        kmsKeyArn - The ARN for a customer managed KMS Key that is be used to encrypt and decrypt your data.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • lastModificationDate

        GetScheduleResponse.Builder lastModificationDate​(Instant lastModificationDate)

        The time at which the schedule was last modified.

        Parameters:
        lastModificationDate - The time at which the schedule was last modified.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • name

        GetScheduleResponse.Builder name​(String name)

        The name of the schedule.

        Parameters:
        name - The name of the schedule.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • scheduleExpression

        GetScheduleResponse.Builder scheduleExpression​(String scheduleExpression)

        The expression that defines when the schedule runs. The following formats are supported.

        • at expression - at(yyyy-mm-ddThh:mm:ss)

        • rate expression - rate(value unit)

        • cron expression - cron(fields)

        You can use at expressions to create one-time schedules that invoke a target once, at the time and in the time zone, that you specify. You can use rate and cron expressions to create recurring schedules. Rate-based schedules are useful when you want to invoke a target at regular intervals, such as every 15 minutes or every five days. Cron-based schedules are useful when you want to invoke a target periodically at a specific time, such as at 8:00 am (UTC+0) every 1st day of the month.

        A cron expression consists of six fields separated by white spaces: (minutes hours day_of_month month day_of_week year).

        A rate expression consists of a value as a positive integer, and a unit with the following options: minute | minutes | hour | hours | day | days

        For more information and examples, see Schedule types on EventBridge Scheduler in the EventBridge Scheduler User Guide.

        Parameters:
        scheduleExpression - The expression that defines when the schedule runs. The following formats are supported.

        • at expression - at(yyyy-mm-ddThh:mm:ss)

        • rate expression - rate(value unit)

        • cron expression - cron(fields)

        You can use at expressions to create one-time schedules that invoke a target once, at the time and in the time zone, that you specify. You can use rate and cron expressions to create recurring schedules. Rate-based schedules are useful when you want to invoke a target at regular intervals, such as every 15 minutes or every five days. Cron-based schedules are useful when you want to invoke a target periodically at a specific time, such as at 8:00 am (UTC+0) every 1st day of the month.

        A cron expression consists of six fields separated by white spaces: (minutes hours day_of_month month day_of_week year).

        A rate expression consists of a value as a positive integer, and a unit with the following options: minute | minutes | hour | hours | day | days

        For more information and examples, see Schedule types on EventBridge Scheduler in the EventBridge Scheduler User Guide.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • scheduleExpressionTimezone

        GetScheduleResponse.Builder scheduleExpressionTimezone​(String scheduleExpressionTimezone)

        The timezone in which the scheduling expression is evaluated.

        Parameters:
        scheduleExpressionTimezone - The timezone in which the scheduling expression is evaluated.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • startDate

        GetScheduleResponse.Builder startDate​(Instant startDate)

        The date, in UTC, after which the schedule can begin invoking its target. Depending on the schedule's recurrence expression, invocations might occur on, or after, the StartDate you specify. EventBridge Scheduler ignores StartDate for one-time schedules.

        Parameters:
        startDate - The date, in UTC, after which the schedule can begin invoking its target. Depending on the schedule's recurrence expression, invocations might occur on, or after, the StartDate you specify. EventBridge Scheduler ignores StartDate for one-time schedules.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • state

        GetScheduleResponse.Builder state​(String state)

        Specifies whether the schedule is enabled or disabled.

        Parameters:
        state - Specifies whether the schedule is enabled or disabled.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ScheduleState, ScheduleState

      • target

        GetScheduleResponse.Builder target​(Target target)

        The schedule target.

        Parameters:
        target - The schedule target.
        Returns:
        Returns a reference to this object so that method calls can be chained together.