Class ReportDefinition

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

The definition of Amazon Web Services Cost and Usage Report. You can specify the report name, time unit, report format, compression format, S3 bucket, additional artifacts, and schema elements in the definition.

See Also:

  • Method Details

    • reportName

      public final String reportName()
      Returns the value of the ReportName property for this object.
      Returns:
      The value of the ReportName property for this object.

    • timeUnit

      public final TimeUnit timeUnit()
      Returns the value of the TimeUnit property for this object.

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

      Returns:
      The value of the TimeUnit property for this object.
      See Also:

    • timeUnitAsString

      public final String timeUnitAsString()
      Returns the value of the TimeUnit property for this object.

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

      Returns:
      The value of the TimeUnit property for this object.
      See Also:

    • format

      public final ReportFormat format()
      Returns the value of the Format property for this object.

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

      Returns:
      The value of the Format property for this object.
      See Also:

    • formatAsString

      public final String formatAsString()
      Returns the value of the Format property for this object.

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

      Returns:
      The value of the Format property for this object.
      See Also:

    • compression

      public final CompressionFormat compression()
      Returns the value of the Compression property for this object.

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

      Returns:
      The value of the Compression property for this object.
      See Also:

    • compressionAsString

      public final String compressionAsString()
      Returns the value of the Compression property for this object.

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

      Returns:
      The value of the Compression property for this object.
      See Also:

    • additionalSchemaElements

      public final List<SchemaElement> additionalSchemaElements()

      A list of strings that indicate additional content that Amazon Web Services includes in the report, such as individual resource IDs.

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

      Returns:
      A list of strings that indicate additional content that Amazon Web Services includes in the report, such as individual resource IDs.

    • hasAdditionalSchemaElements

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

    • additionalSchemaElementsAsStrings

      public final List<String> additionalSchemaElementsAsStrings()

      A list of strings that indicate additional content that Amazon Web Services includes in the report, such as individual resource IDs.

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

      Returns:
      A list of strings that indicate additional content that Amazon Web Services includes in the report, such as individual resource IDs.

    • s3Bucket

      public final String s3Bucket()
      Returns the value of the S3Bucket property for this object.
      Returns:
      The value of the S3Bucket property for this object.

    • s3Prefix

      public final String s3Prefix()
      Returns the value of the S3Prefix property for this object.
      Returns:
      The value of the S3Prefix property for this object.

    • s3Region

      public final AWSRegion s3Region()
      Returns the value of the S3Region property for this object.

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

      Returns:
      The value of the S3Region property for this object.
      See Also:

    • s3RegionAsString

      public final String s3RegionAsString()
      Returns the value of the S3Region property for this object.

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

      Returns:
      The value of the S3Region property for this object.
      See Also:

    • additionalArtifacts

      public final List<AdditionalArtifact> additionalArtifacts()

      A list of manifests that you want Amazon Web Services to create for this report.

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

      Returns:
      A list of manifests that you want Amazon Web Services to create for this report.

    • hasAdditionalArtifacts

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

    • additionalArtifactsAsStrings

      public final List<String> additionalArtifactsAsStrings()

      A list of manifests that you want Amazon Web Services to create for this report.

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

      Returns:
      A list of manifests that you want Amazon Web Services to create for this report.

    • refreshClosedReports

      public final Boolean refreshClosedReports()

      Whether you want Amazon Web Services to update your reports after they have been finalized if Amazon Web Services detects charges related to previous months. These charges can include refunds, credits, or support fees.

      Returns:
      Whether you want Amazon Web Services to update your reports after they have been finalized if Amazon Web Services detects charges related to previous months. These charges can include refunds, credits, or support fees.

    • reportVersioning

      public final ReportVersioning reportVersioning()

      Whether you want Amazon Web Services to overwrite the previous version of each report or to deliver the report in addition to the previous versions.

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

      Returns:
      Whether you want Amazon Web Services to overwrite the previous version of each report or to deliver the report in addition to the previous versions.
      See Also:

    • reportVersioningAsString

      public final String reportVersioningAsString()

      Whether you want Amazon Web Services to overwrite the previous version of each report or to deliver the report in addition to the previous versions.

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

      Returns:
      Whether you want Amazon Web Services to overwrite the previous version of each report or to deliver the report in addition to the previous versions.
      See Also:

    • billingViewArn

      public final String billingViewArn()

      The Amazon resource name of the billing view. The BillingViewArn is needed to create Amazon Web Services Cost and Usage Report for each billing group maintained in the Amazon Web Services Billing Conductor service. The BillingViewArn for a billing group can be constructed as: arn:aws:billing::payer-account-id:billingview/billing-group-primary-account-id

      Returns:
      The Amazon resource name of the billing view. The BillingViewArn is needed to create Amazon Web Services Cost and Usage Report for each billing group maintained in the Amazon Web Services Billing Conductor service. The BillingViewArn for a billing group can be constructed as: arn:aws:billing::payer-account-id:billingview/billing-group-primary-account-id

    • reportStatus

      public final ReportStatus reportStatus()

      The status of the report.

      Returns:
      The status of the report.

    • toBuilder

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

    • builder

      public static ReportDefinition.Builder builder()

    • serializableBuilderClass

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