io.sphere.sdk.subscriptions

Interface Subscription

All Superinterfaces:

CreationTimestamped, Identifiable<Subscription>, Referenceable<Subscription>, Resource<Subscription>, ResourceIdentifiable<Subscription>, ResourceView<Subscription,Subscription>, Timestamped, Versioned<Subscription>, WithKey

public interface Subscription
extends Resource<Subscription>, WithKey

Method Summary

Modifier and Type	Method and Description
List<ChangeSubscription>	getChanges()
Destination	getDestination()
String	getKey()
List<MessageSubscription>	getMessages()
SubscriptionHealthStatus	getStatus()
static Reference<Subscription>	referenceOfId(String id) Creates a reference for one item of this class by a known ID.
static String	referenceTypeId() A type hint for references which resource type is linked in a reference.
static String	resourceTypeId() An identifier for this resource which supports CustomFields.
default Reference<Subscription>	toReference() Creates a reference to this resource, the reference may not be filled.
static com.fasterxml.jackson.core.type.TypeReference<Subscription>	typeReference() Creates a container which contains the full Java type information to deserialize this class from JSON.

Methods inherited from interface io.sphere.sdk.models.Resource

getCreatedAt, getId, getLastModifiedAt, getVersion

Methods inherited from interface io.sphere.sdk.models.Versioned

of, of

Methods inherited from interface io.sphere.sdk.models.Referenceable

hasSameIdAs, toResourceIdentifier

Method Detail

getKey

@Nullable
String getKey()

Specified by:

getKey in interface WithKey

getDestination

Destination getDestination()

getMessages

List<MessageSubscription> getMessages()

getChanges

List<ChangeSubscription> getChanges()

getStatus

SubscriptionHealthStatus getStatus()

typeReference

static com.fasterxml.jackson.core.type.TypeReference<Subscription> typeReference()

Creates a container which contains the full Java type information to deserialize this class from JSON.

Returns:

type reference

See Also:

SphereJsonUtils.readObject(byte[], TypeReference), SphereJsonUtils.readObject(String, TypeReference), SphereJsonUtils.readObject(com.fasterxml.jackson.databind.JsonNode, TypeReference), SphereJsonUtils.readObjectFromResource(String, TypeReference)

referenceOfId

static Reference<Subscription> referenceOfId(String id)

Creates a reference for one item of this class by a known ID.

An example for categories but this applies for other resources, too:

final String categoryIdFromFormOrSession = "84ac4271-0fec-49d0-9fee-55586c565c58";
final Reference<Category> categoryReference = Category.referenceOfId(categoryIdFromFormOrSession);
assertThat(categoryReference.getId()).isEqualTo(categoryIdFromFormOrSession);
See the test code.

If you already have a resource object, then use toReference() instead:

final Category category = getCategory1();
final Reference<Category> categoryReference = category.toReference();
assertThat(category.getId()).isEqualTo(categoryReference.getId());
See the test code.

Parameters:

id - the ID of the resource which should be referenced.

Returns:

reference

referenceTypeId

static String referenceTypeId()

A type hint for references which resource type is linked in a reference.

Returns:

type hint

See Also:

Reference.getTypeId()

resourceTypeId

static String resourceTypeId()

An identifier for this resource which supports CustomFields.

Returns:

ID of this resource type

See Also:

TypeDraft.getResourceTypeIds(), Custom

toReference

default Reference<Subscription> toReference()

Description copied from interface: Referenceable

Creates a reference to this resource, the reference may not be filled.

Specified by:

toReference in interface Referenceable<Subscription>

Specified by:

toReference in interface Resource<Subscription>

Returns:

reference