Package com.sap.ai.sdk.grounding.model

Class BasePipelineResponse

java.lang.Object

com.sap.ai.sdk.grounding.model.BasePipelineResponse

public class BasePipelineResponse
extends Object

BasePipelineResponse

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BasePipelineResponse.Builder	Builder helper class.
static interface	BasePipelineResponse.Builder1	Builder helper class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BasePipelineResponse()	Default constructor for BasePipelineResponse.

Method Summary

Modifier and Type	Method	Description
static BasePipelineResponse.Builder	create()	Create a type-safe, fluent-api builder object to construct a new BasePipelineResponse instance with all required arguments.
boolean	equals(Object o)
Object	getCustomField(String name)	Deprecated. Use toMap() instead.
Set<String>	getCustomFieldNames()	Get the names of the unrecognizable properties of the BasePipelineResponse.
String	getId()	Get id
MetaData	getMetadata()	Get metadata
String	getType()	Get type
int	hashCode()
BasePipelineResponse	id(String id)	Set the id of this BasePipelineResponse instance and return the same instance.
BasePipelineResponse	metadata(MetaData metadata)	Set the metadata of this BasePipelineResponse instance and return the same instance.
void	setCustomField(String customFieldName, Object customFieldValue)	Set an unrecognizable property of this BasePipelineResponse instance.
void	setId(String id)	Set the id of this BasePipelineResponse instance.
void	setMetadata(MetaData metadata)	Set the metadata of this BasePipelineResponse instance.
void	setType(String type)	Set the type of this BasePipelineResponse instance.
Map<String,Object>	toMap()	Get the value of all properties of this BasePipelineResponse instance including unrecognized properties.
String	toString()
BasePipelineResponse	type(String type)	Set the type of this BasePipelineResponse instance and return the same instance.

Methods inherited from class java.lang.Object

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

Constructor Details

BasePipelineResponse

protected BasePipelineResponse()

Default constructor for BasePipelineResponse.

Method Details

id

@Nonnull
public BasePipelineResponse id(@Nonnull
 String id)

Set the id of this BasePipelineResponse instance and return the same instance.

Parameters:

id - The id of this BasePipelineResponse

Returns:

The same instance of this BasePipelineResponse class

getId

@Nonnull
public String getId()

Get id

Returns:

id The id of this BasePipelineResponse instance.

setId

public void setId(@Nonnull
 String id)

Set the id of this BasePipelineResponse instance.

Parameters:

id - The id of this BasePipelineResponse

type

@Nonnull
public BasePipelineResponse type(@Nonnull
 String type)

Set the type of this BasePipelineResponse instance and return the same instance.

Parameters:

type - The type of this BasePipelineResponse

Returns:

The same instance of this BasePipelineResponse class

getType

@Nonnull
public String getType()

Get type

Returns:

type The type of this BasePipelineResponse instance.

setType

public void setType(@Nonnull
 String type)

Set the type of this BasePipelineResponse instance.

Parameters:

type - The type of this BasePipelineResponse

metadata

@Nonnull
public BasePipelineResponse metadata(@Nullable
 MetaData metadata)

Set the metadata of this BasePipelineResponse instance and return the same instance.

Parameters:

metadata - The metadata of this BasePipelineResponse

Returns:

The same instance of this BasePipelineResponse class

getMetadata

@Nonnull
public MetaData getMetadata()

Get metadata

Returns:

metadata The metadata of this BasePipelineResponse instance.

setMetadata

public void setMetadata(@Nullable
 MetaData metadata)

Set the metadata of this BasePipelineResponse instance.

Parameters:

metadata - The metadata of this BasePipelineResponse

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the BasePipelineResponse.

Returns:

The set of properties names

getCustomField

@Nullable
@Deprecated
public Object getCustomField(@Nonnull
 String name)
                      throws NoSuchElementException

Deprecated.

Use toMap() instead.

Get the value of an unrecognizable property of this BasePipelineResponse instance.

Parameters:

name - The name of the property

Returns:

The value of the property

Throws:

NoSuchElementException - If no property with the given name could be found.

toMap

@Nonnull
public Map<String,Object> toMap()

Get the value of all properties of this BasePipelineResponse instance including unrecognized properties.

Returns:

The map of all properties

setCustomField

public void setCustomField(@Nonnull
 String customFieldName,
 @Nullable
 Object customFieldValue)

Set an unrecognizable property of this BasePipelineResponse instance. If the map previously contained a mapping for the key, the old value is replaced by the specified value.

Parameters:

customFieldName - The name of the property

customFieldValue - The value of the property

equals

public boolean equals(@Nullable
 Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

@Nonnull
public String toString()

Overrides:

toString in class Object

create

public static BasePipelineResponse.Builder create()

Create a type-safe, fluent-api builder object to construct a new BasePipelineResponse instance with all required arguments.