Package com.commercetools.api.models.subscription

Class SubscriptionDraftBuilder

java.lang.Object

com.commercetools.api.models.subscription.SubscriptionDraftBuilder

All Implemented Interfaces:

Builder<SubscriptionDraft>

public class SubscriptionDraftBuilder
extends Object
implements Builder<SubscriptionDraft>

SubscriptionDraftBuilder Example to create an instance using the builder pattern

     SubscriptionDraft subscriptionDraft = SubscriptionDraft.builder()
             .destination(destinationBuilder -> destinationBuilder)
             .build()
 

Constructor Summary

Constructors

Constructor	Description
SubscriptionDraftBuilder()

Method Summary

Modifier and Type	Method	Description
SubscriptionDraftBuilder	addChanges(Function<ChangeSubscriptionBuilder,ChangeSubscription> builder)	Change notifications to be subscribed to.
SubscriptionDraftBuilder	addMessages(Function<MessageSubscriptionBuilder,MessageSubscription> builder)	Messages to be subscribed to.
SubscriptionDraft	build()	builds SubscriptionDraft with checking for non-null required values
SubscriptionDraft	buildUnchecked()	builds SubscriptionDraft without checking for non-null required values
SubscriptionDraftBuilder	changes(ChangeSubscription... changes)	Change notifications to be subscribed to.
SubscriptionDraftBuilder	changes(List<ChangeSubscription> changes)	Change notifications to be subscribed to.
SubscriptionDraftBuilder	destination(Destination destination)	Messaging service to which the messages are sent.
SubscriptionDraftBuilder	destination(Function<DestinationBuilder,Builder<? extends Destination>> builder)	Messaging service to which the messages are sent.
SubscriptionDraftBuilder	format(DeliveryFormat format)	Format in which the payload is delivered.
SubscriptionDraftBuilder	format(Function<DeliveryFormatBuilder,Builder<? extends DeliveryFormat>> builder)	Format in which the payload is delivered.
List<ChangeSubscription>	getChanges()	Change notifications to be subscribed to.
Destination	getDestination()	Messaging service to which the messages are sent.
DeliveryFormat	getFormat()	Format in which the payload is delivered.
String	getKey()	User-defined unique identifier for the Subscription.
List<MessageSubscription>	getMessages()	Messages to be subscribed to.
SubscriptionDraftBuilder	key(String key)	User-defined unique identifier for the Subscription.
SubscriptionDraftBuilder	messages(MessageSubscription... messages)	Messages to be subscribed to.
SubscriptionDraftBuilder	messages(List<MessageSubscription> messages)	Messages to be subscribed to.
static SubscriptionDraftBuilder	of()	factory method for an instance of SubscriptionDraftBuilder
static SubscriptionDraftBuilder	of(SubscriptionDraft template)	create builder for SubscriptionDraft instance
SubscriptionDraftBuilder	plusChanges(ChangeSubscription... changes)	Change notifications to be subscribed to.
SubscriptionDraftBuilder	plusChanges(Function<ChangeSubscriptionBuilder,ChangeSubscriptionBuilder> builder)	Change notifications to be subscribed to.
SubscriptionDraftBuilder	plusMessages(MessageSubscription... messages)	Messages to be subscribed to.
SubscriptionDraftBuilder	plusMessages(Function<MessageSubscriptionBuilder,MessageSubscriptionBuilder> builder)	Messages to be subscribed to.
SubscriptionDraftBuilder	setChanges(Function<ChangeSubscriptionBuilder,ChangeSubscription> builder)	Change notifications to be subscribed to.
SubscriptionDraftBuilder	setMessages(Function<MessageSubscriptionBuilder,MessageSubscription> builder)	Messages to be subscribed to.
SubscriptionDraftBuilder	withChanges(Function<ChangeSubscriptionBuilder,ChangeSubscriptionBuilder> builder)	Change notifications to be subscribed to.
SubscriptionDraftBuilder	withMessages(Function<MessageSubscriptionBuilder,MessageSubscriptionBuilder> builder)	Messages to be subscribed to.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SubscriptionDraftBuilder

public SubscriptionDraftBuilder()

Method Details

changes

public SubscriptionDraftBuilder changes(@Nullable
 ChangeSubscription... changes)

Change notifications to be subscribed to.

Parameters:

changes - value to be set

Returns:

Builder

changes

public SubscriptionDraftBuilder changes(@Nullable
 List<ChangeSubscription> changes)

Change notifications to be subscribed to.

Parameters:

changes - value to be set

Returns:

Builder

plusChanges

public SubscriptionDraftBuilder plusChanges(@Nullable
 ChangeSubscription... changes)

Change notifications to be subscribed to.

Parameters:

changes - value to be set

Returns:

Builder

plusChanges

public SubscriptionDraftBuilder plusChanges(Function<ChangeSubscriptionBuilder,ChangeSubscriptionBuilder> builder)

Change notifications to be subscribed to.

Parameters:

builder - function to build the changes value

Returns:

Builder

withChanges

public SubscriptionDraftBuilder withChanges(Function<ChangeSubscriptionBuilder,ChangeSubscriptionBuilder> builder)

Change notifications to be subscribed to.

Parameters:

builder - function to build the changes value

Returns:

Builder

addChanges

public SubscriptionDraftBuilder addChanges(Function<ChangeSubscriptionBuilder,ChangeSubscription> builder)

Change notifications to be subscribed to.

Parameters:

builder - function to build the changes value

Returns:

Builder

setChanges

public SubscriptionDraftBuilder setChanges(Function<ChangeSubscriptionBuilder,ChangeSubscription> builder)

Change notifications to be subscribed to.

Parameters:

builder - function to build the changes value

Returns:

Builder

destination

public SubscriptionDraftBuilder destination(Destination destination)

Messaging service to which the messages are sent.

Parameters:

destination - value to be set

Returns:

Builder

destination

public SubscriptionDraftBuilder destination(Function<DestinationBuilder,Builder<? extends Destination>> builder)

Messaging service to which the messages are sent.

Parameters:

builder - function to build the destination value

Returns:

Builder

key

public SubscriptionDraftBuilder key(@Nullable
 String key)

User-defined unique identifier for the Subscription.

Parameters:

key - value to be set

Returns:

Builder

messages

public SubscriptionDraftBuilder messages(@Nullable
 MessageSubscription... messages)

Messages to be subscribed to.

Parameters:

messages - value to be set

Returns:

Builder

messages

public SubscriptionDraftBuilder messages(@Nullable
 List<MessageSubscription> messages)

Messages to be subscribed to.

Parameters:

messages - value to be set

Returns:

Builder

plusMessages

public SubscriptionDraftBuilder plusMessages(@Nullable
 MessageSubscription... messages)

Messages to be subscribed to.

Parameters:

messages - value to be set

Returns:

Builder

plusMessages

public SubscriptionDraftBuilder plusMessages(Function<MessageSubscriptionBuilder,MessageSubscriptionBuilder> builder)

Messages to be subscribed to.

Parameters:

builder - function to build the messages value

Returns:

Builder

withMessages

public SubscriptionDraftBuilder withMessages(Function<MessageSubscriptionBuilder,MessageSubscriptionBuilder> builder)

Messages to be subscribed to.

Parameters:

builder - function to build the messages value

Returns:

Builder

addMessages

public SubscriptionDraftBuilder addMessages(Function<MessageSubscriptionBuilder,MessageSubscription> builder)

Messages to be subscribed to.

Parameters:

builder - function to build the messages value

Returns:

Builder

setMessages

public SubscriptionDraftBuilder setMessages(Function<MessageSubscriptionBuilder,MessageSubscription> builder)

Messages to be subscribed to.

Parameters:

builder - function to build the messages value

Returns:

Builder

format

public SubscriptionDraftBuilder format(@Nullable
 DeliveryFormat format)

Format in which the payload is delivered. When not provided, the PlatformFormat is selected by default.

Parameters:

format - value to be set

Returns:

Builder

format

public SubscriptionDraftBuilder format(Function<DeliveryFormatBuilder,Builder<? extends DeliveryFormat>> builder)

Format in which the payload is delivered. When not provided, the PlatformFormat is selected by default.

Parameters:

builder - function to build the format value

Returns:

Builder

getChanges

@Nullable
public List<ChangeSubscription> getChanges()

Change notifications to be subscribed to.

Returns:

changes

getDestination

public Destination getDestination()

Messaging service to which the messages are sent.

Returns:

destination

getKey

@Nullable
public String getKey()

User-defined unique identifier for the Subscription.

Returns:

key

getMessages

@Nullable
public List<MessageSubscription> getMessages()

Messages to be subscribed to.

Returns:

messages

getFormat

@Nullable
public DeliveryFormat getFormat()

Format in which the payload is delivered. When not provided, the PlatformFormat is selected by default.

Returns:

format

build

public SubscriptionDraft build()

builds SubscriptionDraft with checking for non-null required values

Specified by:

build in interface Builder<SubscriptionDraft>

Returns:

SubscriptionDraft

buildUnchecked

public SubscriptionDraft buildUnchecked()

builds SubscriptionDraft without checking for non-null required values

Returns:

SubscriptionDraft

of

public static SubscriptionDraftBuilder of()

factory method for an instance of SubscriptionDraftBuilder

Returns:

builder

of

public static SubscriptionDraftBuilder of(SubscriptionDraft template)

create builder for SubscriptionDraft instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder