Package software.amazon.awssdk.services.frauddetector.model

Class GetEventPredictionMetadataResponse

    • Method Detail

      • eventId

        public final String eventId()

        The event ID.

        Returns:
        The event ID.

      • eventTypeName

        public final String eventTypeName()

        The event type associated with the detector specified for this prediction.

        Returns:
        The event type associated with the detector specified for this prediction.

      • entityId

        public final String entityId()

        The entity ID.

        Returns:
        The entity ID.

      • entityType

        public final String entityType()

        The entity type.

        Returns:
        The entity type.

      • eventTimestamp

        public final String eventTimestamp()

        The timestamp for when the prediction was generated for the associated event ID.

        Returns:
        The timestamp for when the prediction was generated for the associated event ID.

      • detectorId

        public final String detectorId()

        The detector ID.

        Returns:
        The detector ID.

      • detectorVersionId

        public final String detectorVersionId()

        The detector version ID.

        Returns:
        The detector version ID.

      • detectorVersionStatus

        public final String detectorVersionStatus()

        The status of the detector version.

        Returns:
        The status of the detector version.

      • hasEventVariables

        public final boolean hasEventVariables()
        For responses, this returns true if the service returned a value for the EventVariables 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.

      • eventVariables

        public final List<EventVariableSummary> eventVariables()

        A list of event variables that influenced the prediction scores.

        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 hasEventVariables() method.

        Returns:
        A list of event variables that influenced the prediction scores.

      • hasRules

        public final boolean hasRules()
        For responses, this returns true if the service returned a value for the Rules 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.

      • rules

        public final List<EvaluatedRule> rules()

        List of rules associated with the detector version that were used for evaluating variable values.

        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 hasRules() method.

        Returns:
        List of rules associated with the detector version that were used for evaluating variable values.

      • ruleExecutionModeAsString

        public final String ruleExecutionModeAsString()

        The execution mode of the rule used for evaluating variable values.

        If the service returns an enum value that is not available in the current SDK version, ruleExecutionMode will return RuleExecutionMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ruleExecutionModeAsString().

        Returns:
        The execution mode of the rule used for evaluating variable values.
        See Also:
        RuleExecutionMode

      • hasOutcomes

        public final boolean hasOutcomes()
        For responses, this returns true if the service returned a value for the Outcomes 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.

      • outcomes

        public final List<String> outcomes()

        The outcomes of the matched rule, based on the rule execution mode.

        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 hasOutcomes() method.

        Returns:
        The outcomes of the matched rule, based on the rule execution mode.

      • hasEvaluatedModelVersions

        public final boolean hasEvaluatedModelVersions()
        For responses, this returns true if the service returned a value for the EvaluatedModelVersions 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.

      • evaluatedModelVersions

        public final List<EvaluatedModelVersion> evaluatedModelVersions()

        Model versions that were evaluated for generating predictions.

        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 hasEvaluatedModelVersions() method.

        Returns:
        Model versions that were evaluated for generating predictions.

      • hasEvaluatedExternalModels

        public final boolean hasEvaluatedExternalModels()
        For responses, this returns true if the service returned a value for the EvaluatedExternalModels 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.

      • evaluatedExternalModels

        public final List<EvaluatedExternalModel> evaluatedExternalModels()

        External (Amazon SageMaker) models that were evaluated for generating predictions.

        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 hasEvaluatedExternalModels() method.

        Returns:
        External (Amazon SageMaker) models that were evaluated for generating predictions.

      • predictionTimestamp

        public final String predictionTimestamp()

        The timestamp that defines when the prediction was generated.

        Returns:
        The timestamp that defines when the prediction was generated.

      • 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