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

Interface WhatIfAnalysisSummary.Builder

All Superinterfaces:
Buildable, CopyableBuilder<WhatIfAnalysisSummary.Builder,WhatIfAnalysisSummary>, SdkBuilder<WhatIfAnalysisSummary.Builder,WhatIfAnalysisSummary>, SdkPojo
Enclosing class:
WhatIfAnalysisSummary
public static interface WhatIfAnalysisSummary.Builder extends SdkPojo, CopyableBuilder<WhatIfAnalysisSummary.Builder,WhatIfAnalysisSummary>

  • Method Details

    • whatIfAnalysisArn

      WhatIfAnalysisSummary.Builder whatIfAnalysisArn(String whatIfAnalysisArn)

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

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

    • whatIfAnalysisName

      WhatIfAnalysisSummary.Builder whatIfAnalysisName(String whatIfAnalysisName)

      The name of the what-if analysis.

      Parameters:
      whatIfAnalysisName - The name of the what-if analysis.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • forecastArn

      WhatIfAnalysisSummary.Builder forecastArn(String forecastArn)

      The Amazon Resource Name (ARN) of the baseline forecast that is being used in this what-if analysis.

      Parameters:
      forecastArn - The Amazon Resource Name (ARN) of the baseline forecast that is being used in this what-if analysis.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      WhatIfAnalysisSummary.Builder status(String status)

      The status of the what-if analysis. 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 analysis. 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

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

      WhatIfAnalysisSummary.Builder creationTime(Instant creationTime)

      When the what-if analysis was created.

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

    • lastModificationTime

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