Package software.amazon.awssdk.services.s3control.model

Interface JobDescriptor.Builder

    • Method Detail

      • jobId

        JobDescriptor.Builder jobId​(String jobId)

        The ID for the specified job.

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

      • confirmationRequired

        JobDescriptor.Builder confirmationRequired​(Boolean confirmationRequired)

        Indicates whether confirmation is required before Amazon S3 begins running the specified job. Confirmation is required only for jobs created through the Amazon S3 console.

        Parameters:
        confirmationRequired - Indicates whether confirmation is required before Amazon S3 begins running the specified job. Confirmation is required only for jobs created through the Amazon S3 console.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • description

        JobDescriptor.Builder description​(String description)

        The description for this job, if one was provided in this job's Create Job request.

        Parameters:
        description - The description for this job, if one was provided in this job's Create Job request.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • jobArn

        JobDescriptor.Builder jobArn​(String jobArn)

        The Amazon Resource Name (ARN) for this job.

        Parameters:
        jobArn - The Amazon Resource Name (ARN) for this job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • status

        JobDescriptor.Builder status​(String status)

        The current status of the specified job.

        Parameters:
        status - The current status of the specified job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        JobStatus, JobStatus

      • status

        JobDescriptor.Builder status​(JobStatus status)

        The current status of the specified job.

        Parameters:
        status - The current status of the specified job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        JobStatus, JobStatus

      • manifest

        JobDescriptor.Builder manifest​(JobManifest manifest)

        The configuration information for the specified job's manifest object.

        Parameters:
        manifest - The configuration information for the specified job's manifest object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • operation

        JobDescriptor.Builder operation​(JobOperation operation)

        The operation that the specified job is configured to run on the objects listed in the manifest.

        Parameters:
        operation - The operation that the specified job is configured to run on the objects listed in the manifest.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • priority

        JobDescriptor.Builder priority​(Integer priority)

        The priority of the specified job.

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

      • progressSummary

        JobDescriptor.Builder progressSummary​(JobProgressSummary progressSummary)

        Describes the total number of tasks that the specified job has run, the number of tasks that succeeded, and the number of tasks that failed.

        Parameters:
        progressSummary - Describes the total number of tasks that the specified job has run, the number of tasks that succeeded, and the number of tasks that failed.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • statusUpdateReason

        JobDescriptor.Builder statusUpdateReason​(String statusUpdateReason)

        The reason for updating the job.

        Parameters:
        statusUpdateReason - The reason for updating the job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • failureReasons

        JobDescriptor.Builder failureReasons​(Collection<JobFailure> failureReasons)

        If the specified job failed, this field contains information describing the failure.

        Parameters:
        failureReasons - If the specified job failed, this field contains information describing the failure.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • failureReasons

        JobDescriptor.Builder failureReasons​(JobFailure... failureReasons)

        If the specified job failed, this field contains information describing the failure.

        Parameters:
        failureReasons - If the specified job failed, this field contains information describing the failure.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • failureReasons

        JobDescriptor.Builder failureReasons​(Consumer<JobFailure.Builder>... failureReasons)

        If the specified job failed, this field contains information describing the failure.

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

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #failureReasons(List).

        Parameters:
        failureReasons - a consumer that will call methods on JobFailure.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #failureReasons(java.util.Collection)

      • report

        JobDescriptor.Builder report​(JobReport report)

        Contains the configuration information for the job-completion report if you requested one in the Create Job request.

        Parameters:
        report - Contains the configuration information for the job-completion report if you requested one in the Create Job request.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • creationTime

        JobDescriptor.Builder creationTime​(Instant creationTime)

        A timestamp indicating when this job was created.

        Parameters:
        creationTime - A timestamp indicating when this job was created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • terminationDate

        JobDescriptor.Builder terminationDate​(Instant terminationDate)

        A timestamp indicating when this job terminated. A job's termination date is the date and time when it succeeded, failed, or was canceled.

        Parameters:
        terminationDate - A timestamp indicating when this job terminated. A job's termination date is the date and time when it succeeded, failed, or was canceled.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • roleArn

        JobDescriptor.Builder roleArn​(String roleArn)

        The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) role assigned to run the tasks for this job.

        Parameters:
        roleArn - The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) role assigned to run the tasks for this job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • suspendedDate

        JobDescriptor.Builder suspendedDate​(Instant suspendedDate)

        The timestamp when this job was suspended, if it has been suspended.

        Parameters:
        suspendedDate - The timestamp when this job was suspended, if it has been suspended.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • suspendedCause

        JobDescriptor.Builder suspendedCause​(String suspendedCause)

        The reason why the specified job was suspended. A job is only suspended if you create it through the Amazon S3 console. When you create the job, it enters the Suspended state to await confirmation before running. After you confirm the job, it automatically exits the Suspended state.

        Parameters:
        suspendedCause - The reason why the specified job was suspended. A job is only suspended if you create it through the Amazon S3 console. When you create the job, it enters the Suspended state to await confirmation before running. After you confirm the job, it automatically exits the Suspended state.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • manifestGenerator

        JobDescriptor.Builder manifestGenerator​(JobManifestGenerator manifestGenerator)

        The manifest generator that was used to generate a job manifest for this job.

        Parameters:
        manifestGenerator - The manifest generator that was used to generate a job manifest for this job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • generatedManifestDescriptor

        JobDescriptor.Builder generatedManifestDescriptor​(S3GeneratedManifestDescriptor generatedManifestDescriptor)

        The attribute of the JobDescriptor containing details about the job's generated manifest.

        Parameters:
        generatedManifestDescriptor - The attribute of the JobDescriptor containing details about the job's generated manifest.
        Returns:
        Returns a reference to this object so that method calls can be chained together.