SendChannelMessageRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.chimesdkmessaging.model.SendChannelMessageRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SendChannelMessageRequest
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

SendChannelMessageRequest()

Constructors
Constructor and Description
`SendChannelMessageRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SendChannelMessageRequest`	`addMessageAttributesEntry(String key, MessageAttributeValue value)` Add a single MessageAttributes entry
`SendChannelMessageRequest`	`clearMessageAttributesEntries()` Removes all the entries added into MessageAttributes.
`SendChannelMessageRequest`	`clone()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals(Object obj)`
`String`	`getChannelArn()` The ARN of the channel.
`String`	`getChimeBearer()` The `AppInstanceUserArn` of the user that makes the API call.
`String`	`getClientRequestToken()` The `Idempotency` token for each client request.
`String`	`getContent()` The content of the message.
`Map<String,MessageAttributeValue>`	`getMessageAttributes()` The attributes for the message, used for message filtering along with a `FilterRule` defined in the `PushNotificationPreferences`.
`String`	`getMetadata()` The optional metadata for each message.
`String`	`getPersistence()` Boolean that controls whether the message is persisted on the back end.
`PushNotificationConfiguration`	`getPushNotification()` The push notification configuration of the message.
`String`	`getType()` The type of message, `STANDARD` or `CONTROL`.
`int`	`hashCode()`
`void`	`setChannelArn(String channelArn)` The ARN of the channel.
`void`	`setChimeBearer(String chimeBearer)` The `AppInstanceUserArn` of the user that makes the API call.
`void`	`setClientRequestToken(String clientRequestToken)` The `Idempotency` token for each client request.
`void`	`setContent(String content)` The content of the message.
`void`	`setMessageAttributes(Map<String,MessageAttributeValue> messageAttributes)` The attributes for the message, used for message filtering along with a `FilterRule` defined in the `PushNotificationPreferences`.
`void`	`setMetadata(String metadata)` The optional metadata for each message.
`void`	`setPersistence(String persistence)` Boolean that controls whether the message is persisted on the back end.
`void`	`setPushNotification(PushNotificationConfiguration pushNotification)` The push notification configuration of the message.
`void`	`setType(String type)` The type of message, `STANDARD` or `CONTROL`.
`String`	`toString()` Returns a string representation of this object.
`SendChannelMessageRequest`	`withChannelArn(String channelArn)` The ARN of the channel.
`SendChannelMessageRequest`	`withChimeBearer(String chimeBearer)` The `AppInstanceUserArn` of the user that makes the API call.
`SendChannelMessageRequest`	`withClientRequestToken(String clientRequestToken)` The `Idempotency` token for each client request.
`SendChannelMessageRequest`	`withContent(String content)` The content of the message.
`SendChannelMessageRequest`	`withMessageAttributes(Map<String,MessageAttributeValue> messageAttributes)` The attributes for the message, used for message filtering along with a `FilterRule` defined in the `PushNotificationPreferences`.
`SendChannelMessageRequest`	`withMetadata(String metadata)` The optional metadata for each message.
`SendChannelMessageRequest`	`withPersistence(ChannelMessagePersistenceType persistence)` Boolean that controls whether the message is persisted on the back end.
`SendChannelMessageRequest`	`withPersistence(String persistence)` Boolean that controls whether the message is persisted on the back end.
`SendChannelMessageRequest`	`withPushNotification(PushNotificationConfiguration pushNotification)` The push notification configuration of the message.
`SendChannelMessageRequest`	`withType(ChannelMessageType type)` The type of message, `STANDARD` or `CONTROL`.
`SendChannelMessageRequest`	`withType(String type)` The type of message, `STANDARD` or `CONTROL`.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SendChannelMessageRequest
```
public SendChannelMessageRequest()
```
- Method Detail
  - setChannelArn
```
public void setChannelArn(String channelArn)
```
    The ARN of the channel.
    
    Parameters:
    
    channelArn - The ARN of the channel.
  - getChannelArn
```
public String getChannelArn()
```
    The ARN of the channel.
    
    Returns:
    
    The ARN of the channel.
  - withChannelArn
```
public SendChannelMessageRequest withChannelArn(String channelArn)
```
    The ARN of the channel.
    
    Parameters:
    
    channelArn - The ARN of the channel.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setContent
```
public void setContent(String content)
```
    The content of the message.
    
    Parameters:
    
    content - The content of the message.
  - getContent
```
public String getContent()
```
    The content of the message.
    
    Returns:
    
    The content of the message.
  - withContent
```
public SendChannelMessageRequest withContent(String content)
```
    The content of the message.
    
    Parameters:
    
    content - The content of the message.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setType
```
public void setType(String type)
```
    The type of message, STANDARD or CONTROL.
    
    Parameters:
    
    type - The type of message, STANDARD or CONTROL.
    
    See Also:
    
    ChannelMessageType
  - getType
```
public String getType()
```
    The type of message, STANDARD or CONTROL.
    
    Returns:
    
    The type of message, STANDARD or CONTROL.
    
    See Also:
    
    ChannelMessageType
  - withType
```
public SendChannelMessageRequest withType(String type)
```
    The type of message, STANDARD or CONTROL.
    
    Parameters:
    
    type - The type of message, STANDARD or CONTROL.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ChannelMessageType
  - withType
```
public SendChannelMessageRequest withType(ChannelMessageType type)
```
    The type of message, STANDARD or CONTROL.
    
    Parameters:
    
    type - The type of message, STANDARD or CONTROL.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ChannelMessageType
  - setPersistence
```
public void setPersistence(String persistence)
```
    Boolean that controls whether the message is persisted on the back end. Required.
    
    Parameters:
    
    persistence - Boolean that controls whether the message is persisted on the back end. Required.
    
    See Also:
    
    ChannelMessagePersistenceType
  - getPersistence
```
public String getPersistence()
```
    Boolean that controls whether the message is persisted on the back end. Required.
    
    Returns:
    
    Boolean that controls whether the message is persisted on the back end. Required.
    
    See Also:
    
    ChannelMessagePersistenceType
  - withPersistence
```
public SendChannelMessageRequest withPersistence(String persistence)
```
    Boolean that controls whether the message is persisted on the back end. Required.
    
    Parameters:
    
    persistence - Boolean that controls whether the message is persisted on the back end. Required.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ChannelMessagePersistenceType
  - withPersistence
```
public SendChannelMessageRequest withPersistence(ChannelMessagePersistenceType persistence)
```
    Boolean that controls whether the message is persisted on the back end. Required.
    
    Parameters:
    
    persistence - Boolean that controls whether the message is persisted on the back end. Required.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ChannelMessagePersistenceType
  - setMetadata
```
public void setMetadata(String metadata)
```
    The optional metadata for each message.
    
    Parameters:
    
    metadata - The optional metadata for each message.
  - getMetadata
```
public String getMetadata()
```
    The optional metadata for each message.
    
    Returns:
    
    The optional metadata for each message.
  - withMetadata
```
public SendChannelMessageRequest withMetadata(String metadata)
```
    The optional metadata for each message.
    
    Parameters:
    
    metadata - The optional metadata for each message.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setClientRequestToken
```
public void setClientRequestToken(String clientRequestToken)
```
    The Idempotency token for each client request.
    
    Parameters:
    
    clientRequestToken - The Idempotency token for each client request.
  - getClientRequestToken
```
public String getClientRequestToken()
```
    The Idempotency token for each client request.
    
    Returns:
    
    The Idempotency token for each client request.
  - withClientRequestToken
```
public SendChannelMessageRequest withClientRequestToken(String clientRequestToken)
```
    The Idempotency token for each client request.
    
    Parameters:
    
    clientRequestToken - The Idempotency token for each client request.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setChimeBearer
```
public void setChimeBearer(String chimeBearer)
```
    The AppInstanceUserArn of the user that makes the API call.
    
    Parameters:
    
    chimeBearer - The AppInstanceUserArn of the user that makes the API call.
  - getChimeBearer
```
public String getChimeBearer()
```
    The AppInstanceUserArn of the user that makes the API call.
    
    Returns:
    
    The AppInstanceUserArn of the user that makes the API call.
  - withChimeBearer
```
public SendChannelMessageRequest withChimeBearer(String chimeBearer)
```
    The AppInstanceUserArn of the user that makes the API call.
    
    Parameters:
    
    chimeBearer - The AppInstanceUserArn of the user that makes the API call.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPushNotification
```
public void setPushNotification(PushNotificationConfiguration pushNotification)
```
    The push notification configuration of the message.
    
    Parameters:
    
    pushNotification - The push notification configuration of the message.
  - getPushNotification
```
public PushNotificationConfiguration getPushNotification()
```
    The push notification configuration of the message.
    
    Returns:
    
    The push notification configuration of the message.
  - withPushNotification
```
public SendChannelMessageRequest withPushNotification(PushNotificationConfiguration pushNotification)
```
    The push notification configuration of the message.
    
    Parameters:
    
    pushNotification - The push notification configuration of the message.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getMessageAttributes
```
public Map<String,MessageAttributeValue> getMessageAttributes()
```
    The attributes for the message, used for message filtering along with a FilterRule defined in the PushNotificationPreferences.
    
    Returns:
    
    The attributes for the message, used for message filtering along with a FilterRule defined in the PushNotificationPreferences.
  - setMessageAttributes
```
public void setMessageAttributes(Map<String,MessageAttributeValue> messageAttributes)
```
    The attributes for the message, used for message filtering along with a FilterRule defined in the PushNotificationPreferences.
    
    Parameters:
    
    messageAttributes - The attributes for the message, used for message filtering along with a FilterRule defined in the PushNotificationPreferences.
  - withMessageAttributes
```
public SendChannelMessageRequest withMessageAttributes(Map<String,MessageAttributeValue> messageAttributes)
```
    The attributes for the message, used for message filtering along with a FilterRule defined in the PushNotificationPreferences.
    
    Parameters:
    
    messageAttributes - The attributes for the message, used for message filtering along with a FilterRule defined in the PushNotificationPreferences.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addMessageAttributesEntry
```
public SendChannelMessageRequest addMessageAttributesEntry(String key,
                                                           MessageAttributeValue value)
```
    Add a single MessageAttributes entry
    
    See Also:
    
    withMessageAttributes(java.util.Map<java.lang.String, com.amazonaws.services.chimesdkmessaging.model.MessageAttributeValue>)
  - clearMessageAttributesEntries
```
public SendChannelMessageRequest clearMessageAttributesEntries()
```
    Removes all the entries added into MessageAttributes.
    
    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 SendChannelMessageRequest 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()

Did this page help you?

Class SendChannelMessageRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

SendChannelMessageRequest

Method Detail

setChannelArn

getChannelArn

withChannelArn

setContent

getContent

withContent

setType

getType

withType

withType

setPersistence

getPersistence

withPersistence

withPersistence

setMetadata

getMetadata

withMetadata

setClientRequestToken

getClientRequestToken

withClientRequestToken

setChimeBearer

getChimeBearer

withChimeBearer

setPushNotification

getPushNotification

withPushNotification

getMessageAttributes

setMessageAttributes

withMessageAttributes

addMessageAttributesEntry

clearMessageAttributesEntries

toString

equals

hashCode

clone