Message (AMPS Java Client (5.3.2.1.6d15937f.540279))

java.lang.Object
- com.crankuptheamps.client.Message

Direct Known Subclasses:

FIXMessage, JSONMessage, XMLMessage
```
public abstract class Message
extends java.lang.Object
```
All communication with AMPS occurs through passing Messages. The AMPS clients provide named convenience methods for core AMPS functionality. These named methods work by creating and sending Messages to AMPS.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Message.AckType` Container class of maskable ints that represent the available types of Message acknowledgement.
`static class`	`Message.Command` Tells AMPS how to interpret a message.
`static class`	`Message.Options` Represents the possible values for message options in an AMPS command.
`static class`	`Message.Reason` Container class of ints that represent the possible values for Message reason.
`static class`	`Message.SerializationResult` Returned by calls to `serialize(ByteBuffer)`
`static class`	`Message.Status` Container class of ints that represent the possible values for Message status.

Field Summary

Fields
Modifier and Type	Field and Description
`protected AckTypeField`	`_AckType`
`protected IntegerField`	`_BatchSize`
`protected BookmarkField`	`_Bookmark`
`protected Client`	`_client`
`protected StringField`	`_ClientName`
`protected CommandField`	`_Command`
`protected StringField`	`_CommandId`
`protected StringField`	`_CorrelationId`
`protected StringField`	`_Data`
`protected IntegerField`	`_Expiration`
`protected Field[]`	`_fields` Need to visit every Field? Use this!
`protected StringField`	`_Filter`
`protected LongField`	`_GroupSeqNo`
`protected StringField`	`_LeasePeriod`
`protected IntegerField`	`_Length`
`protected LongField`	`_Matches`
`protected StringField`	`_MessageType`
`protected OptionsField`	`_Options`
`protected StringField`	`_OrderBy`
`protected StringField`	`_Password`
`protected StringField`	`_QueryId`
`protected ReasonField`	`_Reason`
`protected LongField`	`_RecordsDeleted`
`protected LongField`	`_RecordsInserted`
`protected LongField`	`_RecordsReturned`
`protected LongField`	`_RecordsUpdated`
`protected LongField`	`_Sequence`
`protected StringField`	`_SowKey`
`protected StringField`	`_SowKeys`
`protected StatusField`	`_Status`
`protected StringField`	`_SubId`
`protected StringField`	`_SubIds`
`protected StringField`	`_Timestamp`
`protected StringField`	`_Topic`
`protected LongField`	`_TopicMatches`
`protected LongField`	`_TopN`
`protected StringField`	`_UserId`
`protected StringField`	`_Version`
`protected java.nio.charset.CharsetDecoder`	`decoder` Used by associated `Field` classes to decode byte data
`protected java.nio.charset.CharsetEncoder`	`encoder` Used by associated `Field` classes to encode byte data

Constructor Summary

Constructors
Modifier Constructor and Description

protected Message(java.nio.charset.CharsetEncoder encoder, java.nio.charset.CharsetDecoder decoder)

Constructors
Modifier	Constructor and Description
`protected`	`Message(java.nio.charset.CharsetEncoder encoder, java.nio.charset.CharsetDecoder decoder)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`_copyTo(Message destination)` Overwrites destination data with this Message.
`void`	`ack()` Used to acknowledge a queue message is processed.
`void`	`ack(byte[] options, int optionsPos, int optionsLen)` Used to acknowledge a queue message is processed.
`void`	`ack(Field options)` Used to acknowledge a queue message is processed.
`void`	`ack(java.lang.String options)` Used to acknowledge a queue message is processed.
`abstract Message`	`copy()`
`int`	`getAckType()` Returns the type of acknowledgement for an acknowledgement Message.
`int`	`getAckTypeOutgoing()` Returns the type of acknowledgement for an outgoing Message.
`int`	`getBatchSize()` Returns the BatchSize for this Message.
`java.lang.String`	`getBookmark()` Returns the AMPS Bookmark for this Message.
`BookmarkField`	`getBookmarkRaw()` Gets the raw value for the AMPS Bookmark.
`long`	`getBookmarkSeqNo()` Returns the bookmark sequence number for this Message.
`byte[]`	`getBuffer()` Gets the byte buffer used by the Message.
`Client`	`getClient()` Returns the client who allocated this message.
`java.lang.String`	`getClientName()` Gets the ClientName on this Message.
`Field`	`getClientNameRaw()` Gets the ClientName on this Message.
`int`	`getCommand()` Returns the Command for this Message, indicating the type of of message this is.
`java.lang.String`	`getCommandId()` Gets the CommandId on this Message.
`boolean`	`getCommandId(CommandId v)` Gets the CommandId on this Message by copying it into the provided CommandId object.
`Field`	`getCommandIdRaw()` Gets the CommandId on this Message.
`java.lang.String`	`getCorrelationId()` Get the CorrelationId on this message.
`StringField`	`getCorrelationIdRaw()` Get the CorrelationId on this message.
`java.lang.String`	`getData()` Returns the payload of the Message.
`Field`	`getDataRaw()` Returns the payload of the Message.
`java.nio.charset.CharsetDecoder`	`getDecoder()` Returns the CharsetDecoder for this Message.
`java.nio.charset.CharsetEncoder`	`getEncoder()` Returns the CharsetEncoder for this Message.
`int`	`getExpiration()` Returns the Expiration field set for this Message.
`IntegerField`	`getExpirationRaw()` Returns the Expiration field set for this Message.
`java.lang.String`	`getFilter()` Returns the Filter field on this Message.
`Field`	`getFilterRaw()` Returns the Filter field on this Message.
`long`	`getGroupSeqNo()` Get the group sequence number.
`java.lang.String`	`getLeasePeriod()` Gets the decoded version of the LeasePeriod for the Message.
`StringField`	`getLeasePeriodRaw()` Gets the raw verstion of the LeasePeriod filter for the Message.
`int`	`getLength()` Returns the Length of the Message.
`long`	`getMatches()` Returns the number of matches in the command this Message acknowledges.
`java.lang.String`	`getMessageType()` Returns the MessageType on this client.
`java.lang.String`	`getOptions()` Returns the Options to be set on this Message.
`Field`	`getOptionsRaw()` Returns the Options to be set on this Message.
`java.lang.String`	`getOrderBy()` Get the OrderBy parameter for this Message.
`Field`	`getOrderByRaw()` Get the OrderBy parameter for this Message.
`java.lang.String`	`getPassword()` Returns the Password set on the Message.
`Field`	`getPasswordRaw()` Returns the Password set on the Message.
`java.lang.String`	`getQueryId()` Returns the QueryId for this Message.
`boolean`	`getQueryId(CommandId v)` Returns the QueryId for this Message by copying it into the provided CommandId.
`Field`	`getQueryIdRaw()` Returns the QueryId for this Message.
`int`	`getRawBufferLength()` Gets the length of the Message within the byte buffer.
`int`	`getRawBufferOffset()` Gets the offset into the byte buffer where this Message begins.
`int`	`getReason()` Returns the Reason value of this Message.
`java.lang.String`	`getReasonText()` Returns the Reason value of this Message.
`long`	`getRecordsDeleted()` Returns the number of records deleted for the command that this Message was produced in response to.
`long`	`getRecordsInserted()` Returns the number of records inserted for the command that this Message was produced in response to.
`long`	`getRecordsReturned()` Returns the number of records returned for the command that this Message was produced in response to.
`long`	`getRecordsUpdated()` Returns the number of records updated for the command that this Message was produced in response to.
`long`	`getSequence()` Returns the sequence number for this Message.
`Field`	`getSequenceRaw()` Returns the sequence number for this Message.
`java.lang.String`	`getSowKey()` Returns the SowKey for this Message.
`Field`	`getSowKeyRaw()` Returns the SowKey for this Message.
`java.lang.String`	`getSowKeys()` Gets the set of SowKeys this message applies to.
`Field`	`getSowKeysRaw()` Gets the set of SowKeys this message applies to.
`int`	`getStatus()` Returns the Status of this Message.
`java.lang.String`	`getSubId()` Gets the SubId of this Message.
`boolean`	`getSubId(CommandId v)` Gets the SubId of this Message by copying it into the provided CommandId.
`Field`	`getSubIdRaw()` Gets the SubId of this Message.
`java.lang.String`	`getSubIds()` The set of SubIds for this Message.
`Field`	`getSubIdsRaw()` The set of SubIds for this message.
`Subscription`	`getSubscription()` Gets the Subscription for this Message.
`java.lang.String`	`getTimestamp()` Returns the timestamp for this message, an ISO-8601 formatted string.
`Field`	`getTimestampRaw()` Returns the timestamp for this message, an ISO-8601 formatted string.
`java.lang.String`	`getTopic()` Return the topic that the message applies to.
`long`	`getTopicMatches()` Returns the number of matching topics for the command that this message was produced in response to.
`Field`	`getTopicRaw()` Return the topic that the message applies to.
`long`	`getTopN()` Get the TopN parameter for this message.
`java.lang.String`	`getUserId()` Get the UserId for this message.
`Field`	`getUserIdRaw()` Get the UserId for this message.
`java.lang.String`	`getVersion()` Returns the version of the AMPS server, provided in response to a logon.
`int`	`getVersionAsInt()` Returns the version of the AMPS server, provided in response to a logon.
`Field`	`getVersionRaw()` Returns the version of the AMPS server, provided in response to a logon.
`boolean`	`isAckTypeNull()` Checks whether the AckType field is null.
`boolean`	`isBatchSizeNull()` Checks whether the BatchSize field is null.
`boolean`	`isBookmarkNull()` Checks whether the Bookmark field is null.
`boolean`	`isClientNameNull()` Checks whether the ClientName field is null.
`boolean`	`isCommandIdNull()` Checks whether the CommandId is null.
`boolean`	`isCommandNull()` Checks whether the Command field is null.
`boolean`	`isCorrelationIdNull()` Checks whether the CorrelationId field is null.
`boolean`	`isDataNull()` Checks whether the Data field is null.
`boolean`	`isExpirationNull()` Checks whether the Expiration field is null.
`boolean`	`isFilterNull()` Checks whether the Filter field is null.
`boolean`	`isGroupSeqNoNull()` Checks whether the GroupSeqNo field is null.
`boolean`	`isIgnoreAutoAck()` Used to check if automatic acking of this Message by the Client should be skipped.
`boolean`	`isLeasePeriodNull()` Check whether the LeasePeriod field is null.
`boolean`	`isLengthNull()` Checks whether the Length field is null.
`boolean`	`isMatchesNull()` Checks whether the Matches field is Null.
`boolean`	`isMessageTypeNull()` Checks whether the MessageType field is null.
`boolean`	`isOptionsNull()` Checks whether the Options field is null.
`boolean`	`isOrderByNull()` Checks whether the OrderBy field is null.
`boolean`	`isPasswordNull()` Checks whether the Password field is null.
`boolean`	`isQueryIdNull()` Checks whether the QueryId field is null.
`boolean`	`isReasonNull()` Checks whether the Reason is null.
`boolean`	`isRecordsDeletedNull()` Checks whether the RecordsDeleted field is null.
`boolean`	`isRecordsInsertedNull()` Checks whether the RecordsInserted field is null.
`boolean`	`isRecordsReturnedNull()` Checks whether the RecordsReturned field is null.
`boolean`	`isRecordsUpdatedNull()` Checks whether the RecordsUpdated field is null.
`boolean`	`isSequenceNull()` Checks whether the Sequence field is null.
`boolean`	`isSowKeyNull()` Checks whether the SowKey field is null.
`boolean`	`isSowKeysNull()` Checks whether the SowKeys field is null.
`boolean`	`isSubIdNull()` Checks whether the SubId field is null.
`boolean`	`isSubIdsNull()` Checks whether the SubIds field is null.
`boolean`	`isTimestampNull()` Checks whether the Timestamp field is null.
`boolean`	`isTopicMatchesNull()` Checks whether the TopicMatches field is null.
`boolean`	`isTopicNull()` Checks whether the Topic field is null.
`boolean`	`isTopNNull()` Checks whether the TopN field is null.
`boolean`	`isUserIdNull()` Checks whether the UserId field is null.
`boolean`	`isVersionNull()` Checks whether the Version field is null.
`Message`	`reset()` Resets all `Field` members to null.
`abstract Message.SerializationResult`	`serialize(java.nio.ByteBuffer buffer)` Serializes this message into the provided byte buffer at its current position.
`Message`	`setAckType(int v)` Sets the type of acknowledgement for an acknowledgement Message.
`Message`	`setAckType(java.lang.String v)` Sets the type of acknowledgement for an acknowledgement Message.
`Message`	`setBatchSize(int v)` Sets the BatchSize for this Message.
`Message`	`setBookmark(byte[] buffer, int offset, int length)` Sets the value for the AMPS Bookmark.
`Message`	`setBookmark(java.lang.String v)` Sets the value for the AMPS Bookmark.
`void`	`setBookmarkSeqNo(long val)` Sets the bookmark sequence number for this Message.
`void`	`setBuffer(byte[] buffer)` Sets the byte buffer used for this Message.
`Message`	`setClientName(byte[] buffer, int offset, int length)` Sets the name of the Client sending the Message.
`Message`	`setClientName(java.lang.String v)` Sets the name of the Client sending the Message.
`Message`	`setCommand(int v)` Sets the Command for this Message, indicating the type of of Message this is.
`Message`	`setCommand(java.lang.String v)` Sets the Command for this Message, indicating the type of of Message this is.
`Message`	`setCommandId(byte[] buffer, int offset, int length)` Sets the CommandId on this Message.
`Message`	`setCommandId(CommandId v)` Sets the CommandId on this Message.
`Message`	`setCommandId(java.lang.String v)` Sets the CommandId on this Message.
`Message`	`setCorrelationId(java.lang.String v)` Set the CorrelationId on this message.
`Message`	`setData(byte[] buffer, int offset, int length)` Sets the payload of the Message.
`Message`	`setData(java.lang.String v)` Sets the payload of the Message.
`Message`	`setExpiration(int v)` Sets the Expiration field for this Message.
`Message`	`setFilter(byte[] buffer, int offset, int length)` Sets the Filter field on this Message.
`Message`	`setFilter(java.lang.String v)` Sets the Filter field on this Message.
`Message`	`setGroupSeqNo(long v)` Set the group sequence number.
`void`	`setIgnoreAutoAck()` Used to disable automatic acking of this Message by the Client after the `MessageHandler` completes.
`Message`	`setLength(int v)` Sets the Length of the Message.
`Message`	`setMatches(long v)` Sets the matches field on this Message.
`Message`	`setMessageType(java.lang.String v)` Sets the MessageType on this client.
`Message`	`setOptions(java.lang.String v)` Sets the Options for the Message.
`Message`	`setOrderBy(byte[] buffer, int offset, int length)` Set the OrderBy parameter for this Message.
`Message`	`setOrderBy(java.lang.String v)` Set the OrderBy parameter for this Message.
`Message`	`setPassword(byte[] buffer, int offset, int length)` Set the Password on the Message.
`Message`	`setPassword(java.lang.String v)` Set the Password on the Message.
`Message`	`setQueryId(byte[] buffer, int offset, int length)` Sets the QueryId for this Message.
`Message`	`setQueryId(CommandId v)` Sets the QueryId field for this Message by copying it from a CommandId object.
`Message`	`setQueryId(java.lang.String v)` Sets the QueryId field for this Message.
`void`	`setRawBufferLength(int length)` Sets the length of the Message within the byte buffer.
`void`	`setRawBufferOffset(int offset)` Sets the Offset into the byte buffer where this Message begins.
`Message`	`setReason(int v)` Sets the Reason value of this Message.
`Message`	`setRecordsDeleted(long v)` Sets the records deleted header field.
`Message`	`setRecordsInserted(long v)` Returns the number of records inserted for the command that this Message was produced in response to.
`Message`	`setRecordsReturned(long v)` Sets the records returned header field.
`Message`	`setRecordsUpdated(long v)` Sets the records updated header field.
`Message`	`setSequence(long v)` Sets the sequence number for this Message.
`Message`	`setSowKey(byte[] buffer, int offset, int length)` Sets the SowKey for this Message.
`Message`	`setSowKey(java.lang.String v)` Sets the SowKey for this Message.
`Message`	`setSowKeys(byte[] buffer, int offset, int length)` Sets the set of SowKeys this message applies to, as a comma-delimited list of identifiers.
`Message`	`setSowKeys(java.lang.String v)` Sets the set of SowKeys this message applies to, as a comma-delimited list of identifiers.
`Message`	`setStatus(int v)` Sets the Status of this Message.
`Message`	`setSubId(byte[] buffer, int offset, int length)` Sets the SubId of this Message.
`Message`	`setSubId(CommandId v)` Sets the SubId of this Message by copying it from a CommandId object.
`Message`	`setSubId(java.lang.String v)` Sets the SubId of this Message.
`Message`	`setSubIds(byte[] buffer, int offset, int length)` The set of SubIds for this message.
`Message`	`setSubIds(java.lang.String v)` The set of SubIds for this message.
`void`	`setSubscription(Subscription subscription)` Sets the Subscription for this Message.
`Message`	`setTimestamp(byte[] buffer, int offset, int length)` Sets the timestamp for this message.
`Message`	`setTimestamp(java.lang.String v)` Sets the Timestamp for this Message.
`Message`	`setTopic(byte[] buffer, int offset, int length)` Set the topic that the message applies to.
`Message`	`setTopic(java.lang.String v)` Set the topic that the message applies to.
`Message`	`setTopicMatches(long v)` Sets the topic matches field on this message.
`Message`	`setTopN(long v)` Set the TopN parameter for this message.
`Message`	`setUserId(byte[] buffer, int offset, int length)` Set the UserId for this message.
`Message`	`setUserId(java.lang.String v)` Set the UserId for this message.
`Message`	`setVersion(byte[] buffer, int offset, int length)` Sets the version field of this message.
`Message`	`setVersion(java.lang.String v)` Sets the version field of this message.
`java.lang.String`	`toString()` Return the message as a string.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - encoder
```
protected final java.nio.charset.CharsetEncoder encoder
```
    Used by associated Field classes to encode byte data
  - decoder
```
protected final java.nio.charset.CharsetDecoder decoder
```
    Used by associated Field classes to decode byte data
  - _AckType
```
protected final AckTypeField _AckType
```
  - _BatchSize
```
protected final IntegerField _BatchSize
```
  - _Bookmark
```
protected final BookmarkField _Bookmark
```
  - _ClientName
```
protected final StringField _ClientName
```
  - _CommandId
```
protected final StringField _CommandId
```
  - _Command
```
protected final CommandField _Command
```
  - _Data
```
protected final StringField _Data
```
  - _Expiration
```
protected final IntegerField _Expiration
```
  - _Filter
```
protected final StringField _Filter
```
  - _LeasePeriod
```
protected final StringField _LeasePeriod
```
  - _MessageType
```
protected final StringField _MessageType
```
  - _OrderBy
```
protected final StringField _OrderBy
```
  - _GroupSeqNo
```
protected final LongField _GroupSeqNo
```
  - _Matches
```
protected final LongField _Matches
```
  - _Password
```
protected final StringField _Password
```
  - _Length
```
protected final IntegerField _Length
```
  - _Options
```
protected final OptionsField _Options
```
  - _QueryId
```
protected final StringField _QueryId
```
  - _Reason
```
protected final ReasonField _Reason
```
  - _RecordsInserted
```
protected final LongField _RecordsInserted
```
  - _RecordsUpdated
```
protected final LongField _RecordsUpdated
```
  - _RecordsDeleted
```
protected final LongField _RecordsDeleted
```
  - _RecordsReturned
```
protected final LongField _RecordsReturned
```
  - _Sequence
```
protected final LongField _Sequence
```
  - _SowKey
```
protected final StringField _SowKey
```
  - _SowKeys
```
protected final StringField _SowKeys
```
  - _Status
```
protected final StatusField _Status
```
  - _SubId
```
protected final StringField _SubId
```
  - _SubIds
```
protected final StringField _SubIds
```
  - _Timestamp
```
protected final StringField _Timestamp
```
  - _TopN
```
protected final LongField _TopN
```
  - _Topic
```
protected final StringField _Topic
```
  - _TopicMatches
```
protected final LongField _TopicMatches
```
  - _UserId
```
protected final StringField _UserId
```
  - _Version
```
protected final StringField _Version
```
  - _CorrelationId
```
protected final StringField _CorrelationId
```
  - _client
```
protected Client _client
```
  - _fields
```
protected final Field[] _fields
```
    Need to visit every Field? Use this!
- Constructor Detail
  - Message
```
protected Message(java.nio.charset.CharsetEncoder encoder,
                  java.nio.charset.CharsetDecoder decoder)
```
- Method Detail
  - getEncoder
```
public java.nio.charset.CharsetEncoder getEncoder()
```
    Returns the CharsetEncoder for this Message. The encoder is used by the Message to encode the fields.
    
    Returns:
    
    The CharsetEncoder for this Message.
  - getDecoder
```
public java.nio.charset.CharsetDecoder getDecoder()
```
    Returns the CharsetDecoder for this Message. The decoder is used by the Message to decode the fields.
    
    Returns:
    
    The CharsetDecoder for this Message.
  - setBookmarkSeqNo
```
public void setBookmarkSeqNo(long val)
```
    Sets the bookmark sequence number for this Message. The BookmarkSeqNo is used by bookmark stores to track Messages.
    
    Parameters:
    
    val - The value to set as the new BookmarkSeqNo for this Message.
  - getBookmarkSeqNo
```
public long getBookmarkSeqNo()
```
    Returns the bookmark sequence number for this Message. The BookmarkSeqNo is used by bookmark stores to track Messages.
    
    Returns:
    
    The bookmark sequence number for this Message.
  - setSubscription
```
public void setSubscription(Subscription subscription)
```
    Sets the Subscription for this Message. The Subscription is used by bookmark stores to track Messages.
    
    Parameters:
    
    subscription - the subscription to set
  - getSubscription
```
public Subscription getSubscription()
```
    Gets the Subscription for this Message. The Subscription is used by bookmark stores to track Messages.
    
    Returns:
    
    The Subscription used for this Message.
  - setBuffer
```
public void setBuffer(byte[] buffer)
```
    Sets the byte buffer used for this Message. It is uncommon for applications to use this directly.
    
    Parameters:
    
    buffer - the byte buffer to use for the Message.
  - getBuffer
```
public byte[] getBuffer()
```
    Gets the byte buffer used by the Message. It is uncommon for applications to use this directly.
    
    Returns:
    
    the raw byte buffer backing this Message object.
  - setRawBufferOffset
```
public void setRawBufferOffset(int offset)
```
    Sets the Offset into the byte buffer where this Message begins. It is uncommon for applications to use this directly.
    
    Parameters:
    
    offset - Offset of first byte of Message within the buffer.
  - getRawBufferOffset
```
public int getRawBufferOffset()
```
    Gets the offset into the byte buffer where this Message begins. It is uncommon for applications to use this directly.
    
    Returns:
    
    Offset of first byte of Message within the buffer.
  - setRawBufferLength
```
public void setRawBufferLength(int length)
```
    Sets the length of the Message within the byte buffer. It is uncommon for applications to use this directly.
    
    Parameters:
    
    length - Length of Message within the buffer.
  - getRawBufferLength
```
public int getRawBufferLength()
```
    Gets the length of the Message within the byte buffer. It is uncommon for applications to use this directly.
    
    Returns:
    
    Length of Message within the buffer.
  - serialize
```
public abstract Message.SerializationResult serialize(java.nio.ByteBuffer buffer)
```
    Serializes this message into the provided byte buffer at its current position.
    
    Parameters:
    
    buffer - The byte buffer to write into.
    
    Returns:
    
    A result enum that either indicates success or that the provided buffer doesn't have enough remaining space to hold the serialized representation of the message.
  - reset
```
public Message reset()
```
    Resets all Field members to null.
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
  - getAckType
```
public int getAckType()
```
    Returns the type of acknowledgement for an acknowledgement Message.
    
    Returns:
    
    The AckType for this ackknowledgement Message.
  - getAckTypeOutgoing
```
public int getAckTypeOutgoing()
```
    Returns the type of acknowledgement for an outgoing Message.
    
    Returns:
    
    The AckType for an outgoing Message.
  - setAckType
```
public Message setAckType(int v)
```
    Sets the type of acknowledgement for an acknowledgement Message.
    
    Parameters:
    
    v - The value to set as the AckType for the acknowledgement Message.
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
  - setAckType
```
public Message setAckType(java.lang.String v)
```
    Sets the type of acknowledgement for an acknowledgement Message.
    
    Parameters:
    
    v - The value to set as the AckType for the acknowledgement Message.
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
  - isAckTypeNull
```
public boolean isAckTypeNull()
```
    Checks whether the AckType field is null.
    
    Returns:
    
    True if AckType field is null, false if not.
  - getBatchSize
```
public int getBatchSize()
```
    Returns the BatchSize for this Message.
    
    Returns:
    
    The BatchSize for this Message.
  - setBatchSize
```
public Message setBatchSize(int v)
```
    Sets the BatchSize for this Message.
    
    Parameters:
    
    v - the batch size to set
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
  - isBatchSizeNull
```
public boolean isBatchSizeNull()
```
    Checks whether the BatchSize field is null.
    
    Returns:
    
    True if the BatchSize field is null, false if not.
  - getBookmark
```
public java.lang.String getBookmark()
```
    Returns the AMPS Bookmark for this Message. The Bookmark is an identifier assigned by AMPS to locate a Message in the transaction log.
    
    Returns:
    
    AMPS Bookmark for this Message.
  - getBookmarkRaw
```
public BookmarkField getBookmarkRaw()
```
    Gets the raw value for the AMPS Bookmark. The Bookmark is an identifier assigned by AMPS to locate a Message in the transaction log.
    The Raw variation of this getter allows for finer-grained performance tuning. It provides direct access to the Field that encapsulates the data.
    This does not incur any additional heap allocation or unnecessary decoding of the byte[] in which the data is stored. The lifetime of the underlying buffer for the field is the lifetime of the Message. If you need the data to persist longer than the lifetime of the Message, you must copy the Field.
    
    Returns:
    
    The raw value for the AMPS Bookmark.
  - setBookmark
```
public Message setBookmark(java.lang.String v)
```
    Sets the value for the AMPS Bookmark. The Bookmark is an identifier assigned by AMPS to locate a Message in the transaction log. Setting the Bookmark is used for commands that locate Messages in the log, such as a Bookmark subscribe or historical SOW query. Setting the bookmark on a publish Message has no effect.
    
    Parameters:
    
    v - The string used to set the value of the AMPS Bookmark.
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
  - setBookmark
```
public Message setBookmark(byte[] buffer,
                           int offset,
                           int length)
```
    Sets the value for the AMPS Bookmark. The Bookmark is an identifier assigned by AMPS to locate a Message in the transaction log. Setting the Bookmark is used for commands that locate Messages in the log, such as a Bookmark subscribe or historical SOW query. Setting the Bookmark on a publish Message has no effect.
    
    Parameters:
    
    buffer - The buffer containing the value for the Bookmark.
    
    offset - The location at which the value begins.
    
    length - The length of the value in the buffer.
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
  - isBookmarkNull
```
public boolean isBookmarkNull()
```
    Checks whether the Bookmark field is null.
    
    Returns:
    
    True if the Bookmark field is null, false if not.
  - getClientName
```
public java.lang.String getClientName()
```
    Gets the ClientName on this Message.
    
    Returns:
    
    The decoded Client name for this Message.
  - getClientNameRaw
```
public Field getClientNameRaw()
```
    Gets the ClientName on this Message.
    The Raw variation of this getter allows for finer-grained performance tuning. It provides direct access to the Field that encapsulates the data.
    This does not incur any additional heap allocation or unnecessary decoding of the byte[] in which the data is stored. The lifetime of the underlying buffer for the field is the lifetime of the Message. If you need the data to persist longer than the lifetime of the Message, you must copy the Field.
    
    Returns:
    
    The raw ClientName on this Message.
  - setClientName
```
public Message setClientName(java.lang.String v)
```
    Sets the name of the Client sending the Message.
    
    Parameters:
    
    v - The string used to set the ClientName.
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
  - setClientName
```
public Message setClientName(byte[] buffer,
                             int offset,
                             int length)
```
    Sets the name of the Client sending the Message.
    
    Parameters:
    
    buffer - The buffer containing the ClientName.
    
    offset - The location at which the ClientName begins.
    
    length - The length of the ClientName.
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
  - isClientNameNull
```
public boolean isClientNameNull()
```
    Checks whether the ClientName field is null.
    
    Returns:
    
    True if the ClientName field is null, false if not.
  - getCommandId
```
public java.lang.String getCommandId()
```
    Gets the CommandId on this Message. The CommandId is an identifier set by the client that is used to correlate later Messages. For example, the client sets a CommandId on a subscription request to AMPS, and can later use that CommandId to unsubscribe.
    
    Returns:
    
    The decoded CommandId on this Message.
  - getCommandIdRaw
```
public Field getCommandIdRaw()
```
    Gets the CommandId on this Message. The CommandId is an identifier set by the client that is used to correlate later Messages. For example, the client sets a CommandId on a subscription request to AMPS, and can later use that CommandId to unsubscribe.
    The Raw variation of this getter allows for finer-grained performance tuning. It provides direct access to the Field that encapsulates the data.
    This does not incur any additional heap allocation or unnecessary decoding of the byte[] in which the data is stored. The lifetime of the underlying buffer for the field is the lifetime of the Message. If you need the data to persist longer than the lifetime of the Message, you must copy the Field.
    
    Returns:
    
    The raw CommandId on this Message.
  - getCommandId
```
public boolean getCommandId(CommandId v)
```
    Gets the CommandId on this Message by copying it into the provided CommandId object. The CommandId is an identifier set by the client that is used to correlate later messages. For example, the client sets a CommandId on a subscription request to AMPS, and can later use that CommandId to unsubscribe. The CommandId is returned on ack messages in response to the command.
    
    Parameters:
    
    v - The object to hold the value of the CommandId object.
    
    Returns:
    
    A copy of the message in the provided CommandId object.
  - setCommandId
```
public Message setCommandId(java.lang.String v)
```
    Sets the CommandId on this Message. The CommandId is an identifier set by the client that is used to correlate later messages and commands. For example, the client sets a CommandId on a subscription request to AMPS, and can later use that CommandId to unsubscribe. The CommandId is returned on ack messages in response to the command.
    
    Parameters:
    
    v - The string CommandId to set on this Message.
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
  - setCommandId
```
public Message setCommandId(CommandId v)
```
    Sets the CommandId on this Message. The CommandId is an identifier set by the client that is used to correlate later messages and commands. For example, the client sets a CommandId on a subscription request to AMPS, and can later use that CommandId to unsubscribe. The CommandId is returned on ack messages in response to the command.
    
    Parameters:
    
    v - The CommandId object to set on this Message.
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
  - setCommandId
```
public Message setCommandId(byte[] buffer,
                            int offset,
                            int length)
```
    Sets the CommandId on this Message. The CommandId is an identifier set by the client that is used to correlate later messages and commands. For example, the client sets a CommandId on a subscription request to AMPS, and can later use that CommandId to unsubscribe. The CommandId is returned on ack messages in response to the command.
    
    Parameters:
    
    buffer - The buffer containing the CommandId on this Message.
    
    offset - The location at which the CommandId begins.
    
    length - The length of the CommandId.
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
  - isCommandIdNull
```
public boolean isCommandIdNull()
```
    Checks whether the CommandId is null.
    
    Returns:
    
    True if the CommandId field is null, false if not.
  - getCommand
```
public int getCommand()
```
    Returns the Command for this Message, indicating the type of of message this is. The fields that are supported by this message, and how they are set and interpreted, depend on the type of message. See the AMPS Command Reference for details.
    
    Returns:
    
    The Command for this Message.
  - setCommand
```
public Message setCommand(int v)
```
    Sets the Command for this Message, indicating the type of of Message this is. The fields that are supported by this message, and how they are set and interpreted, depend on the type of message. See the AMPS Command Reference for details.
    
    Parameters:
    
    v - The integer Command to set on this Message.
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
  - setCommand
```
public Message setCommand(java.lang.String v)
```
    Sets the Command for this Message, indicating the type of of Message this is. The fields that are supported by this message, and how they are set and interpreted, depend on the type of message. See the AMPS Command Reference for details.
    
    Parameters:
    
    v - The Command to set on this Message. The value provided must be a value supported by the AMPS server, or the server will refuse to process the command.
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
  - isCommandNull
```
public boolean isCommandNull()
```
    Checks whether the Command field is null.
    
    Returns:
    
    True if the Command field is null, false if not.
  - getData
```
public java.lang.String getData()
```
    Returns the payload of the Message.
    
    Returns:
    
    The decoded payload for this Message.
  - getDataRaw
```
public Field getDataRaw()
```
    Returns the payload of the Message.
    The Raw variation of this getter allows for finer-grained performance tuning. It provides direct access to the Field that encapsulates the data.
    This does not incur any additional heap allocation or unnecessary decoding of the byte[] in which the data is stored. The lifetime of the underlying buffer for the field is the lifetime of the Message. If you need the data to persist longer than the lifetime of the Message, you must copy the Field.
    
    Returns:
    
    The raw payload for this Message.
  - setData
```
public Message setData(java.lang.String v)
```
    Sets the payload of the Message.
    
    Parameters:
    
    v - The string to set as the payload of this Message.
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
  - setData
```
public Message setData(byte[] buffer,
                       int offset,
                       int length)
```
    Sets the payload of the Message.
    
    Parameters:
    
    buffer - The buffer containing the Data.
    
    offset - The location at which the Data begins.
    
    length - The length of the data.
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
  - isDataNull
```
public boolean isDataNull()
```
    Checks whether the Data field is null.
    
    Returns:
    
    True if the Data field is null, false if not.
  - getExpiration
```
public int getExpiration()
```
    Returns the Expiration field set for this Message.
    
    Returns:
    
    The Expiration for this Message.
  - getExpirationRaw
```
public IntegerField getExpirationRaw()
```
    Returns the Expiration field set for this Message.
    The Raw variation of this getter allows for finer-grained performance tuning. It provides direct access to the Field that encapsulates the data.
    This does not incur any additional heap allocation or unnecessary decoding of the byte[] in which the data is stored. The lifetime of the underlying buffer for the field is the lifetime of the Message. If you need the data to persist longer than the lifetime of the Message, you must copy the Field.
    
    Returns:
    
    The raw Expiration for this Message.
  - setExpiration
```
public Message setExpiration(int v)
```
    Sets the Expiration field for this Message. The expiration is used on a publish command to set the lifetime of a message. For the lifetime to be processed by AMPS, the message must be published to a SOW topic that supports message expiration. See the AMPS User Guide for details.
    
    Parameters:
    
    v - The lifetime of the Message.
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
  - isExpirationNull
```
public boolean isExpirationNull()
```
    Checks whether the Expiration field is null.
    
    Returns:
    
    True if the Expiration field is null, false if not.
  - getFilter
```
public java.lang.String getFilter()
```
    Returns the Filter field on this Message. Filters are used for commands that provide content filtering, such as SOW queries, subscriptions, and SOW delete.
    
    Returns:
    
    The decoded Filter on this Message.
  - getFilterRaw
```
public Field getFilterRaw()
```
    Returns the Filter field on this Message. Filters are used for commands that provide content filtering, such as SOW queries, subscriptions, and SOW delete.
    The Raw variation of this getter allows for finer-grained performance tuning. It provides direct access to the Field that encapsulates the data.
    This does not incur any additional heap allocation or unnecessary decoding of the byte[] in which the data is stored. The lifetime of the underlying buffer for the field is the lifetime of the Message. If you need the data to persist longer than the lifetime of the Message, you must copy the Field.
    
    Returns:
    
    The raw Filter on this Message.
  - setFilter
```
public Message setFilter(java.lang.String v)
```
    Sets the Filter field on this Message. Filters are used for commands that provide content filtering, such as SOW queries, subscriptions, and SOW delete.
    
    Parameters:
    
    v - The string to set as the Filter on this Message.
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
  - setFilter
```
public Message setFilter(byte[] buffer,
                         int offset,
                         int length)
```
    Sets the Filter field on this Message. Filters are used for commands that provide content filtering, such as SOW queries, subscriptions, and SOW delete.
    
    Parameters:
    
    buffer - The buffer containing the Filter for this Message.
    
    offset - The location at which the Filter begins.
    
    length - The length of the Filter.
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
  - isFilterNull
```
public boolean isFilterNull()
```
    Checks whether the Filter field is null.
    
    Returns:
    
    True if the Filter field is null, false if not.
  - isLeasePeriodNull
```
public boolean isLeasePeriodNull()
```
    Check whether the LeasePeriod field is null.
    
    Returns:
    
    true if LeasePeriod is null.
  - getLeasePeriod
```
public java.lang.String getLeasePeriod()
```
    Gets the decoded version of the LeasePeriod for the Message.
    
    Returns:
    
    Decoded LeasePeriod for the Message.
  - getLeasePeriodRaw
```
public StringField getLeasePeriodRaw()
```
    Gets the raw verstion of the LeasePeriod filter for the Message.
    
    Returns:
    
    Raw LeasePeriod for the Message.
  - getMessageType
```
public java.lang.String getMessageType()
```
    Returns the MessageType on this client. MessageType is used to specify the message type given in the URI.
    
    Returns:
    
    The MessageType on this client.
  - setMessageType
```
public Message setMessageType(java.lang.String v)
```
    Sets the MessageType on this client. MessageType is used to specify the message type given in the URI.
    
    Parameters:
    
    v - The string MessageType to set on this client.
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
  - isMessageTypeNull
```
public boolean isMessageTypeNull()
```
    Checks whether the MessageType field is null.
    
    Returns:
    
    True if MessageType field is null, false if not.
  - getOrderBy
```
public java.lang.String getOrderBy()
```
    Get the OrderBy parameter for this Message. For commands that support ordering, this parameter provides the order in which AMPS returns results.
    
    Returns:
    
    The decoded OrderBy parameter for this Message.
  - getOrderByRaw
```
public Field getOrderByRaw()
```
    Get the OrderBy parameter for this Message. For commands that support ordering, this parameter provides the order in which AMPS returns results.
    The Raw variation of this getter allows for finer-grained performance tuning. It provides direct access to the Field that encapsulates the data.
    This does not incur any additional heap allocation or unnecessary decoding of the byte[] in which the data is stored. The lifetime of the underlying buffer for the field is the lifetime of the Message. If you need the data to persist longer than the lifetime of the Message, you must copy the Field.
    
    Returns:
    
    The raw OrderBy parameter for this Message.
  - setOrderBy
```
public Message setOrderBy(java.lang.String v)
```
    Set the OrderBy parameter for this Message. For commands that support ordering, this parameter provides the order in which AMPS returns results. See the AMPS User Guide for details.
    
    Parameters:
    
    v - The ordering expressiong to set for this Message.
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
  - setOrderBy
```
public Message setOrderBy(byte[] buffer,
                          int offset,
                          int length)
```
    Set the OrderBy parameter for this Message. For commands that support ordering, this parameter provides the order in which AMPS returns results. See the AMPS User Guide for details.
    
    Parameters:
    
    buffer - The buffer that contains the expression.
    
    offset - The location at which the expression begins.
    
    length - The length of the expression.
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
  - isOrderByNull
```
public boolean isOrderByNull()
```
    Checks whether the OrderBy field is null.
    
    Returns:
    
    True if the OrderBy field is null, false if not.
  - getGroupSeqNo
```
public long getGroupSeqNo()
```
    Get the group sequence number. The group sequence number is the number of the batch within the SOW response.
    
    Returns:
    
    The group sequence number.
  - setGroupSeqNo
```
public Message setGroupSeqNo(long v)
```
    Set the group sequence number. The group sequence number is the number of the batch within the SOW response, and is set on incoming messages by the AMPS client.
    
    Parameters:
    
    v - The number to set as the group sequence number.
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
  - isGroupSeqNoNull
```
public boolean isGroupSeqNoNull()
```
    Checks whether the GroupSeqNo field is null.
    
    Returns:
    
    True if the GroupSeqNo field is null, false if not.
  - getMatches
```
public long getMatches()
```
    Returns the number of matches in the command this Message acknowledges. This header is provided on an acknowledgement message that includes information on the number of matches. See the AMPS Command Reference for details.
    
    Returns:
    
    The number of matches in the command this Message acknowledges.
  - setMatches
```
public Message setMatches(long v)
```
    Sets the matches field on this Message. This header is typically provided by AMPS.
    
    Parameters:
    
    v - The number to set as the Matches field in this Message.
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
  - isMatchesNull
```
public boolean isMatchesNull()
```
    Checks whether the Matches field is Null.
    
    Returns:
    
    True if the Matches field is null, false if not.
  - getPassword
```
public java.lang.String getPassword()
```
    Returns the Password set on the Message. This field is typically used during the logon sequence.
    
    Returns:
    
    The decoded Password set on specified Message.
  - getPasswordRaw
```
public Field getPasswordRaw()
```
    Returns the Password set on the Message. This field is used during the logon sequence.
    The Raw variation of this getter allows for finer-grained performance tuning. It provides direct access to the Field that encapsulates the data.
    This does not incur any additional heap allocation or unnecessary decoding of the byte[] in which the data is stored. The lifetime of the underlying buffer for the field is the lifetime of the Message. If you need the data to persist longer than the lifetime of the Message, you must copy the Field.
    
    Returns:
    
    The raw Password set on this Message.
  - setPassword
```
public Message setPassword(java.lang.String v)
```
    Set the Password on the Message. This field is typically used during the logon sequence.
    
    Parameters:
    
    v - The string Password to set.
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
  - setPassword
```
public Message setPassword(byte[] buffer,
                           int offset,
                           int length)
```
    Set the Password on the Message. This field is typically used during the logon sequence.
    
    Parameters:
    
    buffer - The buffer that contains the Password.
    
    offset - The location where the Password starts.
    
    length - The length of the Password.
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
  - isPasswordNull
```
public boolean isPasswordNull()
```
    Checks whether the Password field is null.
    
    Returns:
    
    True if the Password field is null, false if not.
  - getLength
```
public int getLength()
```
    Returns the Length of the Message.
    
    Returns:
    
    Length of the messgae.
  - setLength
```
public Message setLength(int v)
```
    Sets the Length of the Message. This field is typically set by the AMPS client API rather than by application code.
    
    Parameters:
    
    v - The value to be set as the Length of the Message.
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
  - isLengthNull
```
public boolean isLengthNull()
```
    Checks whether the Length field is null.
    
    Returns:
    
    True if the Length field of the Message is null, false if not.
  - getOptions
```
public java.lang.String getOptions()
```
    Returns the Options to be set on this Message.
    
    Returns:
    
    The decoded Options set on this Message.
  - getOptionsRaw
```
public Field getOptionsRaw()
```
    Returns the Options to be set on this Message.
    The Raw variation of this getter allows for finer-grained performance tuning. It provides direct access to the Field that encapsulates the data.
    This does not incur any additional heap allocation or unnecessary decoding of the byte[] in which the data is stored. The lifetime of the underlying buffer for the field is the lifetime of the Message. If you need the data to persist longer than the lifetime of the Message, you must copy the Field.
    
    Returns:
    
    The decoded Options set on this Message.
  - setOptions
```
public Message setOptions(java.lang.String v)
```
    Sets the Options for the Message. Options are a comma-delimited list of parameters. The values accepted for options depend on the command: see the AMPS Command Reference for details.
    
    Parameters:
    
    v - The string to be used as the Options for this Message.
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
  - isOptionsNull
```
public boolean isOptionsNull()
```
    Checks whether the Options field is null.
    
    Returns:
    
    True if the Options field is null, false if not.
  - getQueryId
```
public java.lang.String getQueryId()
```
    Returns the QueryId for this Message. The QueryId returned on a message is the CommandId of the command that ran the query. For example, when sending a SOW command to AMPS, messages returned in response to that command will have the QueryId set to the CommandId of the SOW command.
    
    Returns:
    
    The decoded QueryId for this Message.
  - getQueryIdRaw
```
public Field getQueryIdRaw()
```
    Returns the QueryId for this Message. The QueryId returned on a message is the CommandId of the command that ran the query. For example, when sending a SOW command to AMPS, messages returned in response to that command will have the QueryId set to the CommandId of the SOW command.
    The Raw variation of this getter allows for finer-grained performance tuning. It provides direct access to the Field that encapsulates the data.
    This does not incur any additional heap allocation or unnecessary decoding of the byte[] in which the data is stored. The lifetime of the underlying buffer for the field is the lifetime of the Message. If you need the data to persist longer than the lifetime of the Message, you must copy the Field.
    
    Returns:
    
    The raw QueryId for this Message.
  - getQueryId
```
public boolean getQueryId(CommandId v)
```
    Returns the QueryId for this Message by copying it into the provided CommandId. The QueryId returned on a message is the CommandId of the command that ran the query. For example, when sending a SOW command to AMPS, messages returned in response to that command will have the QueryId set to the CommandId of the SOW command.
    
    Parameters:
    
    v - The CommandId to be used to copy the QueryId.
    
    Returns:
    
    true if a QueryId is set on this message, false otherwise
  - setQueryId
```
public Message setQueryId(java.lang.String v)
```
    Sets the QueryId field for this Message. Typically, the QueryId is set by the AMPS client on incoming messages.
    
    Parameters:
    
    v - The string to be set as the QueryId for this Message.
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
  - setQueryId
```
public Message setQueryId(CommandId v)
```
    Sets the QueryId field for this Message by copying it from a CommandId object. Typically, the QueryId is set for incoming messages by the AMPS client.
    
    Parameters:
    
    v - The CommandId to be set as the QueryId for this Message.
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
  - setQueryId
```
public Message setQueryId(byte[] buffer,
                          int offset,
                          int length)
```
    Sets the QueryId for this Message. Typically, the QueryId is set by the AMPS client on incoming messages.
    
    Parameters:
    
    buffer - The buffer containing the QueryId.
    
    offset - The location in the buffer where the QueryId begins.
    
    length - The length of the QueryId to be set.
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
  - isQueryIdNull
```
public boolean isQueryIdNull()
```
    Checks whether the QueryId field is null.
    
    Returns:
    
    True if the QueryId field is null, false if not.
  - getReason
```
public int getReason()
```
    Returns the Reason value of this Message. The reason is set on acknowledgement messages to provide more information about the acknowledgement.
    
    Returns:
    
    The value in the Reason field of this Message.
  - getReasonText
```
public java.lang.String getReasonText()
```
    Returns the Reason value of this Message. Typically, the reason is set for incoming messages by the AMPS client.
    
    Returns:
    
    The text from the Reason field of the Message.
  - setReason
```
public Message setReason(int v)
```
    Sets the Reason value of this Message. Typically, the reason is set for incoming messages by the AMPS client.
    
    Parameters:
    
    v - The Reason value to set for this Message.
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
  - isReasonNull
```
public boolean isReasonNull()
```
    Checks whether the Reason is null.
    
    Returns:
    
    True if the Reason field of the message is null, false if not.
  - getRecordsInserted
```
public long getRecordsInserted()
```
    Returns the number of records inserted for the command that this Message was produced in response to. This header is provided on an acknowledgement message that includes information on the number of records inserted. See the AMPS Command Reference for details.
    
    Returns:
    
    The number of records inderted for the command that produced this Message.
  - setRecordsInserted
```
public Message setRecordsInserted(long v)
```
    Returns the number of records inserted for the command that this Message was produced in response to. This header is provided on an acknowledgement message. An application does not typically need to set this field. See the AMPS Command Reference for details.
    
    Parameters:
    
    v - The value to set as the RecordsInserted field of the Message.
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
  - isRecordsInsertedNull
```
public boolean isRecordsInsertedNull()
```
    Checks whether the RecordsInserted field is null.
    
    Returns:
    
    True if the RecordsInserted field is null, false if not.
  - getRecordsUpdated
```
public long getRecordsUpdated()
```
    Returns the number of records updated for the command that this Message was produced in response to. This header is provided on an acknowledgement message. See the AMPS Command Reference for details.
    
    Returns:
    
    Number of records updated for the command that this Message was produced for.
  - setRecordsUpdated
```
public Message setRecordsUpdated(long v)
```
    Sets the records updated header field. This header is provided on an acknowledgement message. An application does not typically need to set this field. See the AMPS Command Reference for details.
    
    Parameters:
    
    v - Value to set the RecordsUpdated field to.
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
  - isRecordsUpdatedNull
```
public boolean isRecordsUpdatedNull()
```
    Checks whether the RecordsUpdated field is null.
    
    Returns:
    
    True if the RecordsUpdated field is null, false if not.
  - getRecordsDeleted
```
public long getRecordsDeleted()
```
    Returns the number of records deleted for the command that this Message was produced in response to. This header is provided on an acknowledgement message. See the AMPS Command Reference for details.
    
    Returns:
    
    The number of RecordsDeleted for the command that this Message was produced for.
  - setRecordsDeleted
```
public Message setRecordsDeleted(long v)
```
    Sets the records deleted header field. This header is provided on an acknowledgement message. An application does not typically need to set this field. See the AMPS Command Reference for details.
    
    Parameters:
    
    v - Value to set as the RecordsDeleted field.
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
  - isRecordsDeletedNull
```
public boolean isRecordsDeletedNull()
```
    Checks whether the RecordsDeleted field is null.
    
    Returns:
    
    True if the RecordsDeleted field is null, false if not.
  - getRecordsReturned
```
public long getRecordsReturned()
```
    Returns the number of records returned for the command that this Message was produced in response to. This header is provided on an acknowledgement message. See the AMPS Command Reference for details.
    
    Returns:
    
    The number of RecordsReturned for the command that this Message was produced for.
  - setRecordsReturned
```
public Message setRecordsReturned(long v)
```
    Sets the records returned header field. This header is provided on an acknowledgement message. An application does not typically need to set this field. See the AMPS Command Reference for details.
    
    Parameters:
    
    v - Value to set as the RecordsReturn field.
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
  - isRecordsReturnedNull
```
public boolean isRecordsReturnedNull()
```
    Checks whether the RecordsReturned field is null.
    
    Returns:
    
    True if the RecordsReturned field is null, false if not.
  - getSequenceRaw
```
public Field getSequenceRaw()
```
    Returns the sequence number for this Message. On outgoing messages, this field is typically set by the AMPS client. The sequence number is used by AMPS for duplicate detection. Each combination of client name and sequence number should be a unique message. In the response to a login, AMPS may return the last sequence number received from a client to assist in recovery.
    The Raw variation of this getter allows for finer-grained performance tuning. It provides direct access to the Field that encapsulates the data.
    This does not incur any additional heap allocation or unnecessary decoding of the byte[] in which the data is stored. The lifetime of the underlying buffer for the field is the lifetime of the Message. If you need the data to persist longer than the lifetime of the Message, you must copy the Field.
    
    Returns:
    
    The raw sequence number for this Message.
  - getSequence
```
public long getSequence()
```
    Returns the sequence number for this Message. On outgoing messages, this field is typically set by the AMPS client. The sequence number is used by AMPS for duplicate detection. Each combination of client name and sequence number should be a unique message. In response to a logon, AMPS may return the last sequence number received from a client to assist in recovery.
    
    Returns:
    
    The decoded sequence number for this Message.
  - setSequence
```
public Message setSequence(long v)
```
    Sets the sequence number for this Message. This field is typically set by the AMPS client. The AMPS client uses the sequence number in outgoing messages. The sequence number is used by AMPS for duplicate detection. Each combination of client name and sequence number should be a unique message.
    
    Parameters:
    
    v - The value to set as the sequence number for this Message.
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
  - isSequenceNull
```
public boolean isSequenceNull()
```
    Checks whether the Sequence field is null.
    
    Returns:
    
    True if the Sequence field is null, false if not.
  - getSowKey
```
public java.lang.String getSowKey()
```
    Returns the SowKey for this Message. The SowKey is an opaque identifier used to uniquely identify a SOW record within AMPS. For messages received from a SOW, AMPS provides the SowKey on each message.
    
    Returns:
    
    The decoded SowKey for this Message.
  - getSowKeyRaw
```
public Field getSowKeyRaw()
```
    Returns the SowKey for this Message. The SowKey is an opaque identifier used to uniquely identify a SOW record within AMPS. For messages received from a SOW, AMPS provides the SowKey on each message.
    The Raw variation of this getter allows for finer-grained performance tuning. It provides direct access to the Field that encapsulates the data.
    This does not incur any additional heap allocation or unnecessary decoding of the byte[] in which the data is stored. The lifetime of the underlying buffer for the field is the lifetime of the Message. If you need the data to persist longer than the lifetime of the Message, you must copy the Field.
    
    Returns:
    
    The raw SowKey for this Message.
  - setSowKey
```
public Message setSowKey(java.lang.String v)
```
    Sets the SowKey for this Message. The SowKey is an opaque identifier used to uniquely identify a SOW record within AMPS. For messages received from a SOW, AMPS provides the SOW key on each message.
    
    Parameters:
    
    v - The string to be used for the SowKey.
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
  - setSowKey
```
public Message setSowKey(byte[] buffer,
                         int offset,
                         int length)
```
    Sets the SowKey for this Message. The SowKey is an opaque identifier used to uniquely identify a SOW record within AMPS. For messages received from a SOW, AMPS provides the SOW key on each message.
    
    Parameters:
    
    buffer - The buffer that contains the SOW Key.
    
    offset - The location within the buffer where the SOW Key begins.
    
    length - The length of the SOW Key.
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
  - isSowKeyNull
```
public boolean isSowKeyNull()
```
    Checks whether the SowKey field is null.
    
    Returns:
    
    True if the SowKey field is null, false if not.
  - getSowKeys
```
public java.lang.String getSowKeys()
```
    Gets the set of SowKeys this message applies to. The SowKey is an opaque identifier used to uniquely identify a SOW record within AMPS. For messages received from a SOW, AMPS provides the SOW key on each message.
    
    Returns:
    
    The decoded set of SowKeys this message applies to.
  - getSowKeysRaw
```
public Field getSowKeysRaw()
```
    Gets the set of SowKeys this message applies to. The SowKey is an opaque identifier used to uniquely identify a SOW record within AMPS. For messages received from a SOW, AMPS provides the SOW key on each message.
    The Raw variation of this getter allows for finer-grained performance tuning. It provides direct access to the Field that encapsulates the data.
    This does not incur any additional heap allocation or unnecessary decoding of the byte[] in which the data is stored. The lifetime of the underlying buffer for the field is the lifetime of the Message. If you need the data to persist longer than the lifetime of the Message, you must copy the Field.
    
    Returns:
    
    The raw SowKeys this message applies to.
  - setSowKeys
```
public Message setSowKeys(java.lang.String v)
```
    Sets the set of SowKeys this message applies to, as a comma-delimited list of identifiers. This can be useful for commands that operate on multiple SOW records, such as a sow_delete that specifies a set of keys to remove. The SowKey is an opaque identifier used to uniquely identify a SOW record within AMPS. For messages received from a SOW, AMPS provides the SOW key on each message.
    
    Parameters:
    
    v - A comma-delimited list of identifiers to be set as the SowKeys that this message applies to.
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
  - setSowKeys
```
public Message setSowKeys(byte[] buffer,
                          int offset,
                          int length)
```
    Sets the set of SowKeys this message applies to, as a comma-delimited list of identifiers. This can be useful for commands that operate on multiple SOW records, such as a sow_delete that specifies a set of keys to remove. The SowKey is an opaque identifier used to uniquely identify a SOW record within AMPS. For messages received from a SOW, AMPS provides the SOW key on each message.
    
    Parameters:
    
    buffer - The buffer that contains the SOW Key.
    
    offset - The location within the buffer where the SOW Key begins.
    
    length - The length of the SOW Key.
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
  - isSowKeysNull
```
public boolean isSowKeysNull()
```
    Checks whether the SowKeys field is null.
    
    Returns:
    
    True if the SowKeys field is null, false if not.
  - getStatus
```
public int getStatus()
```
    Returns the Status of this Message. This field is provided by AMPS on acknowledgements to indicate the success or failure of the command being acknowledged.
    
    Returns:
    
    The Status of this Message.
  - setStatus
```
public Message setStatus(int v)
```
    Sets the Status of this Message. This field is provided by AMPS on acknowledgements to indicate the success or failure of the command being acknowledged.
    
    Parameters:
    
    v - The value to be set as the Status of the Message.
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
  - getSubId
```
public java.lang.String getSubId()
```
    Gets the SubId of this Message. The SubId is a reference to the CommandId of the command that created the subscription.
    
    Returns:
    
    The decoded SubId of this Message.
  - getSubIdRaw
```
public Field getSubIdRaw()
```
    Gets the SubId of this Message. The SubId is a reference to the CommandId of the command that created the subscription.
    The Raw variation of this getter allows for finer-grained performance tuning. It provides direct access to the Field that encapsulates the data.
    This does not incur any additional heap allocation or unnecessary decoding of the byte[] in which the data is stored. The lifetime of the underlying buffer for the field is the lifetime of the Message. If you need the data to persist longer than the lifetime of the Message, you must copy the Field.
    
    Returns:
    
    The raw SubId of this Message.
  - getSubId
```
public boolean getSubId(CommandId v)
```
    Gets the SubId of this Message by copying it into the provided CommandId. The SubId is a reference to the CommandId of the command that created the subscription.
    
    Parameters:
    
    v - The CommandId into which to copy the SubId.
    
    Returns:
    
    true if a SubId is set on this message, false otherwise
  - setSubId
```
public Message setSubId(java.lang.String v)
```
    Sets the SubId of this Message. The SubId is a reference to the CommandId of the command that created the subscription.
    
    Parameters:
    
    v - The string used to set the SubId of this Message.
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
  - setSubId
```
public Message setSubId(CommandId v)
```
    Sets the SubId of this Message by copying it from a CommandId object. The SubId is the CommandId of the command that created the subscription. For example, to replace a subscription, you provide the SubId of the subscription to be replaced with the command that replaces the subscription.
    
    Parameters:
    
    v - The CommandId to be set as the SubId for this Message.
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
  - setSubId
```
public Message setSubId(byte[] buffer,
                        int offset,
                        int length)
```
    Sets the SubId of this Message. The SubId is a reference to the CommandId of the command that created the subscription. For example, messages returned for a subscription contain the SubId of the subscription.
    
    Parameters:
    
    buffer - The buffer that contains the SubId key.
    
    offset - The location within the buffer where the SubId begins.
    
    length - The length of the SubId.
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
  - isSubIdNull
```
public boolean isSubIdNull()
```
    Checks whether the SubId field is null.
    
    Returns:
    
    True if the SubId is null, false if not.
  - getSubIds
```
public java.lang.String getSubIds()
```
    The set of SubIds for this Message. AMPS returns a SubId for each subscription that matches the message as a comma-delimited list. The SubId is the identifier provided when the subscription was registered with AMPS.
    
    Returns:
    
    The decoded set of SubIds for this Message.
  - getSubIdsRaw
```
public Field getSubIdsRaw()
```
    The set of SubIds for this message. AMPS returns a SubId for each subscription that matches the message as a comma-delimited list. The SubId is the identifier provided when the subscription was registered with AMPS.
    The Raw variation of this getter allows for finer-grained performance tuning. It provides direct access to the Field that encapsulates the data.
    This does not incur any additional heap allocation or unnecessary decoding of the byte[] in which the data is stored. The lifetime of the underlying buffer for the field is the lifetime of the Message. If you need the data to persist longer than the lifetime of the Message, you must copy the Field.
    
    Returns:
    
    The raw set of SubIds for this message.
  - setSubIds
```
public Message setSubIds(java.lang.String v)
```
    The set of SubIds for this message. AMPS returns a SubId for each subscription that matches the message as a comma-delimited list. The SubId is the identifier provided when the subscription was registered with AMPS.
    
    Parameters:
    
    v - The comma-delimited list to be set as the SubIds for this message.
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
  - setSubIds
```
public Message setSubIds(byte[] buffer,
                         int offset,
                         int length)
```
    The set of SubIds for this message. AMPS returns a SubId for each subscription that matches the message. The SubId is the identifier provided when the subscription was registered with AMPS.
    
    Parameters:
    
    buffer - The buffer containing the SubIds for this message.
    
    offset - The location of where the SubIds begin.
    
    length - The length of the list of SubIds.
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
  - isSubIdsNull
```
public boolean isSubIdsNull()
```
    Checks whether the SubIds field is null.
    
    Returns:
    
    True if the SubIds feild is null, false if not.
  - getTimestamp
```
public java.lang.String getTimestamp()
```
    Returns the timestamp for this message, an ISO-8601 formatted string. The timestamp is set by AMPS at the time that AMPS processes the message.
    
    Returns:
    
    The Timestamp for this Message as an ISO-8601 formatted string.
  - getTimestampRaw
```
public Field getTimestampRaw()
```
    Returns the timestamp for this message, an ISO-8601 formatted string. The timestamp is set by AMPS at the time that AMPS processes the message.
    The Raw variation of this getter allows for finer-grained performance tuning. It provides direct access to the Field that encapsulates the data.
    This does not incur any additional heap allocation or unnecessary decoding of the byte[] in which the data is stored. The lifetime of the underlying buffer for the field is the lifetime of the Message. If you need the data to persist longer than the lifetime of the Message, you must copy the Field.
    
    Returns:
    
    The raw Timestamp for this Message.
  - setTimestamp
```
public Message setTimestamp(java.lang.String v)
```
    Sets the Timestamp for this Message. The timestamp is set by AMPS at the time that AMPS processes the message. There is generally no need to set this field in your application.
    
    Parameters:
    
    v - The string to set as the Timestamp for this Message.
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
  - setTimestamp
```
public Message setTimestamp(byte[] buffer,
                            int offset,
                            int length)
```
    Sets the timestamp for this message. The timestamp is set by AMPS at the time that AMPS processes the message. There is generally no need to set this field in your application.
    
    Parameters:
    
    buffer - the buffer that contains the timestamp
    
    offset - the location within the buffer where the timestamp begins
    
    length - the length of the timestamp
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
  - isTimestampNull
```
public boolean isTimestampNull()
```
    Checks whether the Timestamp field is null.
    
    Returns:
    
    True if the Timestamp field is null, false if not.
  - getTopN
```
public long getTopN()
```
    Get the TopN parameter for this message. For commands that support limiting the number of messages in the result set, this parameter provides the limit to AMPS.
    
    Returns:
    
    The TopN parameter for this Message.
  - setTopN
```
public Message setTopN(long v)
```
    Set the TopN parameter for this message. For commands that support limiting the number of messages in the result set, this parameter provides the limit to AMPS.
    
    Parameters:
    
    v - The value to be set as the TopN parameter.
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
  - isTopNNull
```
public boolean isTopNNull()
```
    Checks whether the TopN field is null.
    
    Returns:
    
    True if the TopN field is null, false if not.
  - getTopic
```
public java.lang.String getTopic()
```
    Return the topic that the message applies to.
    
    Returns:
    
    The decoded Topic that the Message applies to.
  - getTopicRaw
```
public Field getTopicRaw()
```
    Return the topic that the message applies to.
    The Raw variation of this getter allows for finer-grained performance tuning. It provides direct access to the Field that encapsulates the data.
    This does not incur any additional heap allocation or unnecessary decoding of the byte[] in which the data is stored. The lifetime of the underlying buffer for the field is the lifetime of the Message. If you need the data to persist longer than the lifetime of the Message, you must copy the Field.
    
    Returns:
    
    The raw Topic that the Message applies to.
  - setTopic
```
public Message setTopic(java.lang.String v)
```
    Set the topic that the message applies to.
    
    Parameters:
    
    v - The string to be set as the Topic that the Message applies to.
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
  - setTopic
```
public Message setTopic(byte[] buffer,
                        int offset,
                        int length)
```
    Set the topic that the message applies to.
    
    Parameters:
    
    buffer - the buffer that contains the Topic
    
    offset - the location within the buffer where the Topic begins
    
    length - the length of the Topic
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
  - isTopicNull
```
public boolean isTopicNull()
```
    Checks whether the Topic field is null.
    
    Returns:
    
    True if the Topic field is null, false if not.
  - getTopicMatches
```
public long getTopicMatches()
```
    Returns the number of matching topics for the command that this message was produced in response to. This header is provided on an acknowledgement message that includes information on the number of records inserted. See the AMPS Command Reference for details.
    
    Returns:
    
    The number of matching topics for the command that this Message was produced in response to.
  - isTopicMatchesNull
```
public boolean isTopicMatchesNull()
```
    Checks whether the TopicMatches field is null.
    
    Returns:
    
    True if the TopicMatches field is null, false if not.
  - setTopicMatches
```
public Message setTopicMatches(long v)
```
    Sets the topic matches field on this message. This header is typically provided by AMPS.
    
    Parameters:
    
    v - The value to set as the TopicMatches field on this Message.
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
  - getUserId
```
public java.lang.String getUserId()
```
    Get the UserId for this message. This field is typically set during the logon sequence. The field may also be provided on published messages, depending on the authentication used in AMPS. When provided on a published message, AMPS provides the identity of the connection that sent the message, not the value provided with the message as published.
    
    Returns:
    
    The decoded UserId for this message.
  - isUserIdNull
```
public boolean isUserIdNull()
```
    Checks whether the UserId field is null.
    
    Returns:
    
    True if the UserId field is null, false if not.
  - getUserIdRaw
```
public Field getUserIdRaw()
```
    Get the UserId for this message. This field is typically set during the logon sequence. The field may also be provided on published messages, depending on the authentication used in AMPS. When provided on a published message, AMPS provides the identity of the connection that sent the message, not the value provided with the message as published.
    The Raw variation of this getter allows for finer-grained performance tuning. It provides direct access to the Field that encapsulates the data.
    This does not incur any additional heap allocation or unnecessary decoding of the byte[] in which the data is stored. The lifetime of the underlying buffer for the field is the lifetime of the Message. If you need the data to persist longer than the lifetime of the Message, you must copy the Field.
    
    Returns:
    
    The raw UserId for this Message.
  - setUserId
```
public Message setUserId(java.lang.String v)
```
    Set the UserId for this message. This field is typically set during the logon sequence. The field may also be provided on published messages, depending on the authentication used in AMPS. When provided on a published message, AMPS provides the identity of the connection that sent the message, not the value provided with the message as published. Therefore, applications generally only set this value during logon.
    
    Parameters:
    
    v - The string to be set as the UserId for this Message.
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
  - setUserId
```
public Message setUserId(byte[] buffer,
                         int offset,
                         int length)
```
    Set the UserId for this message. This field is typically set during the logon sequence. The field may also be provided on published messages, depending on the authentication used in AMPS. When provided on a published message, AMPS provides the identity of the connection that sent the message, not the value provided with the message as published. Therefore, applications generally only set this value during logon.
    
    Parameters:
    
    buffer - the buffer that contains the UserId
    
    offset - the position where the UserId begins
    
    length - the length of the UserId
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
  - getVersion
```
public java.lang.String getVersion()
```
    Returns the version of the AMPS server, provided in response to a logon.
    
    Returns:
    
    The decoded version of the AMPS server.
  - getVersionRaw
```
public Field getVersionRaw()
```
    Returns the version of the AMPS server, provided in response to a logon.
    The Raw variation of this getter allows for finer-grained performance tuning. It provides direct access to the Field that encapsulates the data.
    This does not incur any additional heap allocation or unnecessary decoding of the byte[] in which the data is stored. The lifetime of the underlying buffer for the field is the lifetime of the Message. If you need the data to persist longer than the lifetime of the Message, you must copy the Field.
    
    Returns:
    
    The raw version of the AMPS server.
  - isVersionNull
```
public boolean isVersionNull()
```
    Checks whether the Version field is null.
    
    Returns:
    
    True if the Version field is null, false if not.
  - getVersionAsInt
```
public int getVersionAsInt()
```
    Returns the version of the AMPS server, provided in response to a logon.
    
    Returns:
    
    The version of AMPS server.
  - setVersion
```
public Message setVersion(java.lang.String v)
```
    Sets the version field of this message. This is typically done by the AMPS client API when a message with this field set is received.
    
    Parameters:
    
    v - The string used to set the Version field of this Message.
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
  - setVersion
```
public Message setVersion(byte[] buffer,
                          int offset,
                          int length)
```
    Sets the version field of this message. This is typically done by the AMPS client API when a message with this field set is received.
    
    Parameters:
    
    buffer - the buffer that contains the version string
    
    offset - the position where the version string begins
    
    length - the length of the version string
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
  - setCorrelationId
```
public Message setCorrelationId(java.lang.String v)
```
    Set the CorrelationId on this message. The CorrelationId is an opaque identifier provided by the publisher of a message. AMPS provides the identifier to subscribers of the message without interpreting or changing the identifier.
    
    Parameters:
    
    v - The string used to set the CorrelationId on this message.
    
    Returns:
    
    Returns this instance so that various operations can be chained together.
  - getCorrelationId
```
public java.lang.String getCorrelationId()
```
    Get the CorrelationId on this message. The CorrelationId is an opaque identifier provided by the publisher of a message. AMPS provides the identifier to subscribers of the message without interpreting or changing the identifier.
    
    Returns:
    
    The decoded version of the CorrelationId on this Message.
  - getCorrelationIdRaw
```
public StringField getCorrelationIdRaw()
```
    Get the CorrelationId on this message. The CorrelationId is an opaque identifier provided by the publisher of a message. AMPS provides the identifier to subscribers of the message without interpreting or changing the identifier.
    The Raw variation of this getter allows for finer-grained performance tuning. It provides direct access to the Field that encapsulates the data.
    This does not incur any additional heap allocation or unnecessary decoding of the byte[] in which the data is stored. The lifetime of the underlying buffer for the field is the lifetime of the Message. If you need the data to persist longer than the lifetime of the Message, you must copy the Field.
    
    Returns:
    
    The raw CorrelationId on this Message.
  - isCorrelationIdNull
```
public boolean isCorrelationIdNull()
```
    Checks whether the CorrelationId field is null.
    
    Returns:
    
    True if the CorrelationId field is null, false if not.
  - toString
```
public java.lang.String toString()
```
    Return the message as a string. This serializes the message and returns the serialized value.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    The Message as a serialized value.
  - copy
```
public abstract Message copy()
```
  - getClient
```
public Client getClient()
```
    Returns the client who allocated this message.
    
    Returns:
    
    A Client instance.
  - ack
```
public void ack()
         throws AMPSException
```
    Used to acknowledge a queue message is processed.
    
    Throws:
    
    AMPSException - An error occurred sending this acknowledgement to AMPS.
  - ack
```
public void ack(byte[] options,
                int optionsPos,
                int optionsLen)
         throws AMPSException
```
    Used to acknowledge a queue message is processed.
    
    Parameters:
    
    options - The bytes of the options for the ack
    
    optionsPos - The starting position in options
    
    optionsLen - The length of the options
    
    Throws:
    
    AMPSException - An error occurred sending this acknowledgement to AMPS.
  - ack
```
public void ack(Field options)
         throws AMPSException
```
    Used to acknowledge a queue message is processed.
    
    Parameters:
    
    options - The options to include with the ack.
    
    Throws:
    
    AMPSException - An error occurred sending this acknowledgement to AMPS.
  - ack
```
public void ack(java.lang.String options)
         throws AMPSException
```
    Used to acknowledge a queue message is processed.
    
    Parameters:
    
    options - The options to include with the ack.
    
    Throws:
    
    AMPSException - An error occurred sending this acknowledgement to AMPS.
  - isIgnoreAutoAck
```
public boolean isIgnoreAutoAck()
```
    Used to check if automatic acking of this Message by the Client should be skipped.
    
    Returns:
    
    If automatic acking is ignored for this Message.
  - setIgnoreAutoAck
```
public void setIgnoreAutoAck()
```
    Used to disable automatic acking of this Message by the Client after the MessageHandler completes.
  - _copyTo
```
protected void _copyTo(Message destination)
```
    Overwrites destination data with this Message.
    Every field of destination is overwritten with this Message's data, though destination retains the encoder and decoder it was originally constructed with.
    
    Parameters:
    
    destination - overwritten with this Message's data.

Class Message

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

encoder

decoder

_AckType

_BatchSize

_Bookmark

_ClientName

_CommandId

_Command

_Data

_Expiration

_Filter

_LeasePeriod

_MessageType

_OrderBy

_GroupSeqNo

_Matches

_Password

_Length

_Options

_QueryId

_Reason

_RecordsInserted

_RecordsUpdated

_RecordsDeleted

_RecordsReturned

_Sequence

_SowKey

_SowKeys

_Status

_SubId

_SubIds

_Timestamp

_TopN

_Topic

_TopicMatches

_UserId

_Version

_CorrelationId

_client

_fields

Constructor Detail

Message

Method Detail

getEncoder

getDecoder

setBookmarkSeqNo

getBookmarkSeqNo

setSubscription

getSubscription

setBuffer

getBuffer

setRawBufferOffset

getRawBufferOffset

setRawBufferLength

getRawBufferLength

serialize

reset

getAckType

getAckTypeOutgoing

setAckType

setAckType

isAckTypeNull

getBatchSize

setBatchSize

isBatchSizeNull

getBookmark

getBookmarkRaw

setBookmark

setBookmark

isBookmarkNull

getClientName

getClientNameRaw

setClientName