com.amazonaws.services.bedrock.model

Class FoundationModelSummary

java.lang.Object

com.amazonaws.services.bedrock.model.FoundationModelSummary

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class FoundationModelSummary
extends Object
implements Serializable, Cloneable, StructuredPojo

Summary information for a foundation model.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
FoundationModelSummary()

Method Summary

Modifier and Type	Method and Description
FoundationModelSummary	clone()
boolean	equals(Object obj)
List<String>	getCustomizationsSupported() Whether the model supports fine-tuning or continual pre-training.
List<String>	getInferenceTypesSupported() The inference types that the model supports.
List<String>	getInputModalities() The input modalities that the model supports.
String	getModelArn() The ARN of the foundation model.
String	getModelId() The model Id of the foundation model.
FoundationModelLifecycle	getModelLifecycle() Contains details about whether a model version is available or deprecated.
String	getModelName() The name of the model.
List<String>	getOutputModalities() The output modalities that the model supports.
String	getProviderName() The model's provider name.
Boolean	getResponseStreamingSupported() Indicates whether the model supports streaming.
int	hashCode()
Boolean	isResponseStreamingSupported() Indicates whether the model supports streaming.
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setCustomizationsSupported(Collection<String> customizationsSupported) Whether the model supports fine-tuning or continual pre-training.
void	setInferenceTypesSupported(Collection<String> inferenceTypesSupported) The inference types that the model supports.
void	setInputModalities(Collection<String> inputModalities) The input modalities that the model supports.
void	setModelArn(String modelArn) The ARN of the foundation model.
void	setModelId(String modelId) The model Id of the foundation model.
void	setModelLifecycle(FoundationModelLifecycle modelLifecycle) Contains details about whether a model version is available or deprecated.
void	setModelName(String modelName) The name of the model.
void	setOutputModalities(Collection<String> outputModalities) The output modalities that the model supports.
void	setProviderName(String providerName) The model's provider name.
void	setResponseStreamingSupported(Boolean responseStreamingSupported) Indicates whether the model supports streaming.
String	toString() Returns a string representation of this object.
FoundationModelSummary	withCustomizationsSupported(Collection<String> customizationsSupported) Whether the model supports fine-tuning or continual pre-training.
FoundationModelSummary	withCustomizationsSupported(ModelCustomization... customizationsSupported) Whether the model supports fine-tuning or continual pre-training.
FoundationModelSummary	withCustomizationsSupported(String... customizationsSupported) Whether the model supports fine-tuning or continual pre-training.
FoundationModelSummary	withInferenceTypesSupported(Collection<String> inferenceTypesSupported) The inference types that the model supports.
FoundationModelSummary	withInferenceTypesSupported(InferenceType... inferenceTypesSupported) The inference types that the model supports.
FoundationModelSummary	withInferenceTypesSupported(String... inferenceTypesSupported) The inference types that the model supports.
FoundationModelSummary	withInputModalities(Collection<String> inputModalities) The input modalities that the model supports.
FoundationModelSummary	withInputModalities(ModelModality... inputModalities) The input modalities that the model supports.
FoundationModelSummary	withInputModalities(String... inputModalities) The input modalities that the model supports.
FoundationModelSummary	withModelArn(String modelArn) The ARN of the foundation model.
FoundationModelSummary	withModelId(String modelId) The model Id of the foundation model.
FoundationModelSummary	withModelLifecycle(FoundationModelLifecycle modelLifecycle) Contains details about whether a model version is available or deprecated.
FoundationModelSummary	withModelName(String modelName) The name of the model.
FoundationModelSummary	withOutputModalities(Collection<String> outputModalities) The output modalities that the model supports.
FoundationModelSummary	withOutputModalities(ModelModality... outputModalities) The output modalities that the model supports.
FoundationModelSummary	withOutputModalities(String... outputModalities) The output modalities that the model supports.
FoundationModelSummary	withProviderName(String providerName) The model's provider name.
FoundationModelSummary	withResponseStreamingSupported(Boolean responseStreamingSupported) Indicates whether the model supports streaming.

Methods inherited from class java.lang.Object

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

Constructor Detail

FoundationModelSummary

public FoundationModelSummary()

Method Detail

setModelArn

public void setModelArn(String modelArn)

The ARN of the foundation model.

Parameters:

modelArn - The ARN of the foundation model.

getModelArn

public String getModelArn()

The ARN of the foundation model.

Returns:

The ARN of the foundation model.

withModelArn

public FoundationModelSummary withModelArn(String modelArn)

The ARN of the foundation model.

Parameters:

modelArn - The ARN of the foundation model.

Returns:

Returns a reference to this object so that method calls can be chained together.

setModelId

public void setModelId(String modelId)

The model Id of the foundation model.

Parameters:

modelId - The model Id of the foundation model.

getModelId

public String getModelId()

The model Id of the foundation model.

Returns:

The model Id of the foundation model.

withModelId

public FoundationModelSummary withModelId(String modelId)

The model Id of the foundation model.

Parameters:

modelId - The model Id of the foundation model.

Returns:

Returns a reference to this object so that method calls can be chained together.

setModelName

public void setModelName(String modelName)

The name of the model.

Parameters:

modelName - The name of the model.

getModelName

public String getModelName()

The name of the model.

Returns:

The name of the model.

withModelName

public FoundationModelSummary withModelName(String modelName)

The name of the model.

Parameters:

modelName - The name of the model.

Returns:

Returns a reference to this object so that method calls can be chained together.

setProviderName

public void setProviderName(String providerName)

The model's provider name.

Parameters:

providerName - The model's provider name.

getProviderName

public String getProviderName()

The model's provider name.

Returns:

The model's provider name.

withProviderName

public FoundationModelSummary withProviderName(String providerName)

The model's provider name.

Parameters:

providerName - The model's provider name.

Returns:

Returns a reference to this object so that method calls can be chained together.

getInputModalities

public List<String> getInputModalities()

The input modalities that the model supports.

Returns:

The input modalities that the model supports.

See Also:

ModelModality

setInputModalities

public void setInputModalities(Collection<String> inputModalities)

The input modalities that the model supports.

Parameters:

inputModalities - The input modalities that the model supports.

See Also:

ModelModality

withInputModalities

public FoundationModelSummary withInputModalities(String... inputModalities)

The input modalities that the model supports.

NOTE: This method appends the values to the existing list (if any). Use setInputModalities(java.util.Collection) or withInputModalities(java.util.Collection) if you want to override the existing values.

Parameters:

inputModalities - The input modalities that the model supports.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ModelModality

withInputModalities

public FoundationModelSummary withInputModalities(Collection<String> inputModalities)

The input modalities that the model supports.

Parameters:

inputModalities - The input modalities that the model supports.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ModelModality

withInputModalities

public FoundationModelSummary withInputModalities(ModelModality... inputModalities)

The input modalities that the model supports.

Parameters:

inputModalities - The input modalities that the model supports.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ModelModality

getOutputModalities

public List<String> getOutputModalities()

The output modalities that the model supports.

Returns:

The output modalities that the model supports.

See Also:

ModelModality

setOutputModalities

public void setOutputModalities(Collection<String> outputModalities)

The output modalities that the model supports.

Parameters:

outputModalities - The output modalities that the model supports.

See Also:

ModelModality

withOutputModalities

public FoundationModelSummary withOutputModalities(String... outputModalities)

The output modalities that the model supports.

NOTE: This method appends the values to the existing list (if any). Use setOutputModalities(java.util.Collection) or withOutputModalities(java.util.Collection) if you want to override the existing values.

Parameters:

outputModalities - The output modalities that the model supports.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ModelModality

withOutputModalities

public FoundationModelSummary withOutputModalities(Collection<String> outputModalities)

The output modalities that the model supports.

Parameters:

outputModalities - The output modalities that the model supports.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ModelModality

withOutputModalities

public FoundationModelSummary withOutputModalities(ModelModality... outputModalities)

The output modalities that the model supports.

Parameters:

outputModalities - The output modalities that the model supports.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ModelModality

setResponseStreamingSupported

public void setResponseStreamingSupported(Boolean responseStreamingSupported)

Indicates whether the model supports streaming.

Parameters:

responseStreamingSupported - Indicates whether the model supports streaming.

getResponseStreamingSupported

public Boolean getResponseStreamingSupported()

Indicates whether the model supports streaming.

Returns:

Indicates whether the model supports streaming.

withResponseStreamingSupported

public FoundationModelSummary withResponseStreamingSupported(Boolean responseStreamingSupported)

Indicates whether the model supports streaming.

Parameters:

responseStreamingSupported - Indicates whether the model supports streaming.

Returns:

Returns a reference to this object so that method calls can be chained together.

isResponseStreamingSupported

public Boolean isResponseStreamingSupported()

Indicates whether the model supports streaming.

Returns:

Indicates whether the model supports streaming.

getCustomizationsSupported

public List<String> getCustomizationsSupported()

Whether the model supports fine-tuning or continual pre-training.

Returns:

Whether the model supports fine-tuning or continual pre-training.

See Also:

ModelCustomization

setCustomizationsSupported

public void setCustomizationsSupported(Collection<String> customizationsSupported)

Whether the model supports fine-tuning or continual pre-training.

Parameters:

customizationsSupported - Whether the model supports fine-tuning or continual pre-training.

See Also:

ModelCustomization

withCustomizationsSupported

public FoundationModelSummary withCustomizationsSupported(String... customizationsSupported)

Whether the model supports fine-tuning or continual pre-training.

NOTE: This method appends the values to the existing list (if any). Use setCustomizationsSupported(java.util.Collection) or withCustomizationsSupported(java.util.Collection) if you want to override the existing values.

Parameters:

customizationsSupported - Whether the model supports fine-tuning or continual pre-training.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ModelCustomization

withCustomizationsSupported

public FoundationModelSummary withCustomizationsSupported(Collection<String> customizationsSupported)

Whether the model supports fine-tuning or continual pre-training.

Parameters:

customizationsSupported - Whether the model supports fine-tuning or continual pre-training.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ModelCustomization

withCustomizationsSupported

public FoundationModelSummary withCustomizationsSupported(ModelCustomization... customizationsSupported)

Whether the model supports fine-tuning or continual pre-training.

Parameters:

customizationsSupported - Whether the model supports fine-tuning or continual pre-training.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ModelCustomization

getInferenceTypesSupported

public List<String> getInferenceTypesSupported()

The inference types that the model supports.

Returns:

The inference types that the model supports.

See Also:

InferenceType

setInferenceTypesSupported

public void setInferenceTypesSupported(Collection<String> inferenceTypesSupported)

The inference types that the model supports.

Parameters:

inferenceTypesSupported - The inference types that the model supports.

See Also:

InferenceType

withInferenceTypesSupported

public FoundationModelSummary withInferenceTypesSupported(String... inferenceTypesSupported)

The inference types that the model supports.

NOTE: This method appends the values to the existing list (if any). Use setInferenceTypesSupported(java.util.Collection) or withInferenceTypesSupported(java.util.Collection) if you want to override the existing values.

Parameters:

inferenceTypesSupported - The inference types that the model supports.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

InferenceType

withInferenceTypesSupported

public FoundationModelSummary withInferenceTypesSupported(Collection<String> inferenceTypesSupported)

The inference types that the model supports.

Parameters:

inferenceTypesSupported - The inference types that the model supports.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

InferenceType

withInferenceTypesSupported

public FoundationModelSummary withInferenceTypesSupported(InferenceType... inferenceTypesSupported)

The inference types that the model supports.

Parameters:

inferenceTypesSupported - The inference types that the model supports.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

InferenceType

setModelLifecycle

public void setModelLifecycle(FoundationModelLifecycle modelLifecycle)

Contains details about whether a model version is available or deprecated.

Parameters:

modelLifecycle - Contains details about whether a model version is available or deprecated.

getModelLifecycle

public FoundationModelLifecycle getModelLifecycle()

Contains details about whether a model version is available or deprecated.

Returns:

Contains details about whether a model version is available or deprecated.

withModelLifecycle

public FoundationModelSummary withModelLifecycle(FoundationModelLifecycle modelLifecycle)

Contains details about whether a model version is available or deprecated.

Parameters:

modelLifecycle - Contains details about whether a model version is available or deprecated.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public FoundationModelSummary clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo