PollMessage

java.lang.Object
- google.registry.model.ImmutableObject
- - google.registry.model.poll.PollMessage

All Implemented Interfaces:

Buildable, TransferData.TransferServerApproveEntity, DatastoreAndSqlEntity, DatastoreEntity, SqlEntity, java.lang.Cloneable

Direct Known Subclasses:

PollMessage.Autorenew, PollMessage.OneTime
```
@Entity
public abstract class PollMessage
extends ImmutableObject
implements Buildable, DatastoreAndSqlEntity, TransferData.TransferServerApproveEntity
```
A poll message that is pending for a registrar.
Poll messages are not delivered until their eventTime has passed. Poll messages can be speculatively enqueued for future delivery, and then modified or deleted before that date has passed. Unlike most other entities in Datastore, which are marked as deleted but otherwise retained for historical purposes, poll messages are truly deleted once they have been delivered and ACKed.
Poll messages are parented off of the HistoryEntry that resulted in their creation. This means that poll messages are contained in the Datastore entity group of the parent EppResource (which can be a domain, contact, or host). It is thus possible to perform a strongly consistent query to find all poll messages associated with a given EPP resource.
Poll messages are identified externally by registrars using the format defined in PollMessageExternalKeyConverter.

See Also:

RFC5730 - EPP - <poll> Command

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`PollMessage.Autorenew`	An auto-renew poll message which recurs annually.
`static class`	`PollMessage.Builder<T extends PollMessage,B extends PollMessage.Builder<?,?>>`	Builder for `PollMessage` because it is immutable.
`static class`	`PollMessage.OneTime`	A one-time poll message.

Nested classes/interfaces inherited from class google.registry.model.ImmutableObject
ImmutableObject.DoNotCompare, ImmutableObject.DoNotHydrate, ImmutableObject.EmptySetToNull, ImmutableObject.IgnoredInDiffableMap, ImmutableObject.Insignificant

Nested classes/interfaces inherited from interface google.registry.model.Buildable
Buildable.GenericBuilder<S,B extends Buildable.GenericBuilder<?,?>>, Buildable.Overlayable<T>

Field Summary
- Fields inherited from class google.registry.model.ImmutableObject
  hashCode

Constructor Summary

Constructors
Constructor Description

PollMessage()

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`abstract PollMessage.Builder<?,?>`	`asBuilder()`	Override Buildable.asBuilder() to give this method stronger typing.
`abstract VKey<? extends PollMessage>`	`createVKey()`
`static VKey<PollMessage>`	`createVKey(com.googlecode.objectify.Key<PollMessage> key)`	Static VKey factory method for use by VKeyTranslatorFactory.
`java.lang.String`	`getClientId()`
`org.joda.time.DateTime`	`getEventTime()`
`java.lang.Long`	`getId()`
`java.lang.String`	`getMsg()`
`com.googlecode.objectify.Key<? extends HistoryEntry>`	`getParentKey()`
`abstract com.google.common.collect.ImmutableList<EppResponse.ResponseData>`	`getResponseData()`

Methods inherited from class google.registry.model.ImmutableObject
clone, cloneEmptyToNull, equals, getSignificantFields, hashCode, toDiffableFieldMap, toHydratedString, toString, toStringHelper

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

Methods inherited from interface google.registry.schema.replay.DatastoreAndSqlEntity
toDatastoreEntity, toSqlEntity

Constructor Detail
- PollMessage
```
public PollMessage()
```

Method Detail

getParentKey

public com.googlecode.objectify.Key<? extends HistoryEntry> getParentKey()

getId
```
public java.lang.Long getId()
```

getClientId
```
public java.lang.String getClientId()
```

getEventTime

public org.joda.time.DateTime getEventTime()

getMsg
```
public java.lang.String getMsg()
```

getResponseData

public abstract com.google.common.collect.ImmutableList<EppResponse.ResponseData> getResponseData()

createVKey
```
public abstract VKey<? extends PollMessage> createVKey()
```
Specified by:

createVKey in interface TransferData.TransferServerApproveEntity

createVKey

public static VKey<PollMessage> createVKey(com.googlecode.objectify.Key<PollMessage> key)

Static VKey factory method for use by VKeyTranslatorFactory.

asBuilder
```
public abstract PollMessage.Builder<?,?> asBuilder()
```
Override Buildable.asBuilder() to give this method stronger typing.

Specified by:

asBuilder in interface Buildable