Interface GetEventPredictionRequest.Builder

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

  • Method Details

    • detectorId

      GetEventPredictionRequest.Builder detectorId(String detectorId)

      The detector ID.

      Parameters:
      detectorId - The detector ID.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • detectorVersionId

      GetEventPredictionRequest.Builder detectorVersionId(String detectorVersionId)

      The detector version ID.

      Parameters:
      detectorVersionId - The detector version ID.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • eventId

      GetEventPredictionRequest.Builder eventId(String eventId)

      The unique ID used to identify the event.

      Parameters:
      eventId - The unique ID used to identify the event.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • eventTypeName

      GetEventPredictionRequest.Builder eventTypeName(String eventTypeName)

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

      Parameters:
      eventTypeName - The event type associated with the detector specified for the prediction.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • entities

      GetEventPredictionRequest.Builder entities(Collection<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."

      Parameters:
      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."
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • entities

      GetEventPredictionRequest.Builder entities(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."

      Parameters:
      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."
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • entities

      GetEventPredictionRequest.Builder entities(Consumer<Entity.Builder>... 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."

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

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

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

    • eventTimestamp

      GetEventPredictionRequest.Builder eventTimestamp(String eventTimestamp)

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

      Parameters:
      eventTimestamp - Timestamp that defines when the event under evaluation occurred. The timestamp must be specified using ISO 8601 standard in UTC.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • eventVariables

      GetEventPredictionRequest.Builder eventVariables(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.

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

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

    • externalModelEndpointDataBlobs

      GetEventPredictionRequest.Builder externalModelEndpointDataBlobs(Map<String,ModelEndpointDataBlob> externalModelEndpointDataBlobs)

      The Amazon SageMaker model endpoint input data blobs.

      Parameters:
      externalModelEndpointDataBlobs - The Amazon SageMaker model endpoint input data blobs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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