@Generated(value="software.amazon.awssdk:codegen") public final class GetEventPredictionRequest extends FraudDetectorRequest implements ToCopyableBuilder<GetEventPredictionRequest.Builder,GetEventPredictionRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
GetEventPredictionRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
static GetEventPredictionRequest.Builder |
builder() |
String |
detectorId()
The detector ID.
|
String |
detectorVersionId()
The detector version ID.
|
List<Entity> |
entities()
The entity type (associated with the detector's event type) and specific entity ID representing who performed the
event.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
String |
eventId()
The unique ID used to identify the event.
|
String |
eventTimestamp()
Timestamp that defines when the event under evaluation occurred.
|
String |
eventTypeName()
The event type associated with the detector specified for the prediction.
|
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.
|
Map<String,ModelEndpointDataBlob> |
externalModelEndpointDataBlobs()
The Amazon SageMaker model endpoint input data blobs.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest. |
boolean |
hasEntities()
For responses, this returns true if the service returned a value for the Entities property.
|
boolean |
hasEventVariables()
For responses, this returns true if the service returned a value for the EventVariables property.
|
boolean |
hasExternalModelEndpointDataBlobs()
For responses, this returns true if the service returned a value for the ExternalModelEndpointDataBlobs property.
|
int |
hashCode() |
List<SdkField<?>> |
sdkFields() |
static Class<? extends GetEventPredictionRequest.Builder> |
serializableBuilderClass() |
GetEventPredictionRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
overrideConfigurationcopypublic final String detectorId()
The detector ID.
public final String detectorVersionId()
The detector version ID.
public final String eventId()
The unique ID used to identify the event.
public final String eventTypeName()
The event type associated with the detector specified for the prediction.
public final boolean hasEntities()
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.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.
public final String eventTimestamp()
Timestamp that defines when the event under evaluation occurred. The timestamp must be specified using ISO 8601 standard in UTC.
public final boolean hasEventVariables()
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.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.
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.
public final boolean hasExternalModelEndpointDataBlobs()
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.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.
public GetEventPredictionRequest.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<GetEventPredictionRequest.Builder,GetEventPredictionRequest>toBuilder in class FraudDetectorRequestpublic static GetEventPredictionRequest.Builder builder()
public static Class<? extends GetEventPredictionRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
SdkPojoSdkPojo class,
and is generated based on a service model.
If an SdkPojo class does not have any inherited fields, equalsBySdkFields
and equals are essentially the same.
equalsBySdkFields in interface SdkPojoobj - the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequestSdkRequest. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will
again be available.getValueForField in class SdkRequestfieldName - The name of the member to be retrieved.clazz - The class to cast the returned object to.