ReportPlan (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.backup.model.ReportPlan

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ReportPlan
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Contains detailed information about a report plan.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ReportPlan()

Constructors
Constructor and Description
`ReportPlan()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ReportPlan`	`clone()`
`boolean`	`equals(Object obj)`
`Date`	`getCreationTime()` The date and time that a report plan is created, in Unix format and Coordinated Universal Time (UTC).
`String`	`getDeploymentStatus()` The deployment status of a report plan.
`Date`	`getLastAttemptedExecutionTime()` The date and time that a report job associated with this report plan last attempted to run, in Unix format and Coordinated Universal Time (UTC).
`Date`	`getLastSuccessfulExecutionTime()` The date and time that a report job associated with this report plan last successfully ran, in Unix format and Coordinated Universal Time (UTC).
`ReportDeliveryChannel`	`getReportDeliveryChannel()` Contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.
`String`	`getReportPlanArn()` An Amazon Resource Name (ARN) that uniquely identifies a resource.
`String`	`getReportPlanDescription()` An optional description of the report plan with a maximum 1,024 characters.
`String`	`getReportPlanName()` The unique name of the report plan.
`ReportSetting`	`getReportSetting()` Identifies the report template for the report.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCreationTime(Date creationTime)` The date and time that a report plan is created, in Unix format and Coordinated Universal Time (UTC).
`void`	`setDeploymentStatus(String deploymentStatus)` The deployment status of a report plan.
`void`	`setLastAttemptedExecutionTime(Date lastAttemptedExecutionTime)` The date and time that a report job associated with this report plan last attempted to run, in Unix format and Coordinated Universal Time (UTC).
`void`	`setLastSuccessfulExecutionTime(Date lastSuccessfulExecutionTime)` The date and time that a report job associated with this report plan last successfully ran, in Unix format and Coordinated Universal Time (UTC).
`void`	`setReportDeliveryChannel(ReportDeliveryChannel reportDeliveryChannel)` Contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.
`void`	`setReportPlanArn(String reportPlanArn)` An Amazon Resource Name (ARN) that uniquely identifies a resource.
`void`	`setReportPlanDescription(String reportPlanDescription)` An optional description of the report plan with a maximum 1,024 characters.
`void`	`setReportPlanName(String reportPlanName)` The unique name of the report plan.
`void`	`setReportSetting(ReportSetting reportSetting)` Identifies the report template for the report.
`String`	`toString()` Returns a string representation of this object.
`ReportPlan`	`withCreationTime(Date creationTime)` The date and time that a report plan is created, in Unix format and Coordinated Universal Time (UTC).
`ReportPlan`	`withDeploymentStatus(String deploymentStatus)` The deployment status of a report plan.
`ReportPlan`	`withLastAttemptedExecutionTime(Date lastAttemptedExecutionTime)` The date and time that a report job associated with this report plan last attempted to run, in Unix format and Coordinated Universal Time (UTC).
`ReportPlan`	`withLastSuccessfulExecutionTime(Date lastSuccessfulExecutionTime)` The date and time that a report job associated with this report plan last successfully ran, in Unix format and Coordinated Universal Time (UTC).
`ReportPlan`	`withReportDeliveryChannel(ReportDeliveryChannel reportDeliveryChannel)` Contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.
`ReportPlan`	`withReportPlanArn(String reportPlanArn)` An Amazon Resource Name (ARN) that uniquely identifies a resource.
`ReportPlan`	`withReportPlanDescription(String reportPlanDescription)` An optional description of the report plan with a maximum 1,024 characters.
`ReportPlan`	`withReportPlanName(String reportPlanName)` The unique name of the report plan.
`ReportPlan`	`withReportSetting(ReportSetting reportSetting)` Identifies the report template for the report.

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

- Constructor Detail
  - ReportPlan
```
public ReportPlan()
```
- Method Detail
  - setReportPlanArn
```
public void setReportPlanArn(String reportPlanArn)
```
    An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
    
    Parameters:
    
    reportPlanArn - An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
  - getReportPlanArn
```
public String getReportPlanArn()
```
    An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
    
    Returns:
    
    An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
  - withReportPlanArn
```
public ReportPlan withReportPlanArn(String reportPlanArn)
```
    An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
    
    Parameters:
    
    reportPlanArn - An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setReportPlanName
```
public void setReportPlanName(String reportPlanName)
```
    The unique name of the report plan. This name is between 1 and 256 characters starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).
    
    Parameters:
    
    reportPlanName - The unique name of the report plan. This name is between 1 and 256 characters starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).
  - getReportPlanName
```
public String getReportPlanName()
```
    The unique name of the report plan. This name is between 1 and 256 characters starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).
    
    Returns:
    
    The unique name of the report plan. This name is between 1 and 256 characters starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).
  - withReportPlanName
```
public ReportPlan withReportPlanName(String reportPlanName)
```
    The unique name of the report plan. This name is between 1 and 256 characters starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).
    
    Parameters:
    
    reportPlanName - The unique name of the report plan. This name is between 1 and 256 characters starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setReportPlanDescription
```
public void setReportPlanDescription(String reportPlanDescription)
```
    An optional description of the report plan with a maximum 1,024 characters.
    
    Parameters:
    
    reportPlanDescription - An optional description of the report plan with a maximum 1,024 characters.
  - getReportPlanDescription
```
public String getReportPlanDescription()
```
    An optional description of the report plan with a maximum 1,024 characters.
    
    Returns:
    
    An optional description of the report plan with a maximum 1,024 characters.
  - withReportPlanDescription
```
public ReportPlan withReportPlanDescription(String reportPlanDescription)
```
    An optional description of the report plan with a maximum 1,024 characters.
    
    Parameters:
    
    reportPlanDescription - An optional description of the report plan with a maximum 1,024 characters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setReportSetting
```
public void setReportSetting(ReportSetting reportSetting)
```
    Identifies the report template for the report. Reports are built using a report template. The report templates are:
    
    RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT
    
    If the report template is RESOURCE_COMPLIANCE_REPORT or CONTROL_COMPLIANCE_REPORT, this API resource also describes the report coverage by Amazon Web Services Regions and frameworks.
    
    Parameters:
    
    reportSetting - Identifies the report template for the report. Reports are built using a report template. The report templates are:
    
    RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT
    
    If the report template is RESOURCE_COMPLIANCE_REPORT or CONTROL_COMPLIANCE_REPORT, this API resource also describes the report coverage by Amazon Web Services Regions and frameworks.
  - getReportSetting
```
public ReportSetting getReportSetting()
```
    Identifies the report template for the report. Reports are built using a report template. The report templates are:
    
    RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT
    
    If the report template is RESOURCE_COMPLIANCE_REPORT or CONTROL_COMPLIANCE_REPORT, this API resource also describes the report coverage by Amazon Web Services Regions and frameworks.
    
    Returns:
    
    Identifies the report template for the report. Reports are built using a report template. The report templates are:
    
    RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT
    
    If the report template is RESOURCE_COMPLIANCE_REPORT or CONTROL_COMPLIANCE_REPORT, this API resource also describes the report coverage by Amazon Web Services Regions and frameworks.
  - withReportSetting
```
public ReportPlan withReportSetting(ReportSetting reportSetting)
```
    Identifies the report template for the report. Reports are built using a report template. The report templates are:
    
    RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT
    
    If the report template is RESOURCE_COMPLIANCE_REPORT or CONTROL_COMPLIANCE_REPORT, this API resource also describes the report coverage by Amazon Web Services Regions and frameworks.
    
    Parameters:
    
    reportSetting - Identifies the report template for the report. Reports are built using a report template. The report templates are:
    
    RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT
    
    If the report template is RESOURCE_COMPLIANCE_REPORT or CONTROL_COMPLIANCE_REPORT, this API resource also describes the report coverage by Amazon Web Services Regions and frameworks.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setReportDeliveryChannel
```
public void setReportDeliveryChannel(ReportDeliveryChannel reportDeliveryChannel)
```
    Contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.
    
    Parameters:
    
    reportDeliveryChannel - Contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.
  - getReportDeliveryChannel
```
public ReportDeliveryChannel getReportDeliveryChannel()
```
    Contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.
    
    Returns:
    
    Contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.
  - withReportDeliveryChannel
```
public ReportPlan withReportDeliveryChannel(ReportDeliveryChannel reportDeliveryChannel)
```
    Contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.
    
    Parameters:
    
    reportDeliveryChannel - Contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDeploymentStatus
```
public void setDeploymentStatus(String deploymentStatus)
```
    The deployment status of a report plan. The statuses are:
    
    CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED
    
    Parameters:
    
    deploymentStatus - The deployment status of a report plan. The statuses are:
    
    CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED
  - getDeploymentStatus
```
public String getDeploymentStatus()
```
    The deployment status of a report plan. The statuses are:
    
    CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED
    
    Returns:
    
    The deployment status of a report plan. The statuses are:
    
    CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED
  - withDeploymentStatus
```
public ReportPlan withDeploymentStatus(String deploymentStatus)
```
    The deployment status of a report plan. The statuses are:
    
    CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED
    
    Parameters:
    
    deploymentStatus - The deployment status of a report plan. The statuses are:
    
    CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationTime
```
public void setCreationTime(Date creationTime)
```
    The date and time that a report plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
    
    Parameters:
    
    creationTime - The date and time that a report plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
  - getCreationTime
```
public Date getCreationTime()
```
    The date and time that a report plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
    
    Returns:
    
    The date and time that a report plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
  - withCreationTime
```
public ReportPlan withCreationTime(Date creationTime)
```
    The date and time that a report plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
    
    Parameters:
    
    creationTime - The date and time that a report plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastAttemptedExecutionTime
```
public void setLastAttemptedExecutionTime(Date lastAttemptedExecutionTime)
```
    The date and time that a report job associated with this report plan last attempted to run, in Unix format and Coordinated Universal Time (UTC). The value of LastAttemptedExecutionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
    
    Parameters:
    
    lastAttemptedExecutionTime - The date and time that a report job associated with this report plan last attempted to run, in Unix format and Coordinated Universal Time (UTC). The value of LastAttemptedExecutionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
  - getLastAttemptedExecutionTime
```
public Date getLastAttemptedExecutionTime()
```
    The date and time that a report job associated with this report plan last attempted to run, in Unix format and Coordinated Universal Time (UTC). The value of LastAttemptedExecutionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
    
    Returns:
    
    The date and time that a report job associated with this report plan last attempted to run, in Unix format and Coordinated Universal Time (UTC). The value of LastAttemptedExecutionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
  - withLastAttemptedExecutionTime
```
public ReportPlan withLastAttemptedExecutionTime(Date lastAttemptedExecutionTime)
```
    The date and time that a report job associated with this report plan last attempted to run, in Unix format and Coordinated Universal Time (UTC). The value of LastAttemptedExecutionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
    
    Parameters:
    
    lastAttemptedExecutionTime - The date and time that a report job associated with this report plan last attempted to run, in Unix format and Coordinated Universal Time (UTC). The value of LastAttemptedExecutionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastSuccessfulExecutionTime
```
public void setLastSuccessfulExecutionTime(Date lastSuccessfulExecutionTime)
```
    The date and time that a report job associated with this report plan last successfully ran, in Unix format and Coordinated Universal Time (UTC). The value of LastSuccessfulExecutionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
    
    Parameters:
    
    lastSuccessfulExecutionTime - The date and time that a report job associated with this report plan last successfully ran, in Unix format and Coordinated Universal Time (UTC). The value of LastSuccessfulExecutionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
  - getLastSuccessfulExecutionTime
```
public Date getLastSuccessfulExecutionTime()
```
    The date and time that a report job associated with this report plan last successfully ran, in Unix format and Coordinated Universal Time (UTC). The value of LastSuccessfulExecutionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
    
    Returns:
    
    The date and time that a report job associated with this report plan last successfully ran, in Unix format and Coordinated Universal Time (UTC). The value of LastSuccessfulExecutionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
  - withLastSuccessfulExecutionTime
```
public ReportPlan withLastSuccessfulExecutionTime(Date lastSuccessfulExecutionTime)
```
    The date and time that a report job associated with this report plan last successfully ran, in Unix format and Coordinated Universal Time (UTC). The value of LastSuccessfulExecutionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
    
    Parameters:
    
    lastSuccessfulExecutionTime - The date and time that a report job associated with this report plan last successfully ran, in Unix format and Coordinated Universal Time (UTC). The value of LastSuccessfulExecutionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
    
    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 ReportPlan 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.778

Class ReportPlan

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ReportPlan

Method Detail

setReportPlanArn

getReportPlanArn

withReportPlanArn

setReportPlanName

getReportPlanName

withReportPlanName

setReportPlanDescription

getReportPlanDescription

withReportPlanDescription

setReportSetting

getReportSetting

withReportSetting

setReportDeliveryChannel

getReportDeliveryChannel

withReportDeliveryChannel

setDeploymentStatus

getDeploymentStatus

withDeploymentStatus

setCreationTime

getCreationTime

withCreationTime

setLastAttemptedExecutionTime

getLastAttemptedExecutionTime

withLastAttemptedExecutionTime

setLastSuccessfulExecutionTime

getLastSuccessfulExecutionTime

withLastSuccessfulExecutionTime

toString

equals

hashCode

clone

marshall