Package software.amazon.awssdk.services.appflow.model

Interface ScheduledTriggerProperties.Builder

    • Method Detail

      • scheduleExpression

        ScheduledTriggerProperties.Builder scheduleExpression​(String scheduleExpression)

        The scheduling expression that determines the rate at which the schedule will run, for example rate(5minutes).

        Parameters:
        scheduleExpression - The scheduling expression that determines the rate at which the schedule will run, for example rate(5minutes).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dataPullMode

        ScheduledTriggerProperties.Builder dataPullMode​(String dataPullMode)

        Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run.

        Parameters:
        dataPullMode - Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        DataPullMode, DataPullMode

      • dataPullMode

        ScheduledTriggerProperties.Builder dataPullMode​(DataPullMode dataPullMode)

        Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run.

        Parameters:
        dataPullMode - Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        DataPullMode, DataPullMode

      • scheduleStartTime

        ScheduledTriggerProperties.Builder scheduleStartTime​(Instant scheduleStartTime)

        The time at which the scheduled flow starts. The time is formatted as a timestamp that follows the ISO 8601 standard, such as 2022-04-26T13:00:00-07:00.

        Parameters:
        scheduleStartTime - The time at which the scheduled flow starts. The time is formatted as a timestamp that follows the ISO 8601 standard, such as 2022-04-26T13:00:00-07:00.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • scheduleEndTime

        ScheduledTriggerProperties.Builder scheduleEndTime​(Instant scheduleEndTime)

        The time at which the scheduled flow ends. The time is formatted as a timestamp that follows the ISO 8601 standard, such as 2022-04-27T13:00:00-07:00.

        Parameters:
        scheduleEndTime - The time at which the scheduled flow ends. The time is formatted as a timestamp that follows the ISO 8601 standard, such as 2022-04-27T13:00:00-07:00.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • timezone

        ScheduledTriggerProperties.Builder timezone​(String timezone)

        Specifies the time zone used when referring to the dates and times of a scheduled flow, such as America/New_York. This time zone is only a descriptive label. It doesn't affect how Amazon AppFlow interprets the timestamps that you specify to schedule the flow.

        If you want to schedule a flow by using times in a particular time zone, indicate the time zone as a UTC offset in your timestamps. For example, the UTC offsets for the America/New_York timezone are -04:00 EDT and -05:00 EST.

        Parameters:
        timezone - Specifies the time zone used when referring to the dates and times of a scheduled flow, such as America/New_York. This time zone is only a descriptive label. It doesn't affect how Amazon AppFlow interprets the timestamps that you specify to schedule the flow.

        If you want to schedule a flow by using times in a particular time zone, indicate the time zone as a UTC offset in your timestamps. For example, the UTC offsets for the America/New_York timezone are -04:00 EDT and -05:00 EST.

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

      • scheduleOffset

        ScheduledTriggerProperties.Builder scheduleOffset​(Long scheduleOffset)

        Specifies the optional offset that is added to the time interval for a schedule-triggered flow.

        Parameters:
        scheduleOffset - Specifies the optional offset that is added to the time interval for a schedule-triggered flow.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • firstExecutionFrom

        ScheduledTriggerProperties.Builder firstExecutionFrom​(Instant firstExecutionFrom)

        Specifies the date range for the records to import from the connector in the first flow run.

        Parameters:
        firstExecutionFrom - Specifies the date range for the records to import from the connector in the first flow run.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • flowErrorDeactivationThreshold

        ScheduledTriggerProperties.Builder flowErrorDeactivationThreshold​(Integer flowErrorDeactivationThreshold)

        Defines how many times a scheduled flow fails consecutively before Amazon AppFlow deactivates it.

        Parameters:
        flowErrorDeactivationThreshold - Defines how many times a scheduled flow fails consecutively before Amazon AppFlow deactivates it.
        Returns:
        Returns a reference to this object so that method calls can be chained together.