Interface JobSummary.Builder

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

  • Method Details

    • jobId

      JobSummary.Builder jobId(String jobId)

      The unique identifier of the asynchronous job. Use the GetJob operation to check the status of the job and to retrieve its results.

      Parameters:
      jobId - The unique identifier of the asynchronous job. Use the GetJob operation to check the status of the job and to retrieve its results.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      JobSummary.Builder status(String status)

      The current lifecycle status of the job.

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

    • status

      JobSummary.Builder status(JobStatus status)

      The current lifecycle status of the job.

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

    • operationType

      JobSummary.Builder operationType(String operationType)

      The type of mutating operation that created the job.

      Parameters:
      operationType - The type of mutating operation that created the job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • createdAt

      JobSummary.Builder createdAt(Instant createdAt)

      The time when the resource was created, in Unix epoch time.

      Parameters:
      createdAt - The time when the resource was created, in Unix epoch time.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • updatedAt

      JobSummary.Builder updatedAt(Instant updatedAt)

      The time when the resource was last updated, in Unix epoch time.

      Parameters:
      updatedAt - The time when the resource was last updated, in Unix epoch time.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • brandProfileId

      JobSummary.Builder brandProfileId(String brandProfileId)

      The brand profile that the job operates on. This value is absent for operations that create a brand profile.

      Parameters:
      brandProfileId - The brand profile that the job operates on. This value is absent for operations that create a brand profile.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • errorCode

      JobSummary.Builder errorCode(String errorCode)

      A machine-readable code that identifies why the job failed. This value is present only when the job status is FAILED.

      Parameters:
      errorCode - A machine-readable code that identifies why the job failed. This value is present only when the job status is FAILED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • errorMessage

      JobSummary.Builder errorMessage(String errorMessage)

      A human-readable description of why the job failed. This value is present only when the job status is FAILED.

      Parameters:
      errorMessage - A human-readable description of why the job failed. This value is present only when the job status is FAILED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resources

      JobSummary.Builder resources(Collection<JobResource> resources)

      The resources that were created or updated by the job.

      Parameters:
      resources - The resources that were created or updated by the job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resources

      JobSummary.Builder resources(JobResource... resources)

      The resources that were created or updated by the job.

      Parameters:
      resources - The resources that were created or updated by the job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resources

      JobSummary.Builder resources(Consumer<JobResource.Builder>... resources)

      The resources that were created or updated by the job.

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

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

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