Interface WhatIfForecastExportSummary.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<WhatIfForecastExportSummary.Builder,
,WhatIfForecastExportSummary> SdkBuilder<WhatIfForecastExportSummary.Builder,
,WhatIfForecastExportSummary> SdkPojo
- Enclosing class:
WhatIfForecastExportSummary
-
Method Summary
Modifier and TypeMethodDescriptioncreationTime
(Instant creationTime) When the what-if forecast export was created.destination
(Consumer<DataDestination.Builder> destination) The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.destination
(DataDestination destination) The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.lastModificationTime
(Instant lastModificationTime) The last time the resource was modified.If an error occurred, an informational message about the error.The status of the what-if forecast export.whatIfForecastArns
(String... whatIfForecastArns) An array of Amazon Resource Names (ARNs) that define the what-if forecasts included in the export.whatIfForecastArns
(Collection<String> whatIfForecastArns) An array of Amazon Resource Names (ARNs) that define the what-if forecasts included in the export.whatIfForecastExportArn
(String whatIfForecastExportArn) The Amazon Resource Name (ARN) of the what-if forecast export.whatIfForecastExportName
(String whatIfForecastExportName) The what-if forecast export name.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
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
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
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
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
default WhatIfForecastExportSummary.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 theDataDestination.Builder
avoiding the need to create one manually viaDataDestination.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todestination(DataDestination)
.- Parameters:
destination
- a consumer that will call methods onDataDestination.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 beACTIVE
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 beACTIVE
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
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
The last time the resource was modified. The timestamp depends on the status of the job:
-
CREATE_PENDING
- TheCreationTime
. -
CREATE_IN_PROGRESS
- The current timestamp. -
CREATE_STOPPING
- The current timestamp. -
CREATE_STOPPED
- When the job stopped. -
ACTIVE
orCREATE_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
- TheCreationTime
. -
CREATE_IN_PROGRESS
- The current timestamp. -
CREATE_STOPPING
- The current timestamp. -
CREATE_STOPPED
- When the job stopped. -
ACTIVE
orCREATE_FAILED
- When the job finished or failed.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-