Class ScheduledReportInput

java.lang.Object
software.amazon.awssdk.services.bcmdashboards.model.ScheduledReportInput
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ScheduledReportInput.Builder,ScheduledReportInput>
@Generated("software.amazon.awssdk:codegen") public final class ScheduledReportInput extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ScheduledReportInput.Builder,ScheduledReportInput>

Defines the configuration for creating a new scheduled report, including the dashboard, schedule, execution role, and optional widget settings.

See Also:

  • Method Details

    • name

      public final String name()

      The name of the scheduled report.

      Returns:
      The name of the scheduled report.

    • dashboardArn

      public final String dashboardArn()

      The ARN of the dashboard to generate the scheduled report from.

      Returns:
      The ARN of the dashboard to generate the scheduled report from.

    • scheduledReportExecutionRoleArn

      public final String 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:
      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.

    • scheduleConfig

      public final ScheduleConfig scheduleConfig()

      The schedule configuration that defines when and how often the report is generated. If the schedule state is not specified, it defaults to ENABLED.

      Returns:
      The schedule configuration that defines when and how often the report is generated. If the schedule state is not specified, it defaults to ENABLED.

    • description

      public final String description()

      A description of the scheduled report's purpose or contents.

      Returns:
      A description of the scheduled report's purpose or contents.

    • hasWidgetIds

      public final boolean hasWidgetIds()
      For responses, this returns true if the service returned a value for the WidgetIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • widgetIds

      public final List<String> widgetIds()

      The list of widget identifiers to include in the scheduled report. If not specified, all widgets in the dashboard are included.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasWidgetIds() method.

      Returns:
      The list of widget identifiers to include in the scheduled report. If not specified, all widgets in the dashboard are included.

    • widgetDateRangeOverride

      public final DateTimeRange widgetDateRangeOverride()

      The date range override to apply to widgets in the scheduled report.

      Returns:
      The date range override to apply to widgets in the scheduled report.

    • toBuilder

      public ScheduledReportInput.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ScheduledReportInput.Builder,ScheduledReportInput>
      Returns:
      a builder for type T

    • builder

      public static ScheduledReportInput.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ScheduledReportInput.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.