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

Interface ExplainabilitySummary.Builder

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

  • Method Details

    • explainabilityArn

      ExplainabilitySummary.Builder explainabilityArn(String explainabilityArn)

      The Amazon Resource Name (ARN) of the Explainability.

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

    • explainabilityName

      ExplainabilitySummary.Builder explainabilityName(String explainabilityName)

      The name of the Explainability.

      Parameters:
      explainabilityName - The name of the Explainability.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resourceArn

      ExplainabilitySummary.Builder resourceArn(String resourceArn)

      The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the Explainability.

      Parameters:
      resourceArn - The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the Explainability.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • explainabilityConfig

      ExplainabilitySummary.Builder explainabilityConfig(ExplainabilityConfig explainabilityConfig)

      The configuration settings that define the granularity of time series and time points for the Explainability.

      Parameters:
      explainabilityConfig - The configuration settings that define the granularity of time series and time points for the Explainability.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • explainabilityConfig

      default ExplainabilitySummary.Builder explainabilityConfig(Consumer<ExplainabilityConfig.Builder> explainabilityConfig)

      The configuration settings that define the granularity of time series and time points for the Explainability.

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

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

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

    • status

      ExplainabilitySummary.Builder status(String status)

      The status of the Explainability. States include:

      • ACTIVE

      • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

      • CREATE_STOPPING, CREATE_STOPPED

      • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

      Parameters:
      status - The status of the Explainability. States include:

      • ACTIVE

      • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

      • CREATE_STOPPING, CREATE_STOPPED

      • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

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

    • message

      ExplainabilitySummary.Builder message(String message)

      Information about any errors that may have occurred during the Explainability creation process.

      Parameters:
      message - Information about any errors that may have occurred during the Explainability creation process.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • creationTime

      ExplainabilitySummary.Builder creationTime(Instant creationTime)

      When the Explainability was created.

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

    • lastModificationTime

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