AWS SDK for C++  1.9.123
AWS SDK for C++
Public Member Functions | List of all members
Aws::Backup::Model::ReportJob Class Reference

#include <ReportJob.h>

Public Member Functions

 ReportJob ()
 
 ReportJob (Aws::Utils::Json::JsonView jsonValue)
 
ReportJoboperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetReportJobId () const
 
bool ReportJobIdHasBeenSet () const
 
void SetReportJobId (const Aws::String &value)
 
void SetReportJobId (Aws::String &&value)
 
void SetReportJobId (const char *value)
 
ReportJobWithReportJobId (const Aws::String &value)
 
ReportJobWithReportJobId (Aws::String &&value)
 
ReportJobWithReportJobId (const char *value)
 
const Aws::StringGetReportPlanArn () const
 
bool ReportPlanArnHasBeenSet () const
 
void SetReportPlanArn (const Aws::String &value)
 
void SetReportPlanArn (Aws::String &&value)
 
void SetReportPlanArn (const char *value)
 
ReportJobWithReportPlanArn (const Aws::String &value)
 
ReportJobWithReportPlanArn (Aws::String &&value)
 
ReportJobWithReportPlanArn (const char *value)
 
const Aws::StringGetReportTemplate () const
 
bool ReportTemplateHasBeenSet () const
 
void SetReportTemplate (const Aws::String &value)
 
void SetReportTemplate (Aws::String &&value)
 
void SetReportTemplate (const char *value)
 
ReportJobWithReportTemplate (const Aws::String &value)
 
ReportJobWithReportTemplate (Aws::String &&value)
 
ReportJobWithReportTemplate (const char *value)
 
const Aws::Utils::DateTimeGetCreationTime () const
 
bool CreationTimeHasBeenSet () const
 
void SetCreationTime (const Aws::Utils::DateTime &value)
 
void SetCreationTime (Aws::Utils::DateTime &&value)
 
ReportJobWithCreationTime (const Aws::Utils::DateTime &value)
 
ReportJobWithCreationTime (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetCompletionTime () const
 
bool CompletionTimeHasBeenSet () const
 
void SetCompletionTime (const Aws::Utils::DateTime &value)
 
void SetCompletionTime (Aws::Utils::DateTime &&value)
 
ReportJobWithCompletionTime (const Aws::Utils::DateTime &value)
 
ReportJobWithCompletionTime (Aws::Utils::DateTime &&value)
 
const Aws::StringGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const Aws::String &value)
 
void SetStatus (Aws::String &&value)
 
void SetStatus (const char *value)
 
ReportJobWithStatus (const Aws::String &value)
 
ReportJobWithStatus (Aws::String &&value)
 
ReportJobWithStatus (const char *value)
 
const Aws::StringGetStatusMessage () const
 
bool StatusMessageHasBeenSet () const
 
void SetStatusMessage (const Aws::String &value)
 
void SetStatusMessage (Aws::String &&value)
 
void SetStatusMessage (const char *value)
 
ReportJobWithStatusMessage (const Aws::String &value)
 
ReportJobWithStatusMessage (Aws::String &&value)
 
ReportJobWithStatusMessage (const char *value)
 
const ReportDestinationGetReportDestination () const
 
bool ReportDestinationHasBeenSet () const
 
void SetReportDestination (const ReportDestination &value)
 
void SetReportDestination (ReportDestination &&value)
 
ReportJobWithReportDestination (const ReportDestination &value)
 
ReportJobWithReportDestination (ReportDestination &&value)
 

Detailed Description

Contains detailed information about a report job. A report job compiles a report based on a report plan and publishes it to Amazon S3.

See Also:

AWS API Reference

Definition at line 35 of file ReportJob.h.

Constructor & Destructor Documentation

◆ ReportJob() [1/2]

Aws::Backup::Model::ReportJob::ReportJob ( )

◆ ReportJob() [2/2]

Aws::Backup::Model::ReportJob::ReportJob ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ CompletionTimeHasBeenSet()

bool Aws::Backup::Model::ReportJob::CompletionTimeHasBeenSet ( ) const
inline

The date and time that a report job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Definition at line 278 of file ReportJob.h.

◆ CreationTimeHasBeenSet()

bool Aws::Backup::Model::ReportJob::CreationTimeHasBeenSet ( ) const
inline

The date and time that a report job 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.

Definition at line 229 of file ReportJob.h.

◆ GetCompletionTime()

const Aws::Utils::DateTime& Aws::Backup::Model::ReportJob::GetCompletionTime ( ) const
inline

The date and time that a report job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Definition at line 270 of file ReportJob.h.

◆ GetCreationTime()

const Aws::Utils::DateTime& Aws::Backup::Model::ReportJob::GetCreationTime ( ) const
inline

The date and time that a report job 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.

Definition at line 221 of file ReportJob.h.

◆ GetReportDestination()

const ReportDestination& Aws::Backup::Model::ReportJob::GetReportDestination ( ) const
inline

The S3 bucket name and S3 keys for the destination where the report job publishes the report.

Definition at line 431 of file ReportJob.h.

◆ GetReportJobId()

const Aws::String& Aws::Backup::Model::ReportJob::GetReportJobId ( ) const
inline

The identifier for a report job. A unique, randomly generated, Unicode, UTF-8 encoded string that is at most 1,024 bytes long. Report job IDs cannot be edited.

Definition at line 49 of file ReportJob.h.

◆ GetReportPlanArn()

const Aws::String& Aws::Backup::Model::ReportJob::GetReportPlanArn ( ) const
inline

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

Definition at line 105 of file ReportJob.h.

◆ GetReportTemplate()

const Aws::String& Aws::Backup::Model::ReportJob::GetReportTemplate ( ) const
inline

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

Definition at line 156 of file ReportJob.h.

◆ GetStatus()

const Aws::String& Aws::Backup::Model::ReportJob::GetStatus ( ) const
inline

The status of a report job. The statuses are:

CREATED | RUNNING | COMPLETED | FAILED

COMPLETED means that the report is available for your review at your designated destination. If the status is FAILED, review the StatusMessage for the reason.

Definition at line 320 of file ReportJob.h.

◆ GetStatusMessage()

const Aws::String& Aws::Backup::Model::ReportJob::GetStatusMessage ( ) const
inline

A message explaining the status of the report job.

Definition at line 389 of file ReportJob.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::Backup::Model::ReportJob::Jsonize ( ) const

◆ operator=()

ReportJob& Aws::Backup::Model::ReportJob::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ ReportDestinationHasBeenSet()

bool Aws::Backup::Model::ReportJob::ReportDestinationHasBeenSet ( ) const
inline

The S3 bucket name and S3 keys for the destination where the report job publishes the report.

Definition at line 437 of file ReportJob.h.

◆ ReportJobIdHasBeenSet()

bool Aws::Backup::Model::ReportJob::ReportJobIdHasBeenSet ( ) const
inline

The identifier for a report job. A unique, randomly generated, Unicode, UTF-8 encoded string that is at most 1,024 bytes long. Report job IDs cannot be edited.

Definition at line 56 of file ReportJob.h.

◆ ReportPlanArnHasBeenSet()

bool Aws::Backup::Model::ReportJob::ReportPlanArnHasBeenSet ( ) const
inline

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

Definition at line 111 of file ReportJob.h.

◆ ReportTemplateHasBeenSet()

bool Aws::Backup::Model::ReportJob::ReportTemplateHasBeenSet ( ) const
inline

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

Definition at line 164 of file ReportJob.h.

◆ SetCompletionTime() [1/2]

void Aws::Backup::Model::ReportJob::SetCompletionTime ( Aws::Utils::DateTime &&  value)
inline

The date and time that a report job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Definition at line 294 of file ReportJob.h.

◆ SetCompletionTime() [2/2]

void Aws::Backup::Model::ReportJob::SetCompletionTime ( const Aws::Utils::DateTime value)
inline

The date and time that a report job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Definition at line 286 of file ReportJob.h.

◆ SetCreationTime() [1/2]

void Aws::Backup::Model::ReportJob::SetCreationTime ( Aws::Utils::DateTime &&  value)
inline

The date and time that a report job 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.

Definition at line 245 of file ReportJob.h.

◆ SetCreationTime() [2/2]

void Aws::Backup::Model::ReportJob::SetCreationTime ( const Aws::Utils::DateTime value)
inline

The date and time that a report job 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.

Definition at line 237 of file ReportJob.h.

◆ SetReportDestination() [1/2]

void Aws::Backup::Model::ReportJob::SetReportDestination ( const ReportDestination value)
inline

The S3 bucket name and S3 keys for the destination where the report job publishes the report.

Definition at line 443 of file ReportJob.h.

◆ SetReportDestination() [2/2]

void Aws::Backup::Model::ReportJob::SetReportDestination ( ReportDestination &&  value)
inline

The S3 bucket name and S3 keys for the destination where the report job publishes the report.

Definition at line 449 of file ReportJob.h.

◆ SetReportJobId() [1/3]

void Aws::Backup::Model::ReportJob::SetReportJobId ( Aws::String &&  value)
inline

The identifier for a report job. A unique, randomly generated, Unicode, UTF-8 encoded string that is at most 1,024 bytes long. Report job IDs cannot be edited.

Definition at line 70 of file ReportJob.h.

◆ SetReportJobId() [2/3]

void Aws::Backup::Model::ReportJob::SetReportJobId ( const Aws::String value)
inline

The identifier for a report job. A unique, randomly generated, Unicode, UTF-8 encoded string that is at most 1,024 bytes long. Report job IDs cannot be edited.

Definition at line 63 of file ReportJob.h.

◆ SetReportJobId() [3/3]

void Aws::Backup::Model::ReportJob::SetReportJobId ( const char *  value)
inline

The identifier for a report job. A unique, randomly generated, Unicode, UTF-8 encoded string that is at most 1,024 bytes long. Report job IDs cannot be edited.

Definition at line 77 of file ReportJob.h.

◆ SetReportPlanArn() [1/3]

void Aws::Backup::Model::ReportJob::SetReportPlanArn ( Aws::String &&  value)
inline

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

Definition at line 123 of file ReportJob.h.

◆ SetReportPlanArn() [2/3]

void Aws::Backup::Model::ReportJob::SetReportPlanArn ( const Aws::String value)
inline

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

Definition at line 117 of file ReportJob.h.

◆ SetReportPlanArn() [3/3]

void Aws::Backup::Model::ReportJob::SetReportPlanArn ( const char *  value)
inline

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

Definition at line 129 of file ReportJob.h.

◆ SetReportTemplate() [1/3]

void Aws::Backup::Model::ReportJob::SetReportTemplate ( Aws::String &&  value)
inline

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

Definition at line 180 of file ReportJob.h.

◆ SetReportTemplate() [2/3]

void Aws::Backup::Model::ReportJob::SetReportTemplate ( const Aws::String value)
inline

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

Definition at line 172 of file ReportJob.h.

◆ SetReportTemplate() [3/3]

void Aws::Backup::Model::ReportJob::SetReportTemplate ( const char *  value)
inline

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

Definition at line 188 of file ReportJob.h.

◆ SetStatus() [1/3]

void Aws::Backup::Model::ReportJob::SetStatus ( Aws::String &&  value)
inline

The status of a report job. The statuses are:

CREATED | RUNNING | COMPLETED | FAILED

COMPLETED means that the report is available for your review at your designated destination. If the status is FAILED, review the StatusMessage for the reason.

Definition at line 347 of file ReportJob.h.

◆ SetStatus() [2/3]

void Aws::Backup::Model::ReportJob::SetStatus ( const Aws::String value)
inline

The status of a report job. The statuses are:

CREATED | RUNNING | COMPLETED | FAILED

COMPLETED means that the report is available for your review at your designated destination. If the status is FAILED, review the StatusMessage for the reason.

Definition at line 338 of file ReportJob.h.

◆ SetStatus() [3/3]

void Aws::Backup::Model::ReportJob::SetStatus ( const char *  value)
inline

The status of a report job. The statuses are:

CREATED | RUNNING | COMPLETED | FAILED

COMPLETED means that the report is available for your review at your designated destination. If the status is FAILED, review the StatusMessage for the reason.

Definition at line 356 of file ReportJob.h.

◆ SetStatusMessage() [1/3]

void Aws::Backup::Model::ReportJob::SetStatusMessage ( Aws::String &&  value)
inline

A message explaining the status of the report job.

Definition at line 404 of file ReportJob.h.

◆ SetStatusMessage() [2/3]

void Aws::Backup::Model::ReportJob::SetStatusMessage ( const Aws::String value)
inline

A message explaining the status of the report job.

Definition at line 399 of file ReportJob.h.

◆ SetStatusMessage() [3/3]

void Aws::Backup::Model::ReportJob::SetStatusMessage ( const char *  value)
inline

A message explaining the status of the report job.

Definition at line 409 of file ReportJob.h.

◆ StatusHasBeenSet()

bool Aws::Backup::Model::ReportJob::StatusHasBeenSet ( ) const
inline

The status of a report job. The statuses are:

CREATED | RUNNING | COMPLETED | FAILED

COMPLETED means that the report is available for your review at your designated destination. If the status is FAILED, review the StatusMessage for the reason.

Definition at line 329 of file ReportJob.h.

◆ StatusMessageHasBeenSet()

bool Aws::Backup::Model::ReportJob::StatusMessageHasBeenSet ( ) const
inline

A message explaining the status of the report job.

Definition at line 394 of file ReportJob.h.

◆ WithCompletionTime() [1/2]

ReportJob& Aws::Backup::Model::ReportJob::WithCompletionTime ( Aws::Utils::DateTime &&  value)
inline

The date and time that a report job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Definition at line 310 of file ReportJob.h.

◆ WithCompletionTime() [2/2]

ReportJob& Aws::Backup::Model::ReportJob::WithCompletionTime ( const Aws::Utils::DateTime value)
inline

The date and time that a report job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Definition at line 302 of file ReportJob.h.

◆ WithCreationTime() [1/2]

ReportJob& Aws::Backup::Model::ReportJob::WithCreationTime ( Aws::Utils::DateTime &&  value)
inline

The date and time that a report job 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.

Definition at line 261 of file ReportJob.h.

◆ WithCreationTime() [2/2]

ReportJob& Aws::Backup::Model::ReportJob::WithCreationTime ( const Aws::Utils::DateTime value)
inline

The date and time that a report job 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.

Definition at line 253 of file ReportJob.h.

◆ WithReportDestination() [1/2]

ReportJob& Aws::Backup::Model::ReportJob::WithReportDestination ( const ReportDestination value)
inline

The S3 bucket name and S3 keys for the destination where the report job publishes the report.

Definition at line 455 of file ReportJob.h.

◆ WithReportDestination() [2/2]

ReportJob& Aws::Backup::Model::ReportJob::WithReportDestination ( ReportDestination &&  value)
inline

The S3 bucket name and S3 keys for the destination where the report job publishes the report.

Definition at line 461 of file ReportJob.h.

◆ WithReportJobId() [1/3]

ReportJob& Aws::Backup::Model::ReportJob::WithReportJobId ( Aws::String &&  value)
inline

The identifier for a report job. A unique, randomly generated, Unicode, UTF-8 encoded string that is at most 1,024 bytes long. Report job IDs cannot be edited.

Definition at line 91 of file ReportJob.h.

◆ WithReportJobId() [2/3]

ReportJob& Aws::Backup::Model::ReportJob::WithReportJobId ( const Aws::String value)
inline

The identifier for a report job. A unique, randomly generated, Unicode, UTF-8 encoded string that is at most 1,024 bytes long. Report job IDs cannot be edited.

Definition at line 84 of file ReportJob.h.

◆ WithReportJobId() [3/3]

ReportJob& Aws::Backup::Model::ReportJob::WithReportJobId ( const char *  value)
inline

The identifier for a report job. A unique, randomly generated, Unicode, UTF-8 encoded string that is at most 1,024 bytes long. Report job IDs cannot be edited.

Definition at line 98 of file ReportJob.h.

◆ WithReportPlanArn() [1/3]

ReportJob& Aws::Backup::Model::ReportJob::WithReportPlanArn ( Aws::String &&  value)
inline

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

Definition at line 141 of file ReportJob.h.

◆ WithReportPlanArn() [2/3]

ReportJob& Aws::Backup::Model::ReportJob::WithReportPlanArn ( const Aws::String value)
inline

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

Definition at line 135 of file ReportJob.h.

◆ WithReportPlanArn() [3/3]

ReportJob& Aws::Backup::Model::ReportJob::WithReportPlanArn ( const char *  value)
inline

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

Definition at line 147 of file ReportJob.h.

◆ WithReportTemplate() [1/3]

ReportJob& Aws::Backup::Model::ReportJob::WithReportTemplate ( Aws::String &&  value)
inline

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

Definition at line 204 of file ReportJob.h.

◆ WithReportTemplate() [2/3]

ReportJob& Aws::Backup::Model::ReportJob::WithReportTemplate ( const Aws::String value)
inline

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

Definition at line 196 of file ReportJob.h.

◆ WithReportTemplate() [3/3]

ReportJob& Aws::Backup::Model::ReportJob::WithReportTemplate ( const char *  value)
inline

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

Definition at line 212 of file ReportJob.h.

◆ WithStatus() [1/3]

ReportJob& Aws::Backup::Model::ReportJob::WithStatus ( Aws::String &&  value)
inline

The status of a report job. The statuses are:

CREATED | RUNNING | COMPLETED | FAILED

COMPLETED means that the report is available for your review at your designated destination. If the status is FAILED, review the StatusMessage for the reason.

Definition at line 374 of file ReportJob.h.

◆ WithStatus() [2/3]

ReportJob& Aws::Backup::Model::ReportJob::WithStatus ( const Aws::String value)
inline

The status of a report job. The statuses are:

CREATED | RUNNING | COMPLETED | FAILED

COMPLETED means that the report is available for your review at your designated destination. If the status is FAILED, review the StatusMessage for the reason.

Definition at line 365 of file ReportJob.h.

◆ WithStatus() [3/3]

ReportJob& Aws::Backup::Model::ReportJob::WithStatus ( const char *  value)
inline

The status of a report job. The statuses are:

CREATED | RUNNING | COMPLETED | FAILED

COMPLETED means that the report is available for your review at your designated destination. If the status is FAILED, review the StatusMessage for the reason.

Definition at line 383 of file ReportJob.h.

◆ WithStatusMessage() [1/3]

ReportJob& Aws::Backup::Model::ReportJob::WithStatusMessage ( Aws::String &&  value)
inline

A message explaining the status of the report job.

Definition at line 419 of file ReportJob.h.

◆ WithStatusMessage() [2/3]

ReportJob& Aws::Backup::Model::ReportJob::WithStatusMessage ( const Aws::String value)
inline

A message explaining the status of the report job.

Definition at line 414 of file ReportJob.h.

◆ WithStatusMessage() [3/3]

ReportJob& Aws::Backup::Model::ReportJob::WithStatusMessage ( const char *  value)
inline

A message explaining the status of the report job.

Definition at line 424 of file ReportJob.h.


The documentation for this class was generated from the following file: