Class CreateEventRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.bedrockagentcore.model.BedrockAgentCoreRequest
software.amazon.awssdk.services.bedrockagentcore.model.CreateEventRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateEventRequest.Builder,CreateEventRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateEventRequest extends BedrockAgentCoreRequest implements ToCopyableBuilder<CreateEventRequest.Builder,CreateEventRequest>

  • Method Details

    • memoryId

      public final String memoryId()

      The identifier of the memory store in which to create the event.

      Returns:
      The identifier of the memory store in which to create the event.

    • actorId

      public final String actorId()

      The identifier of the actor associated with this event. An actor represents an entity that participates in sessions and generates events.

      Returns:
      The identifier of the actor associated with this event. An actor represents an entity that participates in sessions and generates events.

    • sessionId

      public final String sessionId()

      The identifier of the session in which this event occurs. A session represents a sequence of related events.

      Returns:
      The identifier of the session in which this event occurs. A session represents a sequence of related events.

    • eventTimestamp

      public final Instant eventTimestamp()

      The timestamp when the event occurred. If not specified, the current time is used.

      Returns:
      The timestamp when the event occurred. If not specified, the current time is used.

    • hasPayload

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

    • payload

      public final List<PayloadType> payload()

      The content payload of the event. This can include conversational data or binary content.

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

      Returns:
      The content payload of the event. This can include conversational data or binary content.

    • branch

      public final Branch branch()

      The branch information for this event. Branches allow for organizing events into different conversation threads or paths.

      Returns:
      The branch information for this event. Branches allow for organizing events into different conversation threads or paths.

    • clientToken

      public final String clientToken()

      A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, AgentCore ignores the request, but does not return an error.

      Returns:
      A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, AgentCore ignores the request, but does not return an error.

    • toBuilder

      public CreateEventRequest.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<CreateEventRequest.Builder,CreateEventRequest>
      Specified by:
      toBuilder in class BedrockAgentCoreRequest
      Returns:
      a builder for type T

    • builder

      public static CreateEventRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateEventRequest.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.