Package software.amazon.awssdk.services.alexaforbusiness.model

Interface SendAnnouncementRequest.Builder

    • Method Detail

      • roomFilters

        SendAnnouncementRequest.Builder roomFilters​(Collection<Filter> roomFilters)

        The filters to use to send an announcement to a specified list of rooms. The supported filter keys are RoomName, ProfileName, RoomArn, and ProfileArn. To send to all rooms, specify an empty RoomFilters list.

        Parameters:
        roomFilters - The filters to use to send an announcement to a specified list of rooms. The supported filter keys are RoomName, ProfileName, RoomArn, and ProfileArn. To send to all rooms, specify an empty RoomFilters list.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • roomFilters

        SendAnnouncementRequest.Builder roomFilters​(Filter... roomFilters)

        The filters to use to send an announcement to a specified list of rooms. The supported filter keys are RoomName, ProfileName, RoomArn, and ProfileArn. To send to all rooms, specify an empty RoomFilters list.

        Parameters:
        roomFilters - The filters to use to send an announcement to a specified list of rooms. The supported filter keys are RoomName, ProfileName, RoomArn, and ProfileArn. To send to all rooms, specify an empty RoomFilters list.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • roomFilters

        SendAnnouncementRequest.Builder roomFilters​(Consumer<Filter.Builder>... roomFilters)

        The filters to use to send an announcement to a specified list of rooms. The supported filter keys are RoomName, ProfileName, RoomArn, and ProfileArn. To send to all rooms, specify an empty RoomFilters list.

        This is a convenience method that creates an instance of the Filter.Builder avoiding the need to create one manually via Filter.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #roomFilters(List).

        Parameters:
        roomFilters - a consumer that will call methods on Filter.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #roomFilters(java.util.Collection)

      • content

        SendAnnouncementRequest.Builder content​(Content content)

        The announcement content. This can contain only one of the three possible announcement types (text, SSML or audio).

        Parameters:
        content - The announcement content. This can contain only one of the three possible announcement types (text, SSML or audio).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • timeToLiveInSeconds

        SendAnnouncementRequest.Builder timeToLiveInSeconds​(Integer timeToLiveInSeconds)

        The time to live for an announcement. Default is 300. If delivery doesn't occur within this time, the announcement is not delivered.

        Parameters:
        timeToLiveInSeconds - The time to live for an announcement. Default is 300. If delivery doesn't occur within this time, the announcement is not delivered.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • clientRequestToken

        SendAnnouncementRequest.Builder clientRequestToken​(String clientRequestToken)

        The unique, user-specified identifier for the request that ensures idempotency.

        Parameters:
        clientRequestToken - The unique, user-specified identifier for the request that ensures idempotency.
        Returns:
        Returns a reference to this object so that method calls can be chained together.