Package software.amazon.awscdk.services.bedrockagentcore

Class SchemaDefinition.Builder

java.lang.Object

software.amazon.awscdk.services.bedrockagentcore.SchemaDefinition.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<SchemaDefinition>

Enclosing interface:

SchemaDefinition

@Stability(Stable)
public static final class SchemaDefinition.Builder
extends Object
implements software.amazon.jsii.Builder<SchemaDefinition>

A builder for SchemaDefinition

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SchemaDefinition	build()	Builds the configured instance.
SchemaDefinition.Builder	description(String description)	Sets the value of SchemaDefinition.getDescription()
SchemaDefinition.Builder	items(SchemaDefinition items)	Sets the value of SchemaDefinition.getItems()
SchemaDefinition.Builder	properties(Map<String,? extends SchemaDefinition> properties)	Sets the value of SchemaDefinition.getProperties()
SchemaDefinition.Builder	required(List<String> required)	Sets the value of SchemaDefinition.getRequired()
SchemaDefinition.Builder	type(SchemaDefinitionType type)	Sets the value of SchemaDefinition.getType()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

type

@Stability(Stable)
public SchemaDefinition.Builder type(SchemaDefinitionType type)

Sets the value of SchemaDefinition.getType()

Parameters:

type - The type of the schema definition. This parameter is required. This field specifies the data type of the schema.

Returns:

this

description

@Stability(Stable)
public SchemaDefinition.Builder description(String description)

Sets the value of SchemaDefinition.getDescription()

Parameters:

description - The description of the schema definition. This description provides information about the purpose and usage of the schema.

Returns:

this

items

@Stability(Stable)
public SchemaDefinition.Builder items(SchemaDefinition items)

Sets the value of SchemaDefinition.getItems()

Parameters:

items - The items in the schema definition. This field is used for array types to define the structure of the array elements.

Returns:

this

properties

@Stability(Stable)
public SchemaDefinition.Builder properties(Map<String,? extends SchemaDefinition> properties)

Sets the value of SchemaDefinition.getProperties()

Parameters:

properties - The properties of the schema definition. These properties define the fields in the schema.

Returns:

this

required

@Stability(Stable)
public SchemaDefinition.Builder required(List<String> required)

Sets the value of SchemaDefinition.getRequired()

Parameters:

required - The required fields in the schema definition. These fields must be provided when using the schema.

Returns:

this

build

@Stability(Stable)
public SchemaDefinition build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<SchemaDefinition>

Returns:

a new instance of SchemaDefinition

Throws:

NullPointerException - if any required attribute was not provided