Class GetEventPredictionMetadataResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetEventPredictionMetadataResponse.Builder,
GetEventPredictionMetadataResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
The detector ID.final String
The detector version ID.final String
The status of the detector version.final String
entityId()
The entity ID.final String
The entity type.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final List
<EvaluatedExternalModel> External (Amazon SageMaker) models that were evaluated for generating predictions.final List
<EvaluatedModelVersion> Model versions that were evaluated for generating predictions.final String
eventId()
The event ID.final String
The timestamp for when the prediction was generated for the associated event ID.final String
The event type associated with the detector specified for this prediction.final List
<EventVariableSummary> A list of event variables that influenced the prediction scores.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final boolean
For responses, this returns true if the service returned a value for the EvaluatedExternalModels property.final boolean
For responses, this returns true if the service returned a value for the EvaluatedModelVersions property.final boolean
For responses, this returns true if the service returned a value for the EventVariables property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Outcomes property.final boolean
hasRules()
For responses, this returns true if the service returned a value for the Rules property.outcomes()
The outcomes of the matched rule, based on the rule execution mode.final String
The timestamp that defines when the prediction was generated.final RuleExecutionMode
The execution mode of the rule used for evaluating variable values.final String
The execution mode of the rule used for evaluating variable values.final List
<EvaluatedRule> rules()
List of rules associated with the detector version that were used for evaluating variable values.static Class
<? extends GetEventPredictionMetadataResponse.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.services.frauddetector.model.FraudDetectorResponse
responseMetadata
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
eventId
The event ID.
- Returns:
- The event ID.
-
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
The entity ID.
- Returns:
- The entity ID.
-
entityType
The entity type.
- Returns:
- The entity type.
-
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
The detector ID.
- Returns:
- The detector ID.
-
detectorVersionId
The detector version ID.
- Returns:
- The detector version ID.
-
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 theisEmpty()
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
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 theisEmpty()
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
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.
-
ruleExecutionMode
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 returnRuleExecutionMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromruleExecutionModeAsString()
.- Returns:
- The execution mode of the rule used for evaluating variable values.
- See Also:
-
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 returnRuleExecutionMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromruleExecutionModeAsString()
.- Returns:
- The execution mode of the rule used for evaluating variable values.
- See Also:
-
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 theisEmpty()
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
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 theisEmpty()
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
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 theisEmpty()
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
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
The timestamp that defines when the prediction was generated.
- Returns:
- The timestamp that defines when the prediction was generated.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<GetEventPredictionMetadataResponse.Builder,
GetEventPredictionMetadataResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends GetEventPredictionMetadataResponse.Builder> serializableBuilderClass() -
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. 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, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-