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

Class UpdateReportPlanRequest

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.UpdateReportPlanRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateReportPlanRequest.Builder,UpdateReportPlanRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateReportPlanRequest.Builder

Method Summary

Modifier and Type	Method	Description
static UpdateReportPlanRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	idempotencyToken()	A customer-chosen string that you can use to distinguish between otherwise identical calls to UpdateReportPlanInput.
ReportDeliveryChannel	reportDeliveryChannel()	The information about where 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 1,024 characters.
String	reportPlanName()	The unique name of the report plan.
ReportSetting	reportSetting()	The report template for the report.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateReportPlanRequest.Builder>	serializableBuilderClass()
UpdateReportPlanRequest.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. 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.

reportDeliveryChannel

public final ReportDeliveryChannel reportDeliveryChannel()

The information about where to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.

Returns:

The information about where to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.

reportSetting

public final ReportSetting reportSetting()

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:

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.

idempotencyToken

public final String idempotencyToken()

A customer-chosen string that you can use to distinguish between otherwise identical calls to UpdateReportPlanInput. 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 UpdateReportPlanInput. Retrying a successful request with the same idempotency token results in a success message with no action taken.

toBuilder

public UpdateReportPlanRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateReportPlanRequest.Builder,UpdateReportPlanRequest>

Specified by:

toBuilder in class BackupRequest

builder

public static UpdateReportPlanRequest.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo