com.amazonaws.services.alexaforbusiness.model

Class SendAnnouncementRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.alexaforbusiness.model.SendAnnouncementRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SendAnnouncementRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
SendAnnouncementRequest()

Method Summary

Modifier and Type	Method and Description
SendAnnouncementRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getClientRequestToken() The unique, user-specified identifier for the request that ensures idempotency.
Content	getContent() The announcement content.
List<Filter>	getRoomFilters() The filters to use to send an announcement to a specified list of rooms.
Integer	getTimeToLiveInSeconds() The time to live for an announcement.
int	hashCode()
void	setClientRequestToken(String clientRequestToken) The unique, user-specified identifier for the request that ensures idempotency.
void	setContent(Content content) The announcement content.
void	setRoomFilters(Collection<Filter> roomFilters) The filters to use to send an announcement to a specified list of rooms.
void	setTimeToLiveInSeconds(Integer timeToLiveInSeconds) The time to live for an announcement.
String	toString() Returns a string representation of this object.
SendAnnouncementRequest	withClientRequestToken(String clientRequestToken) The unique, user-specified identifier for the request that ensures idempotency.
SendAnnouncementRequest	withContent(Content content) The announcement content.
SendAnnouncementRequest	withRoomFilters(Collection<Filter> roomFilters) The filters to use to send an announcement to a specified list of rooms.
SendAnnouncementRequest	withRoomFilters(Filter... roomFilters) The filters to use to send an announcement to a specified list of rooms.
SendAnnouncementRequest	withTimeToLiveInSeconds(Integer timeToLiveInSeconds) The time to live for an announcement.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SendAnnouncementRequest

public SendAnnouncementRequest()

Method Detail

getRoomFilters

public List<Filter> getRoomFilters()

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:

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.

setRoomFilters

public void setRoomFilters(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.

withRoomFilters

public SendAnnouncementRequest withRoomFilters(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.

NOTE: This method appends the values to the existing list (if any). Use setRoomFilters(java.util.Collection) or withRoomFilters(java.util.Collection) if you want to override the existing values.

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.

withRoomFilters

public SendAnnouncementRequest withRoomFilters(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.

setContent

public void setContent(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).

getContent

public Content getContent()

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

withContent

public SendAnnouncementRequest withContent(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.

setTimeToLiveInSeconds

public void setTimeToLiveInSeconds(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.

getTimeToLiveInSeconds

public Integer getTimeToLiveInSeconds()

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.

withTimeToLiveInSeconds

public SendAnnouncementRequest withTimeToLiveInSeconds(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.

setClientRequestToken

public void setClientRequestToken(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.

getClientRequestToken

public String getClientRequestToken()

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

Returns:

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

withClientRequestToken

public SendAnnouncementRequest withClientRequestToken(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.

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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public SendAnnouncementRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()