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

Class CreateExplainabilityRequest

    • Method Detail

      • explainabilityName

        public final String explainabilityName()

        A unique name for the Explainability.

        Returns:
        A unique name for the Explainability.

      • resourceArn

        public final String resourceArn()

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

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

      • explainabilityConfig

        public final ExplainabilityConfig explainabilityConfig()

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

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

      • dataSource

        public final DataSource dataSource()
        Returns the value of the DataSource property for this object.
        Returns:
        The value of the DataSource property for this object.

      • schema

        public final Schema schema()
        Returns the value of the Schema property for this object.
        Returns:
        The value of the Schema property for this object.

      • enableVisualization

        public final Boolean enableVisualization()

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

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

      • startDateTime

        public final 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)

        Returns:
        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)

      • endDateTime

        public final 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)

        Returns:
        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)

      • hasTags

        public final boolean hasTags()
        For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • tags

        public final List<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.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

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

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object