Package software.amazon.awssdk.services.backup.model

Class CreateReportPlanRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.backup.model.BackupRequest

software.amazon.awssdk.services.backup.model.CreateReportPlanRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateReportPlanRequest.Builder,CreateReportPlanRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateReportPlanRequest
extends BackupRequest
implements ToCopyableBuilder<CreateReportPlanRequest.Builder,CreateReportPlanRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateReportPlanRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateReportPlanRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasReportPlanTags()	For responses, this returns true if the service returned a value for the ReportPlanTags property.
String	idempotencyToken()	A customer-chosen string that you can use to distinguish between otherwise identical calls to CreateReportPlanInput.
ReportDeliveryChannel	reportDeliveryChannel()	A structure that 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	reportPlanDescription()	An optional description of the report plan with a maximum of 1,024 characters.
String	reportPlanName()	The unique name of the report plan.
Map<String,String>	reportPlanTags()	Metadata that you can assign to help organize the report plans that you create.
ReportSetting	reportSetting()	Identifies the report template for the report.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateReportPlanRequest.Builder>	serializableBuilderClass()
CreateReportPlanRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

reportPlanName

public final String reportPlanName()

The unique name of the report plan. The name must be 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. The name must be 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 of 1,024 characters.

Returns:

An optional description of the report plan with a maximum of 1,024 characters.

reportDeliveryChannel

public final ReportDeliveryChannel reportDeliveryChannel()

A structure that 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:

A structure that 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.

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.

hasReportPlanTags

public final boolean hasReportPlanTags()

For responses, this returns true if the service returned a value for the ReportPlanTags 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.

reportPlanTags

public final Map<String,String> reportPlanTags()

Metadata that you can assign to help organize the report plans that you create. Each tag is a key-value pair.

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 hasReportPlanTags() method.

Returns:

Metadata that you can assign to help organize the report plans that you create. Each tag is a key-value pair.

idempotencyToken

public final String idempotencyToken()

A customer-chosen string that you can use to distinguish between otherwise identical calls to CreateReportPlanInput. Retrying a successful request with the same idempotency token results in a success message with no action taken.

Returns:

A customer-chosen string that you can use to distinguish between otherwise identical calls to CreateReportPlanInput. Retrying a successful request with the same idempotency token results in a success message with no action taken.

toBuilder

public CreateReportPlanRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateReportPlanRequest.Builder,CreateReportPlanRequest>

Specified by:

toBuilder in class BackupRequest

builder

public static CreateReportPlanRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateReportPlanRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo