Package software.amazon.awssdk.services.kinesis.model

Interface ConsumerDescription.Builder

    • Method Detail

      • consumerName

        ConsumerDescription.Builder consumerName​(String consumerName)

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

        Parameters:
        consumerName - The name of the consumer is something you choose when you register the consumer.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • consumerARN

        ConsumerDescription.Builder consumerARN​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • consumerStatus

        ConsumerDescription.Builder consumerStatus​(String consumerStatus)

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

        Parameters:
        consumerStatus - A consumer can't read data while in the CREATING or DELETING states.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ConsumerStatus, ConsumerStatus

      • consumerStatus

        ConsumerDescription.Builder consumerStatus​(ConsumerStatus consumerStatus)

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

        Parameters:
        consumerStatus - A consumer can't read data while in the CREATING or DELETING states.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ConsumerStatus, ConsumerStatus

      • consumerCreationTimestamp

        ConsumerDescription.Builder consumerCreationTimestamp​(Instant consumerCreationTimestamp)

        Parameters:
        consumerCreationTimestamp -
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • streamARN

        ConsumerDescription.Builder streamARN​(String streamARN)

        The ARN of the stream with which you registered the consumer.

        Parameters:
        streamARN - The ARN of the stream with which you registered the consumer.
        Returns:
        Returns a reference to this object so that method calls can be chained together.