/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include namespace Aws { namespace Utils { namespace Xml { class XmlNode; } // namespace Xml } // namespace Utils namespace S3Control { namespace Model { /** *

Contains the configuration parameters for a job-completion * report.

See Also:

AWS * API Reference

*/ class JobReport { public: AWS_S3CONTROL_API JobReport(); AWS_S3CONTROL_API JobReport(const Aws::Utils::Xml::XmlNode& xmlNode); AWS_S3CONTROL_API JobReport& operator=(const Aws::Utils::Xml::XmlNode& xmlNode); AWS_S3CONTROL_API void AddToNode(Aws::Utils::Xml::XmlNode& parentNode) const; /** *

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

*/ inline const Aws::String& GetBucket() const{ return m_bucket; } /** *

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

*/ inline bool BucketHasBeenSet() const { return m_bucketHasBeenSet; } /** *

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

*/ inline void SetBucket(const Aws::String& value) { m_bucketHasBeenSet = true; m_bucket = value; } /** *

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

*/ inline void SetBucket(Aws::String&& value) { m_bucketHasBeenSet = true; m_bucket = std::move(value); } /** *

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

*/ inline void SetBucket(const char* value) { m_bucketHasBeenSet = true; m_bucket.assign(value); } /** *

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

*/ inline JobReport& WithBucket(const Aws::String& value) { SetBucket(value); return *this;} /** *

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

*/ inline JobReport& WithBucket(Aws::String&& value) { SetBucket(std::move(value)); return *this;} /** *

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

*/ inline JobReport& WithBucket(const char* value) { SetBucket(value); return *this;} /** *

The format of the specified job-completion report.

*/ inline const JobReportFormat& GetFormat() const{ return m_format; } /** *

The format of the specified job-completion report.

*/ inline bool FormatHasBeenSet() const { return m_formatHasBeenSet; } /** *

The format of the specified job-completion report.

*/ inline void SetFormat(const JobReportFormat& value) { m_formatHasBeenSet = true; m_format = value; } /** *

The format of the specified job-completion report.

*/ inline void SetFormat(JobReportFormat&& value) { m_formatHasBeenSet = true; m_format = std::move(value); } /** *

The format of the specified job-completion report.

*/ inline JobReport& WithFormat(const JobReportFormat& value) { SetFormat(value); return *this;} /** *

The format of the specified job-completion report.

*/ inline JobReport& WithFormat(JobReportFormat&& value) { SetFormat(std::move(value)); return *this;} /** *

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

*/ inline bool GetEnabled() const{ return m_enabled; } /** *

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

*/ inline bool EnabledHasBeenSet() const { return m_enabledHasBeenSet; } /** *

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

*/ inline void SetEnabled(bool value) { m_enabledHasBeenSet = true; m_enabled = value; } /** *

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

*/ inline JobReport& WithEnabled(bool value) { SetEnabled(value); return *this;} /** *

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.

*/ inline const Aws::String& GetPrefix() const{ return m_prefix; } /** *

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.

*/ inline bool PrefixHasBeenSet() const { return m_prefixHasBeenSet; } /** *

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.

*/ inline void SetPrefix(const Aws::String& value) { m_prefixHasBeenSet = true; m_prefix = value; } /** *

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.

*/ inline void SetPrefix(Aws::String&& value) { m_prefixHasBeenSet = true; m_prefix = std::move(value); } /** *

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.

*/ inline void SetPrefix(const char* value) { m_prefixHasBeenSet = true; m_prefix.assign(value); } /** *

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.

*/ inline JobReport& WithPrefix(const Aws::String& value) { SetPrefix(value); return *this;} /** *

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.

*/ inline JobReport& WithPrefix(Aws::String&& value) { SetPrefix(std::move(value)); return *this;} /** *

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.

*/ inline JobReport& WithPrefix(const char* value) { SetPrefix(value); return *this;} /** *

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

*/ inline const JobReportScope& GetReportScope() const{ return m_reportScope; } /** *

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

*/ inline bool ReportScopeHasBeenSet() const { return m_reportScopeHasBeenSet; } /** *

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

*/ inline void SetReportScope(const JobReportScope& value) { m_reportScopeHasBeenSet = true; m_reportScope = value; } /** *

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

*/ inline void SetReportScope(JobReportScope&& value) { m_reportScopeHasBeenSet = true; m_reportScope = std::move(value); } /** *

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

*/ inline JobReport& WithReportScope(const JobReportScope& value) { SetReportScope(value); return *this;} /** *

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

*/ inline JobReport& WithReportScope(JobReportScope&& value) { SetReportScope(std::move(value)); return *this;} private: Aws::String m_bucket; bool m_bucketHasBeenSet = false; JobReportFormat m_format; bool m_formatHasBeenSet = false; bool m_enabled; bool m_enabledHasBeenSet = false; Aws::String m_prefix; bool m_prefixHasBeenSet = false; JobReportScope m_reportScope; bool m_reportScopeHasBeenSet = false; }; } // namespace Model } // namespace S3Control } // namespace Aws