Interface WhatIfForecastExportSummary.Builder

  • Method Details

    • whatIfForecastExportArn

      WhatIfForecastExportSummary.Builder whatIfForecastExportArn(String whatIfForecastExportArn)

      The Amazon Resource Name (ARN) of the what-if forecast export.

      Parameters:
      whatIfForecastExportArn - The Amazon Resource Name (ARN) of the what-if forecast export.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • whatIfForecastArns

      WhatIfForecastExportSummary.Builder whatIfForecastArns(Collection<String> whatIfForecastArns)

      An array of Amazon Resource Names (ARNs) that define the what-if forecasts included in the export.

      Parameters:
      whatIfForecastArns - An array of Amazon Resource Names (ARNs) that define the what-if forecasts included in the export.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • whatIfForecastArns

      WhatIfForecastExportSummary.Builder whatIfForecastArns(String... whatIfForecastArns)

      An array of Amazon Resource Names (ARNs) that define the what-if forecasts included in the export.

      Parameters:
      whatIfForecastArns - An array of Amazon Resource Names (ARNs) that define the what-if forecasts included in the export.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • whatIfForecastExportName

      WhatIfForecastExportSummary.Builder whatIfForecastExportName(String whatIfForecastExportName)

      The what-if forecast export name.

      Parameters:
      whatIfForecastExportName - The what-if forecast export name.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • 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

      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:
    • status

      The status of the what-if forecast export. 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 what-if analysis must be ACTIVE before you can access the analysis.

      Parameters:
      status - The status of the what-if forecast export. 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 what-if analysis must be ACTIVE before you can access the analysis.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • 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

      WhatIfForecastExportSummary.Builder creationTime(Instant creationTime)

      When the what-if forecast export was created.

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

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