software.amazon.awssdk.services.alexaforbusiness.model

Class SendAnnouncementRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.alexaforbusiness.model.AlexaForBusinessRequest

software.amazon.awssdk.services.alexaforbusiness.model.SendAnnouncementRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<SendAnnouncementRequest.Builder,SendAnnouncementRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class SendAnnouncementRequest
extends AlexaForBusinessRequest
implements ToCopyableBuilder<SendAnnouncementRequest.Builder,SendAnnouncementRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SendAnnouncementRequest.Builder

Method Summary

Modifier and Type	Method and Description
static SendAnnouncementRequest.Builder	builder()
String	clientRequestToken() The unique, user-specified identifier for the request that ensures idempotency.
Content	content() The announcement content.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasRoomFilters() Returns true if the RoomFilters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
List<Filter>	roomFilters() The filters to use to send an announcement to a specified list of rooms.
List<SdkField<?>>	sdkFields()
static Class<? extends SendAnnouncementRequest.Builder>	serializableBuilderClass()
Integer	timeToLiveInSeconds() The time to live for an announcement.
SendAnnouncementRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

hasRoomFilters

public boolean hasRoomFilters()

Returns true if the RoomFilters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

roomFilters

public List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasRoomFilters() to see if a value was sent in this field.

Returns:

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.

content

public Content content()

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

Returns:

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

timeToLiveInSeconds

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

Returns:

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

clientRequestToken

public String clientRequestToken()

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

Returns:

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

toBuilder

public SendAnnouncementRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SendAnnouncementRequest.Builder,SendAnnouncementRequest>

Specified by:

toBuilder in class AlexaForBusinessRequest

builder

public static SendAnnouncementRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo