AWS SDK for C++  1.8.100
AWS SDK for C++
Public Member Functions | List of all members
Aws::S3Control::Model::JobReport Class Reference

#include <JobReport.h>

Public Member Functions

 JobReport ()
 
 JobReport (const Aws::Utils::Xml::XmlNode &xmlNode)
 
JobReportoperator= (const Aws::Utils::Xml::XmlNode &xmlNode)
 
void AddToNode (Aws::Utils::Xml::XmlNode &parentNode) const
 
const Aws::StringGetBucket () const
 
bool BucketHasBeenSet () const
 
void SetBucket (const Aws::String &value)
 
void SetBucket (Aws::String &&value)
 
void SetBucket (const char *value)
 
JobReportWithBucket (const Aws::String &value)
 
JobReportWithBucket (Aws::String &&value)
 
JobReportWithBucket (const char *value)
 
const JobReportFormatGetFormat () const
 
bool FormatHasBeenSet () const
 
void SetFormat (const JobReportFormat &value)
 
void SetFormat (JobReportFormat &&value)
 
JobReportWithFormat (const JobReportFormat &value)
 
JobReportWithFormat (JobReportFormat &&value)
 
bool GetEnabled () const
 
bool EnabledHasBeenSet () const
 
void SetEnabled (bool value)
 
JobReportWithEnabled (bool value)
 
const Aws::StringGetPrefix () const
 
bool PrefixHasBeenSet () const
 
void SetPrefix (const Aws::String &value)
 
void SetPrefix (Aws::String &&value)
 
void SetPrefix (const char *value)
 
JobReportWithPrefix (const Aws::String &value)
 
JobReportWithPrefix (Aws::String &&value)
 
JobReportWithPrefix (const char *value)
 
const JobReportScopeGetReportScope () const
 
bool ReportScopeHasBeenSet () const
 
void SetReportScope (const JobReportScope &value)
 
void SetReportScope (JobReportScope &&value)
 
JobReportWithReportScope (const JobReportScope &value)
 
JobReportWithReportScope (JobReportScope &&value)
 

Detailed Description

Contains the configuration parameters for a job-completion report.

See Also:

AWS API Reference

Definition at line 33 of file JobReport.h.

Constructor & Destructor Documentation

◆ JobReport() [1/2]

Aws::S3Control::Model::JobReport::JobReport ( )

◆ JobReport() [2/2]

Aws::S3Control::Model::JobReport::JobReport ( const Aws::Utils::Xml::XmlNode xmlNode)

Member Function Documentation

◆ AddToNode()

void Aws::S3Control::Model::JobReport::AddToNode ( Aws::Utils::Xml::XmlNode parentNode) const

◆ BucketHasBeenSet()

bool Aws::S3Control::Model::JobReport::BucketHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) for the bucket where specified job-completion report will be stored.

Definition at line 53 of file JobReport.h.

◆ EnabledHasBeenSet()

bool Aws::S3Control::Model::JobReport::EnabledHasBeenSet ( ) const
inline

Indicates whether the specified job will generate a job-completion report.

Definition at line 133 of file JobReport.h.

◆ FormatHasBeenSet()

bool Aws::S3Control::Model::JobReport::FormatHasBeenSet ( ) const
inline

The format of the specified job-completion report.

Definition at line 100 of file JobReport.h.

◆ GetBucket()

const Aws::String& Aws::S3Control::Model::JobReport::GetBucket ( ) const
inline

The Amazon Resource Name (ARN) for the bucket where specified job-completion report will be stored.

Definition at line 47 of file JobReport.h.

◆ GetEnabled()

bool Aws::S3Control::Model::JobReport::GetEnabled ( ) const
inline

Indicates whether the specified job will generate a job-completion report.

Definition at line 127 of file JobReport.h.

◆ GetFormat()

const JobReportFormat& Aws::S3Control::Model::JobReport::GetFormat ( ) const
inline

The format of the specified job-completion report.

Definition at line 95 of file JobReport.h.

◆ GetPrefix()

const Aws::String& Aws::S3Control::Model::JobReport::GetPrefix ( ) const
inline

An optional prefix to describe where in the specified bucket the job-completion report will be stored. Amazon S3 stores the job-completion report at <prefix>/job-<job-id>/report.json.

Definition at line 153 of file JobReport.h.

◆ GetReportScope()

const JobReportScope& Aws::S3Control::Model::JobReport::GetReportScope ( ) const
inline

Indicates whether the job-completion report will include details of all tasks or only failed tasks.

Definition at line 209 of file JobReport.h.

◆ operator=()

JobReport& Aws::S3Control::Model::JobReport::operator= ( const Aws::Utils::Xml::XmlNode xmlNode)

◆ PrefixHasBeenSet()

bool Aws::S3Control::Model::JobReport::PrefixHasBeenSet ( ) const
inline

An optional prefix to describe where in the specified bucket the job-completion report will be stored. Amazon S3 stores the job-completion report at <prefix>/job-<job-id>/report.json.

Definition at line 160 of file JobReport.h.

◆ ReportScopeHasBeenSet()

bool Aws::S3Control::Model::JobReport::ReportScopeHasBeenSet ( ) const
inline

Indicates whether the job-completion report will include details of all tasks or only failed tasks.

Definition at line 215 of file JobReport.h.

◆ SetBucket() [1/3]

void Aws::S3Control::Model::JobReport::SetBucket ( const Aws::String value)
inline

The Amazon Resource Name (ARN) for the bucket where specified job-completion report will be stored.

Definition at line 59 of file JobReport.h.

◆ SetBucket() [2/3]

void Aws::S3Control::Model::JobReport::SetBucket ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) for the bucket where specified job-completion report will be stored.

Definition at line 65 of file JobReport.h.

◆ SetBucket() [3/3]

void Aws::S3Control::Model::JobReport::SetBucket ( const char *  value)
inline

The Amazon Resource Name (ARN) for the bucket where specified job-completion report will be stored.

Definition at line 71 of file JobReport.h.

◆ SetEnabled()

void Aws::S3Control::Model::JobReport::SetEnabled ( bool  value)
inline

Indicates whether the specified job will generate a job-completion report.

Definition at line 139 of file JobReport.h.

◆ SetFormat() [1/2]

void Aws::S3Control::Model::JobReport::SetFormat ( const JobReportFormat value)
inline

The format of the specified job-completion report.

Definition at line 105 of file JobReport.h.

◆ SetFormat() [2/2]

void Aws::S3Control::Model::JobReport::SetFormat ( JobReportFormat &&  value)
inline

The format of the specified job-completion report.

Definition at line 110 of file JobReport.h.

◆ SetPrefix() [1/3]

void Aws::S3Control::Model::JobReport::SetPrefix ( const Aws::String value)
inline

An optional prefix to describe where in the specified bucket the job-completion report will be stored. Amazon S3 stores the job-completion report at <prefix>/job-<job-id>/report.json.

Definition at line 167 of file JobReport.h.

◆ SetPrefix() [2/3]

void Aws::S3Control::Model::JobReport::SetPrefix ( Aws::String &&  value)
inline

An optional prefix to describe where in the specified bucket the job-completion report will be stored. Amazon S3 stores the job-completion report at <prefix>/job-<job-id>/report.json.

Definition at line 174 of file JobReport.h.

◆ SetPrefix() [3/3]

void Aws::S3Control::Model::JobReport::SetPrefix ( const char *  value)
inline

An optional prefix to describe where in the specified bucket the job-completion report will be stored. Amazon S3 stores the job-completion report at <prefix>/job-<job-id>/report.json.

Definition at line 181 of file JobReport.h.

◆ SetReportScope() [1/2]

void Aws::S3Control::Model::JobReport::SetReportScope ( const JobReportScope value)
inline

Indicates whether the job-completion report will include details of all tasks or only failed tasks.

Definition at line 221 of file JobReport.h.

◆ SetReportScope() [2/2]

void Aws::S3Control::Model::JobReport::SetReportScope ( JobReportScope &&  value)
inline

Indicates whether the job-completion report will include details of all tasks or only failed tasks.

Definition at line 227 of file JobReport.h.

◆ WithBucket() [1/3]

JobReport& Aws::S3Control::Model::JobReport::WithBucket ( const Aws::String value)
inline

The Amazon Resource Name (ARN) for the bucket where specified job-completion report will be stored.

Definition at line 77 of file JobReport.h.

◆ WithBucket() [2/3]

JobReport& Aws::S3Control::Model::JobReport::WithBucket ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) for the bucket where specified job-completion report will be stored.

Definition at line 83 of file JobReport.h.

◆ WithBucket() [3/3]

JobReport& Aws::S3Control::Model::JobReport::WithBucket ( const char *  value)
inline

The Amazon Resource Name (ARN) for the bucket where specified job-completion report will be stored.

Definition at line 89 of file JobReport.h.

◆ WithEnabled()

JobReport& Aws::S3Control::Model::JobReport::WithEnabled ( bool  value)
inline

Indicates whether the specified job will generate a job-completion report.

Definition at line 145 of file JobReport.h.

◆ WithFormat() [1/2]

JobReport& Aws::S3Control::Model::JobReport::WithFormat ( const JobReportFormat value)
inline

The format of the specified job-completion report.

Definition at line 115 of file JobReport.h.

◆ WithFormat() [2/2]

JobReport& Aws::S3Control::Model::JobReport::WithFormat ( JobReportFormat &&  value)
inline

The format of the specified job-completion report.

Definition at line 120 of file JobReport.h.

◆ WithPrefix() [1/3]

JobReport& Aws::S3Control::Model::JobReport::WithPrefix ( const Aws::String value)
inline

An optional prefix to describe where in the specified bucket the job-completion report will be stored. Amazon S3 stores the job-completion report at <prefix>/job-<job-id>/report.json.

Definition at line 188 of file JobReport.h.

◆ WithPrefix() [2/3]

JobReport& Aws::S3Control::Model::JobReport::WithPrefix ( Aws::String &&  value)
inline

An optional prefix to describe where in the specified bucket the job-completion report will be stored. Amazon S3 stores the job-completion report at <prefix>/job-<job-id>/report.json.

Definition at line 195 of file JobReport.h.

◆ WithPrefix() [3/3]

JobReport& Aws::S3Control::Model::JobReport::WithPrefix ( const char *  value)
inline

An optional prefix to describe where in the specified bucket the job-completion report will be stored. Amazon S3 stores the job-completion report at <prefix>/job-<job-id>/report.json.

Definition at line 202 of file JobReport.h.

◆ WithReportScope() [1/2]

JobReport& Aws::S3Control::Model::JobReport::WithReportScope ( const JobReportScope value)
inline

Indicates whether the job-completion report will include details of all tasks or only failed tasks.

Definition at line 233 of file JobReport.h.

◆ WithReportScope() [2/2]

JobReport& Aws::S3Control::Model::JobReport::WithReportScope ( JobReportScope &&  value)
inline

Indicates whether the job-completion report will include details of all tasks or only failed tasks.

Definition at line 239 of file JobReport.h.


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