com.amazonaws.services.backup.model

Class CreateReportPlanRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.backup.model.CreateReportPlanRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateReportPlanRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateReportPlanRequest()

Method Summary

Modifier and Type	Method and Description
CreateReportPlanRequest	addReportPlanTagsEntry(String key, String value) Add a single ReportPlanTags entry
CreateReportPlanRequest	clearReportPlanTagsEntries() Removes all the entries added into ReportPlanTags.
CreateReportPlanRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getIdempotencyToken() A customer-chosen string that you can use to distinguish between otherwise identical calls to CreateReportPlanInput.
ReportDeliveryChannel	getReportDeliveryChannel() 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	getReportPlanDescription() An optional description of the report plan with a maximum of 1,024 characters.
String	getReportPlanName() The unique name of the report plan.
Map<String,String>	getReportPlanTags() Metadata that you can assign to help organize the report plans that you create.
ReportSetting	getReportSetting() Identifies the report template for the report.
int	hashCode()
void	setIdempotencyToken(String idempotencyToken) A customer-chosen string that you can use to distinguish between otherwise identical calls to CreateReportPlanInput.
void	setReportDeliveryChannel(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.
void	setReportPlanDescription(String reportPlanDescription) An optional description of the report plan with a maximum of 1,024 characters.
void	setReportPlanName(String reportPlanName) The unique name of the report plan.
void	setReportPlanTags(Map<String,String> reportPlanTags) Metadata that you can assign to help organize the report plans that you create.
void	setReportSetting(ReportSetting reportSetting) Identifies the report template for the report.
String	toString() Returns a string representation of this object.
CreateReportPlanRequest	withIdempotencyToken(String idempotencyToken) A customer-chosen string that you can use to distinguish between otherwise identical calls to CreateReportPlanInput.
CreateReportPlanRequest	withReportDeliveryChannel(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.
CreateReportPlanRequest	withReportPlanDescription(String reportPlanDescription) An optional description of the report plan with a maximum of 1,024 characters.
CreateReportPlanRequest	withReportPlanName(String reportPlanName) The unique name of the report plan.
CreateReportPlanRequest	withReportPlanTags(Map<String,String> reportPlanTags) Metadata that you can assign to help organize the report plans that you create.
CreateReportPlanRequest	withReportSetting(ReportSetting reportSetting) Identifies the report template for the report.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateReportPlanRequest

public CreateReportPlanRequest()

Method Detail

setReportPlanName

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

Parameters:

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

getReportPlanName

public String getReportPlanName()

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

withReportPlanName

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

Parameters:

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:

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 of 1,024 characters.

Parameters:

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

getReportPlanDescription

public String getReportPlanDescription()

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.

withReportPlanDescription

public CreateReportPlanRequest withReportPlanDescription(String reportPlanDescription)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setReportDeliveryChannel

public void setReportDeliveryChannel(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.

Parameters:

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.

getReportDeliveryChannel

public ReportDeliveryChannel getReportDeliveryChannel()

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.

withReportDeliveryChannel

public CreateReportPlanRequest withReportDeliveryChannel(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.

Parameters:

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:

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

getReportPlanTags

public Map<String,String> getReportPlanTags()

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

Returns:

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

setReportPlanTags

public void setReportPlanTags(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.

Parameters:

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

withReportPlanTags

public CreateReportPlanRequest withReportPlanTags(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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

addReportPlanTagsEntry

public CreateReportPlanRequest addReportPlanTagsEntry(String key,
                                                      String value)

Add a single ReportPlanTags entry

See Also:

withReportPlanTags(java.util.Map<java.lang.String, java.lang.String>)

clearReportPlanTagsEntries

public CreateReportPlanRequest clearReportPlanTagsEntries()

Removes all the entries added into ReportPlanTags.

Returns:

Returns a reference to this object so that method calls can be chained together.

setIdempotencyToken

public void setIdempotencyToken(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.

Parameters:

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.

getIdempotencyToken

public String getIdempotencyToken()

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.

withIdempotencyToken

public CreateReportPlanRequest withIdempotencyToken(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.

Parameters:

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:

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 CreateReportPlanRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()