Class ListFoundationModelsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.bedrock.model.BedrockRequest

software.amazon.awssdk.services.bedrock.model.ListFoundationModelsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListFoundationModelsRequest.Builder,ListFoundationModelsRequest>

@Generated("software.amazon.awssdk:codegen")
public final class ListFoundationModelsRequest
extends BedrockRequest
implements ToCopyableBuilder<ListFoundationModelsRequest.Builder,ListFoundationModelsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListFoundationModelsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListFoundationModelsRequest.Builder	builder()
final ModelCustomization	byCustomizationType()	Return models that support the customization type that you specify.
final String	byCustomizationTypeAsString()	Return models that support the customization type that you specify.
final InferenceType	byInferenceType()	Return models that support the inference type that you specify.
final String	byInferenceTypeAsString()	Return models that support the inference type that you specify.
final ModelModality	byOutputModality()	Return models that support the output modality that you specify.
final String	byOutputModalityAsString()	Return models that support the output modality that you specify.
final String	byProvider()	Return models belonging to the model provider that you specify.
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)	Indicates whether some other object is "equal to" this one by SDK fields.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)	Used to retrieve the value of a field from any class that extends SdkRequest.
final int	hashCode()
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends ListFoundationModelsRequest.Builder>	serializableBuilderClass()
ListFoundationModelsRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
final String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Details

byProvider

public final String byProvider()

Return models belonging to the model provider that you specify.

Returns:

Return models belonging to the model provider that you specify.

byCustomizationType

public final ModelCustomization byCustomizationType()

Return models that support the customization type that you specify. For more information, see Custom models in the Amazon Bedrock User Guide.

If the service returns an enum value that is not available in the current SDK version, byCustomizationType will return ModelCustomization.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from byCustomizationTypeAsString().

Returns:

Return models that support the customization type that you specify. For more information, see Custom models in the Amazon Bedrock User Guide.

See Also:

• ModelCustomization

byCustomizationTypeAsString

public final String byCustomizationTypeAsString()

Return models that support the customization type that you specify. For more information, see Custom models in the Amazon Bedrock User Guide.

If the service returns an enum value that is not available in the current SDK version, byCustomizationType will return ModelCustomization.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from byCustomizationTypeAsString().

Returns:

Return models that support the customization type that you specify. For more information, see Custom models in the Amazon Bedrock User Guide.

See Also:

• ModelCustomization

byOutputModality

public final ModelModality byOutputModality()

Return models that support the output modality that you specify.

If the service returns an enum value that is not available in the current SDK version, byOutputModality will return ModelModality.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from byOutputModalityAsString().

Returns:

Return models that support the output modality that you specify.

See Also:

• ModelModality

byOutputModalityAsString

public final String byOutputModalityAsString()

Return models that support the output modality that you specify.

If the service returns an enum value that is not available in the current SDK version, byOutputModality will return ModelModality.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from byOutputModalityAsString().

Returns:

Return models that support the output modality that you specify.

See Also:

• ModelModality

byInferenceType

public final InferenceType byInferenceType()

Return models that support the inference type that you specify. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.

If the service returns an enum value that is not available in the current SDK version, byInferenceType will return InferenceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from byInferenceTypeAsString().

Returns:

Return models that support the inference type that you specify. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.

See Also:

• InferenceType

byInferenceTypeAsString

public final String byInferenceTypeAsString()

Return models that support the inference type that you specify. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.

If the service returns an enum value that is not available in the current SDK version, byInferenceType will return InferenceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from byInferenceTypeAsString().

Returns:

Return models that support the inference type that you specify. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.

See Also:

• InferenceType

toBuilder

public ListFoundationModelsRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<ListFoundationModelsRequest.Builder,ListFoundationModelsRequest>

Specified by:

toBuilder in class BedrockRequest

Returns:

a builder for type T

builder

public static ListFoundationModelsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ListFoundationModelsRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
 Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo

Returns:

The mapping between the field name and its corresponding field.