Class ReportDeliveryChannel

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

Contains information from your report plan about where to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.

See Also:

  • Method Details

    • s3BucketName

      public final String s3BucketName()

      The unique name of the S3 bucket that receives your reports.

      Returns:
      The unique name of the S3 bucket that receives your reports.

    • s3KeyPrefix

      public final String s3KeyPrefix()

      The prefix for where Backup Audit Manager delivers your reports to Amazon S3. The prefix is this part of the following path: s3://your-bucket-name/prefix/Backup/us-west-2/year/month/day/report-name. If not specified, there is no prefix.

      Returns:
      The prefix for where Backup Audit Manager delivers your reports to Amazon S3. The prefix is this part of the following path: s3://your-bucket-name/prefix /Backup/us-west-2/year/month/day/report-name. If not specified, there is no prefix.

    • hasFormats

      public final boolean hasFormats()
      For responses, this returns true if the service returned a value for the Formats 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.

    • formats

      public final List<String> formats()

      The format of your reports: CSV, JSON, or both. If not specified, the default format is CSV.

      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 hasFormats() method.

      Returns:
      The format of your reports: CSV, JSON, or both. If not specified, the default format is CSV.

    • toBuilder

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

    • builder

      public static ReportDeliveryChannel.Builder builder()

    • serializableBuilderClass

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