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

Class GetEventPredictionRequest

    • Method Detail

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

      • eventId

        public final String eventId()

        The unique ID used to identify the event.

        Returns:
        The unique ID used to identify the event.

      • eventTypeName

        public final String eventTypeName()

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

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

      • hasEntities

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

      • entities

        public final List<Entity> entities()

        The entity type (associated with the detector's event type) and specific entity ID representing who performed the event. If an entity id is not available, use "UNKNOWN."

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

        Returns:
        The entity type (associated with the detector's event type) and specific entity ID representing who performed the event. If an entity id is not available, use "UNKNOWN."

      • eventTimestamp

        public final String eventTimestamp()

        Timestamp that defines when the event under evaluation occurred. The timestamp must be specified using ISO 8601 standard in UTC.

        Returns:
        Timestamp that defines when the event under evaluation occurred. The timestamp must be specified using ISO 8601 standard in UTC.

      • 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 Map<String,​String> eventVariables()

        Names of the event type's variables you defined in Amazon Fraud Detector to represent data elements and their corresponding values for the event you are sending for evaluation.

        You must provide at least one eventVariable

        To ensure most accurate fraud prediction and to simplify your data preparation, Amazon Fraud Detector will replace all missing variables or values as follows:

        For Amazon Fraud Detector trained models:

        If a null value is provided explicitly for a variable or if a variable is missing, model will replace the null value or the missing variable (no variable name in the eventVariables map) with calculated default mean/medians for numeric variables and with special values for categorical variables.

        For imported SageMaker models:

        If a null value is provided explicitly for a variable, the model and rules will use “null” as the value. If a variable is not provided (no variable name in the eventVariables map), model and rules will use the default value that is provided for the variable.

        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:
        Names of the event type's variables you defined in Amazon Fraud Detector to represent data elements and their corresponding values for the event you are sending for evaluation.

        You must provide at least one eventVariable

        To ensure most accurate fraud prediction and to simplify your data preparation, Amazon Fraud Detector will replace all missing variables or values as follows:

        For Amazon Fraud Detector trained models:

        If a null value is provided explicitly for a variable or if a variable is missing, model will replace the null value or the missing variable (no variable name in the eventVariables map) with calculated default mean/medians for numeric variables and with special values for categorical variables.

        For imported SageMaker models:

        If a null value is provided explicitly for a variable, the model and rules will use “null” as the value. If a variable is not provided (no variable name in the eventVariables map), model and rules will use the default value that is provided for the variable.

      • hasExternalModelEndpointDataBlobs

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

      • externalModelEndpointDataBlobs

        public final Map<String,​ModelEndpointDataBlob> externalModelEndpointDataBlobs()

        The Amazon SageMaker model endpoint input data blobs.

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

        Returns:
        The Amazon SageMaker model endpoint input data blobs.

      • 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