Class SendOutboundWebNotificationRequest

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

  • Method Details

    • instanceId

      public final String instanceId()

      The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

      Returns:
      The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    • clientToken

      public final String clientToken()

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

      Returns:
      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    • browserId

      public final String browserId()

      A unique identifier for the customer's web browser instance to which the notification is being sent.

      Returns:
      A unique identifier for the customer's web browser instance to which the notification is being sent.

    • sessionId

      public final String sessionId()

      A unique identifier for the customer's web session to which the notification is being sent.

      Returns:
      A unique identifier for the customer's web session to which the notification is being sent.

    • expiresAt

      public final Instant expiresAt()

      The timestamp, in Unix epoch time format, at which the web notification expires. After this time, the notification is no longer delivered to the customer's browser.

      Returns:
      The timestamp, in Unix epoch time format, at which the web notification expires. After this time, the notification is no longer delivered to the customer's browser.

    • source

      public final WebNotificationSource source()

      The source of the web notification. A SourceCampaign object identifies the campaign and outbound request that triggered this notification.

      Returns:
      The source of the web notification. A SourceCampaign object identifies the campaign and outbound request that triggered this notification.

    • destination

      public final WidgetDestination destination()

      The destination for the web notification, specifying the communication widget that delivers the notification and the customer profile of the recipient.

      Returns:
      The destination for the web notification, specifying the communication widget that delivers the notification and the customer profile of the recipient.

    • content

      public final WebNotificationContent content()

      The content of the web notification, including the notification type, the view to render, and any optional attributes used to populate it.

      Returns:
      The content of the web notification, including the notification type, the view to render, and any optional attributes used to populate it.

    • toBuilder

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

    • builder

      public static SendOutboundWebNotificationRequest.Builder builder()

    • serializableBuilderClass

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