org.eclipse.ditto.signals.events.things

Class PolicyIdCreated

java.lang.Object

org.eclipse.ditto.signals.events.things.AbstractThingEvent<PolicyIdCreated>

org.eclipse.ditto.signals.events.things.PolicyIdCreated

All Implemented Interfaces:

org.eclipse.ditto.model.base.headers.WithDittoHeaders<PolicyIdCreated>, org.eclipse.ditto.model.base.headers.WithManifest, org.eclipse.ditto.model.base.json.Jsonifiable<org.eclipse.ditto.json.JsonObject>, org.eclipse.ditto.model.base.json.Jsonifiable.WithPredicate<org.eclipse.ditto.json.JsonObject,org.eclipse.ditto.json.JsonField>, org.eclipse.ditto.signals.base.Signal<PolicyIdCreated>, org.eclipse.ditto.signals.base.WithId, org.eclipse.ditto.signals.base.WithName, org.eclipse.ditto.signals.base.WithOptionalEntity, org.eclipse.ditto.signals.base.WithResource, org.eclipse.ditto.signals.base.WithThingId, org.eclipse.ditto.signals.base.WithType, org.eclipse.ditto.signals.events.base.Event<PolicyIdCreated>, ThingEvent<PolicyIdCreated>, ThingModifiedEvent<PolicyIdCreated>

@Immutable
public final class PolicyIdCreated
extends AbstractThingEvent<PolicyIdCreated>
implements ThingModifiedEvent<PolicyIdCreated>

This event is emitted after a Thing's policyId was created (e.g. before it was in v1 with ACL, so setting a Policy ID will create the Policy ID).

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.ditto.signals.events.things.ThingEvent

ThingEvent.JsonFields

Nested classes/interfaces inherited from interface org.eclipse.ditto.model.base.json.Jsonifiable

org.eclipse.ditto.model.base.json.Jsonifiable.WithFieldSelector, org.eclipse.ditto.model.base.json.Jsonifiable.WithFieldSelectorAndPredicate<T>, org.eclipse.ditto.model.base.json.Jsonifiable.WithPointer<J extends org.eclipse.ditto.json.JsonValue>, org.eclipse.ditto.model.base.json.Jsonifiable.WithPredicate<J extends org.eclipse.ditto.json.JsonValue,T>

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME Name of this event.
static String	TYPE Type of this event.

Fields inherited from interface org.eclipse.ditto.signals.events.things.ThingEvent

RESOURCE_TYPE, TYPE_PREFIX

Fields inherited from interface org.eclipse.ditto.signals.events.base.Event

DEFAULT_REVISION, TYPE_QUALIFIER

Method Summary

Modifier and Type	Method and Description
protected void	appendPayloadAndBuild(org.eclipse.ditto.json.JsonObjectBuilder jsonObjectBuilder, org.eclipse.ditto.model.base.json.JsonSchemaVersion schemaVersion, Predicate<org.eclipse.ditto.json.JsonField> predicate) Appends the event specific custom payload to the passed jsonObjectBuilder.
protected boolean	canEqual(Object other)
boolean	equals(Object o)
static PolicyIdCreated	fromJson(org.eclipse.ditto.json.JsonObject jsonObject, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders) Creates a new PolicyIdCreated from a JSON object.
static PolicyIdCreated	fromJson(String jsonString, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders) Creates a new PolicyIdCreated from a JSON string.
Optional<org.eclipse.ditto.json.JsonValue>	getEntity(org.eclipse.ditto.model.base.json.JsonSchemaVersion schemaVersion)
String	getPolicyId() Returns the created Policy ID.
org.eclipse.ditto.json.JsonPointer	getResourcePath()
int	hashCode()
static PolicyIdCreated	of(String thingId, String policyId, long revision, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders) Creates a new PolicyIdCreated object.
static PolicyIdCreated	of(String thingId, String policyId, long revision, Instant timestamp, org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders) Creates a new PolicyIdCreated object.
PolicyIdCreated	setDittoHeaders(org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)
PolicyIdCreated	setRevision(long revision)
String	toString()

Methods inherited from class org.eclipse.ditto.signals.events.things.AbstractThingEvent

getDittoHeaders, getManifest, getRevision, getThingId, getTimestamp, getType, toJson

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.ditto.signals.events.things.ThingEvent

getId, getResourceType, getThingId

Methods inherited from interface org.eclipse.ditto.signals.events.base.Event

getImplementedSchemaVersion, getRevision, getTimestamp, getType, toJson

Methods inherited from interface org.eclipse.ditto.signals.base.Signal

getName

Methods inherited from interface org.eclipse.ditto.model.base.json.Jsonifiable.WithPredicate

toJson, toJson, toJsonString, toJsonString

Methods inherited from interface org.eclipse.ditto.model.base.json.Jsonifiable

getLatestSchemaVersion, getSupportedSchemaVersions, implementsSchemaVersion, implementsSchemaVersion, toJsonString

Methods inherited from interface org.eclipse.ditto.model.base.headers.WithDittoHeaders

getDittoHeaders

Methods inherited from interface org.eclipse.ditto.model.base.headers.WithManifest

getManifest

Methods inherited from interface org.eclipse.ditto.signals.base.WithOptionalEntity

getEntity

Field Detail

NAME

public static final String NAME

Name of this event.

See Also:

Constant Field Values

TYPE

public static final String TYPE

Type of this event.

See Also:

Constant Field Values

Method Detail

of

public static PolicyIdCreated of(String thingId,
                                 String policyId,
                                 long revision,
                                 org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)

Creates a new PolicyIdCreated object.

Parameters:

thingId - the ID of the Thing with which this event is associated.

policyId - the ID of the Policy.

revision - the revision of the Thing.

dittoHeaders - the headers of the command which was the cause of this event.

Returns:

the PolicyIdCreated

Throws:

NullPointerException - if thingId, revision or dittoHeaders are null.

of

public static PolicyIdCreated of(String thingId,
                                 String policyId,
                                 long revision,
                                 @Nullable
                                 Instant timestamp,
                                 org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)

Creates a new PolicyIdCreated object.

Parameters:

thingId - the ID of the Thing with which this event is associated.

policyId - the ID of the Policy.

revision - the revision of the Thing.

timestamp - the timestamp of this event.

dittoHeaders - the headers of the command which was the cause of this event.

Returns:

the PolicyIdCreated

Throws:

NullPointerException - if thingId, revision or dittoHeaders are null.

fromJson

public static PolicyIdCreated fromJson(String jsonString,
                                       org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)

Creates a new PolicyIdCreated from a JSON string.

Parameters:

jsonString - the JSON string of which a new PolicyIdCreated instance is to be created.

dittoHeaders - the headers of the command which was the cause of this event.

Returns:

the PolicyIdCreated which was created from the given JSON string.

Throws:

NullPointerException - if jsonString is null.

IllegalArgumentException - if jsonString is empty.

org.eclipse.ditto.json.JsonParseException - if the passed in jsonString was not in the expected 'PolicyIdCreated' format.

fromJson

public static PolicyIdCreated fromJson(org.eclipse.ditto.json.JsonObject jsonObject,
                                       org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)

Creates a new PolicyIdCreated from a JSON object.

Parameters:

jsonObject - the JSON object from which a new PolicyIdCreated instance is to be created.

dittoHeaders - the headers of the command which was the cause of this event.

Returns:

the PolicyIdCreated which was created from the given JSON object.

Throws:

NullPointerException - if jsonObject is null.

org.eclipse.ditto.json.JsonParseException - if the passed in jsonObject was not in the expected 'PolicyIdCreated' format.

getPolicyId

public String getPolicyId()

Returns the created Policy ID.

Returns:

the created Policy ID.

getEntity

public Optional<org.eclipse.ditto.json.JsonValue> getEntity(org.eclipse.ditto.model.base.json.JsonSchemaVersion schemaVersion)

Specified by:

getEntity in interface org.eclipse.ditto.signals.base.WithOptionalEntity

getResourcePath

public org.eclipse.ditto.json.JsonPointer getResourcePath()

Specified by:

getResourcePath in interface org.eclipse.ditto.signals.base.WithResource

setRevision

public PolicyIdCreated setRevision(long revision)

Specified by:

setRevision in interface org.eclipse.ditto.signals.events.base.Event<PolicyIdCreated>

setDittoHeaders

public PolicyIdCreated setDittoHeaders(org.eclipse.ditto.model.base.headers.DittoHeaders dittoHeaders)

Specified by:

setDittoHeaders in interface org.eclipse.ditto.model.base.headers.WithDittoHeaders<PolicyIdCreated>

Specified by:

setDittoHeaders in interface ThingEvent<PolicyIdCreated>

Specified by:

setDittoHeaders in interface ThingModifiedEvent<PolicyIdCreated>

appendPayloadAndBuild

protected void appendPayloadAndBuild(org.eclipse.ditto.json.JsonObjectBuilder jsonObjectBuilder,
                                     org.eclipse.ditto.model.base.json.JsonSchemaVersion schemaVersion,
                                     Predicate<org.eclipse.ditto.json.JsonField> predicate)

Description copied from class: AbstractThingEvent

Appends the event specific custom payload to the passed jsonObjectBuilder.

Specified by:

appendPayloadAndBuild in class AbstractThingEvent<PolicyIdCreated>

Parameters:

jsonObjectBuilder - the JsonObjectBuilder to add the custom payload to.

schemaVersion - the JsonSchemaVersion used in toJson().

predicate - the predicate to evaluate when adding the payload.

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractThingEvent<PolicyIdCreated>

equals

public boolean equals(@Nullable
                      Object o)

Overrides:

equals in class AbstractThingEvent<PolicyIdCreated>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class AbstractThingEvent<PolicyIdCreated>

toString

public String toString()

Overrides:

toString in class AbstractThingEvent<PolicyIdCreated>