Interface ScheduledReport.Builder
- All Superinterfaces:
Buildable,CopyableBuilder<ScheduledReport.Builder,,ScheduledReport> SdkBuilder<ScheduledReport.Builder,,ScheduledReport> SdkPojo
- Enclosing class:
ScheduledReport
-
Method Summary
Modifier and TypeMethodDescriptionThe ARN of the scheduled report.The timestamp when the scheduled report was created.dashboardArn(String dashboardArn) The ARN of the dashboard associated with the scheduled report.description(String description) A description of the scheduled report's purpose or contents.default ScheduledReport.BuilderhealthStatus(Consumer<HealthStatus.Builder> healthStatus) The health status of the scheduled report at last refresh time.healthStatus(HealthStatus healthStatus) The health status of the scheduled report at last refresh time.lastExecutionAt(Instant lastExecutionAt) The timestamp of the most recent execution of the scheduled report.The name of the scheduled report.default ScheduledReport.BuilderscheduleConfig(Consumer<ScheduleConfig.Builder> scheduleConfig) The schedule configuration that defines when and how often the report is generated.scheduleConfig(ScheduleConfig scheduleConfig) The schedule configuration that defines when and how often the report is generated.scheduledReportExecutionRoleArn(String scheduledReportExecutionRoleArn) The ARN of the IAM role that the scheduled report uses to execute.The timestamp when the scheduled report was last modified.default ScheduledReport.BuilderwidgetDateRangeOverride(Consumer<DateTimeRange.Builder> widgetDateRangeOverride) The date range override applied to widgets in the scheduled report.widgetDateRangeOverride(DateTimeRange widgetDateRangeOverride) The date range override applied to widgets in the scheduled report.The list of widget identifiers included in the scheduled report.widgetIds(Collection<String> widgetIds) The list of widget identifiers included in the scheduled report.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copyMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
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
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
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.
-
scheduledReportExecutionRoleArn
The ARN of the IAM role that the scheduled report uses to execute. Amazon Web Services Billing and Cost Management Dashboards will assume this IAM role while executing the scheduled report.
- Parameters:
scheduledReportExecutionRoleArn- The ARN of the IAM role that the scheduled report uses to execute. Amazon Web Services Billing and Cost Management Dashboards will assume this IAM role while executing the scheduled report.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
scheduleConfig
The schedule configuration that defines when and how often the report is generated.
- Parameters:
scheduleConfig- The schedule configuration that defines when and how often the report is generated.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
scheduleConfig
The schedule configuration that defines when and how often the report is generated.
This is a convenience method that creates an instance of theScheduleConfig.Builderavoiding the need to create one manually viaScheduleConfig.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toscheduleConfig(ScheduleConfig).- Parameters:
scheduleConfig- a consumer that will call methods onScheduleConfig.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
description
A description of the scheduled report's purpose or contents.
- Parameters:
description- A description of the scheduled report's purpose or contents.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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.
-
widgetDateRangeOverride
The date range override applied to widgets in the scheduled report.
- Parameters:
widgetDateRangeOverride- The date range override applied to widgets in the scheduled report.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
widgetDateRangeOverride
default ScheduledReport.Builder widgetDateRangeOverride(Consumer<DateTimeRange.Builder> widgetDateRangeOverride) The date range override applied to widgets in the scheduled report.
This is a convenience method that creates an instance of theDateTimeRange.Builderavoiding the need to create one manually viaDateTimeRange.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed towidgetDateRangeOverride(DateTimeRange).- Parameters:
widgetDateRangeOverride- a consumer that will call methods onDateTimeRange.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
createdAt
The timestamp when the scheduled report was created.
- Parameters:
createdAt- The timestamp when the scheduled report was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
updatedAt
The timestamp when the scheduled report was last modified.
- Parameters:
updatedAt- The timestamp when the scheduled report was last modified.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
lastExecutionAt
The timestamp of the most recent execution of the scheduled report.
- Parameters:
lastExecutionAt- The timestamp of the most recent execution of the scheduled report.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
healthStatus
The health status of the scheduled report at last refresh time.
- Parameters:
healthStatus- The health status of the scheduled report at last refresh time.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
healthStatus
The health status of the scheduled report at last refresh time.
This is a convenience method that creates an instance of theHealthStatus.Builderavoiding the need to create one manually viaHealthStatus.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tohealthStatus(HealthStatus).- Parameters:
healthStatus- a consumer that will call methods onHealthStatus.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-