Package software.amazon.awssdk.services.forecast.model

Interface DescribeForecastExportJobResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<DescribeForecastExportJobResponse.Builder,DescribeForecastExportJobResponse>, ForecastResponse.Builder, SdkBuilder<DescribeForecastExportJobResponse.Builder,DescribeForecastExportJobResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
DescribeForecastExportJobResponse
public static interface DescribeForecastExportJobResponse.Builder extends ForecastResponse.Builder, SdkPojo, CopyableBuilder<DescribeForecastExportJobResponse.Builder,DescribeForecastExportJobResponse>

  • Method Details

    • forecastExportJobArn

      DescribeForecastExportJobResponse.Builder forecastExportJobArn(String forecastExportJobArn)

      The ARN of the forecast export job.

      Parameters:
      forecastExportJobArn - The ARN of the forecast export job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • forecastExportJobName

      DescribeForecastExportJobResponse.Builder forecastExportJobName(String forecastExportJobName)

      The name of the forecast export job.

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

    • forecastArn

      DescribeForecastExportJobResponse.Builder forecastArn(String forecastArn)

      The Amazon Resource Name (ARN) of the exported forecast.

      Parameters:
      forecastArn - The Amazon Resource Name (ARN) of the exported forecast.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • destination

      DescribeForecastExportJobResponse.Builder destination(DataDestination destination)

      The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.

      Parameters:
      destination - The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • destination

      default DescribeForecastExportJobResponse.Builder destination(Consumer<DataDestination.Builder> destination)

      The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.

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

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

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

    • message

      DescribeForecastExportJobResponse.Builder message(String message)

      If an error occurred, an informational message about the error.

      Parameters:
      message - If an error occurred, an informational message about the error.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      DescribeForecastExportJobResponse.Builder status(String status)

      The status of the forecast export job. States include:

      • ACTIVE

      • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

      • CREATE_STOPPING, CREATE_STOPPED

      • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

      The Status of the forecast export job must be ACTIVE before you can access the forecast in your S3 bucket.

      Parameters:
      status - The status of the forecast export job. States include:

      • ACTIVE

      • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

      • CREATE_STOPPING, CREATE_STOPPED

      • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

      The Status of the forecast export job must be ACTIVE before you can access the forecast in your S3 bucket.

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

    • creationTime

      DescribeForecastExportJobResponse.Builder creationTime(Instant creationTime)

      When the forecast export job was created.

      Parameters:
      creationTime - When the forecast export job was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lastModificationTime

      DescribeForecastExportJobResponse.Builder lastModificationTime(Instant lastModificationTime)

      The last time the resource was modified. The timestamp depends on the status of the job:

      • CREATE_PENDING - The CreationTime.

      • CREATE_IN_PROGRESS - The current timestamp.

      • CREATE_STOPPING - The current timestamp.

      • CREATE_STOPPED - When the job stopped.

      • ACTIVE or CREATE_FAILED - When the job finished or failed.

      Parameters:
      lastModificationTime - The last time the resource was modified. The timestamp depends on the status of the job:

      • CREATE_PENDING - The CreationTime.

      • CREATE_IN_PROGRESS - The current timestamp.

      • CREATE_STOPPING - The current timestamp.

      • CREATE_STOPPED - When the job stopped.

      • ACTIVE or CREATE_FAILED - When the job finished or failed.

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

    • format

      DescribeForecastExportJobResponse.Builder format(String format)

      The format of the exported data, CSV or PARQUET.

      Parameters:
      format - The format of the exported data, CSV or PARQUET.
      Returns:
      Returns a reference to this object so that method calls can be chained together.