Package software.amazon.awssdk.services.alexaforbusiness.model

Class BusinessReportSchedule

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

The schedule of the usage report.

See Also:

  • Method Details

    • scheduleArn

      public final String scheduleArn()

      The ARN of the business report schedule.

      Returns:
      The ARN of the business report schedule.

    • scheduleName

      public final String scheduleName()

      The name identifier of the schedule.

      Returns:
      The name identifier of the schedule.

    • s3BucketName

      public final String s3BucketName()

      The S3 bucket name of the output reports.

      Returns:
      The S3 bucket name of the output reports.

    • s3KeyPrefix

      public final String s3KeyPrefix()

      The S3 key where the report is delivered.

      Returns:
      The S3 key where the report is delivered.

    • format

      public final BusinessReportFormat format()

      The format of the generated report (individual CSV files or zipped files of individual files).

      If the service returns an enum value that is not available in the current SDK version, format will return BusinessReportFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from formatAsString().

      Returns:
      The format of the generated report (individual CSV files or zipped files of individual files).
      See Also:

    • formatAsString

      public final String formatAsString()

      The format of the generated report (individual CSV files or zipped files of individual files).

      If the service returns an enum value that is not available in the current SDK version, format will return BusinessReportFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from formatAsString().

      Returns:
      The format of the generated report (individual CSV files or zipped files of individual files).
      See Also:

    • contentRange

      public final BusinessReportContentRange contentRange()

      The content range of the reports.

      Returns:
      The content range of the reports.

    • recurrence

      public final BusinessReportRecurrence recurrence()

      The recurrence of the reports.

      Returns:
      The recurrence of the reports.

    • lastBusinessReport

      public final BusinessReport lastBusinessReport()

      The details of the last business report delivery for a specified time interval.

      Returns:
      The details of the last business report delivery for a specified time interval.

    • toBuilder

      public BusinessReportSchedule.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<BusinessReportSchedule.Builder,BusinessReportSchedule>
      Returns:
      a builder for type T

    • builder

      public static BusinessReportSchedule.Builder builder()

    • serializableBuilderClass

      public static Class<? extends BusinessReportSchedule.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.