Class ReportPlan
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ReportPlan.Builder,
ReportPlan>
Contains detailed information about a report plan.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic ReportPlan.Builder
builder()
final Instant
The date and time that a report plan is created, in Unix format and Coordinated Universal Time (UTC).final String
The deployment status of a report plan.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final Instant
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).final Instant
The date and time that a report job associated with this report plan last successfully ran, in Unix format and Coordinated Universal Time (UTC).final 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.final String
An Amazon Resource Name (ARN) that uniquely identifies a resource.final String
An optional description of the report plan with a maximum 1,024 characters.final String
The unique name of the report plan.final ReportSetting
Identifies the report template for the report.static Class
<? extends ReportPlan.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
reportPlanArn
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.
-
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:
- 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 (_).
-
reportPlanDescription
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.
-
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
orCONTROL_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
orCONTROL_COMPLIANCE_REPORT
, this API resource also describes the report coverage by Amazon Web Services Regions and frameworks.
-
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:
- 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.
-
deploymentStatus
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
-
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:
- 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.
-
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:
- 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.
-
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:
- 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.
-
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 interfaceToCopyableBuilder<ReportPlan.Builder,
ReportPlan> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-