ReportDefinition (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.costandusagereport.model.ReportDefinition

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ReportDefinition
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ReportDefinition()

Constructors
Constructor and Description
`ReportDefinition()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ReportDefinition`	`clone()`
`boolean`	`equals(Object obj)`
`List<String>`	`getAdditionalArtifacts()` A list of manifests that you want Amazon Web Services to create for this report.
`List<String>`	`getAdditionalSchemaElements()` A list of strings that indicate additional content that Amazon Web Services includes in the report, such as individual resource IDs.
`String`	`getBillingViewArn()` The Amazon resource name of the billing view.
`String`	`getCompression()`
`String`	`getFormat()`
`Boolean`	`getRefreshClosedReports()` 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`	`getReportName()`
`ReportStatus`	`getReportStatus()` The status of the report.
`String`	`getReportVersioning()` 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`	`getS3Bucket()`
`String`	`getS3Prefix()`
`String`	`getS3Region()`
`String`	`getTimeUnit()`
`int`	`hashCode()`
`Boolean`	`isRefreshClosedReports()` 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.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAdditionalArtifacts(Collection<String> additionalArtifacts)` A list of manifests that you want Amazon Web Services to create for this report.
`void`	`setAdditionalSchemaElements(Collection<String> additionalSchemaElements)` A list of strings that indicate additional content that Amazon Web Services includes in the report, such as individual resource IDs.
`void`	`setBillingViewArn(String billingViewArn)` The Amazon resource name of the billing view.
`void`	`setCompression(CompressionFormat compression)`
`void`	`setCompression(String compression)`
`void`	`setFormat(ReportFormat format)`
`void`	`setFormat(String format)`
`void`	`setRefreshClosedReports(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.
`void`	`setReportName(String reportName)`
`void`	`setReportStatus(ReportStatus reportStatus)` The status of the report.
`void`	`setReportVersioning(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.
`void`	`setReportVersioning(String 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.
`void`	`setS3Bucket(String s3Bucket)`
`void`	`setS3Prefix(String s3Prefix)`
`void`	`setS3Region(AWSRegion s3Region)`
`void`	`setS3Region(String s3Region)`
`void`	`setTimeUnit(String timeUnit)`
`void`	`setTimeUnit(TimeUnit timeUnit)`
`String`	`toString()` Returns a string representation of this object.
`ReportDefinition`	`withAdditionalArtifacts(AdditionalArtifact... additionalArtifacts)` A list of manifests that you want Amazon Web Services to create for this report.
`ReportDefinition`	`withAdditionalArtifacts(Collection<String> additionalArtifacts)` A list of manifests that you want Amazon Web Services to create for this report.
`ReportDefinition`	`withAdditionalArtifacts(String... additionalArtifacts)` A list of manifests that you want Amazon Web Services to create for this report.
`ReportDefinition`	`withAdditionalSchemaElements(Collection<String> additionalSchemaElements)` A list of strings that indicate additional content that Amazon Web Services includes in the report, such as individual resource IDs.
`ReportDefinition`	`withAdditionalSchemaElements(SchemaElement... additionalSchemaElements)` A list of strings that indicate additional content that Amazon Web Services includes in the report, such as individual resource IDs.
`ReportDefinition`	`withAdditionalSchemaElements(String... additionalSchemaElements)` A list of strings that indicate additional content that Amazon Web Services includes in the report, such as individual resource IDs.
`ReportDefinition`	`withBillingViewArn(String billingViewArn)` The Amazon resource name of the billing view.
`ReportDefinition`	`withCompression(CompressionFormat compression)`
`ReportDefinition`	`withCompression(String compression)`
`ReportDefinition`	`withFormat(ReportFormat format)`
`ReportDefinition`	`withFormat(String format)`
`ReportDefinition`	`withRefreshClosedReports(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.
`ReportDefinition`	`withReportName(String reportName)`
`ReportDefinition`	`withReportStatus(ReportStatus reportStatus)` The status of the report.
`ReportDefinition`	`withReportVersioning(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.
`ReportDefinition`	`withReportVersioning(String 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.
`ReportDefinition`	`withS3Bucket(String s3Bucket)`
`ReportDefinition`	`withS3Prefix(String s3Prefix)`
`ReportDefinition`	`withS3Region(AWSRegion s3Region)`
`ReportDefinition`	`withS3Region(String s3Region)`
`ReportDefinition`	`withTimeUnit(String timeUnit)`
`ReportDefinition`	`withTimeUnit(TimeUnit timeUnit)`

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

- Constructor Detail
  - ReportDefinition
```
public ReportDefinition()
```
- Method Detail
  - setReportName
```
public void setReportName(String reportName)
```
    Parameters:
    
    reportName -
  - getReportName
```
public String getReportName()
```
    Returns:
  - withReportName
```
public ReportDefinition withReportName(String reportName)
```
    Parameters:
    
    reportName -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTimeUnit
```
public void setTimeUnit(String timeUnit)
```
    Parameters:
    
    timeUnit -
    
    See Also:
    
    TimeUnit
  - getTimeUnit
```
public String getTimeUnit()
```
    Returns:
    
    See Also:
    
    TimeUnit
  - withTimeUnit
```
public ReportDefinition withTimeUnit(String timeUnit)
```
    Parameters:
    
    timeUnit -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TimeUnit
  - setTimeUnit
```
public void setTimeUnit(TimeUnit timeUnit)
```
    Parameters:
    
    timeUnit -
    
    See Also:
    
    TimeUnit
  - withTimeUnit
```
public ReportDefinition withTimeUnit(TimeUnit timeUnit)
```
    Parameters:
    
    timeUnit -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TimeUnit
  - setFormat
```
public void setFormat(String format)
```
    Parameters:
    
    format -
    
    See Also:
    
    ReportFormat
  - getFormat
```
public String getFormat()
```
    Returns:
    
    See Also:
    
    ReportFormat
  - withFormat
```
public ReportDefinition withFormat(String format)
```
    Parameters:
    
    format -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ReportFormat
  - setFormat
```
public void setFormat(ReportFormat format)
```
    Parameters:
    
    format -
    
    See Also:
    
    ReportFormat
  - withFormat
```
public ReportDefinition withFormat(ReportFormat format)
```
    Parameters:
    
    format -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ReportFormat
  - setCompression
```
public void setCompression(String compression)
```
    Parameters:
    
    compression -
    
    See Also:
    
    CompressionFormat
  - getCompression
```
public String getCompression()
```
    Returns:
    
    See Also:
    
    CompressionFormat
  - withCompression
```
public ReportDefinition withCompression(String compression)
```
    Parameters:
    
    compression -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CompressionFormat
  - setCompression
```
public void setCompression(CompressionFormat compression)
```
    Parameters:
    
    compression -
    
    See Also:
    
    CompressionFormat
  - withCompression
```
public ReportDefinition withCompression(CompressionFormat compression)
```
    Parameters:
    
    compression -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CompressionFormat
  - getAdditionalSchemaElements
```
public List<String> getAdditionalSchemaElements()
```
    A list of strings that indicate additional content that Amazon Web Services includes in the report, such as individual resource IDs.
    
    Returns:
    
    A list of strings that indicate additional content that Amazon Web Services includes in the report, such as individual resource IDs.
    
    See Also:
    
    SchemaElement
  - setAdditionalSchemaElements
```
public void setAdditionalSchemaElements(Collection<String> additionalSchemaElements)
```
    A list of strings that indicate additional content that Amazon Web Services includes in the report, such as individual resource IDs.
    
    Parameters:
    
    additionalSchemaElements - A list of strings that indicate additional content that Amazon Web Services includes in the report, such as individual resource IDs.
    
    See Also:
    
    SchemaElement
  - withAdditionalSchemaElements
```
public ReportDefinition withAdditionalSchemaElements(String... additionalSchemaElements)
```
    A list of strings that indicate additional content that Amazon Web Services includes in the report, such as individual resource IDs.
    
    NOTE: This method appends the values to the existing list (if any). Use setAdditionalSchemaElements(java.util.Collection) or withAdditionalSchemaElements(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    additionalSchemaElements - A list of strings that indicate additional content that Amazon Web Services includes in the report, such as individual resource IDs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SchemaElement
  - withAdditionalSchemaElements
```
public ReportDefinition withAdditionalSchemaElements(Collection<String> additionalSchemaElements)
```
    A list of strings that indicate additional content that Amazon Web Services includes in the report, such as individual resource IDs.
    
    Parameters:
    
    additionalSchemaElements - A list of strings that indicate additional content that Amazon Web Services includes in the report, such as individual resource IDs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SchemaElement
  - withAdditionalSchemaElements
```
public ReportDefinition withAdditionalSchemaElements(SchemaElement... additionalSchemaElements)
```
    A list of strings that indicate additional content that Amazon Web Services includes in the report, such as individual resource IDs.
    
    Parameters:
    
    additionalSchemaElements - A list of strings that indicate additional content that Amazon Web Services includes in the report, such as individual resource IDs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SchemaElement
  - setS3Bucket
```
public void setS3Bucket(String s3Bucket)
```
    Parameters:
    
    s3Bucket -
  - getS3Bucket
```
public String getS3Bucket()
```
    Returns:
  - withS3Bucket
```
public ReportDefinition withS3Bucket(String s3Bucket)
```
    Parameters:
    
    s3Bucket -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setS3Prefix
```
public void setS3Prefix(String s3Prefix)
```
    Parameters:
    
    s3Prefix -
  - getS3Prefix
```
public String getS3Prefix()
```
    Returns:
  - withS3Prefix
```
public ReportDefinition withS3Prefix(String s3Prefix)
```
    Parameters:
    
    s3Prefix -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setS3Region
```
public void setS3Region(String s3Region)
```
    Parameters:
    
    s3Region -
    
    See Also:
    
    AWSRegion
  - getS3Region
```
public String getS3Region()
```
    Returns:
    
    See Also:
    
    AWSRegion
  - withS3Region
```
public ReportDefinition withS3Region(String s3Region)
```
    Parameters:
    
    s3Region -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AWSRegion
  - setS3Region
```
public void setS3Region(AWSRegion s3Region)
```
    Parameters:
    
    s3Region -
    
    See Also:
    
    AWSRegion
  - withS3Region
```
public ReportDefinition withS3Region(AWSRegion s3Region)
```
    Parameters:
    
    s3Region -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AWSRegion
  - getAdditionalArtifacts
```
public List<String> getAdditionalArtifacts()
```
    A list of manifests that you want Amazon Web Services to create for this report.
    
    Returns:
    
    A list of manifests that you want Amazon Web Services to create for this report.
    
    See Also:
    
    AdditionalArtifact
  - setAdditionalArtifacts
```
public void setAdditionalArtifacts(Collection<String> additionalArtifacts)
```
    A list of manifests that you want Amazon Web Services to create for this report.
    
    Parameters:
    
    additionalArtifacts - A list of manifests that you want Amazon Web Services to create for this report.
    
    See Also:
    
    AdditionalArtifact
  - withAdditionalArtifacts
```
public ReportDefinition withAdditionalArtifacts(String... additionalArtifacts)
```
    A list of manifests that you want Amazon Web Services to create for this report.
    
    NOTE: This method appends the values to the existing list (if any). Use setAdditionalArtifacts(java.util.Collection) or withAdditionalArtifacts(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    additionalArtifacts - A list of manifests that you want Amazon Web Services to create for this report.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AdditionalArtifact
  - withAdditionalArtifacts
```
public ReportDefinition withAdditionalArtifacts(Collection<String> additionalArtifacts)
```
    A list of manifests that you want Amazon Web Services to create for this report.
    
    Parameters:
    
    additionalArtifacts - A list of manifests that you want Amazon Web Services to create for this report.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AdditionalArtifact
  - withAdditionalArtifacts
```
public ReportDefinition withAdditionalArtifacts(AdditionalArtifact... additionalArtifacts)
```
    A list of manifests that you want Amazon Web Services to create for this report.
    
    Parameters:
    
    additionalArtifacts - A list of manifests that you want Amazon Web Services to create for this report.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AdditionalArtifact
  - setRefreshClosedReports
```
public void setRefreshClosedReports(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.
    
    Parameters:
    
    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.
  - getRefreshClosedReports
```
public Boolean getRefreshClosedReports()
```
    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.
  - withRefreshClosedReports
```
public ReportDefinition withRefreshClosedReports(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - isRefreshClosedReports
```
public Boolean isRefreshClosedReports()
```
    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.
  - setReportVersioning
```
public void setReportVersioning(String 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.
    
    Parameters:
    
    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.
    
    See Also:
    
    ReportVersioning
  - getReportVersioning
```
public String getReportVersioning()
```
    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.
    
    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
  - withReportVersioning
```
public ReportDefinition withReportVersioning(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ReportVersioning
  - setReportVersioning
```
public void setReportVersioning(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.
    
    Parameters:
    
    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.
    
    See Also:
    
    ReportVersioning
  - withReportVersioning
```
public ReportDefinition withReportVersioning(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ReportVersioning
  - setBillingViewArn
```
public void setBillingViewArn(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
    
    Parameters:
    
    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
  - getBillingViewArn
```
public String getBillingViewArn()
```
    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
  - withBillingViewArn
```
public ReportDefinition withBillingViewArn(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
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setReportStatus
```
public void setReportStatus(ReportStatus reportStatus)
```
    The status of the report.
    
    Parameters:
    
    reportStatus - The status of the report.
  - getReportStatus
```
public ReportStatus getReportStatus()
```
    The status of the report.
    
    Returns:
    
    The status of the report.
  - withReportStatus
```
public ReportDefinition withReportStatus(ReportStatus reportStatus)
```
    The status of the report.
    
    Parameters:
    
    reportStatus - The status of the report.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ReportDefinition clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.793

Class ReportDefinition

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ReportDefinition

Method Detail

setReportName

getReportName

withReportName

setTimeUnit

getTimeUnit

withTimeUnit

setTimeUnit

withTimeUnit

setFormat

getFormat

withFormat

setFormat

withFormat

setCompression

getCompression

withCompression

setCompression

withCompression

getAdditionalSchemaElements

setAdditionalSchemaElements

withAdditionalSchemaElements

withAdditionalSchemaElements

withAdditionalSchemaElements

setS3Bucket

getS3Bucket

withS3Bucket

setS3Prefix

getS3Prefix

withS3Prefix

setS3Region

getS3Region

withS3Region

setS3Region

withS3Region

getAdditionalArtifacts

setAdditionalArtifacts

withAdditionalArtifacts

withAdditionalArtifacts

withAdditionalArtifacts

setRefreshClosedReports

getRefreshClosedReports

withRefreshClosedReports

isRefreshClosedReports

setReportVersioning

getReportVersioning

withReportVersioning

setReportVersioning

withReportVersioning

setBillingViewArn

getBillingViewArn

withBillingViewArn

setReportStatus

getReportStatus

withReportStatus

toString

equals

hashCode

clone

marshall