Class EventStream

java.lang.Object
software.amazon.awssdk.services.pinpoint.model.EventStream
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<EventStream.Builder,EventStream>
@Generated("software.amazon.awssdk:codegen") public final class EventStream extends Object implements SdkPojo, Serializable, ToCopyableBuilder<EventStream.Builder,EventStream>

Specifies settings for publishing event data to an Amazon Kinesis data stream or an Amazon Kinesis Data Firehose delivery stream.

See Also:

  • Method Details

    • applicationId

      public final String applicationId()

      The unique identifier for the application to publish event data for.

      Returns:
      The unique identifier for the application to publish event data for.

    • destinationStreamArn

      public final String destinationStreamArn()

      The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon Kinesis Data Firehose delivery stream to publish event data to.

      For a Kinesis data stream, the ARN format is: arn:aws:kinesis:region:account -id:stream/stream_name

      For a Kinesis Data Firehose delivery stream, the ARN format is: arn:aws:firehose:region :account-id:deliverystream/stream_name

      Returns:
      The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon Kinesis Data Firehose delivery stream to publish event data to.

      For a Kinesis data stream, the ARN format is: arn:aws:kinesis:region:account-id:stream/stream_name

      For a Kinesis Data Firehose delivery stream, the ARN format is: arn:aws:firehose:region:account-id:deliverystream/stream_name

    • externalId

      public final String externalId()

      (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when publishing event data, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.

      Returns:
      (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when publishing event data, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.

    • lastModifiedDate

      public final String lastModifiedDate()

      The date, in ISO 8601 format, when the event stream was last modified.

      Returns:
      The date, in ISO 8601 format, when the event stream was last modified.

    • lastUpdatedBy

      public final String lastUpdatedBy()

      The IAM user who last modified the event stream.

      Returns:
      The IAM user who last modified the event stream.

    • roleArn

      public final String roleArn()

      The AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event data to the stream in your AWS account.

      Returns:
      The AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event data to the stream in your AWS account.

    • toBuilder

      public EventStream.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<EventStream.Builder,EventStream>
      Returns:
      a builder for type T

    • builder

      public static EventStream.Builder builder()

    • serializableBuilderClass

      public static Class<? extends EventStream.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

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

    • 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)

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