Interface JobSummary.Builder

All Superinterfaces:
Buildable, CopyableBuilder<JobSummary.Builder,JobSummary>, SdkBuilder<JobSummary.Builder,JobSummary>, SdkPojo
Enclosing class:
JobSummary
public static interface JobSummary.Builder extends SdkPojo, CopyableBuilder<JobSummary.Builder,JobSummary>

  • Method Details

    • bucketCriteria

      JobSummary.Builder bucketCriteria(S3BucketCriteriaForJob bucketCriteria)

      The property- and tag-based conditions that determine which S3 buckets are included or excluded from the job's analysis. Each time the job runs, the job uses these criteria to determine which buckets to analyze. A job's definition can contain a bucketCriteria object or a bucketDefinitions array, not both.

      Parameters:
      bucketCriteria - The property- and tag-based conditions that determine which S3 buckets are included or excluded from the job's analysis. Each time the job runs, the job uses these criteria to determine which buckets to analyze. A job's definition can contain a bucketCriteria object or a bucketDefinitions array, not both.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • bucketCriteria

      default JobSummary.Builder bucketCriteria(Consumer<S3BucketCriteriaForJob.Builder> bucketCriteria)

      The property- and tag-based conditions that determine which S3 buckets are included or excluded from the job's analysis. Each time the job runs, the job uses these criteria to determine which buckets to analyze. A job's definition can contain a bucketCriteria object or a bucketDefinitions array, not both.

      This is a convenience method that creates an instance of the S3BucketCriteriaForJob.Builder avoiding the need to create one manually via S3BucketCriteriaForJob.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to bucketCriteria(S3BucketCriteriaForJob).

      Parameters:
      bucketCriteria - a consumer that will call methods on S3BucketCriteriaForJob.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • bucketDefinitions

      JobSummary.Builder bucketDefinitions(Collection<S3BucketDefinitionForJob> bucketDefinitions)

      An array of objects, one for each Amazon Web Services account that owns specific S3 buckets for the job to analyze. Each object specifies the account ID for an account and one or more buckets to analyze for that account. A job's definition can contain a bucketDefinitions array or a bucketCriteria object, not both.

      Parameters:
      bucketDefinitions - An array of objects, one for each Amazon Web Services account that owns specific S3 buckets for the job to analyze. Each object specifies the account ID for an account and one or more buckets to analyze for that account. A job's definition can contain a bucketDefinitions array or a bucketCriteria object, not both.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • bucketDefinitions

      JobSummary.Builder bucketDefinitions(S3BucketDefinitionForJob... bucketDefinitions)

      An array of objects, one for each Amazon Web Services account that owns specific S3 buckets for the job to analyze. Each object specifies the account ID for an account and one or more buckets to analyze for that account. A job's definition can contain a bucketDefinitions array or a bucketCriteria object, not both.

      Parameters:
      bucketDefinitions - An array of objects, one for each Amazon Web Services account that owns specific S3 buckets for the job to analyze. Each object specifies the account ID for an account and one or more buckets to analyze for that account. A job's definition can contain a bucketDefinitions array or a bucketCriteria object, not both.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • bucketDefinitions

      JobSummary.Builder bucketDefinitions(Consumer<S3BucketDefinitionForJob.Builder>... bucketDefinitions)

      An array of objects, one for each Amazon Web Services account that owns specific S3 buckets for the job to analyze. Each object specifies the account ID for an account and one or more buckets to analyze for that account. A job's definition can contain a bucketDefinitions array or a bucketCriteria object, not both.

      This is a convenience method that creates an instance of the S3BucketDefinitionForJob.Builder avoiding the need to create one manually via S3BucketDefinitionForJob.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to bucketDefinitions(List<S3BucketDefinitionForJob>).

      Parameters:
      bucketDefinitions - a consumer that will call methods on S3BucketDefinitionForJob.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • createdAt

      JobSummary.Builder createdAt(Instant createdAt)

      The date and time, in UTC and extended ISO 8601 format, when the job was created.

      Parameters:
      createdAt - The date and time, in UTC and extended ISO 8601 format, when the job was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • jobId

      JobSummary.Builder jobId(String jobId)

      The unique identifier for the job.

      Parameters:
      jobId - The unique identifier for the job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • jobStatus

      JobSummary.Builder jobStatus(String jobStatus)

      The current status of the job. Possible values are:

      • CANCELLED - You cancelled the job or, if it's a one-time job, you paused the job and didn't resume it within 30 days.

      • COMPLETE - For a one-time job, Amazon Macie finished processing the data specified for the job. This value doesn't apply to recurring jobs.

      • IDLE - For a recurring job, the previous scheduled run is complete and the next scheduled run is pending. This value doesn't apply to one-time jobs.

      • PAUSED - Macie started running the job but additional processing would exceed the monthly sensitive data discovery quota for your account or one or more member accounts that the job analyzes data for.

      • RUNNING - For a one-time job, the job is in progress. For a recurring job, a scheduled run is in progress.

      • USER_PAUSED - You paused the job. If you paused the job while it had a status of RUNNING and you don't resume it within 30 days of pausing it, the job or job run will expire and be cancelled, depending on the job's type. To check the expiration date, refer to the UserPausedDetails.jobExpiresAt property.

      Parameters:
      jobStatus - The current status of the job. Possible values are:

      • CANCELLED - You cancelled the job or, if it's a one-time job, you paused the job and didn't resume it within 30 days.

      • COMPLETE - For a one-time job, Amazon Macie finished processing the data specified for the job. This value doesn't apply to recurring jobs.

      • IDLE - For a recurring job, the previous scheduled run is complete and the next scheduled run is pending. This value doesn't apply to one-time jobs.

      • PAUSED - Macie started running the job but additional processing would exceed the monthly sensitive data discovery quota for your account or one or more member accounts that the job analyzes data for.

      • RUNNING - For a one-time job, the job is in progress. For a recurring job, a scheduled run is in progress.

      • USER_PAUSED - You paused the job. If you paused the job while it had a status of RUNNING and you don't resume it within 30 days of pausing it, the job or job run will expire and be cancelled, depending on the job's type. To check the expiration date, refer to the UserPausedDetails.jobExpiresAt property.

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

    • jobStatus

      JobSummary.Builder jobStatus(JobStatus jobStatus)

      The current status of the job. Possible values are:

      • CANCELLED - You cancelled the job or, if it's a one-time job, you paused the job and didn't resume it within 30 days.

      • COMPLETE - For a one-time job, Amazon Macie finished processing the data specified for the job. This value doesn't apply to recurring jobs.

      • IDLE - For a recurring job, the previous scheduled run is complete and the next scheduled run is pending. This value doesn't apply to one-time jobs.

      • PAUSED - Macie started running the job but additional processing would exceed the monthly sensitive data discovery quota for your account or one or more member accounts that the job analyzes data for.

      • RUNNING - For a one-time job, the job is in progress. For a recurring job, a scheduled run is in progress.

      • USER_PAUSED - You paused the job. If you paused the job while it had a status of RUNNING and you don't resume it within 30 days of pausing it, the job or job run will expire and be cancelled, depending on the job's type. To check the expiration date, refer to the UserPausedDetails.jobExpiresAt property.

      Parameters:
      jobStatus - The current status of the job. Possible values are:

      • CANCELLED - You cancelled the job or, if it's a one-time job, you paused the job and didn't resume it within 30 days.

      • COMPLETE - For a one-time job, Amazon Macie finished processing the data specified for the job. This value doesn't apply to recurring jobs.

      • IDLE - For a recurring job, the previous scheduled run is complete and the next scheduled run is pending. This value doesn't apply to one-time jobs.

      • PAUSED - Macie started running the job but additional processing would exceed the monthly sensitive data discovery quota for your account or one or more member accounts that the job analyzes data for.

      • RUNNING - For a one-time job, the job is in progress. For a recurring job, a scheduled run is in progress.

      • USER_PAUSED - You paused the job. If you paused the job while it had a status of RUNNING and you don't resume it within 30 days of pausing it, the job or job run will expire and be cancelled, depending on the job's type. To check the expiration date, refer to the UserPausedDetails.jobExpiresAt property.

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

    • jobType

      JobSummary.Builder jobType(String jobType)

      The schedule for running the job. Possible values are:

      • ONE_TIME - The job runs only once.

      • SCHEDULED - The job runs on a daily, weekly, or monthly basis.

      Parameters:
      jobType - The schedule for running the job. Possible values are:

      • ONE_TIME - The job runs only once.

      • SCHEDULED - The job runs on a daily, weekly, or monthly basis.

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

    • jobType

      JobSummary.Builder jobType(JobType jobType)

      The schedule for running the job. Possible values are:

      • ONE_TIME - The job runs only once.

      • SCHEDULED - The job runs on a daily, weekly, or monthly basis.

      Parameters:
      jobType - The schedule for running the job. Possible values are:

      • ONE_TIME - The job runs only once.

      • SCHEDULED - The job runs on a daily, weekly, or monthly basis.

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

    • lastRunErrorStatus

      JobSummary.Builder lastRunErrorStatus(LastRunErrorStatus lastRunErrorStatus)

      Specifies whether any account- or bucket-level access errors occurred when the job ran. For a recurring job, this value indicates the error status of the job's most recent run.

      Parameters:
      lastRunErrorStatus - Specifies whether any account- or bucket-level access errors occurred when the job ran. For a recurring job, this value indicates the error status of the job's most recent run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lastRunErrorStatus

      default JobSummary.Builder lastRunErrorStatus(Consumer<LastRunErrorStatus.Builder> lastRunErrorStatus)

      Specifies whether any account- or bucket-level access errors occurred when the job ran. For a recurring job, this value indicates the error status of the job's most recent run.

      This is a convenience method that creates an instance of the LastRunErrorStatus.Builder avoiding the need to create one manually via LastRunErrorStatus.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to lastRunErrorStatus(LastRunErrorStatus).

      Parameters:
      lastRunErrorStatus - a consumer that will call methods on LastRunErrorStatus.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • name

      JobSummary.Builder name(String name)

      The custom name of the job.

      Parameters:
      name - The custom name of the job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userPausedDetails

      JobSummary.Builder userPausedDetails(UserPausedDetails userPausedDetails)

      If the current status of the job is USER_PAUSED, specifies when the job was paused and when the job or job run will expire and be cancelled if it isn't resumed. This value is present only if the value for jobStatus is USER_PAUSED.

      Parameters:
      userPausedDetails - If the current status of the job is USER_PAUSED, specifies when the job was paused and when the job or job run will expire and be cancelled if it isn't resumed. This value is present only if the value for jobStatus is USER_PAUSED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userPausedDetails

      default JobSummary.Builder userPausedDetails(Consumer<UserPausedDetails.Builder> userPausedDetails)

      If the current status of the job is USER_PAUSED, specifies when the job was paused and when the job or job run will expire and be cancelled if it isn't resumed. This value is present only if the value for jobStatus is USER_PAUSED.

      This is a convenience method that creates an instance of the UserPausedDetails.Builder avoiding the need to create one manually via UserPausedDetails.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to userPausedDetails(UserPausedDetails).

      Parameters:
      userPausedDetails - a consumer that will call methods on UserPausedDetails.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: