pxz-hos-client-cpp-module/support/aws-sdk-cpp-master/aws-cpp-sdk-macie2/include/aws/macie2/model/JobSummary.h

/**
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * SPDX-License-Identifier: Apache-2.0.
 */

#pragma once
#include <aws/macie2/Macie2_EXPORTS.h>
#include <aws/core/utils/memory/stl/AWSVector.h>
#include <aws/core/utils/DateTime.h>
#include <aws/core/utils/memory/stl/AWSString.h>
#include <aws/macie2/model/JobStatus.h>
#include <aws/macie2/model/JobType.h>
#include <aws/macie2/model/S3BucketDefinitionForJob.h>
#include <utility>

namespace Aws
{
namespace Utils
{
namespace Json
{
  class JsonValue;
  class JsonView;
} // namespace Json
} // namespace Utils
namespace Macie2
{
namespace Model
{

  /**
   * <p>Provides information about a classification job, including the current status
   * of the job.</p><p><h3>See Also:</h3>   <a
   * href="http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01/JobSummary">AWS
   * API Reference</a></p>
   */
  class AWS_MACIE2_API JobSummary
  {
  public:
    JobSummary();
    JobSummary(Aws::Utils::Json::JsonView jsonValue);
    JobSummary& operator=(Aws::Utils::Json::JsonView jsonValue);
    Aws::Utils::Json::JsonValue Jsonize() const;


    /**
     * <p>The S3 buckets that the job is configured to analyze.</p>
     */
    inline const Aws::Vector<S3BucketDefinitionForJob>& GetBucketDefinitions() const{ return m_bucketDefinitions; }

    /**
     * <p>The S3 buckets that the job is configured to analyze.</p>
     */
    inline bool BucketDefinitionsHasBeenSet() const { return m_bucketDefinitionsHasBeenSet; }

    /**
     * <p>The S3 buckets that the job is configured to analyze.</p>
     */
    inline void SetBucketDefinitions(const Aws::Vector<S3BucketDefinitionForJob>& value) { m_bucketDefinitionsHasBeenSet = true; m_bucketDefinitions = value; }

    /**
     * <p>The S3 buckets that the job is configured to analyze.</p>
     */
    inline void SetBucketDefinitions(Aws::Vector<S3BucketDefinitionForJob>&& value) { m_bucketDefinitionsHasBeenSet = true; m_bucketDefinitions = std::move(value); }

    /**
     * <p>The S3 buckets that the job is configured to analyze.</p>
     */
    inline JobSummary& WithBucketDefinitions(const Aws::Vector<S3BucketDefinitionForJob>& value) { SetBucketDefinitions(value); return *this;}

    /**
     * <p>The S3 buckets that the job is configured to analyze.</p>
     */
    inline JobSummary& WithBucketDefinitions(Aws::Vector<S3BucketDefinitionForJob>&& value) { SetBucketDefinitions(std::move(value)); return *this;}

    /**
     * <p>The S3 buckets that the job is configured to analyze.</p>
     */
    inline JobSummary& AddBucketDefinitions(const S3BucketDefinitionForJob& value) { m_bucketDefinitionsHasBeenSet = true; m_bucketDefinitions.push_back(value); return *this; }

    /**
     * <p>The S3 buckets that the job is configured to analyze.</p>
     */
    inline JobSummary& AddBucketDefinitions(S3BucketDefinitionForJob&& value) { m_bucketDefinitionsHasBeenSet = true; m_bucketDefinitions.push_back(std::move(value)); return *this; }


    /**
     * <p>The date and time, in UTC and extended ISO 8601 format, when the job was
     * created.</p>
     */
    inline const Aws::Utils::DateTime& GetCreatedAt() const{ return m_createdAt; }

    /**
     * <p>The date and time, in UTC and extended ISO 8601 format, when the job was
     * created.</p>
     */
    inline bool CreatedAtHasBeenSet() const { return m_createdAtHasBeenSet; }

    /**
     * <p>The date and time, in UTC and extended ISO 8601 format, when the job was
     * created.</p>
     */
    inline void SetCreatedAt(const Aws::Utils::DateTime& value) { m_createdAtHasBeenSet = true; m_createdAt = value; }

    /**
     * <p>The date and time, in UTC and extended ISO 8601 format, when the job was
     * created.</p>
     */
    inline void SetCreatedAt(Aws::Utils::DateTime&& value) { m_createdAtHasBeenSet = true; m_createdAt = std::move(value); }

    /**
     * <p>The date and time, in UTC and extended ISO 8601 format, when the job was
     * created.</p>
     */
    inline JobSummary& WithCreatedAt(const Aws::Utils::DateTime& value) { SetCreatedAt(value); return *this;}

    /**
     * <p>The date and time, in UTC and extended ISO 8601 format, when the job was
     * created.</p>
     */
    inline JobSummary& WithCreatedAt(Aws::Utils::DateTime&& value) { SetCreatedAt(std::move(value)); return *this;}


    /**
     * <p>The unique identifier for the job.</p>
     */
    inline const Aws::String& GetJobId() const{ return m_jobId; }

    /**
     * <p>The unique identifier for the job.</p>
     */
    inline bool JobIdHasBeenSet() const { return m_jobIdHasBeenSet; }

    /**
     * <p>The unique identifier for the job.</p>
     */
    inline void SetJobId(const Aws::String& value) { m_jobIdHasBeenSet = true; m_jobId = value; }

    /**
     * <p>The unique identifier for the job.</p>
     */
    inline void SetJobId(Aws::String&& value) { m_jobIdHasBeenSet = true; m_jobId = std::move(value); }

    /**
     * <p>The unique identifier for the job.</p>
     */
    inline void SetJobId(const char* value) { m_jobIdHasBeenSet = true; m_jobId.assign(value); }

    /**
     * <p>The unique identifier for the job.</p>
     */
    inline JobSummary& WithJobId(const Aws::String& value) { SetJobId(value); return *this;}

    /**
     * <p>The unique identifier for the job.</p>
     */
    inline JobSummary& WithJobId(Aws::String&& value) { SetJobId(std::move(value)); return *this;}

    /**
     * <p>The unique identifier for the job.</p>
     */
    inline JobSummary& WithJobId(const char* value) { SetJobId(value); return *this;}


    /**
     * <p>The current status of the job. Possible values are:</p> <ul><li><p>CANCELLED
     * - The job was cancelled by you or a user of the master account for your
     * organization. A job might also be cancelled if ownership of an S3 bucket changed
     * while the job was running, and that change affected the job's access to the
     * bucket.</p></li> <li><p>COMPLETE - Amazon Macie finished processing all the data
     * specified for the job.</p></li> <li><p>IDLE - For a recurring job, the previous
     * scheduled run is complete and the next scheduled run is pending. This value
     * doesn't apply to jobs that occur only once.</p></li> <li><p>PAUSED - Amazon
     * Macie started the job, but completion of the job would exceed one or more quotas
     * for your account.</p></li> <li><p>RUNNING - The job is in
     * progress.</p></li></ul>
     */
    inline const JobStatus& GetJobStatus() const{ return m_jobStatus; }

    /**
     * <p>The current status of the job. Possible values are:</p> <ul><li><p>CANCELLED
     * - The job was cancelled by you or a user of the master account for your
     * organization. A job might also be cancelled if ownership of an S3 bucket changed
     * while the job was running, and that change affected the job's access to the
     * bucket.</p></li> <li><p>COMPLETE - Amazon Macie finished processing all the data
     * specified for the job.</p></li> <li><p>IDLE - For a recurring job, the previous
     * scheduled run is complete and the next scheduled run is pending. This value
     * doesn't apply to jobs that occur only once.</p></li> <li><p>PAUSED - Amazon
     * Macie started the job, but completion of the job would exceed one or more quotas
     * for your account.</p></li> <li><p>RUNNING - The job is in
     * progress.</p></li></ul>
     */
    inline bool JobStatusHasBeenSet() const { return m_jobStatusHasBeenSet; }

    /**
     * <p>The current status of the job. Possible values are:</p> <ul><li><p>CANCELLED
     * - The job was cancelled by you or a user of the master account for your
     * organization. A job might also be cancelled if ownership of an S3 bucket changed
     * while the job was running, and that change affected the job's access to the
     * bucket.</p></li> <li><p>COMPLETE - Amazon Macie finished processing all the data
     * specified for the job.</p></li> <li><p>IDLE - For a recurring job, the previous
     * scheduled run is complete and the next scheduled run is pending. This value
     * doesn't apply to jobs that occur only once.</p></li> <li><p>PAUSED - Amazon
     * Macie started the job, but completion of the job would exceed one or more quotas
     * for your account.</p></li> <li><p>RUNNING - The job is in
     * progress.</p></li></ul>
     */
    inline void SetJobStatus(const JobStatus& value) { m_jobStatusHasBeenSet = true; m_jobStatus = value; }

    /**
     * <p>The current status of the job. Possible values are:</p> <ul><li><p>CANCELLED
     * - The job was cancelled by you or a user of the master account for your
     * organization. A job might also be cancelled if ownership of an S3 bucket changed
     * while the job was running, and that change affected the job's access to the
     * bucket.</p></li> <li><p>COMPLETE - Amazon Macie finished processing all the data
     * specified for the job.</p></li> <li><p>IDLE - For a recurring job, the previous
     * scheduled run is complete and the next scheduled run is pending. This value
     * doesn't apply to jobs that occur only once.</p></li> <li><p>PAUSED - Amazon
     * Macie started the job, but completion of the job would exceed one or more quotas
     * for your account.</p></li> <li><p>RUNNING - The job is in
     * progress.</p></li></ul>
     */
    inline void SetJobStatus(JobStatus&& value) { m_jobStatusHasBeenSet = true; m_jobStatus = std::move(value); }

    /**
     * <p>The current status of the job. Possible values are:</p> <ul><li><p>CANCELLED
     * - The job was cancelled by you or a user of the master account for your
     * organization. A job might also be cancelled if ownership of an S3 bucket changed
     * while the job was running, and that change affected the job's access to the
     * bucket.</p></li> <li><p>COMPLETE - Amazon Macie finished processing all the data
     * specified for the job.</p></li> <li><p>IDLE - For a recurring job, the previous
     * scheduled run is complete and the next scheduled run is pending. This value
     * doesn't apply to jobs that occur only once.</p></li> <li><p>PAUSED - Amazon
     * Macie started the job, but completion of the job would exceed one or more quotas
     * for your account.</p></li> <li><p>RUNNING - The job is in
     * progress.</p></li></ul>
     */
    inline JobSummary& WithJobStatus(const JobStatus& value) { SetJobStatus(value); return *this;}

    /**
     * <p>The current status of the job. Possible values are:</p> <ul><li><p>CANCELLED
     * - The job was cancelled by you or a user of the master account for your
     * organization. A job might also be cancelled if ownership of an S3 bucket changed
     * while the job was running, and that change affected the job's access to the
     * bucket.</p></li> <li><p>COMPLETE - Amazon Macie finished processing all the data
     * specified for the job.</p></li> <li><p>IDLE - For a recurring job, the previous
     * scheduled run is complete and the next scheduled run is pending. This value
     * doesn't apply to jobs that occur only once.</p></li> <li><p>PAUSED - Amazon
     * Macie started the job, but completion of the job would exceed one or more quotas
     * for your account.</p></li> <li><p>RUNNING - The job is in
     * progress.</p></li></ul>
     */
    inline JobSummary& WithJobStatus(JobStatus&& value) { SetJobStatus(std::move(value)); return *this;}


    /**
     * <p>The schedule for running the job. Possible values are:</p>
     * <ul><li><p>ONE_TIME - The job ran or will run only once.</p></li>
     * <li><p>SCHEDULED - The job runs on a daily, weekly, or monthly
     * basis.</p></li></ul>
     */
    inline const JobType& GetJobType() const{ return m_jobType; }

    /**
     * <p>The schedule for running the job. Possible values are:</p>
     * <ul><li><p>ONE_TIME - The job ran or will run only once.</p></li>
     * <li><p>SCHEDULED - The job runs on a daily, weekly, or monthly
     * basis.</p></li></ul>
     */
    inline bool JobTypeHasBeenSet() const { return m_jobTypeHasBeenSet; }

    /**
     * <p>The schedule for running the job. Possible values are:</p>
     * <ul><li><p>ONE_TIME - The job ran or will run only once.</p></li>
     * <li><p>SCHEDULED - The job runs on a daily, weekly, or monthly
     * basis.</p></li></ul>
     */
    inline void SetJobType(const JobType& value) { m_jobTypeHasBeenSet = true; m_jobType = value; }

    /**
     * <p>The schedule for running the job. Possible values are:</p>
     * <ul><li><p>ONE_TIME - The job ran or will run only once.</p></li>
     * <li><p>SCHEDULED - The job runs on a daily, weekly, or monthly
     * basis.</p></li></ul>
     */
    inline void SetJobType(JobType&& value) { m_jobTypeHasBeenSet = true; m_jobType = std::move(value); }

    /**
     * <p>The schedule for running the job. Possible values are:</p>
     * <ul><li><p>ONE_TIME - The job ran or will run only once.</p></li>
     * <li><p>SCHEDULED - The job runs on a daily, weekly, or monthly
     * basis.</p></li></ul>
     */
    inline JobSummary& WithJobType(const JobType& value) { SetJobType(value); return *this;}

    /**
     * <p>The schedule for running the job. Possible values are:</p>
     * <ul><li><p>ONE_TIME - The job ran or will run only once.</p></li>
     * <li><p>SCHEDULED - The job runs on a daily, weekly, or monthly
     * basis.</p></li></ul>
     */
    inline JobSummary& WithJobType(JobType&& value) { SetJobType(std::move(value)); return *this;}


    /**
     * <p>The custom name of the job.</p>
     */
    inline const Aws::String& GetName() const{ return m_name; }

    /**
     * <p>The custom name of the job.</p>
     */
    inline bool NameHasBeenSet() const { return m_nameHasBeenSet; }

    /**
     * <p>The custom name of the job.</p>
     */
    inline void SetName(const Aws::String& value) { m_nameHasBeenSet = true; m_name = value; }

    /**
     * <p>The custom name of the job.</p>
     */
    inline void SetName(Aws::String&& value) { m_nameHasBeenSet = true; m_name = std::move(value); }

    /**
     * <p>The custom name of the job.</p>
     */
    inline void SetName(const char* value) { m_nameHasBeenSet = true; m_name.assign(value); }

    /**
     * <p>The custom name of the job.</p>
     */
    inline JobSummary& WithName(const Aws::String& value) { SetName(value); return *this;}

    /**
     * <p>The custom name of the job.</p>
     */
    inline JobSummary& WithName(Aws::String&& value) { SetName(std::move(value)); return *this;}

    /**
     * <p>The custom name of the job.</p>
     */
    inline JobSummary& WithName(const char* value) { SetName(value); return *this;}

  private:

    Aws::Vector<S3BucketDefinitionForJob> m_bucketDefinitions;
    bool m_bucketDefinitionsHasBeenSet;

    Aws::Utils::DateTime m_createdAt;
    bool m_createdAtHasBeenSet;

    Aws::String m_jobId;
    bool m_jobIdHasBeenSet;

    JobStatus m_jobStatus;
    bool m_jobStatusHasBeenSet;

    JobType m_jobType;
    bool m_jobTypeHasBeenSet;

    Aws::String m_name;
    bool m_nameHasBeenSet;
  };

} // namespace Model
} // namespace Macie2
} // namespace Aws