Class Consumer

    • Method Detail

      • consumerName

        public final String consumerName()

        The name of the consumer is something you choose when you register the consumer.

        Returns:
        The name of the consumer is something you choose when you register the consumer.
      • consumerARN

        public final String consumerARN()

        When you register a consumer, Kinesis Data Streams generates an ARN for it. You need this ARN to be able to call SubscribeToShard.

        If you delete a consumer and then create a new one with the same name, it won't have the same ARN. That's because consumer ARNs contain the creation timestamp. This is important to keep in mind if you have IAM policies that reference consumer ARNs.

        Returns:
        When you register a consumer, Kinesis Data Streams generates an ARN for it. You need this ARN to be able to call SubscribeToShard.

        If you delete a consumer and then create a new one with the same name, it won't have the same ARN. That's because consumer ARNs contain the creation timestamp. This is important to keep in mind if you have IAM policies that reference consumer ARNs.

      • consumerStatusAsString

        public final String consumerStatusAsString()

        A consumer can't read data while in the CREATING or DELETING states.

        If the service returns an enum value that is not available in the current SDK version, consumerStatus will return ConsumerStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from consumerStatusAsString().

        Returns:
        A consumer can't read data while in the CREATING or DELETING states.
        See Also:
        ConsumerStatus
      • consumerCreationTimestamp

        public final Instant consumerCreationTimestamp()

        Returns:
      • hashCode

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

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • 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)