Interface ScheduledReportSummary.Builder

All Superinterfaces:
Buildable, CopyableBuilder<ScheduledReportSummary.Builder,ScheduledReportSummary>, SdkBuilder<ScheduledReportSummary.Builder,ScheduledReportSummary>, SdkPojo
Enclosing class:
ScheduledReportSummary
@Mutable @NotThreadSafe public static interface ScheduledReportSummary.Builder extends SdkPojo, CopyableBuilder<ScheduledReportSummary.Builder,ScheduledReportSummary>

  • Method Details

    • arn

      ScheduledReportSummary.Builder arn(String arn)

      The ARN of the scheduled report.

      Parameters:
      arn - The ARN of the scheduled report.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      ScheduledReportSummary.Builder name(String name)

      The name of the scheduled report.

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

    • dashboardArn

      ScheduledReportSummary.Builder dashboardArn(String dashboardArn)

      The ARN of the dashboard associated with the scheduled report.

      Parameters:
      dashboardArn - The ARN of the dashboard associated with the scheduled report.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scheduleExpression

      ScheduledReportSummary.Builder scheduleExpression(String scheduleExpression)

      The schedule expression that defines when the report runs.

      Parameters:
      scheduleExpression - The schedule expression that defines when the report runs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • state

      ScheduledReportSummary.Builder state(String state)

      The state of the schedule: ENABLED or DISABLED.

      Parameters:
      state - The state of the schedule: ENABLED or DISABLED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • state

      ScheduledReportSummary.Builder state(ScheduleState state)

      The state of the schedule: ENABLED or DISABLED.

      Parameters:
      state - The state of the schedule: ENABLED or DISABLED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • healthStatus

      ScheduledReportSummary.Builder healthStatus(HealthStatus healthStatus)

      The health status of the scheduled report as of its last refresh time.

      Parameters:
      healthStatus - The health status of the scheduled report as of its last refresh time.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • healthStatus

      default ScheduledReportSummary.Builder healthStatus(Consumer<HealthStatus.Builder> healthStatus)

      The health status of the scheduled report as of its last refresh time.

      This is a convenience method that creates an instance of the HealthStatus.Builder avoiding the need to create one manually via HealthStatus.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to healthStatus(HealthStatus).

      Parameters:
      healthStatus - a consumer that will call methods on HealthStatus.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • scheduleExpressionTimeZone

      ScheduledReportSummary.Builder scheduleExpressionTimeZone(String scheduleExpressionTimeZone)

      The time zone for the schedule expression, for example, UTC.

      Parameters:
      scheduleExpressionTimeZone - The time zone for the schedule expression, for example, UTC.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • widgetIds

      ScheduledReportSummary.Builder widgetIds(Collection<String> widgetIds)

      The list of widget identifiers included in the scheduled report.

      Parameters:
      widgetIds - The list of widget identifiers included in the scheduled report.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • widgetIds

      ScheduledReportSummary.Builder widgetIds(String... widgetIds)

      The list of widget identifiers included in the scheduled report.

      Parameters:
      widgetIds - The list of widget identifiers included in the scheduled report.
      Returns:
      Returns a reference to this object so that method calls can be chained together.