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

Interface CreateExplainabilityRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateExplainabilityRequest.Builder,CreateExplainabilityRequest>, ForecastRequest.Builder, SdkBuilder<CreateExplainabilityRequest.Builder,CreateExplainabilityRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateExplainabilityRequest
public static interface CreateExplainabilityRequest.Builder extends ForecastRequest.Builder, SdkPojo, CopyableBuilder<CreateExplainabilityRequest.Builder,CreateExplainabilityRequest>

  • Method Details

    • explainabilityName

      CreateExplainabilityRequest.Builder explainabilityName(String explainabilityName)

      A unique name for the Explainability.

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

    • resourceArn

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

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

    • dataSource

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

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

    • enableVisualization

      CreateExplainabilityRequest.Builder enableVisualization(Boolean enableVisualization)

      Create an Explainability visualization that is viewable within the Amazon Web Services console.

      Parameters:
      enableVisualization - Create an Explainability visualization that is viewable within the Amazon Web Services console.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • startDateTime

      CreateExplainabilityRequest.Builder startDateTime(String startDateTime)

      If TimePointGranularity is set to SPECIFIC, define the first point for the Explainability.

      Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example: 2015-01-01T20:00:00)

      Parameters:
      startDateTime - If TimePointGranularity is set to SPECIFIC, define the first point for the Explainability.

      Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example: 2015-01-01T20:00:00)

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

    • endDateTime

      CreateExplainabilityRequest.Builder endDateTime(String endDateTime)

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

      Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example: 2015-01-01T20:00:00)

      Parameters:
      endDateTime - If TimePointGranularity is set to SPECIFIC, define the last time point for the Explainability.

      Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example: 2015-01-01T20:00:00)

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

    • tags

      CreateExplainabilityRequest.Builder tags(Collection<Tag> tags)

      Optional metadata to help you categorize and organize your resources. Each tag consists of a key and an optional value, both of which you define. Tag keys and values are case sensitive.

      The following restrictions apply to tags:

      • For each resource, each tag key must be unique and each tag key must have one value.

      • Maximum number of tags per resource: 50.

      • Maximum key length: 128 Unicode characters in UTF-8.

      • Maximum value length: 256 Unicode characters in UTF-8.

      • Accepted characters: all letters and numbers, spaces representable in UTF-8, and + - = . _ : / @. If your tagging schema is used across other services and resources, the character restrictions of those services also apply.

      • Key prefixes cannot include any upper or lowercase combination of aws: or AWS:. Values can have this prefix. If a tag value has aws as its prefix but the key does not, Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit. You cannot edit or delete tag keys with this prefix.

      Parameters:
      tags - Optional metadata to help you categorize and organize your resources. Each tag consists of a key and an optional value, both of which you define. Tag keys and values are case sensitive.

      The following restrictions apply to tags:

      • For each resource, each tag key must be unique and each tag key must have one value.

      • Maximum number of tags per resource: 50.

      • Maximum key length: 128 Unicode characters in UTF-8.

      • Maximum value length: 256 Unicode characters in UTF-8.

      • Accepted characters: all letters and numbers, spaces representable in UTF-8, and + - = . _ : / @. If your tagging schema is used across other services and resources, the character restrictions of those services also apply.

      • Key prefixes cannot include any upper or lowercase combination of aws: or AWS:. Values can have this prefix. If a tag value has aws as its prefix but the key does not, Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit. You cannot edit or delete tag keys with this prefix.

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

    • tags

      CreateExplainabilityRequest.Builder tags(Tag... tags)

      Optional metadata to help you categorize and organize your resources. Each tag consists of a key and an optional value, both of which you define. Tag keys and values are case sensitive.

      The following restrictions apply to tags:

      • For each resource, each tag key must be unique and each tag key must have one value.

      • Maximum number of tags per resource: 50.

      • Maximum key length: 128 Unicode characters in UTF-8.

      • Maximum value length: 256 Unicode characters in UTF-8.

      • Accepted characters: all letters and numbers, spaces representable in UTF-8, and + - = . _ : / @. If your tagging schema is used across other services and resources, the character restrictions of those services also apply.

      • Key prefixes cannot include any upper or lowercase combination of aws: or AWS:. Values can have this prefix. If a tag value has aws as its prefix but the key does not, Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit. You cannot edit or delete tag keys with this prefix.

      Parameters:
      tags - Optional metadata to help you categorize and organize your resources. Each tag consists of a key and an optional value, both of which you define. Tag keys and values are case sensitive.

      The following restrictions apply to tags:

      • For each resource, each tag key must be unique and each tag key must have one value.

      • Maximum number of tags per resource: 50.

      • Maximum key length: 128 Unicode characters in UTF-8.

      • Maximum value length: 256 Unicode characters in UTF-8.

      • Accepted characters: all letters and numbers, spaces representable in UTF-8, and + - = . _ : / @. If your tagging schema is used across other services and resources, the character restrictions of those services also apply.

      • Key prefixes cannot include any upper or lowercase combination of aws: or AWS:. Values can have this prefix. If a tag value has aws as its prefix but the key does not, Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit. You cannot edit or delete tag keys with this prefix.

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

    • tags

      CreateExplainabilityRequest.Builder tags(Consumer<Tag.Builder>... tags)

      Optional metadata to help you categorize and organize your resources. Each tag consists of a key and an optional value, both of which you define. Tag keys and values are case sensitive.

      The following restrictions apply to tags:

      • For each resource, each tag key must be unique and each tag key must have one value.

      • Maximum number of tags per resource: 50.

      • Maximum key length: 128 Unicode characters in UTF-8.

      • Maximum value length: 256 Unicode characters in UTF-8.

      • Accepted characters: all letters and numbers, spaces representable in UTF-8, and + - = . _ : / @. If your tagging schema is used across other services and resources, the character restrictions of those services also apply.

      • Key prefixes cannot include any upper or lowercase combination of aws: or AWS:. Values can have this prefix. If a tag value has aws as its prefix but the key does not, Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit. You cannot edit or delete tag keys with this prefix.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

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

    • overrideConfiguration

      CreateExplainabilityRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateExplainabilityRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.