Interface DescribeDatasetImportJobResponse.Builder

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

  • Method Details

    • datasetImportJobName

      DescribeDatasetImportJobResponse.Builder datasetImportJobName(String datasetImportJobName)

      The name of the dataset import job.

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

    • datasetImportJobArn

      DescribeDatasetImportJobResponse.Builder datasetImportJobArn(String datasetImportJobArn)

      The ARN of the dataset import job.

      Parameters:
      datasetImportJobArn - The ARN of the dataset import job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • datasetArn

      DescribeDatasetImportJobResponse.Builder datasetArn(String datasetArn)

      The Amazon Resource Name (ARN) of the dataset that the training data was imported to.

      Parameters:
      datasetArn - The Amazon Resource Name (ARN) of the dataset that the training data was imported to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • timestampFormat

      DescribeDatasetImportJobResponse.Builder timestampFormat(String timestampFormat)

      The format of timestamps in the dataset. The format that you specify depends on the DataFrequency specified when the dataset was created. The following formats are supported

      • "yyyy-MM-dd"

        For the following data frequencies: Y, M, W, and D

      • "yyyy-MM-dd HH:mm:ss"

        For the following data frequencies: H, 30min, 15min, and 1min; and optionally, for: Y, M, W, and D

      Parameters:
      timestampFormat - The format of timestamps in the dataset. The format that you specify depends on the DataFrequency specified when the dataset was created. The following formats are supported

      • "yyyy-MM-dd"

        For the following data frequencies: Y, M, W, and D

      • "yyyy-MM-dd HH:mm:ss"

        For the following data frequencies: H, 30min, 15min, and 1min; and optionally, for: Y, M, W, and D

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

    • timeZone

      DescribeDatasetImportJobResponse.Builder timeZone(String timeZone)

      The single time zone applied to every item in the dataset

      Parameters:
      timeZone - The single time zone applied to every item in the dataset
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • useGeolocationForTimeZone

      DescribeDatasetImportJobResponse.Builder useGeolocationForTimeZone(Boolean useGeolocationForTimeZone)

      Whether TimeZone is automatically derived from the geolocation attribute.

      Parameters:
      useGeolocationForTimeZone - Whether TimeZone is automatically derived from the geolocation attribute.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • geolocationFormat

      DescribeDatasetImportJobResponse.Builder geolocationFormat(String geolocationFormat)

      The format of the geolocation attribute. Valid Values:"LAT_LONG" and "CC_POSTALCODE".

      Parameters:
      geolocationFormat - The format of the geolocation attribute. Valid Values:"LAT_LONG" and "CC_POSTALCODE".
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dataSource

      DescribeDatasetImportJobResponse.Builder dataSource(DataSource dataSource)

      The location of the training data to import and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data.

      If encryption is used, DataSource includes an Key Management Service (KMS) key.

      Parameters:
      dataSource - The location of the training data to import and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data.

      If encryption is used, DataSource includes an Key Management Service (KMS) key.

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

    • dataSource

      default DescribeDatasetImportJobResponse.Builder dataSource(Consumer<DataSource.Builder> dataSource)

      The location of the training data to import and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data.

      If encryption is used, DataSource includes an Key Management Service (KMS) key.

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

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

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

    • estimatedTimeRemainingInMinutes

      DescribeDatasetImportJobResponse.Builder estimatedTimeRemainingInMinutes(Long estimatedTimeRemainingInMinutes)

      The estimated time remaining in minutes for the dataset import job to complete.

      Parameters:
      estimatedTimeRemainingInMinutes - The estimated time remaining in minutes for the dataset import job to complete.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fieldStatistics

      DescribeDatasetImportJobResponse.Builder fieldStatistics(Map<String,Statistics> fieldStatistics)

      Statistical information about each field in the input data.

      Parameters:
      fieldStatistics - Statistical information about each field in the input data.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dataSize

      DescribeDatasetImportJobResponse.Builder dataSize(Double dataSize)

      The size of the dataset in gigabytes (GB) after the import job has finished.

      Parameters:
      dataSize - The size of the dataset in gigabytes (GB) after the import job has finished.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      DescribeDatasetImportJobResponse.Builder status(String status)

      The status of the dataset import job. States include:

      • ACTIVE

      • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

      • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

      • CREATE_STOPPING, CREATE_STOPPED

      Parameters:
      status - The status of the dataset import job. States include:

      • ACTIVE

      • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

      • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

      • CREATE_STOPPING, CREATE_STOPPED

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

    • message

      DescribeDatasetImportJobResponse.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.

    • creationTime

      DescribeDatasetImportJobResponse.Builder creationTime(Instant creationTime)

      When the dataset import job was created.

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

    • lastModificationTime

      DescribeDatasetImportJobResponse.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

      DescribeDatasetImportJobResponse.Builder format(String format)

      The format of the imported data, CSV or PARQUET.

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

    • importMode

      DescribeDatasetImportJobResponse.Builder importMode(String importMode)

      The import mode of the dataset import job, FULL or INCREMENTAL.

      Parameters:
      importMode - The import mode of the dataset import job, FULL or INCREMENTAL.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • importMode

      DescribeDatasetImportJobResponse.Builder importMode(ImportMode importMode)

      The import mode of the dataset import job, FULL or INCREMENTAL.

      Parameters:
      importMode - The import mode of the dataset import job, FULL or INCREMENTAL.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: