ReportDefinition (AWS Java SDK :: Services :: AWS Cost and Usage Report 2.20.95 API)

java.lang.Object
- software.amazon.awssdk.services.costandusagereport.model.ReportDefinition

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ReportDefinition.Builder,ReportDefinition>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class ReportDefinition
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ReportDefinition.Builder,ReportDefinition>
```
The definition of AWS 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:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ReportDefinition.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ReportDefinition.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<AdditionalArtifact>`	`additionalArtifacts()` A list of manifests that you want Amazon Web Services to create for this report.
`List<String>`	`additionalArtifactsAsStrings()` A list of manifests that you want Amazon Web Services to create for this report.
`List<SchemaElement>`	`additionalSchemaElements()` A list of strings that indicate additional content that Amazon Web Services includes in the report, such as individual resource IDs.
`List<String>`	`additionalSchemaElementsAsStrings()` A list of strings that indicate additional content that Amazon Web Services includes in the report, such as individual resource IDs.
`String`	`billingViewArn()` The Amazon resource name of the billing view.
`static ReportDefinition.Builder`	`builder()`
`CompressionFormat`	`compression()` Returns the value of the Compression property for this object.
`String`	`compressionAsString()` Returns the value of the Compression property for this object.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`ReportFormat`	`format()` Returns the value of the Format property for this object.
`String`	`formatAsString()` Returns the value of the Format property for this object.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAdditionalArtifacts()` For responses, this returns true if the service returned a value for the AdditionalArtifacts property.
`boolean`	`hasAdditionalSchemaElements()` For responses, this returns true if the service returned a value for the AdditionalSchemaElements property.
`int`	`hashCode()`
`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.
`String`	`reportName()` Returns the value of the ReportName property for this object.
`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.
`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.
`String`	`s3Bucket()` Returns the value of the S3Bucket property for this object.
`String`	`s3Prefix()` Returns the value of the S3Prefix property for this object.
`AWSRegion`	`s3Region()` Returns the value of the S3Region property for this object.
`String`	`s3RegionAsString()` Returns the value of the S3Region property for this object.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ReportDefinition.Builder>`	`serializableBuilderClass()`
`TimeUnit`	`timeUnit()` Returns the value of the TimeUnit property for this object.
`String`	`timeUnitAsString()` Returns the value of the TimeUnit property for this object.
`ReportDefinition.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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:
    
    TimeUnit
  - 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:
    
    TimeUnit
  - 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:
    
    ReportFormat
  - 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:
    
    ReportFormat
  - 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:
    
    CompressionFormat
  - 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:
    
    CompressionFormat
  - 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:
    
    AWSRegion
  - 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:
    
    AWSRegion
  - 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:
    
    ReportVersioning
  - 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:
    
    ReportVersioning
  - billingViewArn
```
public final String billingViewArn()
```
    The Amazon resource name of the billing view. You can get this value by using the billing view service public APIs.
    
    Returns:
    
    The Amazon resource name of the billing view. You can get this value by using the billing view service public APIs.
  - toBuilder
```
public ReportDefinition.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ReportDefinition.Builder,ReportDefinition>
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class ReportDefinition

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

reportName

timeUnit

timeUnitAsString

format

formatAsString

compression

compressionAsString

additionalSchemaElements

hasAdditionalSchemaElements

additionalSchemaElementsAsStrings

s3Bucket

s3Prefix

s3Region

s3RegionAsString

additionalArtifacts

hasAdditionalArtifacts

additionalArtifactsAsStrings

refreshClosedReports

reportVersioning

reportVersioningAsString

billingViewArn

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields