software.amazon.awssdk.services.backup.model

Class ReportPlan

java.lang.Object

software.amazon.awssdk.services.backup.model.ReportPlan

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ReportPlan.Builder,ReportPlan>

@Generated(value="software.amazon.awssdk:codegen")
public final class ReportPlan
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ReportPlan.Builder,ReportPlan>

Contains detailed information about a report plan.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ReportPlan.Builder

Method Summary

Modifier and Type	Method and Description
static ReportPlan.Builder	builder()
Instant	creationTime() The date and time that a report plan is created, in Unix format and Coordinated Universal Time (UTC).
String	deploymentStatus() The deployment status of a report plan.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Instant	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).
Instant	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).
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.
String	reportPlanArn() An Amazon Resource Name (ARN) that uniquely identifies a resource.
String	reportPlanDescription() An optional description of the report plan with a maximum 1,024 characters.
String	reportPlanName() The unique name of the report plan.
ReportSetting	reportSetting() Identifies the report template for the report.
List<SdkField<?>>	sdkFields()
static Class<? extends ReportPlan.Builder>	serializableBuilderClass()
ReportPlan.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

reportPlanArn

public final String 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

public final 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 (_).

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

public final String 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

public final 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.

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.

reportDeliveryChannel

public final 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.

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

public final String 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

public final Instant 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

public final Instant 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

public final Instant 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

public ReportPlan.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ReportPlan.Builder,ReportPlan>

builder

public static ReportPlan.Builder builder()

serializableBuilderClass

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