Package com.commercetools.api.models.agent

Class AgentResponsesPayloadBuilder

java.lang.Object

com.commercetools.api.models.agent.AgentResponsesPayloadBuilder

All Implemented Interfaces:

Builder<AgentResponsesPayload>

public class AgentResponsesPayloadBuilder
extends Object
implements Builder<AgentResponsesPayload>

AgentResponsesPayloadBuilder Example to create an instance using the builder pattern

     AgentResponsesPayload agentResponsesPayload = AgentResponsesPayload.builder()
             .outputType(AgentResponsesOutputType.CART)
             .locale("{locale}")
             .build()
 

Constructor Summary

Constructors

Constructor	Description
AgentResponsesPayloadBuilder()

Method Summary

Modifier and Type	Method	Description
AgentResponsesPayload	build()	builds AgentResponsesPayload with checking for non-null required values
AgentResponsesPayload	buildUnchecked()	builds AgentResponsesPayload without checking for non-null required values
AgentResponsesPayloadBuilder	businessUnit(BusinessUnitResourceIdentifier businessUnit)	BusinessUnit to use for the request.
AgentResponsesPayloadBuilder	businessUnit(Function<BusinessUnitResourceIdentifierBuilder,BusinessUnitResourceIdentifierBuilder> builder)	BusinessUnit to use for the request.
BusinessUnitResourceIdentifier	getBusinessUnit()	BusinessUnit to use for the request.
String	getLocale()	A valid BCP 47 language tag, for example en-US.
AgentResponsesOutputType	getOutputType()	The entity to create.
String	getPrompt()	Natural-language description of the desired Cart or Quote Request, such as the body of an email or a note.
StoreResourceIdentifier	getStore()	Store to use for the request.
AgentResponsesPayloadBuilder	locale(String locale)	A valid BCP 47 language tag, for example en-US.
static AgentResponsesPayloadBuilder	of()	factory method for an instance of AgentResponsesPayloadBuilder
static AgentResponsesPayloadBuilder	of(AgentResponsesPayload template)	create builder for AgentResponsesPayload instance
AgentResponsesPayloadBuilder	outputType(AgentResponsesOutputType outputType)	The entity to create.
AgentResponsesPayloadBuilder	prompt(String prompt)	Natural-language description of the desired Cart or Quote Request, such as the body of an email or a note.
AgentResponsesPayloadBuilder	store(StoreResourceIdentifier store)	Store to use for the request.
AgentResponsesPayloadBuilder	store(Function<StoreResourceIdentifierBuilder,StoreResourceIdentifierBuilder> builder)	Store to use for the request.
AgentResponsesPayloadBuilder	withBusinessUnit(Function<BusinessUnitResourceIdentifierBuilder,BusinessUnitResourceIdentifier> builder)	BusinessUnit to use for the request.
AgentResponsesPayloadBuilder	withStore(Function<StoreResourceIdentifierBuilder,StoreResourceIdentifier> builder)	Store to use for the request.

Methods inherited from class java.lang.Object

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

Constructor Details

AgentResponsesPayloadBuilder

public AgentResponsesPayloadBuilder()

Method Details

outputType

public AgentResponsesPayloadBuilder outputType(AgentResponsesOutputType outputType)

The entity to create.

Parameters:

outputType - value to be set

Returns:

Builder

locale

public AgentResponsesPayloadBuilder locale(String locale)

A valid BCP 47 language tag, for example en-US.

Parameters:

locale - value to be set

Returns:

Builder

prompt

public AgentResponsesPayloadBuilder prompt(@Nullable
 String prompt)

Natural-language description of the desired Cart or Quote Request, such as the body of an email or a note. Required if no file is attached.

Parameters:

prompt - value to be set

Returns:

Builder

businessUnit

public AgentResponsesPayloadBuilder businessUnit(Function<BusinessUnitResourceIdentifierBuilder,BusinessUnitResourceIdentifierBuilder> builder)

BusinessUnit to use for the request. If omitted, the Intake Agent resolves it from the input.

Parameters:

builder - function to build the businessUnit value

Returns:

Builder

withBusinessUnit

public AgentResponsesPayloadBuilder withBusinessUnit(Function<BusinessUnitResourceIdentifierBuilder,BusinessUnitResourceIdentifier> builder)

BusinessUnit to use for the request. If omitted, the Intake Agent resolves it from the input.

Parameters:

builder - function to build the businessUnit value

Returns:

Builder

businessUnit

public AgentResponsesPayloadBuilder businessUnit(@Nullable
 BusinessUnitResourceIdentifier businessUnit)

BusinessUnit to use for the request. If omitted, the Intake Agent resolves it from the input.

Parameters:

businessUnit - value to be set

Returns:

Builder

store

public AgentResponsesPayloadBuilder store(Function<StoreResourceIdentifierBuilder,StoreResourceIdentifierBuilder> builder)

Store to use for the request. If omitted, the Intake Agent resolves it from the input.

Parameters:

builder - function to build the store value

Returns:

Builder

withStore

public AgentResponsesPayloadBuilder withStore(Function<StoreResourceIdentifierBuilder,StoreResourceIdentifier> builder)

Store to use for the request. If omitted, the Intake Agent resolves it from the input.

Parameters:

builder - function to build the store value

Returns:

Builder

store

public AgentResponsesPayloadBuilder store(@Nullable
 StoreResourceIdentifier store)

Store to use for the request. If omitted, the Intake Agent resolves it from the input.

Parameters:

store - value to be set

Returns:

Builder

getOutputType

public AgentResponsesOutputType getOutputType()

The entity to create.

Returns:

outputType

getLocale

public String getLocale()

A valid BCP 47 language tag, for example en-US.

Returns:

locale

getPrompt

@Nullable
public String getPrompt()

Natural-language description of the desired Cart or Quote Request, such as the body of an email or a note. Required if no file is attached.

Returns:

prompt

getBusinessUnit

@Nullable
public BusinessUnitResourceIdentifier getBusinessUnit()

BusinessUnit to use for the request. If omitted, the Intake Agent resolves it from the input.

Returns:

businessUnit

getStore

@Nullable
public StoreResourceIdentifier getStore()

Store to use for the request. If omitted, the Intake Agent resolves it from the input.

Returns:

store

build

public AgentResponsesPayload build()

builds AgentResponsesPayload with checking for non-null required values

Specified by:

build in interface Builder<AgentResponsesPayload>

Returns:

AgentResponsesPayload

buildUnchecked

public AgentResponsesPayload buildUnchecked()

builds AgentResponsesPayload without checking for non-null required values

Returns:

AgentResponsesPayload

of

public static AgentResponsesPayloadBuilder of()

factory method for an instance of AgentResponsesPayloadBuilder

Returns:

builder

of

public static AgentResponsesPayloadBuilder of(AgentResponsesPayload template)

create builder for AgentResponsesPayload instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder