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

Interface DescribeExplainabilityResponse.Builder

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

  • Method Details

    • explainabilityArn

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

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

      DescribeExplainabilityResponse.Builder resourceArn(String resourceArn)

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

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

    • explainabilityConfig

      DescribeExplainabilityResponse.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 DescribeExplainabilityResponse.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:

    • enableVisualization

      DescribeExplainabilityResponse.Builder enableVisualization(Boolean enableVisualization)

      Whether the visualization was enabled for the Explainability resource.

      Parameters:
      enableVisualization - Whether the visualization was enabled for the Explainability resource.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dataSource

      DescribeExplainabilityResponse.Builder dataSource(DataSource dataSource)
      Sets the value of the DataSource property for this object.
      Parameters:
      dataSource - The new value for the DataSource property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dataSource

      default DescribeExplainabilityResponse.Builder dataSource(Consumer<DataSource.Builder> dataSource)
      Sets the value of the DataSource property for this object. 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:

    • schema

      DescribeExplainabilityResponse.Builder schema(Schema schema)
      Sets the value of the Schema property for this object.
      Parameters:
      schema - The new value for the Schema property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • schema

      default DescribeExplainabilityResponse.Builder schema(Consumer<Schema.Builder> schema)
      Sets the value of the Schema property for this object. This is a convenience method that creates an instance of the Schema.Builder avoiding the need to create one manually via Schema.builder().

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

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

    • startDateTime

      DescribeExplainabilityResponse.Builder startDateTime(String startDateTime)

      If TimePointGranularity is set to SPECIFIC, the first time point in the Explainability.

      Parameters:
      startDateTime - If TimePointGranularity is set to SPECIFIC, the first time point in the Explainability.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endDateTime

      DescribeExplainabilityResponse.Builder endDateTime(String endDateTime)

      If TimePointGranularity is set to SPECIFIC, the last time point in the Explainability.

      Parameters:
      endDateTime - If TimePointGranularity is set to SPECIFIC, the last time point in the Explainability.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • estimatedTimeRemainingInMinutes

      DescribeExplainabilityResponse.Builder estimatedTimeRemainingInMinutes(Long estimatedTimeRemainingInMinutes)

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

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

    • message

      DescribeExplainabilityResponse.Builder message(String message)

      If an error occurred, a message about the error.

      Parameters:
      message - If an error occurred, a message about the error.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      DescribeExplainabilityResponse.Builder status(String status)

      The status of the Explainability resource. 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 resource. 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.

    • creationTime

      DescribeExplainabilityResponse.Builder creationTime(Instant creationTime)

      When the Explainability resource was created.

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

    • lastModificationTime

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