Class SendEventRequest

All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<SendEventRequest.Builder,SendEventRequest>

@Generated("software.amazon.awssdk:codegen") public final class SendEventRequest extends FraudDetectorRequest implements ToCopyableBuilder<SendEventRequest.Builder,SendEventRequest>
  • Method Details

    • eventId

      public final String eventId()

      The event ID to upload.

      Returns:
      The event ID to upload.
    • eventTypeName

      public final String eventTypeName()

      The event type name of the event.

      Returns:
      The event type name of the event.
    • eventTimestamp

      public final String eventTimestamp()

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

      Returns:
      The 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.

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

      public final String assignedLabel()

      The label to associate with the event. Required if specifying labelTimestamp.

      Returns:
      The label to associate with the event. Required if specifying labelTimestamp.
    • labelTimestamp

      public final String labelTimestamp()

      The timestamp associated with the label. Required if specifying assignedLabel.

      Returns:
      The timestamp associated with the label. Required if specifying assignedLabel.
    • 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()

      An array of entities.

      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:
      An array of entities.
    • toBuilder

      public SendEventRequest.Builder 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 interface ToCopyableBuilder<SendEventRequest.Builder,SendEventRequest>
      Specified by:
      toBuilder in class FraudDetectorRequest
      Returns:
      a builder for type T
    • builder

      public static SendEventRequest.Builder builder()
    • serializableBuilderClass

      public static Class<? extends SendEventRequest.Builder> serializableBuilderClass()
    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest
    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest
    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo 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.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.
    • 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
    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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.
      Overrides:
      getValueForField in class SdkRequest
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.